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

DescribeContact

Describes an existing contact.

Request Syntax


GET /contact/contactId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

contactId

UUID of a contact.

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}$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "contactId": "string",
   "contactStatus": "string",
   "dataflowList": [ 
      { 
         "destination": { 
            "configDetails": { ... },
            "configId": "string",
            "configType": "string",
            "dataflowDestinationRegion": "string"
         },
         "errorMessage": "string",
         "source": { 
            "configDetails": { ... },
            "configId": "string",
            "configType": "string",
            "dataflowSourceRegion": "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
}

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}$

contactStatus

Status of a contact.

Type: String

dataflowList

List describing source and destination details for each dataflow edge.

Type: Array of DataflowDetail objects

endTime

End time of a contact in UTC.

Type: Timestamp

errorMessage

Error message for a contact.

Type: String

groundStation

Ground station for a contact.

Type: String

maximumElevation

Maximum elevation angle of a contact.

Type: Elevation object

missionProfileArn

ARN of a mission profile.

Type: String

postPassEndTime

Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.

Type: Timestamp

prePassStartTime

Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.

Type: Timestamp

region

Region of a contact.

Type: String

satelliteArn

ARN of a satellite.

Type: String

startTime

Start time of a contact in UTC.

Type: Timestamp

tags

Tags assigned to a contact.

Type: String to string map

visibilityEndTime

Projected time in UTC your satellite will set below the receive mask. This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts.

Type: Timestamp

visibilityStartTime

Projected time in UTC your satellite will rise above the receive mask. This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts.

Type: Timestamp

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