ListContacts - AWS Ground Station

ListContacts

Returns a list of contacts.

If statusList contains AVAILABLE, the request must include groundStation, missionprofileArn, and satelliteArn.

Request Syntax

POST /contacts HTTP/1.1 Content-type: application/json { "endTime": number, "groundStation": "string", "maxResults": number, "missionProfileArn": "string", "nextToken": "string", "satelliteArn": "string", "startTime": number, "statusList": [ "string" ] }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

endTime

End time of a contact.

Type: Timestamp

Required: Yes

groundStation

Name of a ground station.

Type: String

Required: No

maxResults

Maximum number of contacts returned.

Type: Integer

Required: No

missionProfileArn

ARN of a mission profile.

Type: String

Required: No

nextToken

Next token returned in the request of a previous ListContacts call. Used to get the next page of results.

Type: String

Required: No

satelliteArn

ARN of a satellite.

Type: String

Required: No

startTime

Start time of a contact.

Type: Timestamp

Required: Yes

statusList

Status of a contact reservation.

Type: Array of strings

Valid Values: AVAILABLE | AWS_CANCELLED | CANCELLED | CANCELLING | COMPLETED | FAILED | FAILED_TO_SCHEDULE | PASS | POSTPASS | PREPASS | SCHEDULED | SCHEDULING

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "contactList": [ { "contactId": "string", "contactStatus": "string", "endTime": number, "errorMessage": "string", "groundStation": "string", "maximumElevation": { "unit": "string", "value": number }, "missionProfileArn": "string", "postPassEndTime": number, "prePassStartTime": number, "region": "string", "satelliteArn": "string", "startTime": number, "tags": { "string" : "string" } } ], "nextToken": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

contactList

List of contacts.

Type: Array of ContactData objects

nextToken

Next token returned in the response of a previous ListContacts call. Used to get the next page of results.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

DependencyException

Dependency encountered an error.

HTTP Status Code: 531

InvalidParameterException

One or more parameters are not valid.

HTTP Status Code: 431

ResourceNotFoundException

Resource was not found.

HTTP Status Code: 434

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: