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.
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": {
"antennaDemodDecodeDetails": {
"outputNode": "string"
},
"endpointDetails": {
"endpoint": {
"address": {
"name": "string",
"port": number
},
"mtu": number,
"name": "string",
"status": "string"
},
"securityDetails": {
"roleArn": "string",
"securityGroupIds": [ "string" ],
"subnetIds": [ "string" ]
}
},
"s3RecordingDetails": {
"bucketArn": "string",
"keyTemplate": "string"
}
},
"configId": "string",
"configType": "string",
"dataflowDestinationRegion": "string"
},
"errorMessage": "string",
"source": {
"configDetails": {
"antennaDemodDecodeDetails": {
"outputNode": "string"
},
"endpointDetails": {
"endpoint": {
"address": {
"name": "string",
"port": number
},
"mtu": number,
"name": "string",
"status": "string"
},
"securityDetails": {
"roleArn": "string",
"securityGroupIds": [ "string" ],
"subnetIds": [ "string" ]
}
},
"s3RecordingDetails": {
"bucketArn": "string",
"keyTemplate": "string"
}
},
"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"
}
}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
- contactStatus
-
Status of a contact.
Type: String
Valid Values:
AVAILABLE | AWS_CANCELLED | AWS_FAILED | CANCELLED | CANCELLING | COMPLETED | FAILED | FAILED_TO_SCHEDULE | PASS | POSTPASS | PREPASS | SCHEDULED | SCHEDULING - dataflowList
-
List describing source and destination details for each dataflow edge.
Type: Array of DataflowDetail objects
- endTime
-
End time of a contact.
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.
Type: Timestamp
- tags
-
Tags assigned to a contact.
Type: String to string map
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:
