Table of Contents
GroundStation.Client¶A low-level client representing AWS Ground Station
Welcome to the AWS Ground Station API Reference. AWS Ground Station is a fully managed service that enables you to control satellite communications, downlink and process satellite data, and scale your satellite operations efficiently and cost-effectively without having to build or manage your own ground station infrastructure.
import boto3
client = boto3.client('groundstation')
These are the available methods:
can_paginate()cancel_contact()close()create_config()create_dataflow_endpoint_group()create_ephemeris()create_mission_profile()delete_config()delete_dataflow_endpoint_group()delete_ephemeris()delete_mission_profile()describe_contact()describe_ephemeris()get_agent_configuration()get_config()get_dataflow_endpoint_group()get_minute_usage()get_mission_profile()get_paginator()get_satellite()get_waiter()list_configs()list_contacts()list_dataflow_endpoint_groups()list_ephemerides()list_ground_stations()list_mission_profiles()list_satellites()list_tags_for_resource()register_agent()reserve_contact()tag_resource()untag_resource()update_agent_status()update_config()update_ephemeris()update_mission_profile()can_paginate(operation_name)¶Check if an operation can be paginated.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").True if the operation can be paginated,
False otherwise.cancel_contact(**kwargs)¶Cancels a contact with a specified contact ID.
See also: AWS API Documentation
Request Syntax
response = client.cancel_contact(
contactId='string'
)
[REQUIRED]
UUID of a contact.
{
'contactId': 'string'
}
Response Structure
UUID of a contact.
Exceptions
GroundStation.Client.exceptions.InvalidParameterExceptionGroundStation.Client.exceptions.DependencyExceptionGroundStation.Client.exceptions.ResourceNotFoundExceptionclose()¶Closes underlying endpoint connections.
create_config(**kwargs)¶Creates a Config with the specified configData parameters.
Only one type of configData can be specified.
See also: AWS API Documentation
Request Syntax
response = client.create_config(
configData={
'antennaDownlinkConfig': {
'spectrumConfig': {
'bandwidth': {
'units': 'GHz'|'MHz'|'kHz',
'value': 123.0
},
'centerFrequency': {
'units': 'GHz'|'MHz'|'kHz',
'value': 123.0
},
'polarization': 'LEFT_HAND'|'NONE'|'RIGHT_HAND'
}
},
'antennaDownlinkDemodDecodeConfig': {
'decodeConfig': {
'unvalidatedJSON': 'string'
},
'demodulationConfig': {
'unvalidatedJSON': 'string'
},
'spectrumConfig': {
'bandwidth': {
'units': 'GHz'|'MHz'|'kHz',
'value': 123.0
},
'centerFrequency': {
'units': 'GHz'|'MHz'|'kHz',
'value': 123.0
},
'polarization': 'LEFT_HAND'|'NONE'|'RIGHT_HAND'
}
},
'antennaUplinkConfig': {
'spectrumConfig': {
'centerFrequency': {
'units': 'GHz'|'MHz'|'kHz',
'value': 123.0
},
'polarization': 'LEFT_HAND'|'NONE'|'RIGHT_HAND'
},
'targetEirp': {
'units': 'dBW',
'value': 123.0
},
'transmitDisabled': True|False
},
'dataflowEndpointConfig': {
'dataflowEndpointName': 'string',
'dataflowEndpointRegion': 'string'
},
's3RecordingConfig': {
'bucketArn': 'string',
'prefix': 'string',
'roleArn': 'string'
},
'trackingConfig': {
'autotrack': 'PREFERRED'|'REMOVED'|'REQUIRED'
},
'uplinkEchoConfig': {
'antennaUplinkConfigArn': 'string',
'enabled': True|False
}
},
name='string',
tags={
'string': 'string'
}
)
[REQUIRED]
Parameters of a Config .
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: antennaDownlinkConfig, antennaDownlinkDemodDecodeConfig, antennaUplinkConfig, dataflowEndpointConfig, s3RecordingConfig, trackingConfig, uplinkEchoConfig.
Information about how AWS Ground Station should configure an antenna for downlink during a contact.
Object that describes a spectral Config .
Bandwidth of a spectral Config . AWS Ground Station currently has the following bandwidth limitations:
AntennaDownlinkDemodDecodeconfig , valid values are between 125 kHz to 650 MHz.AntennaDownlinkconfig valid values are between 10 kHz to 54 MHz.AntennaUplinkConfig , valid values are between 10 kHz to 54 MHz.Frequency bandwidth units.
Frequency bandwidth value. AWS Ground Station currently has the following bandwidth limitations:
AntennaDownlinkDemodDecodeconfig , valid values are between 125 kHz to 650 MHz.AntennaDownlinkconfig , valid values are between 10 kHz to 54 MHz.AntennaUplinkConfig , valid values are between 10 kHz to 54 MHz.Center frequency of a spectral Config . Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.
Frequency units.
Frequency value. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.
Polarization of a spectral Config . Capturing both "RIGHT_HAND" and "LEFT_HAND" polarization requires two separate configs.
Information about how AWS Ground Station should configure an antenna for downlink demod decode during a contact.
Information about the decode Config .
Unvalidated JSON of a decode Config .
Information about the demodulation Config .
Unvalidated JSON of a demodulation Config .
Information about the spectral Config .
Bandwidth of a spectral Config . AWS Ground Station currently has the following bandwidth limitations:
AntennaDownlinkDemodDecodeconfig , valid values are between 125 kHz to 650 MHz.AntennaDownlinkconfig valid values are between 10 kHz to 54 MHz.AntennaUplinkConfig , valid values are between 10 kHz to 54 MHz.Frequency bandwidth units.
Frequency bandwidth value. AWS Ground Station currently has the following bandwidth limitations:
AntennaDownlinkDemodDecodeconfig , valid values are between 125 kHz to 650 MHz.AntennaDownlinkconfig , valid values are between 10 kHz to 54 MHz.AntennaUplinkConfig , valid values are between 10 kHz to 54 MHz.Center frequency of a spectral Config . Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.
Frequency units.
Frequency value. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.
Polarization of a spectral Config . Capturing both "RIGHT_HAND" and "LEFT_HAND" polarization requires two separate configs.
Information about how AWS Ground Station should configure an antenna for uplink during a contact.
Information about the uplink spectral Config .
Center frequency of an uplink spectral Config . Valid values are between 2025 to 2120 MHz.
Frequency units.
Frequency value. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.
Polarization of an uplink spectral Config . Capturing both "RIGHT_HAND" and "LEFT_HAND" polarization requires two separate configs.
EIRP of the target.
Units of an EIRP.
Value of an EIRP. Valid values are between 20.0 to 50.0 dBW.
Whether or not uplink transmit is disabled.
Information about the dataflow endpoint Config .
Name of a dataflow endpoint.
Region of a dataflow endpoint.
Information about an S3 recording Config .
ARN of the bucket to record to.
S3 Key prefix to prefice data files.
ARN of the role Ground Station assumes to write data to the bucket.
Object that determines whether tracking should be used during a contact executed with this Config in the mission profile.
Current setting for autotrack.
Information about an uplink echo Config .
Parameters from the AntennaUplinkConfig , corresponding to the specified AntennaUplinkConfigArn , are used when this UplinkEchoConfig is used in a contact.
ARN of an uplink Config .
Whether or not an uplink Config is enabled.
[REQUIRED]
Name of a Config .
Tags assigned to a Config .
dict
Response Syntax
{
'configArn': 'string',
'configId': 'string',
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'antenna-uplink'|'dataflow-endpoint'|'tracking'|'uplink-echo'|'s3-recording'
}
Response Structure
(dict) --
configArn (string) --
ARN of a Config .
configId (string) --
UUID of a Config .
configType (string) --
Type of a Config .
Exceptions
GroundStation.Client.exceptions.InvalidParameterExceptionGroundStation.Client.exceptions.DependencyExceptionGroundStation.Client.exceptions.ResourceLimitExceededExceptionGroundStation.Client.exceptions.ResourceNotFoundExceptioncreate_dataflow_endpoint_group(**kwargs)¶Creates a DataflowEndpoint group containing the specified list of DataflowEndpoint objects.
The name field in each endpoint is used in your mission profile DataflowEndpointConfig to specify which endpoints to use during a contact.
When a contact uses multiple DataflowEndpointConfig objects, each Config must match a DataflowEndpoint in the same group.
See also: AWS API Documentation
Request Syntax
response = client.create_dataflow_endpoint_group(
contactPostPassDurationSeconds=123,
contactPrePassDurationSeconds=123,
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',
]
}
},
],
tags={
'string': 'string'
}
)
POSTPASS state. A CloudWatch event is emitted when the contact enters and exits the POSTPASS state.PREPASS state. A CloudWatch event is emitted when the contact enters and exits the PREPASS state.[REQUIRED]
Endpoint details of each endpoint in the dataflow endpoint group.
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.
Tags of a dataflow endpoint group.
dict
Response Syntax
{
'dataflowEndpointGroupId': 'string'
}
Response Structure
(dict) --
dataflowEndpointGroupId (string) --
UUID of a dataflow endpoint group.
Exceptions
GroundStation.Client.exceptions.InvalidParameterExceptionGroundStation.Client.exceptions.DependencyExceptionGroundStation.Client.exceptions.ResourceNotFoundExceptioncreate_ephemeris(**kwargs)¶Creates an Ephemeris with the specified EphemerisData .
See also: AWS API Documentation
Request Syntax
response = client.create_ephemeris(
enabled=True|False,
ephemeris={
'oem': {
'oemData': 'string',
's3Object': {
'bucket': 'string',
'key': 'string',
'version': 'string'
}
},
'tle': {
's3Object': {
'bucket': 'string',
'key': 'string',
'version': 'string'
},
'tleData': [
{
'tleLine1': 'string',
'tleLine2': 'string',
'validTimeRange': {
'endTime': datetime(2015, 1, 1),
'startTime': datetime(2015, 1, 1)
}
},
]
}
},
expirationTime=datetime(2015, 1, 1),
kmsKeyArn='string',
name='string',
priority=123,
satelliteId='string',
tags={
'string': 'string'
}
)
Whether to set the ephemeris status to ENABLED after validation.
Setting this to false will set the ephemeris status to DISABLED after validation.
Ephemeris data.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: oem, tle.
Ephemeris data in Orbit Ephemeris Message (OEM) format.
The data for an OEM ephemeris, supplied directly in the request rather than through an S3 object.
Identifies the S3 object to be used as the ephemeris.
An Amazon S3 Bucket name.
An Amazon S3 key for the ephemeris.
For versioned S3 objects, the version to use for the ephemeris.
Two-line element set (TLE) ephemeris.
Identifies the S3 object to be used as the ephemeris.
An Amazon S3 Bucket name.
An Amazon S3 key for the ephemeris.
For versioned S3 objects, the version to use for the ephemeris.
The data for a TLE ephemeris, supplied directly in the request rather than through an S3 object.
Two-line element set (TLE) data.
First line of two-line element set (TLE) data.
Second line of two-line element set (TLE) data.
The valid time range for the TLE. Gaps or overlap are not permitted.
Time in UTC at which the time range ends.
Time in UTC at which the time range starts.
EXPIRED .[REQUIRED]
A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
Customer-provided priority score to establish the order in which overlapping ephemerides should be used.
The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.
Priority must be 1 or greater
[REQUIRED]
AWS Ground Station satellite ID for this ephemeris.
Tags assigned to an ephemeris.
dict
Response Syntax
{
'ephemerisId': 'string'
}
Response Structure
(dict) --
ephemerisId (string) --
The AWS Ground Station ephemeris ID.
Exceptions
GroundStation.Client.exceptions.InvalidParameterExceptionGroundStation.Client.exceptions.DependencyExceptionGroundStation.Client.exceptions.ResourceNotFoundExceptioncreate_mission_profile(**kwargs)¶Creates a mission profile.
dataflowEdgesis a list of lists of strings. Each lower level list of strings has two elements: a from ARN and a to ARN.
See also: AWS API Documentation
Request Syntax
response = client.create_mission_profile(
contactPostPassDurationSeconds=123,
contactPrePassDurationSeconds=123,
dataflowEdges=[
[
'string',
],
],
minimumViableContactDurationSeconds=123,
name='string',
streamsKmsKey={
'kmsAliasArn': 'string',
'kmsKeyArn': 'string'
},
streamsKmsRole='string',
tags={
'string': 'string'
},
trackingConfigArn='string'
)
[REQUIRED]
A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config .
[REQUIRED]
Smallest amount of time in seconds that you’d like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.
[REQUIRED]
Name of a mission profile.
KMS key to use for encrypting streams.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: kmsAliasArn, kmsKeyArn.
KMS Alias Arn.
KMS Key Arn.
Tags assigned to a mission profile.
[REQUIRED]
ARN of a tracking Config .
dict
Response Syntax
{
'missionProfileId': 'string'
}
Response Structure
(dict) --
missionProfileId (string) --
UUID of a mission profile.
Exceptions
GroundStation.Client.exceptions.InvalidParameterExceptionGroundStation.Client.exceptions.DependencyExceptionGroundStation.Client.exceptions.ResourceNotFoundExceptiondelete_config(**kwargs)¶Deletes a Config .
See also: AWS API Documentation
Request Syntax
response = client.delete_config(
configId='string',
configType='antenna-downlink'|'antenna-downlink-demod-decode'|'antenna-uplink'|'dataflow-endpoint'|'tracking'|'uplink-echo'|'s3-recording'
)
[REQUIRED]
UUID of a Config .
[REQUIRED]
Type of a Config .
dict
Response Syntax
{
'configArn': 'string',
'configId': 'string',
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'antenna-uplink'|'dataflow-endpoint'|'tracking'|'uplink-echo'|'s3-recording'
}
Response Structure
(dict) --
configArn (string) --
ARN of a Config .
configId (string) --
UUID of a Config .
configType (string) --
Type of a Config .
Exceptions
GroundStation.Client.exceptions.InvalidParameterExceptionGroundStation.Client.exceptions.DependencyExceptionGroundStation.Client.exceptions.ResourceNotFoundExceptiondelete_dataflow_endpoint_group(**kwargs)¶Deletes a dataflow endpoint group.
See also: AWS API Documentation
Request Syntax
response = client.delete_dataflow_endpoint_group(
dataflowEndpointGroupId='string'
)
[REQUIRED]
UUID of a dataflow endpoint group.
{
'dataflowEndpointGroupId': 'string'
}
Response Structure
UUID of a dataflow endpoint group.
Exceptions
GroundStation.Client.exceptions.InvalidParameterExceptionGroundStation.Client.exceptions.DependencyExceptionGroundStation.Client.exceptions.ResourceNotFoundExceptiondelete_ephemeris(**kwargs)¶Deletes an ephemeris
See also: AWS API Documentation
Request Syntax
response = client.delete_ephemeris(
ephemerisId='string'
)
[REQUIRED]
The AWS Ground Station ephemeris ID.
{
'ephemerisId': 'string'
}
Response Structure
The AWS Ground Station ephemeris ID.
Exceptions
GroundStation.Client.exceptions.InvalidParameterExceptionGroundStation.Client.exceptions.DependencyExceptionGroundStation.Client.exceptions.ResourceNotFoundExceptiondelete_mission_profile(**kwargs)¶Deletes a mission profile.
See also: AWS API Documentation
Request Syntax
response = client.delete_mission_profile(
missionProfileId='string'
)
[REQUIRED]
UUID of a mission profile.
{
'missionProfileId': 'string'
}
Response Structure
UUID of a mission profile.
Exceptions
GroundStation.Client.exceptions.InvalidParameterExceptionGroundStation.Client.exceptions.DependencyExceptionGroundStation.Client.exceptions.ResourceNotFoundExceptiondescribe_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.ResourceNotFoundExceptiondescribe_ephemeris(**kwargs)¶Describes an existing ephemeris.
See also: AWS API Documentation
Request Syntax
response = client.describe_ephemeris(
ephemerisId='string'
)
[REQUIRED]
The AWS Ground Station ephemeris ID.
{
'creationTime': datetime(2015, 1, 1),
'enabled': True|False,
'ephemerisId': 'string',
'invalidReason': 'METADATA_INVALID'|'TIME_RANGE_INVALID'|'TRAJECTORY_INVALID'|'KMS_KEY_INVALID'|'VALIDATION_ERROR',
'name': 'string',
'priority': 123,
'satelliteId': 'string',
'status': 'VALIDATING'|'INVALID'|'ERROR'|'ENABLED'|'DISABLED'|'EXPIRED',
'suppliedData': {
'oem': {
'ephemerisData': 'string',
'sourceS3Object': {
'bucket': 'string',
'key': 'string',
'version': 'string'
}
},
'tle': {
'ephemerisData': 'string',
'sourceS3Object': {
'bucket': 'string',
'key': 'string',
'version': 'string'
}
}
},
'tags': {
'string': 'string'
}
}
Response Structure
The time the ephemeris was uploaded in UTC.
Whether or not the ephemeris is enabled.
The AWS Ground Station ephemeris ID.
Reason that an ephemeris failed validation. Only provided for ephemerides with INVALID status.
A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
Customer-provided priority score to establish the order in which overlapping ephemerides should be used.
The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.
Priority must be 1 or greater
The AWS Ground Station satellite ID associated with ephemeris.
The status of the ephemeris.
Supplied ephemeris data.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: oem, tle. 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'}
Description of ephemeris.
Supplied ephemeris data.
Source S3 object used for the ephemeris.
An Amazon S3 Bucket name.
An Amazon S3 key for the ephemeris.
For versioned S3 objects, the version to use for the ephemeris.
Description of ephemeris.
Supplied ephemeris data.
Source S3 object used for the ephemeris.
An Amazon S3 Bucket name.
An Amazon S3 key for the ephemeris.
For versioned S3 objects, the version to use for the ephemeris.
Tags assigned to an ephemeris.
Exceptions
GroundStation.Client.exceptions.InvalidParameterExceptionGroundStation.Client.exceptions.DependencyExceptionGroundStation.Client.exceptions.ResourceNotFoundExceptionget_agent_configuration(**kwargs)¶Gets the latest configuration information for a registered agent.
See also: AWS API Documentation
Request Syntax
response = client.get_agent_configuration(
agentId='string'
)
[REQUIRED]
UUID of agent to get configuration information for.
{
'agentId': 'string',
'taskingDocument': 'string'
}
Response Structure
UUID of agent.
Tasking document for agent.
Exceptions
GroundStation.Client.exceptions.InvalidParameterExceptionGroundStation.Client.exceptions.DependencyExceptionGroundStation.Client.exceptions.ResourceNotFoundExceptionget_config(**kwargs)¶Returns Config information.
Only one Config response can be returned.
See also: AWS API Documentation
Request Syntax
response = client.get_config(
configId='string',
configType='antenna-downlink'|'antenna-downlink-demod-decode'|'antenna-uplink'|'dataflow-endpoint'|'tracking'|'uplink-echo'|'s3-recording'
)
[REQUIRED]
UUID of a Config .
[REQUIRED]
Type of a Config .
dict
Response Syntax
{
'configArn': 'string',
'configData': {
'antennaDownlinkConfig': {
'spectrumConfig': {
'bandwidth': {
'units': 'GHz'|'MHz'|'kHz',
'value': 123.0
},
'centerFrequency': {
'units': 'GHz'|'MHz'|'kHz',
'value': 123.0
},
'polarization': 'LEFT_HAND'|'NONE'|'RIGHT_HAND'
}
},
'antennaDownlinkDemodDecodeConfig': {
'decodeConfig': {
'unvalidatedJSON': 'string'
},
'demodulationConfig': {
'unvalidatedJSON': 'string'
},
'spectrumConfig': {
'bandwidth': {
'units': 'GHz'|'MHz'|'kHz',
'value': 123.0
},
'centerFrequency': {
'units': 'GHz'|'MHz'|'kHz',
'value': 123.0
},
'polarization': 'LEFT_HAND'|'NONE'|'RIGHT_HAND'
}
},
'antennaUplinkConfig': {
'spectrumConfig': {
'centerFrequency': {
'units': 'GHz'|'MHz'|'kHz',
'value': 123.0
},
'polarization': 'LEFT_HAND'|'NONE'|'RIGHT_HAND'
},
'targetEirp': {
'units': 'dBW',
'value': 123.0
},
'transmitDisabled': True|False
},
'dataflowEndpointConfig': {
'dataflowEndpointName': 'string',
'dataflowEndpointRegion': 'string'
},
's3RecordingConfig': {
'bucketArn': 'string',
'prefix': 'string',
'roleArn': 'string'
},
'trackingConfig': {
'autotrack': 'PREFERRED'|'REMOVED'|'REQUIRED'
},
'uplinkEchoConfig': {
'antennaUplinkConfigArn': 'string',
'enabled': True|False
}
},
'configId': 'string',
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'antenna-uplink'|'dataflow-endpoint'|'tracking'|'uplink-echo'|'s3-recording',
'name': 'string',
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
configArn (string) --
ARN of a Config
configData (dict) --
Data elements in a Config .
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: antennaDownlinkConfig, antennaDownlinkDemodDecodeConfig, antennaUplinkConfig, dataflowEndpointConfig, s3RecordingConfig, trackingConfig, uplinkEchoConfig. 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'}
antennaDownlinkConfig (dict) --
Information about how AWS Ground Station should configure an antenna for downlink during a contact.
spectrumConfig (dict) --
Object that describes a spectral Config .
bandwidth (dict) --
Bandwidth of a spectral Config . AWS Ground Station currently has the following bandwidth limitations:
AntennaDownlinkDemodDecodeconfig , valid values are between 125 kHz to 650 MHz.AntennaDownlinkconfig valid values are between 10 kHz to 54 MHz.AntennaUplinkConfig , valid values are between 10 kHz to 54 MHz.units (string) --
Frequency bandwidth units.
value (float) --
Frequency bandwidth value. AWS Ground Station currently has the following bandwidth limitations:
AntennaDownlinkDemodDecodeconfig , valid values are between 125 kHz to 650 MHz.AntennaDownlinkconfig , valid values are between 10 kHz to 54 MHz.AntennaUplinkConfig , valid values are between 10 kHz to 54 MHz.centerFrequency (dict) --
Center frequency of a spectral Config . Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.
units (string) --
Frequency units.
value (float) --
Frequency value. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.
polarization (string) --
Polarization of a spectral Config . Capturing both "RIGHT_HAND" and "LEFT_HAND" polarization requires two separate configs.
antennaDownlinkDemodDecodeConfig (dict) --
Information about how AWS Ground Station should configure an antenna for downlink demod decode during a contact.
decodeConfig (dict) --
Information about the decode Config .
unvalidatedJSON (string) --
Unvalidated JSON of a decode Config .
demodulationConfig (dict) --
Information about the demodulation Config .
unvalidatedJSON (string) --
Unvalidated JSON of a demodulation Config .
spectrumConfig (dict) --
Information about the spectral Config .
bandwidth (dict) --
Bandwidth of a spectral Config . AWS Ground Station currently has the following bandwidth limitations:
AntennaDownlinkDemodDecodeconfig , valid values are between 125 kHz to 650 MHz.AntennaDownlinkconfig valid values are between 10 kHz to 54 MHz.AntennaUplinkConfig , valid values are between 10 kHz to 54 MHz.units (string) --
Frequency bandwidth units.
value (float) --
Frequency bandwidth value. AWS Ground Station currently has the following bandwidth limitations:
AntennaDownlinkDemodDecodeconfig , valid values are between 125 kHz to 650 MHz.AntennaDownlinkconfig , valid values are between 10 kHz to 54 MHz.AntennaUplinkConfig , valid values are between 10 kHz to 54 MHz.centerFrequency (dict) --
Center frequency of a spectral Config . Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.
units (string) --
Frequency units.
value (float) --
Frequency value. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.
polarization (string) --
Polarization of a spectral Config . Capturing both "RIGHT_HAND" and "LEFT_HAND" polarization requires two separate configs.
antennaUplinkConfig (dict) --
Information about how AWS Ground Station should configure an antenna for uplink during a contact.
spectrumConfig (dict) --
Information about the uplink spectral Config .
centerFrequency (dict) --
Center frequency of an uplink spectral Config . Valid values are between 2025 to 2120 MHz.
units (string) --
Frequency units.
value (float) --
Frequency value. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.
polarization (string) --
Polarization of an uplink spectral Config . Capturing both "RIGHT_HAND" and "LEFT_HAND" polarization requires two separate configs.
targetEirp (dict) --
EIRP of the target.
units (string) --
Units of an EIRP.
value (float) --
Value of an EIRP. Valid values are between 20.0 to 50.0 dBW.
transmitDisabled (boolean) --
Whether or not uplink transmit is disabled.
dataflowEndpointConfig (dict) --
Information about the dataflow endpoint Config .
dataflowEndpointName (string) --
Name of a dataflow endpoint.
dataflowEndpointRegion (string) --
Region of a dataflow endpoint.
s3RecordingConfig (dict) --
Information about an S3 recording Config .
bucketArn (string) --
ARN of the bucket to record to.
prefix (string) --
S3 Key prefix to prefice data files.
roleArn (string) --
ARN of the role Ground Station assumes to write data to the bucket.
trackingConfig (dict) --
Object that determines whether tracking should be used during a contact executed with this Config in the mission profile.
autotrack (string) --
Current setting for autotrack.
uplinkEchoConfig (dict) --
Information about an uplink echo Config .
Parameters from the AntennaUplinkConfig , corresponding to the specified AntennaUplinkConfigArn , are used when this UplinkEchoConfig is used in a contact.
antennaUplinkConfigArn (string) --
ARN of an uplink Config .
enabled (boolean) --
Whether or not an uplink Config is enabled.
configId (string) --
UUID of a Config .
configType (string) --
Type of a Config .
name (string) --
Name of a Config .
tags (dict) --
Tags assigned to a Config .
Exceptions
GroundStation.Client.exceptions.InvalidParameterExceptionGroundStation.Client.exceptions.DependencyExceptionGroundStation.Client.exceptions.ResourceNotFoundExceptionget_dataflow_endpoint_group(**kwargs)¶Returns the dataflow endpoint group.
See also: AWS API Documentation
Request Syntax
response = client.get_dataflow_endpoint_group(
dataflowEndpointGroupId='string'
)
[REQUIRED]
UUID of a dataflow endpoint group.
{
'contactPostPassDurationSeconds': 123,
'contactPrePassDurationSeconds': 123,
'dataflowEndpointGroupArn': 'string',
'dataflowEndpointGroupId': 'string',
'endpointsDetails': [
{
'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',
]
}
},
],
'tags': {
'string': 'string'
}
}
Response Structure
Amount of time, in seconds, after a contact ends for the contact to remain in a POSTPASS state. A CloudWatch event is emitted when the contact enters and exits the POSTPASS state.
Amount of time, in seconds, prior to contact start for the contact to remain in a PREPASS state. A CloudWatch event is emitted when the contact enters and exits the PREPASS state.
ARN of a dataflow endpoint group.
UUID of a dataflow endpoint group.
Details of a dataflow endpoint.
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.
Tags assigned to a dataflow endpoint group.
Exceptions
GroundStation.Client.exceptions.InvalidParameterExceptionGroundStation.Client.exceptions.DependencyExceptionGroundStation.Client.exceptions.ResourceNotFoundExceptionget_minute_usage(**kwargs)¶Returns the number of minutes used by account.
See also: AWS API Documentation
Request Syntax
response = client.get_minute_usage(
month=123,
year=123
)
[REQUIRED]
The month being requested, with a value of 1-12.
[REQUIRED]
The year being requested, in the format of YYYY.
dict
Response Syntax
{
'estimatedMinutesRemaining': 123,
'isReservedMinutesCustomer': True|False,
'totalReservedMinuteAllocation': 123,
'totalScheduledMinutes': 123,
'upcomingMinutesScheduled': 123
}
Response Structure
(dict) --
estimatedMinutesRemaining (integer) --
Estimated number of minutes remaining for an account, specific to the month being requested.
isReservedMinutesCustomer (boolean) --
Returns whether or not an account has signed up for the reserved minutes pricing plan, specific to the month being requested.
totalReservedMinuteAllocation (integer) --
Total number of reserved minutes allocated, specific to the month being requested.
totalScheduledMinutes (integer) --
Total scheduled minutes for an account, specific to the month being requested.
upcomingMinutesScheduled (integer) --
Upcoming minutes scheduled for an account, specific to the month being requested.
Exceptions
GroundStation.Client.exceptions.InvalidParameterExceptionGroundStation.Client.exceptions.DependencyExceptionGroundStation.Client.exceptions.ResourceNotFoundExceptionget_mission_profile(**kwargs)¶Returns a mission profile.
See also: AWS API Documentation
Request Syntax
response = client.get_mission_profile(
missionProfileId='string'
)
[REQUIRED]
UUID of a mission profile.
{
'contactPostPassDurationSeconds': 123,
'contactPrePassDurationSeconds': 123,
'dataflowEdges': [
[
'string',
],
],
'minimumViableContactDurationSeconds': 123,
'missionProfileArn': 'string',
'missionProfileId': 'string',
'name': 'string',
'region': 'string',
'streamsKmsKey': {
'kmsAliasArn': 'string',
'kmsKeyArn': 'string'
},
'streamsKmsRole': 'string',
'tags': {
'string': 'string'
},
'trackingConfigArn': 'string'
}
Response Structure
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.
A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config .
Smallest amount of time in seconds that you’d like to see for an available contact. AWS Ground Station will not present you with contacts shorter than this duration.
ARN of a mission profile.
UUID of a mission profile.
Name of a mission profile.
Region of a mission profile.
KMS key to use for encrypting streams.
Note
This is a Tagged Union structure. Only one of the following top level keys will be set: kmsAliasArn, kmsKeyArn. 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'}
KMS Alias Arn.
KMS Key Arn.
Role to use for encrypting streams with KMS key.
Tags assigned to a mission profile.
ARN of a tracking Config .
Exceptions
GroundStation.Client.exceptions.InvalidParameterExceptionGroundStation.Client.exceptions.DependencyExceptionGroundStation.Client.exceptions.ResourceNotFoundExceptionget_paginator(operation_name)¶Create a paginator for an operation.
create_foo, and you'd normally invoke the
operation as client.create_foo(**kwargs), if the
create_foo operation can be paginated, you can use the
call client.get_paginator("create_foo").client.can_paginate method to
check if an operation is pageable.get_satellite(**kwargs)¶Returns a satellite.
See also: AWS API Documentation
Request Syntax
response = client.get_satellite(
satelliteId='string'
)
[REQUIRED]
UUID of a satellite.
{
'currentEphemeris': {
'ephemerisId': 'string',
'epoch': datetime(2015, 1, 1),
'name': 'string',
'source': 'CUSTOMER_PROVIDED'|'SPACE_TRACK'
},
'groundStations': [
'string',
],
'noradSatelliteID': 123,
'satelliteArn': 'string',
'satelliteId': 'string'
}
Response Structure
The current ephemeris being used to compute the trajectory of the satellite.
UUID of a customer-provided ephemeris.
This field is not populated for default ephemerides from Space Track.
The epoch of a default, ephemeris from Space Track in UTC.
This field is not populated for customer-provided ephemerides.
A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
A name is only returned for customer-provider ephemerides that have a name associated.
The EphemerisSource that generated a given ephemeris.
A list of ground stations to which the satellite is on-boarded.
NORAD satellite ID number.
ARN of a satellite.
UUID of a satellite.
Exceptions
GroundStation.Client.exceptions.InvalidParameterExceptionGroundStation.Client.exceptions.DependencyExceptionGroundStation.Client.exceptions.ResourceNotFoundExceptionget_waiter(waiter_name)¶Returns an object that can wait for some condition.
list_configs(**kwargs)¶Returns a list of Config objects.
See also: AWS API Documentation
Request Syntax
response = client.list_configs(
maxResults=123,
nextToken='string'
)
Configs returned.ListConfigs call. Used to get the next page of results.dict
Response Syntax
{
'configList': [
{
'configArn': 'string',
'configId': 'string',
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'antenna-uplink'|'dataflow-endpoint'|'tracking'|'uplink-echo'|'s3-recording',
'name': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
configList (list) --
List of Config items.
(dict) --
An item in a list of Config objects.
configArn (string) --
ARN of a Config .
configId (string) --
UUID of a Config .
configType (string) --
Type of a Config .
name (string) --
Name of a Config .
nextToken (string) --
Next token returned in the response of a previous ListConfigs call. Used to get the next page of results.
Exceptions
GroundStation.Client.exceptions.InvalidParameterExceptionGroundStation.Client.exceptions.DependencyExceptionGroundStation.Client.exceptions.ResourceNotFoundExceptionlist_contacts(**kwargs)¶Returns a list of contacts.
If statusList contains AVAILABLE, the request must include groundStation , missionprofileArn , and satelliteArn .
See also: AWS API Documentation
Request Syntax
response = client.list_contacts(
endTime=datetime(2015, 1, 1),
groundStation='string',
maxResults=123,
missionProfileArn='string',
nextToken='string',
satelliteArn='string',
startTime=datetime(2015, 1, 1),
statusList=[
'AVAILABLE'|'AWS_CANCELLED'|'AWS_FAILED'|'CANCELLED'|'CANCELLING'|'COMPLETED'|'FAILED'|'FAILED_TO_SCHEDULE'|'PASS'|'POSTPASS'|'PREPASS'|'SCHEDULED'|'SCHEDULING',
]
)
[REQUIRED]
End time of a contact in UTC.
ListContacts call. Used to get the next page of results.[REQUIRED]
Start time of a contact in UTC.
[REQUIRED]
Status of a contact reservation.
dict
Response Syntax
{
'contactList': [
{
'contactId': 'string',
'contactStatus': 'AVAILABLE'|'AWS_CANCELLED'|'AWS_FAILED'|'CANCELLED'|'CANCELLING'|'COMPLETED'|'FAILED'|'FAILED_TO_SCHEDULE'|'PASS'|'POSTPASS'|'PREPASS'|'SCHEDULED'|'SCHEDULING',
'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'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
contactList (list) --
List of contacts.
(dict) --
Data describing a contact.
contactId (string) --
UUID of a contact.
contactStatus (string) --
Status of a contact.
endTime (datetime) --
End time of a contact in UTC.
errorMessage (string) --
Error message of a contact.
groundStation (string) --
Name of a ground station.
maximumElevation (dict) --
Maximum elevation angle of a contact.
unit (string) --
Elevation angle units.
value (float) --
Elevation angle value.
missionProfileArn (string) --
ARN of a mission profile.
postPassEndTime (datetime) --
Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
prePassStartTime (datetime) --
Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
region (string) --
Region of a contact.
satelliteArn (string) --
ARN of a satellite.
startTime (datetime) --
Start time of a contact in UTC.
tags (dict) --
Tags assigned to a contact.
nextToken (string) --
Next token returned in the response of a previous ListContacts call. Used to get the next page of results.
Exceptions
GroundStation.Client.exceptions.InvalidParameterExceptionGroundStation.Client.exceptions.DependencyExceptionGroundStation.Client.exceptions.ResourceNotFoundExceptionlist_dataflow_endpoint_groups(**kwargs)¶Returns a list of DataflowEndpoint groups.
See also: AWS API Documentation
Request Syntax
response = client.list_dataflow_endpoint_groups(
maxResults=123,
nextToken='string'
)
ListDataflowEndpointGroups call. Used to get the next page of results.dict
Response Syntax
{
'dataflowEndpointGroupList': [
{
'dataflowEndpointGroupArn': 'string',
'dataflowEndpointGroupId': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
dataflowEndpointGroupList (list) --
A list of dataflow endpoint groups.
(dict) --
Item in a list of DataflowEndpoint groups.
dataflowEndpointGroupArn (string) --
ARN of a dataflow endpoint group.
dataflowEndpointGroupId (string) --
UUID of a dataflow endpoint group.
nextToken (string) --
Next token returned in the response of a previous ListDataflowEndpointGroups call. Used to get the next page of results.
Exceptions
GroundStation.Client.exceptions.InvalidParameterExceptionGroundStation.Client.exceptions.DependencyExceptionGroundStation.Client.exceptions.ResourceNotFoundExceptionlist_ephemerides(**kwargs)¶List existing ephemerides.
See also: AWS API Documentation
Request Syntax
response = client.list_ephemerides(
endTime=datetime(2015, 1, 1),
maxResults=123,
nextToken='string',
satelliteId='string',
startTime=datetime(2015, 1, 1),
statusList=[
'VALIDATING'|'INVALID'|'ERROR'|'ENABLED'|'DISABLED'|'EXPIRED',
]
)
[REQUIRED]
The end time to list in UTC. The operation will return an ephemeris if its expiration time is within the time range defined by the startTime and endTime .
[REQUIRED]
The AWS Ground Station satellite ID to list ephemeris for.
[REQUIRED]
The start time to list in UTC. The operation will return an ephemeris if its expiration time is within the time range defined by the startTime and endTime .
The list of ephemeris status to return.
dict
Response Syntax
{
'ephemerides': [
{
'creationTime': datetime(2015, 1, 1),
'enabled': True|False,
'ephemerisId': 'string',
'name': 'string',
'priority': 123,
'sourceS3Object': {
'bucket': 'string',
'key': 'string',
'version': 'string'
},
'status': 'VALIDATING'|'INVALID'|'ERROR'|'ENABLED'|'DISABLED'|'EXPIRED'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
ephemerides (list) --
List of ephemerides.
(dict) --
Ephemeris item.
creationTime (datetime) --
The time the ephemeris was uploaded in UTC.
enabled (boolean) --
Whether or not the ephemeris is enabled.
ephemerisId (string) --
The AWS Ground Station ephemeris ID.
name (string) --
A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
priority (integer) --
Customer-provided priority score to establish the order in which overlapping ephemerides should be used.
The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.
Priority must be 1 or greater
sourceS3Object (dict) --
Source 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 S3 objects, the version to use for the ephemeris.
status (string) --
The status of the ephemeris.
nextToken (string) --
Pagination token.
Exceptions
GroundStation.Client.exceptions.InvalidParameterExceptionGroundStation.Client.exceptions.DependencyExceptionGroundStation.Client.exceptions.ResourceNotFoundExceptionlist_ground_stations(**kwargs)¶Returns a list of ground stations.
See also: AWS API Documentation
Request Syntax
response = client.list_ground_stations(
maxResults=123,
nextToken='string',
satelliteId='string'
)
dict
Response Syntax
{
'groundStationList': [
{
'groundStationId': 'string',
'groundStationName': 'string',
'region': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
groundStationList (list) --
List of ground stations.
(dict) --
Information about the ground station data.
groundStationId (string) --
UUID of a ground station.
groundStationName (string) --
Name of a ground station.
region (string) --
Ground station Region.
nextToken (string) --
Next token that can be supplied in the next call to get the next page of ground stations.
Exceptions
GroundStation.Client.exceptions.InvalidParameterExceptionGroundStation.Client.exceptions.DependencyExceptionGroundStation.Client.exceptions.ResourceNotFoundExceptionlist_mission_profiles(**kwargs)¶Returns a list of mission profiles.
See also: AWS API Documentation
Request Syntax
response = client.list_mission_profiles(
maxResults=123,
nextToken='string'
)
ListMissionProfiles call. Used to get the next page of results.dict
Response Syntax
{
'missionProfileList': [
{
'missionProfileArn': 'string',
'missionProfileId': 'string',
'name': 'string',
'region': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
missionProfileList (list) --
List of mission profiles.
(dict) --
Item in a list of mission profiles.
missionProfileArn (string) --
ARN of a mission profile.
missionProfileId (string) --
UUID of a mission profile.
name (string) --
Name of a mission profile.
region (string) --
Region of a mission profile.
nextToken (string) --
Next token returned in the response of a previous ListMissionProfiles call. Used to get the next page of results.
Exceptions
GroundStation.Client.exceptions.InvalidParameterExceptionGroundStation.Client.exceptions.DependencyExceptionGroundStation.Client.exceptions.ResourceNotFoundExceptionlist_satellites(**kwargs)¶Returns a list of satellites.
See also: AWS API Documentation
Request Syntax
response = client.list_satellites(
maxResults=123,
nextToken='string'
)
dict
Response Syntax
{
'nextToken': 'string',
'satellites': [
{
'currentEphemeris': {
'ephemerisId': 'string',
'epoch': datetime(2015, 1, 1),
'name': 'string',
'source': 'CUSTOMER_PROVIDED'|'SPACE_TRACK'
},
'groundStations': [
'string',
],
'noradSatelliteID': 123,
'satelliteArn': 'string',
'satelliteId': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
Next token that can be supplied in the next call to get the next page of satellites.
satellites (list) --
List of satellites.
(dict) --
Item in a list of satellites.
currentEphemeris (dict) --
The current ephemeris being used to compute the trajectory of the satellite.
ephemerisId (string) --
UUID of a customer-provided ephemeris.
This field is not populated for default ephemerides from Space Track.
epoch (datetime) --
The epoch of a default, ephemeris from Space Track in UTC.
This field is not populated for customer-provided ephemerides.
name (string) --
A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
A name is only returned for customer-provider ephemerides that have a name associated.
source (string) --
The EphemerisSource that generated a given ephemeris.
groundStations (list) --
A list of ground stations to which the satellite is on-boarded.
noradSatelliteID (integer) --
NORAD satellite ID number.
satelliteArn (string) --
ARN of a satellite.
satelliteId (string) --
UUID of a satellite.
Exceptions
GroundStation.Client.exceptions.InvalidParameterExceptionGroundStation.Client.exceptions.DependencyExceptionGroundStation.Client.exceptions.ResourceNotFoundExceptionReturns a list of tags for a specified resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
[REQUIRED]
ARN of a resource.
{
'tags': {
'string': 'string'
}
}
Response Structure
Tags assigned to a resource.
Exceptions
GroundStation.Client.exceptions.InvalidParameterExceptionGroundStation.Client.exceptions.DependencyExceptionGroundStation.Client.exceptions.ResourceNotFoundExceptionregister_agent(**kwargs)¶Registers a new agent with AWS Groundstation.
See also: AWS API Documentation
Request Syntax
response = client.register_agent(
agentDetails={
'agentVersion': 'string',
'componentVersions': [
{
'componentType': 'LAMINAR_FLOW'|'PRISM'|'DIGITIZER',
'versions': [
'string',
]
},
],
'instanceId': 'string',
'instanceType': 'string',
'reservedCpuCores': [
123,
]
},
discoveryData={
'capabilityArns': [
'string',
],
'privateIpAddresses': [
'string',
],
'publicIpAddresses': [
'string',
]
}
)
[REQUIRED]
Detailed information about the agent being registered.
Current agent version.
List of versions being used by agent components.
Version information for agent components.
Component type.
List of versions.
ID of EC2 instance agent is running on.
Type of EC2 instance agent is running on.
Number of Cpu cores reserved for agent.
[REQUIRED]
Data for associating and agent with the capabilities it is managing.
List of capabilities to associate with agent.
List of private IP addresses to associate with agent.
List of public IP addresses to associate with agent.
dict
Response Syntax
{
'agentId': 'string'
}
Response Structure
(dict) --
agentId (string) --
UUID of registered agent.
Exceptions
GroundStation.Client.exceptions.InvalidParameterExceptionGroundStation.Client.exceptions.DependencyExceptionGroundStation.Client.exceptions.ResourceNotFoundExceptionreserve_contact(**kwargs)¶Reserves a contact using specified parameters.
See also: AWS API Documentation
Request Syntax
response = client.reserve_contact(
endTime=datetime(2015, 1, 1),
groundStation='string',
missionProfileArn='string',
satelliteArn='string',
startTime=datetime(2015, 1, 1),
tags={
'string': 'string'
}
)
[REQUIRED]
End time of a contact in UTC.
[REQUIRED]
Name of a ground station.
[REQUIRED]
ARN of a mission profile.
[REQUIRED]
ARN of a satellite
[REQUIRED]
Start time of a contact in UTC.
Tags assigned to a contact.
dict
Response Syntax
{
'contactId': 'string'
}
Response Structure
(dict) --
contactId (string) --
UUID of a contact.
Exceptions
GroundStation.Client.exceptions.InvalidParameterExceptionGroundStation.Client.exceptions.DependencyExceptionGroundStation.Client.exceptions.ResourceNotFoundExceptiontag_resource(**kwargs)¶Assigns a tag to a resource.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
[REQUIRED]
ARN of a resource tag.
[REQUIRED]
Tags assigned to a resource.
dict
Response Syntax
{}
Response Structure
Exceptions
GroundStation.Client.exceptions.InvalidParameterExceptionGroundStation.Client.exceptions.DependencyExceptionGroundStation.Client.exceptions.ResourceNotFoundExceptionuntag_resource(**kwargs)¶Deassigns a resource tag.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
ARN of a resource.
[REQUIRED]
Keys of a resource tag.
dict
Response Syntax
{}
Response Structure
Exceptions
GroundStation.Client.exceptions.InvalidParameterExceptionGroundStation.Client.exceptions.DependencyExceptionGroundStation.Client.exceptions.ResourceNotFoundExceptionupdate_agent_status(**kwargs)¶Update the status of the agent.
See also: AWS API Documentation
Request Syntax
response = client.update_agent_status(
agentId='string',
aggregateStatus={
'signatureMap': {
'string': True|False
},
'status': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE'
},
componentStatuses=[
{
'bytesReceived': 123,
'bytesSent': 123,
'capabilityArn': 'string',
'componentType': 'LAMINAR_FLOW'|'PRISM'|'DIGITIZER',
'dataflowId': 'string',
'packetsDropped': 123,
'status': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE'
},
],
taskId='string'
)
[REQUIRED]
UUID of agent to update.
[REQUIRED]
Aggregate status for agent.
Sparse map of failure signatures.
Aggregate status.
[REQUIRED]
List of component statuses for agent.
Data on the status of agent components.
Bytes received by the component.
Bytes sent by the component.
Capability ARN of the component.
The Component type.
Dataflow UUID associated with the component.
Packets dropped by component.
Component status.
[REQUIRED]
GUID of agent task.
dict
Response Syntax
{
'agentId': 'string'
}
Response Structure
(dict) --
agentId (string) --
UUID of updated agent.
Exceptions
GroundStation.Client.exceptions.InvalidParameterExceptionGroundStation.Client.exceptions.DependencyExceptionGroundStation.Client.exceptions.ResourceNotFoundExceptionupdate_config(**kwargs)¶Updates the Config used when scheduling contacts.
Updating a Config will not update the execution parameters for existing future contacts scheduled with this Config .
See also: AWS API Documentation
Request Syntax
response = client.update_config(
configData={
'antennaDownlinkConfig': {
'spectrumConfig': {
'bandwidth': {
'units': 'GHz'|'MHz'|'kHz',
'value': 123.0
},
'centerFrequency': {
'units': 'GHz'|'MHz'|'kHz',
'value': 123.0
},
'polarization': 'LEFT_HAND'|'NONE'|'RIGHT_HAND'
}
},
'antennaDownlinkDemodDecodeConfig': {
'decodeConfig': {
'unvalidatedJSON': 'string'
},
'demodulationConfig': {
'unvalidatedJSON': 'string'
},
'spectrumConfig': {
'bandwidth': {
'units': 'GHz'|'MHz'|'kHz',
'value': 123.0
},
'centerFrequency': {
'units': 'GHz'|'MHz'|'kHz',
'value': 123.0
},
'polarization': 'LEFT_HAND'|'NONE'|'RIGHT_HAND'
}
},
'antennaUplinkConfig': {
'spectrumConfig': {
'centerFrequency': {
'units': 'GHz'|'MHz'|'kHz',
'value': 123.0
},
'polarization': 'LEFT_HAND'|'NONE'|'RIGHT_HAND'
},
'targetEirp': {
'units': 'dBW',
'value': 123.0
},
'transmitDisabled': True|False
},
'dataflowEndpointConfig': {
'dataflowEndpointName': 'string',
'dataflowEndpointRegion': 'string'
},
's3RecordingConfig': {
'bucketArn': 'string',
'prefix': 'string',
'roleArn': 'string'
},
'trackingConfig': {
'autotrack': 'PREFERRED'|'REMOVED'|'REQUIRED'
},
'uplinkEchoConfig': {
'antennaUplinkConfigArn': 'string',
'enabled': True|False
}
},
configId='string',
configType='antenna-downlink'|'antenna-downlink-demod-decode'|'antenna-uplink'|'dataflow-endpoint'|'tracking'|'uplink-echo'|'s3-recording',
name='string'
)
[REQUIRED]
Parameters of a Config .
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: antennaDownlinkConfig, antennaDownlinkDemodDecodeConfig, antennaUplinkConfig, dataflowEndpointConfig, s3RecordingConfig, trackingConfig, uplinkEchoConfig.
Information about how AWS Ground Station should configure an antenna for downlink during a contact.
Object that describes a spectral Config .
Bandwidth of a spectral Config . AWS Ground Station currently has the following bandwidth limitations:
AntennaDownlinkDemodDecodeconfig , valid values are between 125 kHz to 650 MHz.AntennaDownlinkconfig valid values are between 10 kHz to 54 MHz.AntennaUplinkConfig , valid values are between 10 kHz to 54 MHz.Frequency bandwidth units.
Frequency bandwidth value. AWS Ground Station currently has the following bandwidth limitations:
AntennaDownlinkDemodDecodeconfig , valid values are between 125 kHz to 650 MHz.AntennaDownlinkconfig , valid values are between 10 kHz to 54 MHz.AntennaUplinkConfig , valid values are between 10 kHz to 54 MHz.Center frequency of a spectral Config . Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.
Frequency units.
Frequency value. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.
Polarization of a spectral Config . Capturing both "RIGHT_HAND" and "LEFT_HAND" polarization requires two separate configs.
Information about how AWS Ground Station should configure an antenna for downlink demod decode during a contact.
Information about the decode Config .
Unvalidated JSON of a decode Config .
Information about the demodulation Config .
Unvalidated JSON of a demodulation Config .
Information about the spectral Config .
Bandwidth of a spectral Config . AWS Ground Station currently has the following bandwidth limitations:
AntennaDownlinkDemodDecodeconfig , valid values are between 125 kHz to 650 MHz.AntennaDownlinkconfig valid values are between 10 kHz to 54 MHz.AntennaUplinkConfig , valid values are between 10 kHz to 54 MHz.Frequency bandwidth units.
Frequency bandwidth value. AWS Ground Station currently has the following bandwidth limitations:
AntennaDownlinkDemodDecodeconfig , valid values are between 125 kHz to 650 MHz.AntennaDownlinkconfig , valid values are between 10 kHz to 54 MHz.AntennaUplinkConfig , valid values are between 10 kHz to 54 MHz.Center frequency of a spectral Config . Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.
Frequency units.
Frequency value. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.
Polarization of a spectral Config . Capturing both "RIGHT_HAND" and "LEFT_HAND" polarization requires two separate configs.
Information about how AWS Ground Station should configure an antenna for uplink during a contact.
Information about the uplink spectral Config .
Center frequency of an uplink spectral Config . Valid values are between 2025 to 2120 MHz.
Frequency units.
Frequency value. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.
Polarization of an uplink spectral Config . Capturing both "RIGHT_HAND" and "LEFT_HAND" polarization requires two separate configs.
EIRP of the target.
Units of an EIRP.
Value of an EIRP. Valid values are between 20.0 to 50.0 dBW.
Whether or not uplink transmit is disabled.
Information about the dataflow endpoint Config .
Name of a dataflow endpoint.
Region of a dataflow endpoint.
Information about an S3 recording Config .
ARN of the bucket to record to.
S3 Key prefix to prefice data files.
ARN of the role Ground Station assumes to write data to the bucket.
Object that determines whether tracking should be used during a contact executed with this Config in the mission profile.
Current setting for autotrack.
Information about an uplink echo Config .
Parameters from the AntennaUplinkConfig , corresponding to the specified AntennaUplinkConfigArn , are used when this UplinkEchoConfig is used in a contact.
ARN of an uplink Config .
Whether or not an uplink Config is enabled.
[REQUIRED]
UUID of a Config .
[REQUIRED]
Type of a Config .
[REQUIRED]
Name of a Config .
dict
Response Syntax
{
'configArn': 'string',
'configId': 'string',
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'antenna-uplink'|'dataflow-endpoint'|'tracking'|'uplink-echo'|'s3-recording'
}
Response Structure
(dict) --
configArn (string) --
ARN of a Config .
configId (string) --
UUID of a Config .
configType (string) --
Type of a Config .
Exceptions
GroundStation.Client.exceptions.InvalidParameterExceptionGroundStation.Client.exceptions.DependencyExceptionGroundStation.Client.exceptions.ResourceNotFoundExceptionupdate_ephemeris(**kwargs)¶Updates an existing ephemeris
See also: AWS API Documentation
Request Syntax
response = client.update_ephemeris(
enabled=True|False,
ephemerisId='string',
name='string',
priority=123
)
[REQUIRED]
Whether the ephemeris is enabled or not. Changing this value will not require the ephemeris to be re-validated.
[REQUIRED]
The AWS Ground Station ephemeris ID.
Customer-provided priority score to establish the order in which overlapping ephemerides should be used.
The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.
Priority must be 1 or greater
dict
Response Syntax
{
'ephemerisId': 'string'
}
Response Structure
(dict) --
ephemerisId (string) --
The AWS Ground Station ephemeris ID.
Exceptions
GroundStation.Client.exceptions.InvalidParameterExceptionGroundStation.Client.exceptions.DependencyExceptionGroundStation.Client.exceptions.ResourceNotFoundExceptionupdate_mission_profile(**kwargs)¶Updates a mission profile.
Updating a mission profile will not update the execution parameters for existing future contacts.
See also: AWS API Documentation
Request Syntax
response = client.update_mission_profile(
contactPostPassDurationSeconds=123,
contactPrePassDurationSeconds=123,
dataflowEdges=[
[
'string',
],
],
minimumViableContactDurationSeconds=123,
missionProfileId='string',
name='string',
streamsKmsKey={
'kmsAliasArn': 'string',
'kmsKeyArn': 'string'
},
streamsKmsRole='string',
trackingConfigArn='string'
)
A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config .
[REQUIRED]
UUID of a mission profile.
KMS key to use for encrypting streams.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set: kmsAliasArn, kmsKeyArn.
KMS Alias Arn.
KMS Key Arn.
Config .dict
Response Syntax
{
'missionProfileId': 'string'
}
Response Structure
(dict) --
missionProfileId (string) --
UUID of a mission profile.
Exceptions
GroundStation.Client.exceptions.InvalidParameterExceptionGroundStation.Client.exceptions.DependencyExceptionGroundStation.Client.exceptions.ResourceNotFoundExceptionThe available paginators are:
GroundStation.Paginator.ListConfigsGroundStation.Paginator.ListContactsGroundStation.Paginator.ListDataflowEndpointGroupsGroundStation.Paginator.ListEphemeridesGroundStation.Paginator.ListGroundStationsGroundStation.Paginator.ListMissionProfilesGroundStation.Paginator.ListSatellitesGroundStation.Paginator.ListConfigs¶paginator = client.get_paginator('list_configs')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from GroundStation.Client.list_configs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'configList': [
{
'configArn': 'string',
'configId': 'string',
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'antenna-uplink'|'dataflow-endpoint'|'tracking'|'uplink-echo'|'s3-recording',
'name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
List of Config items.
An item in a list of Config objects.
ARN of a Config .
UUID of a Config .
Type of a Config .
Name of a Config .
A token to resume pagination.
GroundStation.Paginator.ListContacts¶paginator = client.get_paginator('list_contacts')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from GroundStation.Client.list_contacts().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
endTime=datetime(2015, 1, 1),
groundStation='string',
missionProfileArn='string',
satelliteArn='string',
startTime=datetime(2015, 1, 1),
statusList=[
'AVAILABLE'|'AWS_CANCELLED'|'AWS_FAILED'|'CANCELLED'|'CANCELLING'|'COMPLETED'|'FAILED'|'FAILED_TO_SCHEDULE'|'PASS'|'POSTPASS'|'PREPASS'|'SCHEDULED'|'SCHEDULING',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
End time of a contact in UTC.
[REQUIRED]
Start time of a contact in UTC.
[REQUIRED]
Status of a contact reservation.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'contactList': [
{
'contactId': 'string',
'contactStatus': 'AVAILABLE'|'AWS_CANCELLED'|'AWS_FAILED'|'CANCELLED'|'CANCELLING'|'COMPLETED'|'FAILED'|'FAILED_TO_SCHEDULE'|'PASS'|'POSTPASS'|'PREPASS'|'SCHEDULED'|'SCHEDULING',
'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'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
contactList (list) --
List of contacts.
(dict) --
Data describing a contact.
contactId (string) --
UUID of a contact.
contactStatus (string) --
Status of a contact.
endTime (datetime) --
End time of a contact in UTC.
errorMessage (string) --
Error message of a contact.
groundStation (string) --
Name of a ground station.
maximumElevation (dict) --
Maximum elevation angle of a contact.
unit (string) --
Elevation angle units.
value (float) --
Elevation angle value.
missionProfileArn (string) --
ARN of a mission profile.
postPassEndTime (datetime) --
Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
prePassStartTime (datetime) --
Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
region (string) --
Region of a contact.
satelliteArn (string) --
ARN of a satellite.
startTime (datetime) --
Start time of a contact in UTC.
tags (dict) --
Tags assigned to a contact.
NextToken (string) --
A token to resume pagination.
GroundStation.Paginator.ListDataflowEndpointGroups¶paginator = client.get_paginator('list_dataflow_endpoint_groups')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from GroundStation.Client.list_dataflow_endpoint_groups().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'dataflowEndpointGroupList': [
{
'dataflowEndpointGroupArn': 'string',
'dataflowEndpointGroupId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
A list of dataflow endpoint groups.
Item in a list of DataflowEndpoint groups.
ARN of a dataflow endpoint group.
UUID of a dataflow endpoint group.
A token to resume pagination.
GroundStation.Paginator.ListEphemerides¶paginator = client.get_paginator('list_ephemerides')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from GroundStation.Client.list_ephemerides().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
endTime=datetime(2015, 1, 1),
satelliteId='string',
startTime=datetime(2015, 1, 1),
statusList=[
'VALIDATING'|'INVALID'|'ERROR'|'ENABLED'|'DISABLED'|'EXPIRED',
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
[REQUIRED]
The end time to list in UTC. The operation will return an ephemeris if its expiration time is within the time range defined by the startTime and endTime .
[REQUIRED]
The AWS Ground Station satellite ID to list ephemeris for.
[REQUIRED]
The start time to list in UTC. The operation will return an ephemeris if its expiration time is within the time range defined by the startTime and endTime .
The list of ephemeris status to return.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'ephemerides': [
{
'creationTime': datetime(2015, 1, 1),
'enabled': True|False,
'ephemerisId': 'string',
'name': 'string',
'priority': 123,
'sourceS3Object': {
'bucket': 'string',
'key': 'string',
'version': 'string'
},
'status': 'VALIDATING'|'INVALID'|'ERROR'|'ENABLED'|'DISABLED'|'EXPIRED'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
ephemerides (list) --
List of ephemerides.
(dict) --
Ephemeris item.
creationTime (datetime) --
The time the ephemeris was uploaded in UTC.
enabled (boolean) --
Whether or not the ephemeris is enabled.
ephemerisId (string) --
The AWS Ground Station ephemeris ID.
name (string) --
A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
priority (integer) --
Customer-provided priority score to establish the order in which overlapping ephemerides should be used.
The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.
Priority must be 1 or greater
sourceS3Object (dict) --
Source 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 S3 objects, the version to use for the ephemeris.
status (string) --
The status of the ephemeris.
NextToken (string) --
A token to resume pagination.
GroundStation.Paginator.ListGroundStations¶paginator = client.get_paginator('list_ground_stations')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from GroundStation.Client.list_ground_stations().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
satelliteId='string',
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'groundStationList': [
{
'groundStationId': 'string',
'groundStationName': 'string',
'region': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
groundStationList (list) --
List of ground stations.
(dict) --
Information about the ground station data.
groundStationId (string) --
UUID of a ground station.
groundStationName (string) --
Name of a ground station.
region (string) --
Ground station Region.
NextToken (string) --
A token to resume pagination.
GroundStation.Paginator.ListMissionProfiles¶paginator = client.get_paginator('list_mission_profiles')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from GroundStation.Client.list_mission_profiles().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'missionProfileList': [
{
'missionProfileArn': 'string',
'missionProfileId': 'string',
'name': 'string',
'region': 'string'
},
],
'NextToken': 'string'
}
Response Structure
List of mission profiles.
Item in a list of mission profiles.
ARN of a mission profile.
UUID of a mission profile.
Name of a mission profile.
Region of a mission profile.
A token to resume pagination.
GroundStation.Paginator.ListSatellites¶paginator = client.get_paginator('list_satellites')
paginate(**kwargs)¶Creates an iterator that will paginate through responses from GroundStation.Client.list_satellites().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'satellites': [
{
'currentEphemeris': {
'ephemerisId': 'string',
'epoch': datetime(2015, 1, 1),
'name': 'string',
'source': 'CUSTOMER_PROVIDED'|'SPACE_TRACK'
},
'groundStations': [
'string',
],
'noradSatelliteID': 123,
'satelliteArn': 'string',
'satelliteId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
List of satellites.
Item in a list of satellites.
The current ephemeris being used to compute the trajectory of the satellite.
UUID of a customer-provided ephemeris.
This field is not populated for default ephemerides from Space Track.
The epoch of a default, ephemeris from Space Track in UTC.
This field is not populated for customer-provided ephemerides.
A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.
A name is only returned for customer-provider ephemerides that have a name associated.
The EphemerisSource that generated a given ephemeris.
A list of ground stations to which the satellite is on-boarded.
NORAD satellite ID number.
ARN of a satellite.
UUID of a satellite.
A token to resume pagination.
The available waiters are:
GroundStation.Waiter.ContactScheduled¶waiter = client.get_waiter('contact_scheduled')
wait(**kwargs)¶Polls GroundStation.Client.describe_contact() every 5 seconds until a successful state is reached. An error is returned after 180 failed checks.
See also: AWS API Documentation
Request Syntax
waiter.wait(
contactId='string',
WaiterConfig={
'Delay': 123,
'MaxAttempts': 123
}
)
[REQUIRED]
UUID of a contact.
A dictionary that provides parameters to control waiting behavior.
The amount of time in seconds to wait between attempts. Default: 5
The maximum number of attempts to be made. Default: 180
None