2026/04/17 - AWS Ground Station - 5 new 4 updated api methods
Changes Adds support for updating contacts, listing antennas, and listing ground station reservations. New API operations - UpdateContact, ListContactVersions, DescribeContactVersion, ListAntennas, and ListGroundStationReservations.
Updates a specific contact.
See also: AWS API Documentation
Request Syntax
client.update_contact(
contactId='string',
clientToken='string',
trackingOverrides={
'programTrackSettings': {
'azEl': {
'ephemerisId': 'string'
},
'oem': {
'ephemerisId': 'string'
},
'tle': {
'ephemerisId': 'string'
}
}
},
satelliteArn='string'
)
string
[REQUIRED]
UUID of a contact.
string
A client token is a unique, case-sensitive string of up to 64 ASCII characters. It is generated by the client to ensure idempotent operations, allowing safe retries without unintended side effects.
This field is autopopulated if not provided.
dict
Overrides the default tracking configuration on an antenna during a contact.
programTrackSettings (dict) --
Program track settings to override for antenna tracking during the contact.
azEl (dict) --
Program track settings for AzElEphemeris.
ephemerisId (string) -- [REQUIRED]
Unique identifier of the azimuth elevation ephemeris.
oem (dict) --
Program track settings for OEMEphemeris.
ephemerisId (string) -- [REQUIRED]
Unique identifier of the OEM ephemeris.
tle (dict) --
Program track settings for TLEEphemeris.
ephemerisId (string) -- [REQUIRED]
Unique identifier of the TLE ephemeris.
string
ARN of a satellite.
dict
Response Syntax
{
'contactId': 'string',
'versionId': 123
}
Response Structure
(dict) --
contactId (string) --
UUID of a contact.
versionId (integer) --
Version ID of a contact.
Returns a list of reservations for a specified ground station.
See also: AWS API Documentation
Request Syntax
client.list_ground_station_reservations(
groundStationId='string',
startTime=datetime(2015, 1, 1),
endTime=datetime(2015, 1, 1),
reservationTypes=[
'MAINTENANCE'|'CONTACT',
],
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
ID of a ground station.
datetime
[REQUIRED]
Start time of the reservation window in UTC.
datetime
[REQUIRED]
End time of the reservation window in UTC.
list
Types of reservations to filter by.
(string) --
integer
Maximum number of ground station reservations returned.
string
Next token returned in the request of a previous ListGroundStationReservations call. Used to get the next page of results.
dict
Response Syntax
{
'reservationList': [
{
'reservationType': 'MAINTENANCE'|'CONTACT',
'groundStationId': 'string',
'antennaName': 'string',
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'reservationDetails': {
'maintenance': {
'maintenanceType': 'PLANNED'|'UNPLANNED'
},
'contact': {
'contactId': 'string'
}
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
reservationList (list) --
List of ground station reservations.
(dict) --
Item in a list of ground station reservations.
reservationType (string) --
Type of a ground station reservation.
groundStationId (string) --
ID of a ground station.
antennaName (string) --
Name of an antenna.
startTime (datetime) --
Start time of a ground station reservation in UTC.
endTime (datetime) --
End time of a ground station reservation in UTC.
reservationDetails (dict) --
Details of a ground station reservation.
maintenance (dict) --
Details of a maintenance reservation.
maintenanceType (string) --
Type of maintenance.
contact (dict) --
Details of a contact reservation.
contactId (string) --
UUID of a contact.
nextToken (string) --
Next token to be used in a subsequent ListGroundStationReservations call to retrieve the next page of results.
Returns a list of versions for a specified contact.
See also: AWS API Documentation
Request Syntax
client.list_contact_versions(
contactId='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
UUID of a contact.
integer
Maximum number of contact versions returned.
string
Next token returned in the request of a previous ListContactVersions call. Used to get the next page of results.
dict
Response Syntax
{
'nextToken': 'string',
'contactVersionsList': [
{
'versionId': 123,
'created': datetime(2015, 1, 1),
'activated': datetime(2015, 1, 1),
'superseded': datetime(2015, 1, 1),
'lastUpdated': datetime(2015, 1, 1),
'status': 'UPDATING'|'ACTIVE'|'SUPERSEDED'|'FAILED_TO_UPDATE',
'failureCodes': [
'INTERNAL_ERROR'|'INVALID_SATELLITE_ARN'|'INVALID_UPDATE_CONTACT_REQUEST'|'EPHEMERIS_NOT_FOUND'|'EPHEMERIS_TIME_RANGE_INVALID'|'EPHEMERIS_NOT_ENABLED'|'SATELLITE_DOES_NOT_MATCH_EPHEMERIS'|'NOT_ONBOARDED_TO_AZEL_EPHEMERIS'|'AZEL_EPHEMERIS_NOT_FOUND'|'AZEL_EPHEMERIS_WRONG_GROUND_STATION'|'AZEL_EPHEMERIS_INVALID_STATUS'|'AZEL_EPHEMERIS_TIME_RANGE_INVALID',
],
'failureMessage': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
Next token to be used in a subsequent ListContactVersions call to retrieve the next page of results.
contactVersionsList (list) --
List of contact versions.
(dict) --
Version information for a contact.
versionId (integer) --
Version ID of a contact.
created (datetime) --
Time the contact version was created in UTC.
activated (datetime) --
Time the contact version was activated in UTC. A version is activated when it becomes the current active version of the contact.
superseded (datetime) --
Time the contact version was superseded in UTC. A version is superseded when a newer version becomes active.
lastUpdated (datetime) --
Time the contact version was last updated in UTC.
status (string) --
Status of the contact version.
failureCodes (list) --
List of failure codes for the contact version.
(string) --
failureMessage (string) --
Failure message for the contact version.
Returns a list of antennas at a specified ground station.
See also: AWS API Documentation
Request Syntax
client.list_antennas(
groundStationId='string',
maxResults=123,
nextToken='string'
)
string
[REQUIRED]
ID of a ground station.
integer
Maximum number of antennas returned.
string
Next token returned in the request of a previous ListAntennas call. Used to get the next page of results.
dict
Response Syntax
{
'antennaList': [
{
'groundStationName': 'string',
'antennaName': 'string',
'region': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
antennaList (list) --
List of antennas.
(dict) --
An antenna at a ground station.
groundStationName (string) --
Name of the ground station the antenna is associated with.
antennaName (string) --
Name of the antenna.
region (string) --
Region of the antenna.
nextToken (string) --
Next token to be used in a subsequent ListAntennas call to retrieve the next page of results.
Describes a specific version of a contact.
See also: AWS API Documentation
Request Syntax
client.describe_contact_version(
contactId='string',
versionId=123
)
string
[REQUIRED]
UUID of a contact.
integer
[REQUIRED]
Version ID of a contact.
dict
Response Syntax
{
'contactId': 'string',
'missionProfileArn': 'string',
'satelliteArn': 'string',
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'prePassStartTime': datetime(2015, 1, 1),
'postPassEndTime': datetime(2015, 1, 1),
'groundStation': 'string',
'contactStatus': 'SCHEDULING'|'FAILED_TO_SCHEDULE'|'SCHEDULED'|'CANCELLED'|'AWS_CANCELLED'|'PREPASS'|'PASS'|'POSTPASS'|'COMPLETED'|'FAILED'|'AVAILABLE'|'CANCELLING'|'AWS_FAILED',
'errorMessage': 'string',
'maximumElevation': {
'value': 123.0,
'unit': 'DEGREE_ANGLE'|'RADIAN'
},
'tags': {
'string': 'string'
},
'region': 'string',
'dataflowList': [
{
'source': {
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'tracking'|'dataflow-endpoint'|'antenna-uplink'|'uplink-echo'|'s3-recording'|'telemetry-sink',
'configId': 'string',
'configDetails': {
'endpointDetails': {
'securityDetails': {
'subnetIds': [
'string',
],
'securityGroupIds': [
'string',
],
'roleArn': 'string'
},
'endpoint': {
'name': 'string',
'address': {
'name': 'string',
'port': 123
},
'status': 'created'|'creating'|'deleted'|'deleting'|'failed',
'mtu': 123
},
'awsGroundStationAgentEndpoint': {
'name': 'string',
'egressAddress': {
'socketAddress': {
'name': 'string',
'port': 123
},
'mtu': 123
},
'ingressAddress': {
'socketAddress': {
'name': 'string',
'portRange': {
'minimum': 123,
'maximum': 123
}
},
'mtu': 123
},
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY'
},
'uplinkAwsGroundStationAgentEndpoint': {
'name': 'string',
'dataflowDetails': {
'agentConnectionDetails': {
'ingressAddressAndPort': {
'socketAddress': {
'name': 'string',
'port': 123
},
'mtu': 123
},
'agentIpAndPortAddress': {
'socketAddress': {
'name': 'string',
'portRange': {
'minimum': 123,
'maximum': 123
}
},
'mtu': 123
}
}
},
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY'
},
'downlinkAwsGroundStationAgentEndpoint': {
'name': 'string',
'dataflowDetails': {
'agentConnectionDetails': {
'agentIpAndPortAddress': {
'socketAddress': {
'name': 'string',
'portRange': {
'minimum': 123,
'maximum': 123
}
},
'mtu': 123
},
'egressAddressAndPort': {
'socketAddress': {
'name': 'string',
'port': 123
},
'mtu': 123
}
}
},
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY'
},
'healthStatus': 'HEALTHY'|'UNHEALTHY',
'healthReasons': [
'NO_REGISTERED_AGENT'|'INVALID_IP_OWNERSHIP'|'NOT_AUTHORIZED_TO_CREATE_SLR'|'UNVERIFIED_IP_OWNERSHIP'|'INITIALIZING_DATAPLANE'|'DATAPLANE_FAILURE'|'HEALTHY',
]
},
'antennaDemodDecodeDetails': {
'outputNode': 'string'
},
's3RecordingDetails': {
'bucketArn': 'string',
'keyTemplate': 'string'
}
},
'dataflowSourceRegion': 'string'
},
'destination': {
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'tracking'|'dataflow-endpoint'|'antenna-uplink'|'uplink-echo'|'s3-recording'|'telemetry-sink',
'configId': 'string',
'configDetails': {
'endpointDetails': {
'securityDetails': {
'subnetIds': [
'string',
],
'securityGroupIds': [
'string',
],
'roleArn': 'string'
},
'endpoint': {
'name': 'string',
'address': {
'name': 'string',
'port': 123
},
'status': 'created'|'creating'|'deleted'|'deleting'|'failed',
'mtu': 123
},
'awsGroundStationAgentEndpoint': {
'name': 'string',
'egressAddress': {
'socketAddress': {
'name': 'string',
'port': 123
},
'mtu': 123
},
'ingressAddress': {
'socketAddress': {
'name': 'string',
'portRange': {
'minimum': 123,
'maximum': 123
}
},
'mtu': 123
},
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY'
},
'uplinkAwsGroundStationAgentEndpoint': {
'name': 'string',
'dataflowDetails': {
'agentConnectionDetails': {
'ingressAddressAndPort': {
'socketAddress': {
'name': 'string',
'port': 123
},
'mtu': 123
},
'agentIpAndPortAddress': {
'socketAddress': {
'name': 'string',
'portRange': {
'minimum': 123,
'maximum': 123
}
},
'mtu': 123
}
}
},
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY'
},
'downlinkAwsGroundStationAgentEndpoint': {
'name': 'string',
'dataflowDetails': {
'agentConnectionDetails': {
'agentIpAndPortAddress': {
'socketAddress': {
'name': 'string',
'portRange': {
'minimum': 123,
'maximum': 123
}
},
'mtu': 123
},
'egressAddressAndPort': {
'socketAddress': {
'name': 'string',
'port': 123
},
'mtu': 123
}
}
},
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY'
},
'healthStatus': 'HEALTHY'|'UNHEALTHY',
'healthReasons': [
'NO_REGISTERED_AGENT'|'INVALID_IP_OWNERSHIP'|'NOT_AUTHORIZED_TO_CREATE_SLR'|'UNVERIFIED_IP_OWNERSHIP'|'INITIALIZING_DATAPLANE'|'DATAPLANE_FAILURE'|'HEALTHY',
]
},
'antennaDemodDecodeDetails': {
'outputNode': 'string'
},
's3RecordingDetails': {
'bucketArn': 'string',
'keyTemplate': 'string'
}
},
'dataflowDestinationRegion': 'string'
},
'errorMessage': 'string'
},
],
'visibilityStartTime': datetime(2015, 1, 1),
'visibilityEndTime': datetime(2015, 1, 1),
'trackingOverrides': {
'programTrackSettings': {
'azEl': {
'ephemerisId': 'string'
},
'oem': {
'ephemerisId': 'string'
},
'tle': {
'ephemerisId': 'string'
}
}
},
'ephemeris': {
'ephemerisId': 'string',
'ephemerisType': 'TLE'|'OEM'|'AZ_EL'|'SERVICE_MANAGED'
},
'version': {
'versionId': 123,
'created': datetime(2015, 1, 1),
'activated': datetime(2015, 1, 1),
'superseded': datetime(2015, 1, 1),
'lastUpdated': datetime(2015, 1, 1),
'status': 'UPDATING'|'ACTIVE'|'SUPERSEDED'|'FAILED_TO_UPDATE',
'failureCodes': [
'INTERNAL_ERROR'|'INVALID_SATELLITE_ARN'|'INVALID_UPDATE_CONTACT_REQUEST'|'EPHEMERIS_NOT_FOUND'|'EPHEMERIS_TIME_RANGE_INVALID'|'EPHEMERIS_NOT_ENABLED'|'SATELLITE_DOES_NOT_MATCH_EPHEMERIS'|'NOT_ONBOARDED_TO_AZEL_EPHEMERIS'|'AZEL_EPHEMERIS_NOT_FOUND'|'AZEL_EPHEMERIS_WRONG_GROUND_STATION'|'AZEL_EPHEMERIS_INVALID_STATUS'|'AZEL_EPHEMERIS_TIME_RANGE_INVALID',
],
'failureMessage': 'string'
}
}
Response Structure
(dict) --
contactId (string) --
UUID of a contact.
missionProfileArn (string) --
ARN of the contact's mission profile.
satelliteArn (string) --
ARN of a satellite.
startTime (datetime) --
Start time of a contact in UTC.
endTime (datetime) --
End time of a contact in UTC.
prePassStartTime (datetime) --
Start time in UTC of the pre-pass period, at which you receive a CloudWatch event indicating an upcoming pass.
postPassEndTime (datetime) --
End time in UTC of the post-pass period, at which you receive a CloudWatch event indicating the pass has finished.
groundStation (string) --
Ground station for a contact.
contactStatus (string) --
Status of a contact.
errorMessage (string) --
Error message for a contact.
maximumElevation (dict) --
Maximum elevation angle of a contact.
value (float) --
Elevation angle value.
unit (string) --
Elevation angle units.
tags (dict) --
Tags assigned to a contact.
(string) --
(string) --
region (string) --
Region where the ReserveContact API was called to schedule this contact.
dataflowList (list) --
List describing source and destination details for each dataflow edge.
(dict) --
Information about a dataflow edge used in a contact.
source (dict) --
Dataflow details for the source side.
configType (string) --
Type of a Config.
configId (string) --
UUID of a Config.
configDetails (dict) --
Additional details for a Config, if type is dataflow-endpoint or antenna-downlink-demod-decode
endpointDetails (dict) --
Information about the endpoint details.
securityDetails (dict) --
Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.
subnetIds (list) --
A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.
(string) --
securityGroupIds (list) --
The security groups to attach to the elastic network interfaces.
(string) --
roleArn (string) --
ARN to a role needed for connecting streams to your instances.
endpoint (dict) --
A dataflow endpoint.
name (string) --
Name of a dataflow endpoint.
address (dict) --
Socket address of a dataflow endpoint.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
status (string) --
Status of a dataflow endpoint.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
awsGroundStationAgentEndpoint (dict) --
An agent endpoint.
name (string) --
Name string associated with AgentEndpoint. Used as a human-readable identifier for AgentEndpoint.
egressAddress (dict) --
The egress address of AgentEndpoint.
socketAddress (dict) --
A socket address.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
ingressAddress (dict) --
The ingress address of AgentEndpoint.
socketAddress (dict) --
A ranged socket address.
name (string) --
IPv4 socket address.
portRange (dict) --
Port range of a socket address.
minimum (integer) --
A minimum value.
maximum (integer) --
A maximum value.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentStatus (string) --
The status of AgentEndpoint.
auditResults (string) --
The results of the audit.
uplinkAwsGroundStationAgentEndpoint (dict) --
Definition for an uplink agent endpoint
name (string) --
Uplink dataflow endpoint name
dataflowDetails (dict) --
Dataflow details for the uplink endpoint
agentConnectionDetails (dict) --
Uplink connection details for customer to Agent and Agent to Ground Station
ingressAddressAndPort (dict) --
Egress address of AgentEndpoint with an optional mtu.
socketAddress (dict) --
A socket address.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentIpAndPortAddress (dict) --
Ingress address of AgentEndpoint with a port range and an optional mtu.
socketAddress (dict) --
A ranged socket address.
name (string) --
IPv4 socket address.
portRange (dict) --
Port range of a socket address.
minimum (integer) --
A minimum value.
maximum (integer) --
A maximum value.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentStatus (string) --
Status of the agent associated with the uplink dataflow endpoint
auditResults (string) --
Health audit results for the uplink dataflow endpoint
downlinkAwsGroundStationAgentEndpoint (dict) --
Definition for a downlink agent endpoint
name (string) --
Downlink dataflow endpoint name
dataflowDetails (dict) --
Dataflow details for the downlink endpoint
agentConnectionDetails (dict) --
Downlink connection details for customer to Agent and Agent to Ground Station
agentIpAndPortAddress (dict) --
Ingress address of AgentEndpoint with a port range and an optional mtu.
socketAddress (dict) --
A ranged socket address.
name (string) --
IPv4 socket address.
portRange (dict) --
Port range of a socket address.
minimum (integer) --
A minimum value.
maximum (integer) --
A maximum value.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
egressAddressAndPort (dict) --
Egress address of AgentEndpoint with an optional mtu.
socketAddress (dict) --
A socket address.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentStatus (string) --
Status of the agent associated with the downlink dataflow endpoint
auditResults (string) --
Health audit results for the downlink dataflow endpoint
healthStatus (string) --
A dataflow endpoint health status. This field is ignored when calling CreateDataflowEndpointGroup.
healthReasons (list) --
Health reasons for a dataflow endpoint. This field is ignored when calling CreateDataflowEndpointGroup.
(string) --
antennaDemodDecodeDetails (dict) --
Details for antenna demod decode Config in a contact.
outputNode (string) --
Name of an antenna demod decode output node used in a contact.
s3RecordingDetails (dict) --
Details for an S3 recording Config in a contact.
bucketArn (string) --
ARN of the bucket used.
keyTemplate (string) --
Key template used for the S3 Recording Configuration
dataflowSourceRegion (string) --
Region of a dataflow source.
destination (dict) --
Dataflow details for the destination side.
configType (string) --
Type of a Config.
configId (string) --
UUID of a Config.
configDetails (dict) --
Additional details for a Config, if type is dataflow endpoint or antenna demod decode.
endpointDetails (dict) --
Information about the endpoint details.
securityDetails (dict) --
Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.
subnetIds (list) --
A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.
(string) --
securityGroupIds (list) --
The security groups to attach to the elastic network interfaces.
(string) --
roleArn (string) --
ARN to a role needed for connecting streams to your instances.
endpoint (dict) --
A dataflow endpoint.
name (string) --
Name of a dataflow endpoint.
address (dict) --
Socket address of a dataflow endpoint.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
status (string) --
Status of a dataflow endpoint.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
awsGroundStationAgentEndpoint (dict) --
An agent endpoint.
name (string) --
Name string associated with AgentEndpoint. Used as a human-readable identifier for AgentEndpoint.
egressAddress (dict) --
The egress address of AgentEndpoint.
socketAddress (dict) --
A socket address.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
ingressAddress (dict) --
The ingress address of AgentEndpoint.
socketAddress (dict) --
A ranged socket address.
name (string) --
IPv4 socket address.
portRange (dict) --
Port range of a socket address.
minimum (integer) --
A minimum value.
maximum (integer) --
A maximum value.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentStatus (string) --
The status of AgentEndpoint.
auditResults (string) --
The results of the audit.
uplinkAwsGroundStationAgentEndpoint (dict) --
Definition for an uplink agent endpoint
name (string) --
Uplink dataflow endpoint name
dataflowDetails (dict) --
Dataflow details for the uplink endpoint
agentConnectionDetails (dict) --
Uplink connection details for customer to Agent and Agent to Ground Station
ingressAddressAndPort (dict) --
Egress address of AgentEndpoint with an optional mtu.
socketAddress (dict) --
A socket address.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentIpAndPortAddress (dict) --
Ingress address of AgentEndpoint with a port range and an optional mtu.
socketAddress (dict) --
A ranged socket address.
name (string) --
IPv4 socket address.
portRange (dict) --
Port range of a socket address.
minimum (integer) --
A minimum value.
maximum (integer) --
A maximum value.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentStatus (string) --
Status of the agent associated with the uplink dataflow endpoint
auditResults (string) --
Health audit results for the uplink dataflow endpoint
downlinkAwsGroundStationAgentEndpoint (dict) --
Definition for a downlink agent endpoint
name (string) --
Downlink dataflow endpoint name
dataflowDetails (dict) --
Dataflow details for the downlink endpoint
agentConnectionDetails (dict) --
Downlink connection details for customer to Agent and Agent to Ground Station
agentIpAndPortAddress (dict) --
Ingress address of AgentEndpoint with a port range and an optional mtu.
socketAddress (dict) --
A ranged socket address.
name (string) --
IPv4 socket address.
portRange (dict) --
Port range of a socket address.
minimum (integer) --
A minimum value.
maximum (integer) --
A maximum value.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
egressAddressAndPort (dict) --
Egress address of AgentEndpoint with an optional mtu.
socketAddress (dict) --
A socket address.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentStatus (string) --
Status of the agent associated with the downlink dataflow endpoint
auditResults (string) --
Health audit results for the downlink dataflow endpoint
healthStatus (string) --
A dataflow endpoint health status. This field is ignored when calling CreateDataflowEndpointGroup.
healthReasons (list) --
Health reasons for a dataflow endpoint. This field is ignored when calling CreateDataflowEndpointGroup.
(string) --
antennaDemodDecodeDetails (dict) --
Details for antenna demod decode Config in a contact.
outputNode (string) --
Name of an antenna demod decode output node used in a contact.
s3RecordingDetails (dict) --
Details for an S3 recording Config in a contact.
bucketArn (string) --
ARN of the bucket used.
keyTemplate (string) --
Key template used for the S3 Recording Configuration
dataflowDestinationRegion (string) --
Region of a dataflow destination.
errorMessage (string) --
Error message for a dataflow.
visibilityStartTime (datetime) --
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.
visibilityEndTime (datetime) --
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.
trackingOverrides (dict) --
Tracking configuration overrides applied to this contact version. For the initial version, these are the overrides specified when the contact was reserved. For subsequent versions, these are the overrides associated with that specific version update.
programTrackSettings (dict) --
Program track settings to override for antenna tracking during the contact.
azEl (dict) --
Program track settings for AzElEphemeris.
ephemerisId (string) --
Unique identifier of the azimuth elevation ephemeris.
oem (dict) --
Program track settings for OEMEphemeris.
ephemerisId (string) --
Unique identifier of the OEM ephemeris.
tle (dict) --
Program track settings for TLEEphemeris.
ephemerisId (string) --
Unique identifier of the TLE ephemeris.
ephemeris (dict) --
The ephemeris that determines antenna pointing directions for the contact.
ephemerisId (string) --
Unique identifier of the ephemeris. Appears only for custom ephemerides.
ephemerisType (string) --
Type of ephemeris.
version (dict) --
Version information for a contact.
versionId (integer) --
Version ID of a contact.
created (datetime) --
Time the contact version was created in UTC.
activated (datetime) --
Time the contact version was activated in UTC. A version is activated when it becomes the current active version of the contact.
superseded (datetime) --
Time the contact version was superseded in UTC. A version is superseded when a newer version becomes active.
lastUpdated (datetime) --
Time the contact version was last updated in UTC.
status (string) --
Status of the contact version.
failureCodes (list) --
List of failure codes for the contact version.
(string) --
failureMessage (string) --
Failure message for the contact version.
{'versionId': 'integer'}
Cancels or stops a contact with a specified contact ID based on its position in the contact lifecycle.
For contacts that:
Have yet to start, the contact will be cancelled.
Have started but have yet to finish, the contact will be stopped.
See also: AWS API Documentation
Request Syntax
client.cancel_contact(
contactId='string'
)
string
[REQUIRED]
UUID of a contact.
dict
Response Syntax
{
'contactId': 'string',
'versionId': 123
}
Response Structure
(dict) --
Response containing the ID of a contact.
contactId (string) --
UUID of a contact.
versionId (integer) --
Version ID of a contact.
{'trackingOverrides': {'programTrackSettings': {'oem': {'ephemerisId': 'string'},
'tle': {'ephemerisId': 'string'}}},
'version': {'activated': 'timestamp',
'created': 'timestamp',
'failureCodes': ['INTERNAL_ERROR | INVALID_SATELLITE_ARN | '
'INVALID_UPDATE_CONTACT_REQUEST | '
'EPHEMERIS_NOT_FOUND | '
'EPHEMERIS_TIME_RANGE_INVALID | '
'EPHEMERIS_NOT_ENABLED | '
'SATELLITE_DOES_NOT_MATCH_EPHEMERIS | '
'NOT_ONBOARDED_TO_AZEL_EPHEMERIS | '
'AZEL_EPHEMERIS_NOT_FOUND | '
'AZEL_EPHEMERIS_WRONG_GROUND_STATION | '
'AZEL_EPHEMERIS_INVALID_STATUS | '
'AZEL_EPHEMERIS_TIME_RANGE_INVALID'],
'failureMessage': 'string',
'lastUpdated': 'timestamp',
'status': 'UPDATING | ACTIVE | SUPERSEDED | FAILED_TO_UPDATE',
'superseded': 'timestamp',
'versionId': 'integer'}}
Describes an existing contact.
See also: AWS API Documentation
Request Syntax
client.describe_contact(
contactId='string'
)
string
[REQUIRED]
UUID of a contact.
dict
Response Syntax
{
'contactId': 'string',
'missionProfileArn': 'string',
'satelliteArn': 'string',
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'prePassStartTime': datetime(2015, 1, 1),
'postPassEndTime': datetime(2015, 1, 1),
'groundStation': 'string',
'contactStatus': 'SCHEDULING'|'FAILED_TO_SCHEDULE'|'SCHEDULED'|'CANCELLED'|'AWS_CANCELLED'|'PREPASS'|'PASS'|'POSTPASS'|'COMPLETED'|'FAILED'|'AVAILABLE'|'CANCELLING'|'AWS_FAILED',
'errorMessage': 'string',
'maximumElevation': {
'value': 123.0,
'unit': 'DEGREE_ANGLE'|'RADIAN'
},
'tags': {
'string': 'string'
},
'region': 'string',
'dataflowList': [
{
'source': {
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'tracking'|'dataflow-endpoint'|'antenna-uplink'|'uplink-echo'|'s3-recording'|'telemetry-sink',
'configId': 'string',
'configDetails': {
'endpointDetails': {
'securityDetails': {
'subnetIds': [
'string',
],
'securityGroupIds': [
'string',
],
'roleArn': 'string'
},
'endpoint': {
'name': 'string',
'address': {
'name': 'string',
'port': 123
},
'status': 'created'|'creating'|'deleted'|'deleting'|'failed',
'mtu': 123
},
'awsGroundStationAgentEndpoint': {
'name': 'string',
'egressAddress': {
'socketAddress': {
'name': 'string',
'port': 123
},
'mtu': 123
},
'ingressAddress': {
'socketAddress': {
'name': 'string',
'portRange': {
'minimum': 123,
'maximum': 123
}
},
'mtu': 123
},
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY'
},
'uplinkAwsGroundStationAgentEndpoint': {
'name': 'string',
'dataflowDetails': {
'agentConnectionDetails': {
'ingressAddressAndPort': {
'socketAddress': {
'name': 'string',
'port': 123
},
'mtu': 123
},
'agentIpAndPortAddress': {
'socketAddress': {
'name': 'string',
'portRange': {
'minimum': 123,
'maximum': 123
}
},
'mtu': 123
}
}
},
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY'
},
'downlinkAwsGroundStationAgentEndpoint': {
'name': 'string',
'dataflowDetails': {
'agentConnectionDetails': {
'agentIpAndPortAddress': {
'socketAddress': {
'name': 'string',
'portRange': {
'minimum': 123,
'maximum': 123
}
},
'mtu': 123
},
'egressAddressAndPort': {
'socketAddress': {
'name': 'string',
'port': 123
},
'mtu': 123
}
}
},
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY'
},
'healthStatus': 'HEALTHY'|'UNHEALTHY',
'healthReasons': [
'NO_REGISTERED_AGENT'|'INVALID_IP_OWNERSHIP'|'NOT_AUTHORIZED_TO_CREATE_SLR'|'UNVERIFIED_IP_OWNERSHIP'|'INITIALIZING_DATAPLANE'|'DATAPLANE_FAILURE'|'HEALTHY',
]
},
'antennaDemodDecodeDetails': {
'outputNode': 'string'
},
's3RecordingDetails': {
'bucketArn': 'string',
'keyTemplate': 'string'
}
},
'dataflowSourceRegion': 'string'
},
'destination': {
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'tracking'|'dataflow-endpoint'|'antenna-uplink'|'uplink-echo'|'s3-recording'|'telemetry-sink',
'configId': 'string',
'configDetails': {
'endpointDetails': {
'securityDetails': {
'subnetIds': [
'string',
],
'securityGroupIds': [
'string',
],
'roleArn': 'string'
},
'endpoint': {
'name': 'string',
'address': {
'name': 'string',
'port': 123
},
'status': 'created'|'creating'|'deleted'|'deleting'|'failed',
'mtu': 123
},
'awsGroundStationAgentEndpoint': {
'name': 'string',
'egressAddress': {
'socketAddress': {
'name': 'string',
'port': 123
},
'mtu': 123
},
'ingressAddress': {
'socketAddress': {
'name': 'string',
'portRange': {
'minimum': 123,
'maximum': 123
}
},
'mtu': 123
},
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY'
},
'uplinkAwsGroundStationAgentEndpoint': {
'name': 'string',
'dataflowDetails': {
'agentConnectionDetails': {
'ingressAddressAndPort': {
'socketAddress': {
'name': 'string',
'port': 123
},
'mtu': 123
},
'agentIpAndPortAddress': {
'socketAddress': {
'name': 'string',
'portRange': {
'minimum': 123,
'maximum': 123
}
},
'mtu': 123
}
}
},
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY'
},
'downlinkAwsGroundStationAgentEndpoint': {
'name': 'string',
'dataflowDetails': {
'agentConnectionDetails': {
'agentIpAndPortAddress': {
'socketAddress': {
'name': 'string',
'portRange': {
'minimum': 123,
'maximum': 123
}
},
'mtu': 123
},
'egressAddressAndPort': {
'socketAddress': {
'name': 'string',
'port': 123
},
'mtu': 123
}
}
},
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY'
},
'healthStatus': 'HEALTHY'|'UNHEALTHY',
'healthReasons': [
'NO_REGISTERED_AGENT'|'INVALID_IP_OWNERSHIP'|'NOT_AUTHORIZED_TO_CREATE_SLR'|'UNVERIFIED_IP_OWNERSHIP'|'INITIALIZING_DATAPLANE'|'DATAPLANE_FAILURE'|'HEALTHY',
]
},
'antennaDemodDecodeDetails': {
'outputNode': 'string'
},
's3RecordingDetails': {
'bucketArn': 'string',
'keyTemplate': 'string'
}
},
'dataflowDestinationRegion': 'string'
},
'errorMessage': 'string'
},
],
'visibilityStartTime': datetime(2015, 1, 1),
'visibilityEndTime': datetime(2015, 1, 1),
'trackingOverrides': {
'programTrackSettings': {
'azEl': {
'ephemerisId': 'string'
},
'oem': {
'ephemerisId': 'string'
},
'tle': {
'ephemerisId': 'string'
}
}
},
'ephemeris': {
'ephemerisId': 'string',
'ephemerisType': 'TLE'|'OEM'|'AZ_EL'|'SERVICE_MANAGED'
},
'version': {
'versionId': 123,
'created': datetime(2015, 1, 1),
'activated': datetime(2015, 1, 1),
'superseded': datetime(2015, 1, 1),
'lastUpdated': datetime(2015, 1, 1),
'status': 'UPDATING'|'ACTIVE'|'SUPERSEDED'|'FAILED_TO_UPDATE',
'failureCodes': [
'INTERNAL_ERROR'|'INVALID_SATELLITE_ARN'|'INVALID_UPDATE_CONTACT_REQUEST'|'EPHEMERIS_NOT_FOUND'|'EPHEMERIS_TIME_RANGE_INVALID'|'EPHEMERIS_NOT_ENABLED'|'SATELLITE_DOES_NOT_MATCH_EPHEMERIS'|'NOT_ONBOARDED_TO_AZEL_EPHEMERIS'|'AZEL_EPHEMERIS_NOT_FOUND'|'AZEL_EPHEMERIS_WRONG_GROUND_STATION'|'AZEL_EPHEMERIS_INVALID_STATUS'|'AZEL_EPHEMERIS_TIME_RANGE_INVALID',
],
'failureMessage': 'string'
}
}
Response Structure
(dict) --
Output for the DescribeContact operation.
contactId (string) --
UUID of a contact.
missionProfileArn (string) --
ARN of a mission profile.
satelliteArn (string) --
ARN of a satellite.
startTime (datetime) --
Start time of a contact in UTC.
endTime (datetime) --
End time of a contact in UTC.
prePassStartTime (datetime) --
Start time in UTC of the pre-pass period, at which you receive a CloudWatch event indicating an upcoming pass.
postPassEndTime (datetime) --
End time in UTC of the post-pass period, at which you receive a CloudWatch event indicating the pass has finished.
groundStation (string) --
Ground station for a contact.
contactStatus (string) --
Status of a contact.
errorMessage (string) --
Error message for a contact.
maximumElevation (dict) --
Maximum elevation angle of a contact.
value (float) --
Elevation angle value.
unit (string) --
Elevation angle units.
tags (dict) --
Tags assigned to a contact.
(string) --
(string) --
region (string) --
Region where the ReserveContact API was called to schedule this contact.
dataflowList (list) --
List describing source and destination details for each dataflow edge.
(dict) --
Information about a dataflow edge used in a contact.
source (dict) --
Dataflow details for the source side.
configType (string) --
Type of a Config.
configId (string) --
UUID of a Config.
configDetails (dict) --
Additional details for a Config, if type is dataflow-endpoint or antenna-downlink-demod-decode
endpointDetails (dict) --
Information about the endpoint details.
securityDetails (dict) --
Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.
subnetIds (list) --
A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.
(string) --
securityGroupIds (list) --
The security groups to attach to the elastic network interfaces.
(string) --
roleArn (string) --
ARN to a role needed for connecting streams to your instances.
endpoint (dict) --
A dataflow endpoint.
name (string) --
Name of a dataflow endpoint.
address (dict) --
Socket address of a dataflow endpoint.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
status (string) --
Status of a dataflow endpoint.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
awsGroundStationAgentEndpoint (dict) --
An agent endpoint.
name (string) --
Name string associated with AgentEndpoint. Used as a human-readable identifier for AgentEndpoint.
egressAddress (dict) --
The egress address of AgentEndpoint.
socketAddress (dict) --
A socket address.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
ingressAddress (dict) --
The ingress address of AgentEndpoint.
socketAddress (dict) --
A ranged socket address.
name (string) --
IPv4 socket address.
portRange (dict) --
Port range of a socket address.
minimum (integer) --
A minimum value.
maximum (integer) --
A maximum value.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentStatus (string) --
The status of AgentEndpoint.
auditResults (string) --
The results of the audit.
uplinkAwsGroundStationAgentEndpoint (dict) --
Definition for an uplink agent endpoint
name (string) --
Uplink dataflow endpoint name
dataflowDetails (dict) --
Dataflow details for the uplink endpoint
agentConnectionDetails (dict) --
Uplink connection details for customer to Agent and Agent to Ground Station
ingressAddressAndPort (dict) --
Egress address of AgentEndpoint with an optional mtu.
socketAddress (dict) --
A socket address.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentIpAndPortAddress (dict) --
Ingress address of AgentEndpoint with a port range and an optional mtu.
socketAddress (dict) --
A ranged socket address.
name (string) --
IPv4 socket address.
portRange (dict) --
Port range of a socket address.
minimum (integer) --
A minimum value.
maximum (integer) --
A maximum value.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentStatus (string) --
Status of the agent associated with the uplink dataflow endpoint
auditResults (string) --
Health audit results for the uplink dataflow endpoint
downlinkAwsGroundStationAgentEndpoint (dict) --
Definition for a downlink agent endpoint
name (string) --
Downlink dataflow endpoint name
dataflowDetails (dict) --
Dataflow details for the downlink endpoint
agentConnectionDetails (dict) --
Downlink connection details for customer to Agent and Agent to Ground Station
agentIpAndPortAddress (dict) --
Ingress address of AgentEndpoint with a port range and an optional mtu.
socketAddress (dict) --
A ranged socket address.
name (string) --
IPv4 socket address.
portRange (dict) --
Port range of a socket address.
minimum (integer) --
A minimum value.
maximum (integer) --
A maximum value.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
egressAddressAndPort (dict) --
Egress address of AgentEndpoint with an optional mtu.
socketAddress (dict) --
A socket address.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentStatus (string) --
Status of the agent associated with the downlink dataflow endpoint
auditResults (string) --
Health audit results for the downlink dataflow endpoint
healthStatus (string) --
A dataflow endpoint health status. This field is ignored when calling CreateDataflowEndpointGroup.
healthReasons (list) --
Health reasons for a dataflow endpoint. This field is ignored when calling CreateDataflowEndpointGroup.
(string) --
antennaDemodDecodeDetails (dict) --
Details for antenna demod decode Config in a contact.
outputNode (string) --
Name of an antenna demod decode output node used in a contact.
s3RecordingDetails (dict) --
Details for an S3 recording Config in a contact.
bucketArn (string) --
ARN of the bucket used.
keyTemplate (string) --
Key template used for the S3 Recording Configuration
dataflowSourceRegion (string) --
Region of a dataflow source.
destination (dict) --
Dataflow details for the destination side.
configType (string) --
Type of a Config.
configId (string) --
UUID of a Config.
configDetails (dict) --
Additional details for a Config, if type is dataflow endpoint or antenna demod decode.
endpointDetails (dict) --
Information about the endpoint details.
securityDetails (dict) --
Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.
subnetIds (list) --
A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.
(string) --
securityGroupIds (list) --
The security groups to attach to the elastic network interfaces.
(string) --
roleArn (string) --
ARN to a role needed for connecting streams to your instances.
endpoint (dict) --
A dataflow endpoint.
name (string) --
Name of a dataflow endpoint.
address (dict) --
Socket address of a dataflow endpoint.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
status (string) --
Status of a dataflow endpoint.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
awsGroundStationAgentEndpoint (dict) --
An agent endpoint.
name (string) --
Name string associated with AgentEndpoint. Used as a human-readable identifier for AgentEndpoint.
egressAddress (dict) --
The egress address of AgentEndpoint.
socketAddress (dict) --
A socket address.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
ingressAddress (dict) --
The ingress address of AgentEndpoint.
socketAddress (dict) --
A ranged socket address.
name (string) --
IPv4 socket address.
portRange (dict) --
Port range of a socket address.
minimum (integer) --
A minimum value.
maximum (integer) --
A maximum value.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentStatus (string) --
The status of AgentEndpoint.
auditResults (string) --
The results of the audit.
uplinkAwsGroundStationAgentEndpoint (dict) --
Definition for an uplink agent endpoint
name (string) --
Uplink dataflow endpoint name
dataflowDetails (dict) --
Dataflow details for the uplink endpoint
agentConnectionDetails (dict) --
Uplink connection details for customer to Agent and Agent to Ground Station
ingressAddressAndPort (dict) --
Egress address of AgentEndpoint with an optional mtu.
socketAddress (dict) --
A socket address.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentIpAndPortAddress (dict) --
Ingress address of AgentEndpoint with a port range and an optional mtu.
socketAddress (dict) --
A ranged socket address.
name (string) --
IPv4 socket address.
portRange (dict) --
Port range of a socket address.
minimum (integer) --
A minimum value.
maximum (integer) --
A maximum value.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentStatus (string) --
Status of the agent associated with the uplink dataflow endpoint
auditResults (string) --
Health audit results for the uplink dataflow endpoint
downlinkAwsGroundStationAgentEndpoint (dict) --
Definition for a downlink agent endpoint
name (string) --
Downlink dataflow endpoint name
dataflowDetails (dict) --
Dataflow details for the downlink endpoint
agentConnectionDetails (dict) --
Downlink connection details for customer to Agent and Agent to Ground Station
agentIpAndPortAddress (dict) --
Ingress address of AgentEndpoint with a port range and an optional mtu.
socketAddress (dict) --
A ranged socket address.
name (string) --
IPv4 socket address.
portRange (dict) --
Port range of a socket address.
minimum (integer) --
A minimum value.
maximum (integer) --
A maximum value.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
egressAddressAndPort (dict) --
Egress address of AgentEndpoint with an optional mtu.
socketAddress (dict) --
A socket address.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentStatus (string) --
Status of the agent associated with the downlink dataflow endpoint
auditResults (string) --
Health audit results for the downlink dataflow endpoint
healthStatus (string) --
A dataflow endpoint health status. This field is ignored when calling CreateDataflowEndpointGroup.
healthReasons (list) --
Health reasons for a dataflow endpoint. This field is ignored when calling CreateDataflowEndpointGroup.
(string) --
antennaDemodDecodeDetails (dict) --
Details for antenna demod decode Config in a contact.
outputNode (string) --
Name of an antenna demod decode output node used in a contact.
s3RecordingDetails (dict) --
Details for an S3 recording Config in a contact.
bucketArn (string) --
ARN of the bucket used.
keyTemplate (string) --
Key template used for the S3 Recording Configuration
dataflowDestinationRegion (string) --
Region of a dataflow destination.
errorMessage (string) --
Error message for a dataflow.
visibilityStartTime (datetime) --
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.
visibilityEndTime (datetime) --
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.
trackingOverrides (dict) --
Tracking configuration overrides specified when the contact was reserved.
programTrackSettings (dict) --
Program track settings to override for antenna tracking during the contact.
azEl (dict) --
Program track settings for AzElEphemeris.
ephemerisId (string) --
Unique identifier of the azimuth elevation ephemeris.
oem (dict) --
Program track settings for OEMEphemeris.
ephemerisId (string) --
Unique identifier of the OEM ephemeris.
tle (dict) --
Program track settings for TLEEphemeris.
ephemerisId (string) --
Unique identifier of the TLE ephemeris.
ephemeris (dict) --
The ephemeris that determines antenna pointing directions for the contact.
ephemerisId (string) --
Unique identifier of the ephemeris. Appears only for custom ephemerides.
ephemerisType (string) --
Type of ephemeris.
version (dict) --
Version information for a contact.
versionId (integer) --
Version ID of a contact.
created (datetime) --
Time the contact version was created in UTC.
activated (datetime) --
Time the contact version was activated in UTC. A version is activated when it becomes the current active version of the contact.
superseded (datetime) --
Time the contact version was superseded in UTC. A version is superseded when a newer version becomes active.
lastUpdated (datetime) --
Time the contact version was last updated in UTC.
status (string) --
Status of the contact version.
failureCodes (list) --
List of failure codes for the contact version.
(string) --
failureMessage (string) --
Failure message for the contact version.
{'contactList': {'version': {'activated': 'timestamp',
'created': 'timestamp',
'failureCodes': ['INTERNAL_ERROR | '
'INVALID_SATELLITE_ARN | '
'INVALID_UPDATE_CONTACT_REQUEST '
'| EPHEMERIS_NOT_FOUND | '
'EPHEMERIS_TIME_RANGE_INVALID | '
'EPHEMERIS_NOT_ENABLED | '
'SATELLITE_DOES_NOT_MATCH_EPHEMERIS '
'| '
'NOT_ONBOARDED_TO_AZEL_EPHEMERIS '
'| AZEL_EPHEMERIS_NOT_FOUND | '
'AZEL_EPHEMERIS_WRONG_GROUND_STATION '
'| AZEL_EPHEMERIS_INVALID_STATUS '
'| '
'AZEL_EPHEMERIS_TIME_RANGE_INVALID'],
'failureMessage': 'string',
'lastUpdated': 'timestamp',
'status': 'UPDATING | ACTIVE | SUPERSEDED | '
'FAILED_TO_UPDATE',
'superseded': 'timestamp',
'versionId': 'integer'}}}
Returns a list of contacts.
If statusList contains AVAILABLE, the request must include groundStation, missionprofileArn, and satelliteArn.
See also: AWS API Documentation
Request Syntax
client.list_contacts(
maxResults=123,
nextToken='string',
statusList=[
'SCHEDULING'|'FAILED_TO_SCHEDULE'|'SCHEDULED'|'CANCELLED'|'AWS_CANCELLED'|'PREPASS'|'PASS'|'POSTPASS'|'COMPLETED'|'FAILED'|'AVAILABLE'|'CANCELLING'|'AWS_FAILED',
],
startTime=datetime(2015, 1, 1),
endTime=datetime(2015, 1, 1),
groundStation='string',
satelliteArn='string',
missionProfileArn='string',
ephemeris={
'azEl': {
'id': 'string'
}
}
)
integer
Maximum number of contacts returned.
string
Next token returned in the request of a previous ListContacts call. Used to get the next page of results.
list
[REQUIRED]
Status of a contact reservation.
(string) --
datetime
[REQUIRED]
Start time of a contact in UTC.
datetime
[REQUIRED]
End time of a contact in UTC.
string
Name of a ground station.
string
ARN of a satellite.
string
ARN of a mission profile.
dict
Filter for selecting contacts that use a specific ephemeris".
azEl (dict) --
Filter for AzElEphemeris.
id (string) -- [REQUIRED]
Unique identifier of the azimuth elevation ephemeris.
dict
Response Syntax
{
'nextToken': 'string',
'contactList': [
{
'contactId': 'string',
'missionProfileArn': 'string',
'satelliteArn': 'string',
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'prePassStartTime': datetime(2015, 1, 1),
'postPassEndTime': datetime(2015, 1, 1),
'groundStation': 'string',
'contactStatus': 'SCHEDULING'|'FAILED_TO_SCHEDULE'|'SCHEDULED'|'CANCELLED'|'AWS_CANCELLED'|'PREPASS'|'PASS'|'POSTPASS'|'COMPLETED'|'FAILED'|'AVAILABLE'|'CANCELLING'|'AWS_FAILED',
'errorMessage': 'string',
'maximumElevation': {
'value': 123.0,
'unit': 'DEGREE_ANGLE'|'RADIAN'
},
'region': 'string',
'tags': {
'string': 'string'
},
'visibilityStartTime': datetime(2015, 1, 1),
'visibilityEndTime': datetime(2015, 1, 1),
'ephemeris': {
'ephemerisId': 'string',
'ephemerisType': 'TLE'|'OEM'|'AZ_EL'|'SERVICE_MANAGED'
},
'version': {
'versionId': 123,
'created': datetime(2015, 1, 1),
'activated': datetime(2015, 1, 1),
'superseded': datetime(2015, 1, 1),
'lastUpdated': datetime(2015, 1, 1),
'status': 'UPDATING'|'ACTIVE'|'SUPERSEDED'|'FAILED_TO_UPDATE',
'failureCodes': [
'INTERNAL_ERROR'|'INVALID_SATELLITE_ARN'|'INVALID_UPDATE_CONTACT_REQUEST'|'EPHEMERIS_NOT_FOUND'|'EPHEMERIS_TIME_RANGE_INVALID'|'EPHEMERIS_NOT_ENABLED'|'SATELLITE_DOES_NOT_MATCH_EPHEMERIS'|'NOT_ONBOARDED_TO_AZEL_EPHEMERIS'|'AZEL_EPHEMERIS_NOT_FOUND'|'AZEL_EPHEMERIS_WRONG_GROUND_STATION'|'AZEL_EPHEMERIS_INVALID_STATUS'|'AZEL_EPHEMERIS_TIME_RANGE_INVALID',
],
'failureMessage': 'string'
}
},
]
}
Response Structure
(dict) --
Output for the ListContacts operation.
nextToken (string) --
Next token returned in the response of a previous ListContacts call. Used to get the next page of results.
contactList (list) --
List of contacts.
(dict) --
Data describing a contact.
contactId (string) --
UUID of a contact.
missionProfileArn (string) --
ARN of a mission profile.
satelliteArn (string) --
ARN of a satellite.
startTime (datetime) --
Start time of a contact in UTC.
endTime (datetime) --
End time of a contact in UTC.
prePassStartTime (datetime) --
Start time in UTC of the pre-pass period, at which you receive a CloudWatch event indicating an upcoming pass.
postPassEndTime (datetime) --
End time in UTC of the post-pass period, at which you receive a CloudWatch event indicating the pass has finished.
groundStation (string) --
Name of a ground station.
contactStatus (string) --
Status of a contact.
errorMessage (string) --
Error message of a contact.
maximumElevation (dict) --
Maximum elevation angle of a contact.
value (float) --
Elevation angle value.
unit (string) --
Elevation angle units.
region (string) --
Region of a contact.
tags (dict) --
Tags assigned to a contact.
(string) --
(string) --
visibilityStartTime (datetime) --
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. This field is not present for contacts with a SCHEDULING or SCHEDULED status.
visibilityEndTime (datetime) --
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. This field is not present for contacts with a SCHEDULING or SCHEDULED status.
ephemeris (dict) --
The ephemeris that determines antenna pointing for the contact.
ephemerisId (string) --
Unique identifier of the ephemeris. Appears only for custom ephemerides.
ephemerisType (string) --
Type of ephemeris.
version (dict) --
Version information for a contact.
versionId (integer) --
Version ID of a contact.
created (datetime) --
Time the contact version was created in UTC.
activated (datetime) --
Time the contact version was activated in UTC. A version is activated when it becomes the current active version of the contact.
superseded (datetime) --
Time the contact version was superseded in UTC. A version is superseded when a newer version becomes active.
lastUpdated (datetime) --
Time the contact version was last updated in UTC.
status (string) --
Status of the contact version.
failureCodes (list) --
List of failure codes for the contact version.
(string) --
failureMessage (string) --
Failure message for the contact version.
{'trackingOverrides': {'programTrackSettings': {'oem': {'ephemerisId': 'string'},
'tle': {'ephemerisId': 'string'}}}}
Response {'versionId': 'integer'}
Reserves a contact using specified parameters.
See also: AWS API Documentation
Request Syntax
client.reserve_contact(
missionProfileArn='string',
satelliteArn='string',
startTime=datetime(2015, 1, 1),
endTime=datetime(2015, 1, 1),
groundStation='string',
tags={
'string': 'string'
},
trackingOverrides={
'programTrackSettings': {
'azEl': {
'ephemerisId': 'string'
},
'oem': {
'ephemerisId': 'string'
},
'tle': {
'ephemerisId': 'string'
}
}
}
)
string
[REQUIRED]
ARN of a mission profile.
string
ARN of a satellite
datetime
[REQUIRED]
Start time of a contact in UTC.
datetime
[REQUIRED]
End time of a contact in UTC.
string
[REQUIRED]
Name of a ground station.
dict
Tags assigned to a contact.
(string) --
(string) --
dict
Tracking configuration overrides for the contact.
programTrackSettings (dict) --
Program track settings to override for antenna tracking during the contact.
azEl (dict) --
Program track settings for AzElEphemeris.
ephemerisId (string) -- [REQUIRED]
Unique identifier of the azimuth elevation ephemeris.
oem (dict) --
Program track settings for OEMEphemeris.
ephemerisId (string) -- [REQUIRED]
Unique identifier of the OEM ephemeris.
tle (dict) --
Program track settings for TLEEphemeris.
ephemerisId (string) -- [REQUIRED]
Unique identifier of the TLE ephemeris.
dict
Response Syntax
{
'contactId': 'string',
'versionId': 123
}
Response Structure
(dict) --
Response containing the ID of a contact.
contactId (string) --
UUID of a contact.
versionId (integer) --
Version ID of a contact.