GroundStation.Client.describe_contact(**kwargs)¶Describes an existing contact.
See also: AWS API Documentation
Request Syntax
response = client.describe_contact(
contactId='string'
)
[REQUIRED]
UUID of a contact.
{
'contactId': 'string',
'contactStatus': 'AVAILABLE'|'AWS_CANCELLED'|'AWS_FAILED'|'CANCELLED'|'CANCELLING'|'COMPLETED'|'FAILED'|'FAILED_TO_SCHEDULE'|'PASS'|'POSTPASS'|'PREPASS'|'SCHEDULED'|'SCHEDULING',
'dataflowList': [
{
'destination': {
'configDetails': {
'antennaDemodDecodeDetails': {
'outputNode': 'string'
},
'endpointDetails': {
'awsGroundStationAgentEndpoint': {
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY',
'egressAddress': {
'mtu': 123,
'socketAddress': {
'name': 'string',
'port': 123
}
},
'ingressAddress': {
'mtu': 123,
'socketAddress': {
'name': 'string',
'portRange': {
'maximum': 123,
'minimum': 123
}
}
},
'name': 'string'
},
'endpoint': {
'address': {
'name': 'string',
'port': 123
},
'mtu': 123,
'name': 'string',
'status': 'created'|'creating'|'deleted'|'deleting'|'failed'
},
'securityDetails': {
'roleArn': 'string',
'securityGroupIds': [
'string',
],
'subnetIds': [
'string',
]
}
},
's3RecordingDetails': {
'bucketArn': 'string',
'keyTemplate': 'string'
}
},
'configId': 'string',
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'antenna-uplink'|'dataflow-endpoint'|'tracking'|'uplink-echo'|'s3-recording',
'dataflowDestinationRegion': 'string'
},
'errorMessage': 'string',
'source': {
'configDetails': {
'antennaDemodDecodeDetails': {
'outputNode': 'string'
},
'endpointDetails': {
'awsGroundStationAgentEndpoint': {
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY',
'egressAddress': {
'mtu': 123,
'socketAddress': {
'name': 'string',
'port': 123
}
},
'ingressAddress': {
'mtu': 123,
'socketAddress': {
'name': 'string',
'portRange': {
'maximum': 123,
'minimum': 123
}
}
},
'name': 'string'
},
'endpoint': {
'address': {
'name': 'string',
'port': 123
},
'mtu': 123,
'name': 'string',
'status': 'created'|'creating'|'deleted'|'deleting'|'failed'
},
'securityDetails': {
'roleArn': 'string',
'securityGroupIds': [
'string',
],
'subnetIds': [
'string',
]
}
},
's3RecordingDetails': {
'bucketArn': 'string',
'keyTemplate': 'string'
}
},
'configId': 'string',
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'antenna-uplink'|'dataflow-endpoint'|'tracking'|'uplink-echo'|'s3-recording',
'dataflowSourceRegion': 'string'
}
},
],
'endTime': datetime(2015, 1, 1),
'errorMessage': 'string',
'groundStation': 'string',
'maximumElevation': {
'unit': 'DEGREE_ANGLE'|'RADIAN',
'value': 123.0
},
'missionProfileArn': 'string',
'postPassEndTime': datetime(2015, 1, 1),
'prePassStartTime': datetime(2015, 1, 1),
'region': 'string',
'satelliteArn': 'string',
'startTime': datetime(2015, 1, 1),
'tags': {
'string': 'string'
}
}
Response Structure
UUID of a contact.
Status of a contact.
List describing source and destination details for each dataflow edge.
Information about a dataflow edge used in a contact.
Dataflow details for the destination side.
Additional details for a Config , if type is dataflow endpoint or antenna demod decode.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: antennaDemodDecodeDetails, endpointDetails, s3RecordingDetails. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
Details for antenna demod decode Config in a contact.
Name of an antenna demod decode output node used in a contact.
Information about the endpoint details.
An agent endpoint.
The status of AgentEndpoint.
The results of the audit.
The egress address of AgentEndpoint.
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
A socket address.
Name of a socket address.
Port of a socket address.
The ingress address of AgentEndpoint.
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
A ranged socket address.
IPv4 socket address.
Port range of a socket address.
A maximum value.
A minimum value.
Name string associated with AgentEndpoint. Used as a human-readable identifier for AgentEndpoint.
A dataflow endpoint.
Socket address of a dataflow endpoint.
Name of a socket address.
Port of a socket address.
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
Name of a dataflow endpoint.
Status of a dataflow endpoint.
Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.
ARN to a role needed for connecting streams to your instances.
The security groups to attach to the elastic network interfaces.
A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.
Details for an S3 recording Config in a contact.
ARN of the bucket used.
Key template used for the S3 Recording Configuration
UUID of a Config .
Type of a Config .
Region of a dataflow destination.
Error message for a dataflow.
Dataflow details for the source side.
Additional details for a Config , if type is dataflow-endpoint or antenna-downlink-demod-decode
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: antennaDemodDecodeDetails, endpointDetails, s3RecordingDetails. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:
'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
Details for antenna demod decode Config in a contact.
Name of an antenna demod decode output node used in a contact.
Information about the endpoint details.
An agent endpoint.
The status of AgentEndpoint.
The results of the audit.
The egress address of AgentEndpoint.
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
A socket address.
Name of a socket address.
Port of a socket address.
The ingress address of AgentEndpoint.
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
A ranged socket address.
IPv4 socket address.
Port range of a socket address.
A maximum value.
A minimum value.
Name string associated with AgentEndpoint. Used as a human-readable identifier for AgentEndpoint.
A dataflow endpoint.
Socket address of a dataflow endpoint.
Name of a socket address.
Port of a socket address.
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
Name of a dataflow endpoint.
Status of a dataflow endpoint.
Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.
ARN to a role needed for connecting streams to your instances.
The security groups to attach to the elastic network interfaces.
A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.
Details for an S3 recording Config in a contact.
ARN of the bucket used.
Key template used for the S3 Recording Configuration
UUID of a Config .
Type of a Config .
Region of a dataflow source.
End time of a contact in UTC.
Error message for a contact.
Ground station for a contact.
Maximum elevation angle of a contact.
Elevation angle units.
Elevation angle value.
ARN of a mission profile.
Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
Region of a contact.
ARN of a satellite.
Start time of a contact in UTC.
Tags assigned to a contact.
Exceptions
GroundStation.Client.exceptions.InvalidParameterExceptionGroundStation.Client.exceptions.DependencyExceptionGroundStation.Client.exceptions.ResourceNotFoundException