Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

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 in UTC.

Type: Timestamp

Required: Yes

groundStation

Name of a ground station.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 500.

Pattern: ^[ a-zA-Z0-9-._:=]{4,256}$

Required: No

maxResults

Maximum number of contacts returned.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 100.

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

Length Constraints: Minimum length of 3. Maximum length of 1000.

Pattern: ^[A-Za-z0-9-/+_.=]+$

Required: No

satelliteArn

ARN of a satellite.

Type: String

Required: No

startTime

Start time of a contact in UTC.

Type: Timestamp

Required: Yes

statusList

Status of a contact reservation.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 500 items.

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" 
         },
         "visibilityEndTime": number,
         "visibilityStartTime": number
      }
   ],
   "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

Length Constraints: Minimum length of 3. Maximum length of 1000.

Pattern: ^[A-Za-z0-9-/+_.=]+$

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