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

ReserveContact

Reserves a contact using specified parameters.

Request Syntax


POST /contact HTTP/1.1
Content-type: application/json

{
   "endTime": number,
   "groundStation": "string",
   "missionProfileArn": "string",
   "satelliteArn": "string",
   "startTime": number,
   "tags": { 
      "string" : "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: Yes

missionProfileArn

ARN of a mission profile.

Type: String

Required: Yes

satelliteArn

ARN of a satellite

Type: String

Required: Yes

startTime

Start time of a contact in UTC.

Type: Timestamp

Required: Yes

tags

Tags assigned to a contact.

Type: String to string map

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "contactId": "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.

contactId

UUID of a contact.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

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