2025/10/28 - AWS Ground Station - 6 updated api methods
Changes Enable use of AzEl ephemerides
{'ephemeris': {'azEl': {'data': {'azElData': {'angleUnit': 'DEGREE_ANGLE | '
'RADIAN',
'azElSegmentList': [{'azElList': [{'az': 'double',
'dt': 'double',
'el': 'double'}],
'referenceEpoch': 'timestamp',
'validTimeRange': {'endTime': 'timestamp',
'startTime': 'timestamp'}}]},
's3Object': {'bucket': 'string',
'key': 'string',
'version': 'string'}},
'groundStation': 'string'}}}
Create an ephemeris with your specified EphemerisData.
See also: AWS API Documentation
Request Syntax
client.create_ephemeris(
satelliteId='string',
enabled=True|False,
priority=123,
expirationTime=datetime(2015, 1, 1),
name='string',
kmsKeyArn='string',
ephemeris={
'tle': {
's3Object': {
'bucket': 'string',
'key': 'string',
'version': 'string'
},
'tleData': [
{
'tleLine1': 'string',
'tleLine2': 'string',
'validTimeRange': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1)
}
},
]
},
'oem': {
's3Object': {
'bucket': 'string',
'key': 'string',
'version': 'string'
},
'oemData': 'string'
},
'azEl': {
'groundStation': 'string',
'data': {
's3Object': {
'bucket': 'string',
'key': 'string',
'version': 'string'
},
'azElData': {
'angleUnit': 'DEGREE_ANGLE'|'RADIAN',
'azElSegmentList': [
{
'referenceEpoch': datetime(2015, 1, 1),
'validTimeRange': {
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1)
},
'azElList': [
{
'dt': 123.0,
'az': 123.0,
'el': 123.0
},
]
},
]
}
}
}
},
tags={
'string': 'string'
}
)
string
The satellite ID that associates this ephemeris with a satellite in AWS Ground Station.
boolean
Set to true to enable the ephemeris after validation. Set to false to keep it disabled.
integer
A priority score that determines which ephemeris to use when multiple ephemerides overlap.
Higher numbers take precedence. The default is 1. Must be 1 or greater.
datetime
An overall expiration time for the ephemeris in UTC, after which it will become EXPIRED.
string
[REQUIRED]
A name that you can use to identify the ephemeris.
string
The ARN of the KMS key to use for encrypting the ephemeris.
dict
Ephemeris data.
tle (dict) --
Two-line element set (TLE) ephemeris.
For more detail about providing Two-line element sets to AWS Ground Station, see the TLE section of the AWS Ground Station user guide.
s3Object (dict) --
The Amazon S3 object that contains the ephemeris data.
bucket (string) --
An Amazon S3 Bucket name.
key (string) --
An Amazon S3 key for the ephemeris.
version (string) --
For versioned Amazon S3 objects, the version to use for the ephemeris.
tleData (list) --
TLE data that you provide directly instead of using an Amazon S3 object.
(dict) --
Two-line element set (TLE) data.
tleLine1 (string) -- [REQUIRED]
First line of two-line element set (TLE) data.
tleLine2 (string) -- [REQUIRED]
Second line of two-line element set (TLE) data.
validTimeRange (dict) -- [REQUIRED]
The valid time range for the TLE. Time ranges must be continuous without gaps or overlaps.
startTime (datetime) -- [REQUIRED]
Unix epoch timestamp in UTC at which the time range starts.
endTime (datetime) -- [REQUIRED]
Unix epoch timestamp in UTC at which the time range ends.
oem (dict) --
Ephemeris data in Orbit Ephemeris Message (OEM) format.
AWS Ground Station processes OEM ephemerides according to the CCSDS standard with some extra restrictions. OEM files should be in KVN format. For more detail about the OEM format that AWS Ground Station supports, see OEM ephemeris format in the AWS Ground Station user guide.
s3Object (dict) --
The Amazon S3 object that contains the ephemeris data.
bucket (string) --
An Amazon S3 Bucket name.
key (string) --
An Amazon S3 key for the ephemeris.
version (string) --
For versioned Amazon S3 objects, the version to use for the ephemeris.
oemData (string) --
OEM data that you provide directly instead of using an Amazon S3 object.
azEl (dict) --
Azimuth elevation ephemeris data.
Use this ephemeris type to provide pointing angles directly, rather than satellite orbital elements. Use this when you need precise antenna pointing but have imprecise or unknown satellite trajectory information.
The azimuth elevation data specifies the antenna pointing direction at specific times relative to a ground station location. AWS Ground Station uses 4th order Lagrange interpolation to compute pointing angles between the provided data points.
AWS Ground Station automatically filters interpolated pointing angles, including only those that are above the site mask elevation of the specified ground station.
For more detail about providing azimuth elevation ephemerides to AWS Ground Station, see the azimuth elevation ephemeris section of the AWS Ground Station User Guide.
groundStation (string) -- [REQUIRED]
The ground station name for which you're providing azimuth elevation data.
This ephemeris is specific to this ground station and can't be used at other locations.
data (dict) -- [REQUIRED]
Azimuth elevation segment data.
You can provide data inline in the request or through an Amazon S3 object reference.
s3Object (dict) --
The Amazon S3 object containing azimuth elevation segment data.
The Amazon S3 object must contain JSON-formatted azimuth elevation data matching the AzElSegments structure.
bucket (string) --
An Amazon S3 Bucket name.
key (string) --
An Amazon S3 key for the ephemeris.
version (string) --
For versioned Amazon S3 objects, the version to use for the ephemeris.
azElData (dict) --
Azimuth elevation segment data provided directly in the request.
Use this option for smaller datasets or when Amazon S3 access is not available.
angleUnit (string) -- [REQUIRED]
The unit of measure for azimuth and elevation angles. All angles in all segments must use the same unit.
azElSegmentList (list) -- [REQUIRED]
List of azimuth elevation segments.
Must contain between 1 and 100 segments. Segments must be in chronological order with no overlaps.
(dict) --
A time segment containing azimuth elevation pointing data.
Each segment defines a continuous time period with pointing angle data points. AWS Ground Station uses 4th order Lagrange interpolation between the provided points, so each segment must contain at least five data points.
referenceEpoch (datetime) -- [REQUIRED]
The reference time for this segment in ISO 8601 format in Coordinated Universal Time (UTC).
All time values within the segment's AzElSegment$azElList are specified as offsets in atomic seconds from this reference epoch.
Example: 2024-01-15T12:00:00.000Z
validTimeRange (dict) -- [REQUIRED]
The valid time range for this segment.
Specifies the start and end timestamps in ISO 8601 format in Coordinated Universal Time (UTC). The segment's pointing data must cover this entire time range.
startTime (datetime) -- [REQUIRED]
Start time in ISO 8601 format in Coordinated Universal Time (UTC).
Example: 2026-11-15T10:28:48.000Z
endTime (datetime) -- [REQUIRED]
End time in ISO 8601 format in Coordinated Universal Time (UTC).
Example: 2024-01-15T12:00:00.000Z
azElList (list) -- [REQUIRED]
List of time-tagged azimuth elevation data points.
Must contain at least five points to support 4th order Lagrange interpolation. Points must be in chronological order with no duplicates.
(dict) --
Time-tagged azimuth elevation pointing data.
Specifies the antenna pointing direction at a specific time offset from the segment's reference epoch.
dt (float) -- [REQUIRED]
Time offset in atomic seconds from the segment's reference epoch.
All dt values within a segment must be in ascending order with no duplicates.
dt values may be:
negative
expressed as fractions of a second
expressed in scientific notation
az (float) -- [REQUIRED]
Azimuth angle at the specified time.
Valid ranges by unit:
DEGREE_ANGLE: -180 to 360 degrees, measured clockwise from true north
RADIAN: -π to 2π radians, measured clockwise from true north
el (float) -- [REQUIRED]
Elevation angle at the specified time.
Valid ranges by unit:
DEGREE_ANGLE: -90 to 90 degrees, where 0 is the horizon, 90 is zenith, and negative values are below the horizon
RADIAN: -π/2 to π/2 radians, where 0 is the horizon, π/2 is zenith, and negative values are below the horizon
dict
Tags assigned to an ephemeris.
(string) --
(string) --
dict
Response Syntax
{
'ephemerisId': 'string'
}
Response Structure
(dict) --
ephemerisId (string) --
The AWS Ground Station ephemeris ID.
{'ephemeris': {'ephemerisId': 'string',
'ephemerisType': 'TLE | OEM | AZ_EL | SERVICE_MANAGED'},
'trackingOverrides': {'programTrackSettings': {'azEl': {'ephemerisId': 'string'}}}}
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',
'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'
},
'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',
'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'
},
'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'
}
}
},
'ephemeris': {
'ephemerisId': 'string',
'ephemerisType': 'TLE'|'OEM'|'AZ_EL'|'SERVICE_MANAGED'
}
}
Response Structure
(dict) --
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) --
Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
postPassEndTime (datetime) --
Amount of time after a contact ends that you’d like to 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 of a 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.
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.
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.
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.
{'errorReasons': [{'errorCode': 'INTERNAL_ERROR | MISMATCHED_SATCAT_ID | '
'OEM_VERSION_UNSUPPORTED | ORIGINATOR_MISSING '
'| CREATION_DATE_MISSING | OBJECT_NAME_MISSING '
'| OBJECT_ID_MISSING | REF_FRAME_UNSUPPORTED | '
'REF_FRAME_EPOCH_UNSUPPORTED | '
'TIME_SYSTEM_UNSUPPORTED | '
'CENTER_BODY_UNSUPPORTED | '
'INTERPOLATION_MISSING | '
'INTERPOLATION_DEGREE_INVALID | '
'AZ_EL_SEGMENT_LIST_MISSING | '
'INSUFFICIENT_TIME_AZ_EL | '
'START_TIME_IN_FUTURE | END_TIME_IN_PAST | '
'EXPIRATION_TIME_TOO_EARLY | '
'START_TIME_METADATA_TOO_EARLY | '
'STOP_TIME_METADATA_TOO_LATE | '
'AZ_EL_SEGMENT_END_TIME_BEFORE_START_TIME | '
'AZ_EL_SEGMENT_TIMES_OVERLAP | '
'AZ_EL_SEGMENTS_OUT_OF_ORDER | '
'TIME_AZ_EL_ITEMS_OUT_OF_ORDER | '
'MEAN_MOTION_INVALID | '
'TIME_AZ_EL_AZ_RADIAN_RANGE_INVALID | '
'TIME_AZ_EL_EL_RADIAN_RANGE_INVALID | '
'TIME_AZ_EL_AZ_DEGREE_RANGE_INVALID | '
'TIME_AZ_EL_EL_DEGREE_RANGE_INVALID | '
'TIME_AZ_EL_ANGLE_UNITS_INVALID | '
'INSUFFICIENT_KMS_PERMISSIONS | '
'FILE_FORMAT_INVALID | '
'AZ_EL_SEGMENT_REFERENCE_EPOCH_INVALID | '
'AZ_EL_SEGMENT_START_TIME_INVALID | '
'AZ_EL_SEGMENT_END_TIME_INVALID | '
'AZ_EL_SEGMENT_VALID_TIME_RANGE_INVALID | '
'AZ_EL_SEGMENT_END_TIME_TOO_LATE | '
'AZ_EL_TOTAL_DURATION_EXCEEDED',
'errorMessage': 'string'}],
'suppliedData': {'azEl': {'ephemerisData': 'string',
'sourceS3Object': {'bucket': 'string',
'key': 'string',
'version': 'string'}}}}
Retrieve information about an existing ephemeris.
See also: AWS API Documentation
Request Syntax
client.describe_ephemeris(
ephemerisId='string'
)
string
[REQUIRED]
The AWS Ground Station ephemeris ID.
dict
Response Syntax
{
'ephemerisId': 'string',
'satelliteId': 'string',
'status': 'VALIDATING'|'INVALID'|'ERROR'|'ENABLED'|'DISABLED'|'EXPIRED',
'priority': 123,
'creationTime': datetime(2015, 1, 1),
'enabled': True|False,
'name': 'string',
'tags': {
'string': 'string'
},
'suppliedData': {
'tle': {
'sourceS3Object': {
'bucket': 'string',
'key': 'string',
'version': 'string'
},
'ephemerisData': 'string'
},
'oem': {
'sourceS3Object': {
'bucket': 'string',
'key': 'string',
'version': 'string'
},
'ephemerisData': 'string'
},
'azEl': {
'sourceS3Object': {
'bucket': 'string',
'key': 'string',
'version': 'string'
},
'ephemerisData': 'string'
}
},
'invalidReason': 'METADATA_INVALID'|'TIME_RANGE_INVALID'|'TRAJECTORY_INVALID'|'KMS_KEY_INVALID'|'VALIDATION_ERROR',
'errorReasons': [
{
'errorCode': 'INTERNAL_ERROR'|'MISMATCHED_SATCAT_ID'|'OEM_VERSION_UNSUPPORTED'|'ORIGINATOR_MISSING'|'CREATION_DATE_MISSING'|'OBJECT_NAME_MISSING'|'OBJECT_ID_MISSING'|'REF_FRAME_UNSUPPORTED'|'REF_FRAME_EPOCH_UNSUPPORTED'|'TIME_SYSTEM_UNSUPPORTED'|'CENTER_BODY_UNSUPPORTED'|'INTERPOLATION_MISSING'|'INTERPOLATION_DEGREE_INVALID'|'AZ_EL_SEGMENT_LIST_MISSING'|'INSUFFICIENT_TIME_AZ_EL'|'START_TIME_IN_FUTURE'|'END_TIME_IN_PAST'|'EXPIRATION_TIME_TOO_EARLY'|'START_TIME_METADATA_TOO_EARLY'|'STOP_TIME_METADATA_TOO_LATE'|'AZ_EL_SEGMENT_END_TIME_BEFORE_START_TIME'|'AZ_EL_SEGMENT_TIMES_OVERLAP'|'AZ_EL_SEGMENTS_OUT_OF_ORDER'|'TIME_AZ_EL_ITEMS_OUT_OF_ORDER'|'MEAN_MOTION_INVALID'|'TIME_AZ_EL_AZ_RADIAN_RANGE_INVALID'|'TIME_AZ_EL_EL_RADIAN_RANGE_INVALID'|'TIME_AZ_EL_AZ_DEGREE_RANGE_INVALID'|'TIME_AZ_EL_EL_DEGREE_RANGE_INVALID'|'TIME_AZ_EL_ANGLE_UNITS_INVALID'|'INSUFFICIENT_KMS_PERMISSIONS'|'FILE_FORMAT_INVALID'|'AZ_EL_SEGMENT_REFERENCE_EPOCH_INVALID'|'AZ_EL_SEGMENT_START_TIME_INVALID'|'AZ_EL_SEGMENT_END_TIME_INVALID'|'AZ_EL_SEGMENT_VALID_TIME_RANGE_INVALID'|'AZ_EL_SEGMENT_END_TIME_TOO_LATE'|'AZ_EL_TOTAL_DURATION_EXCEEDED',
'errorMessage': 'string'
},
]
}
Response Structure
(dict) --
ephemerisId (string) --
The AWS Ground Station ephemeris ID.
satelliteId (string) --
The AWS Ground Station satellite ID associated with ephemeris.
status (string) --
The status of the ephemeris.
priority (integer) --
A priority score that determines which ephemeris to use when multiple ephemerides overlap.
Higher numbers take precedence. The default is 1. Must be 1 or greater.
creationTime (datetime) --
The time the ephemeris was uploaded in UTC.
enabled (boolean) --
Whether or not the ephemeris is enabled.
name (string) --
A name that you can use to identify the ephemeris.
tags (dict) --
Tags assigned to an ephemeris.
(string) --
(string) --
suppliedData (dict) --
Supplied ephemeris data.
tle (dict) --
Description of ephemeris.
sourceS3Object (dict) --
Source Amazon S3 object used for the ephemeris.
bucket (string) --
An Amazon S3 Bucket name.
key (string) --
An Amazon S3 key for the ephemeris.
version (string) --
For versioned Amazon S3 objects, the version to use for the ephemeris.
ephemerisData (string) --
Supplied ephemeris data.
oem (dict) --
Description of ephemeris.
sourceS3Object (dict) --
Source Amazon S3 object used for the ephemeris.
bucket (string) --
An Amazon S3 Bucket name.
key (string) --
An Amazon S3 key for the ephemeris.
version (string) --
For versioned Amazon S3 objects, the version to use for the ephemeris.
ephemerisData (string) --
Supplied ephemeris data.
azEl (dict) --
Description of ephemeris.
sourceS3Object (dict) --
Source Amazon S3 object used for the ephemeris.
bucket (string) --
An Amazon S3 Bucket name.
key (string) --
An Amazon S3 key for the ephemeris.
version (string) --
For versioned Amazon S3 objects, the version to use for the ephemeris.
ephemerisData (string) --
Supplied ephemeris data.
invalidReason (string) --
Reason that an ephemeris failed validation. Appears only when the status is INVALID.
errorReasons (list) --
Detailed error information for ephemerides with INVALID status.
Provides specific error codes and messages to help diagnose validation failures.
(dict) --
Detailed error information for ephemeris validation failures.
Provides an error code and descriptive message to help diagnose and resolve validation issues.
errorCode (string) --
The error code identifying the type of validation failure.
See the Troubleshooting Invalid Ephemerides guide for error code details.
errorMessage (string) --
A human-readable message describing the validation failure.
Provides specific details about what failed and may include suggestions for remediation.
{'ephemeris': {'azEl': {'id': 'string'}}}
Response {'contactList': {'ephemeris': {'ephemerisId': 'string',
'ephemerisType': 'TLE | OEM | AZ_EL | '
'SERVICE_MANAGED'}}}
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'
}
},
]
}
Response Structure
(dict) --
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) --
Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
postPassEndTime (datetime) --
Amount of time after a contact ends that you’d like to 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.
{'ephemerisType': 'TLE | OEM | AZ_EL | SERVICE_MANAGED'}
Response {'ephemerides': {'ephemerisType': 'TLE | OEM | AZ_EL | SERVICE_MANAGED'}}
List your existing ephemerides.
See also: AWS API Documentation
Request Syntax
client.list_ephemerides(
satelliteId='string',
ephemerisType='TLE'|'OEM'|'AZ_EL'|'SERVICE_MANAGED',
startTime=datetime(2015, 1, 1),
endTime=datetime(2015, 1, 1),
statusList=[
'VALIDATING'|'INVALID'|'ERROR'|'ENABLED'|'DISABLED'|'EXPIRED',
],
maxResults=123,
nextToken='string'
)
string
The AWS Ground Station satellite ID to list ephemeris for.
string
Filter ephemerides by type. If not specified, all ephemeris types will be returned.
datetime
[REQUIRED]
The start time for the list operation in UTC. Returns ephemerides with expiration times within your specified time range.
datetime
[REQUIRED]
The end time for the list operation in UTC. Returns ephemerides with expiration times within your specified time range.
list
The list of ephemeris status to return.
(string) --
integer
Maximum number of ephemerides to return.
string
Pagination token.
dict
Response Syntax
{
'nextToken': 'string',
'ephemerides': [
{
'ephemerisId': 'string',
'ephemerisType': 'TLE'|'OEM'|'AZ_EL'|'SERVICE_MANAGED',
'status': 'VALIDATING'|'INVALID'|'ERROR'|'ENABLED'|'DISABLED'|'EXPIRED',
'priority': 123,
'enabled': True|False,
'creationTime': datetime(2015, 1, 1),
'name': 'string',
'sourceS3Object': {
'bucket': 'string',
'key': 'string',
'version': 'string'
}
},
]
}
Response Structure
(dict) --
nextToken (string) --
Pagination token.
ephemerides (list) --
List of ephemerides.
(dict) --
Ephemeris item.
ephemerisId (string) --
The AWS Ground Station ephemeris ID.
ephemerisType (string) --
The type of ephemeris.
status (string) --
The status of the ephemeris.
priority (integer) --
A priority score that determines which ephemeris to use when multiple ephemerides overlap.
Higher numbers take precedence. The default is 1. Must be 1 or greater.
enabled (boolean) --
Whether or not the ephemeris is enabled.
creationTime (datetime) --
The time the ephemeris was uploaded in UTC.
name (string) --
A name that you can use to identify the ephemeris.
sourceS3Object (dict) --
Source Amazon S3 object used for the ephemeris.
bucket (string) --
An Amazon S3 Bucket name.
key (string) --
An Amazon S3 key for the ephemeris.
version (string) --
For versioned Amazon S3 objects, the version to use for the ephemeris.
{'trackingOverrides': {'programTrackSettings': {'azEl': {'ephemerisId': 'string'}}}}
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'
}
}
}
)
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) -- [REQUIRED]
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.
dict
Response Syntax
{
'contactId': 'string'
}
Response Structure
(dict) --
contactId (string) --
UUID of a contact.