Table of Contents
A low-level client representing AWS Ground Station:
import boto3
client = boto3.client('groundstation')
These are the available methods:
Check if an operation can be paginated.
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
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'
},
'trackingConfig': {
'autotrack': 'PREFERRED'|'REMOVED'|'REQUIRED'
},
'uplinkEchoConfig': {
'antennaUplinkConfigArn': 'string',
'enabled': True|False
}
},
name='string',
tags={
'string': 'string'
}
)
[REQUIRED]
Parameters of a Config .
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:
Frequency bandwidth units.
Frequency bandwidth value. AWS Ground Station currently has the following bandwidth limitations:
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:
Frequency bandwidth units.
Frequency bandwidth value. AWS Ground Station currently has the following bandwidth limitations:
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.
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'
}
Response Structure
(dict) --
configArn (string) --
ARN of a Config .
configId (string) --
UUID of a Config .
configType (string) --
Type of a Config .
Exceptions
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(
endpointDetails=[
{
'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'
}
)
[REQUIRED]
Endpoint details of each endpoint in the dataflow endpoint group.
Information about the endpoint details.
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.
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
Creates a mission profile.
dataflowEdges is 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',
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.
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
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'
)
[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'
}
Response Structure
(dict) --
configArn (string) --
ARN of a Config .
configId (string) --
UUID of a Config .
configType (string) --
Type of a Config .
Exceptions
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
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
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'|'CANCELLED'|'CANCELLING'|'COMPLETED'|'FAILED'|'FAILED_TO_SCHEDULE'|'PASS'|'POSTPASS'|'PREPASS'|'SCHEDULED'|'SCHEDULING',
'dataflowList': [
{
'destination': {
'configDetails': {
'antennaDemodDecodeDetails': {
'outputNode': 'string'
},
'endpointDetails': {
'endpoint': {
'address': {
'name': 'string',
'port': 123
},
'mtu': 123,
'name': 'string',
'status': 'created'|'creating'|'deleted'|'deleting'|'failed'
},
'securityDetails': {
'roleArn': 'string',
'securityGroupIds': [
'string',
],
'subnetIds': [
'string',
]
}
}
},
'configId': 'string',
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'antenna-uplink'|'dataflow-endpoint'|'tracking'|'uplink-echo',
'dataflowDestinationRegion': 'string'
},
'source': {
'configDetails': {
'antennaDemodDecodeDetails': {
'outputNode': 'string'
},
'endpointDetails': {
'endpoint': {
'address': {
'name': 'string',
'port': 123
},
'mtu': 123,
'name': 'string',
'status': 'created'|'creating'|'deleted'|'deleting'|'failed'
},
'securityDetails': {
'roleArn': 'string',
'securityGroupIds': [
'string',
],
'subnetIds': [
'string',
]
}
}
},
'configId': 'string',
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'antenna-uplink'|'dataflow-endpoint'|'tracking'|'uplink-echo',
'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.
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.
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.
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.
UUID of a Config .
Type of a Config .
Region of a dataflow destination.
Dataflow details for the source side.
Additional details for a Config , if type is dataflow endpoint or antenna demod decode.
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.
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.
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.
UUID of a Config .
Type of a Config .
Region of a dataflow source.
End time of a contact.
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.
Tags assigned to a contact.
Exceptions
Generate a presigned url given a client, its method, and arguments
The presigned url
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'
)
[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'
},
'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',
'name': 'string',
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
configArn (string) --
ARN of a Config
configData (dict) --
Data elements in a Config .
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:
units (string) --
Frequency bandwidth units.
value (float) --
Frequency bandwidth value. AWS Ground Station currently has the following bandwidth limitations:
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:
units (string) --
Frequency bandwidth units.
value (float) --
Frequency bandwidth value. AWS Ground Station currently has the following bandwidth limitations:
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.
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
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.
{
'dataflowEndpointGroupArn': 'string',
'dataflowEndpointGroupId': 'string',
'endpointsDetails': [
{
'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
ARN of a dataflow endpoint group.
UUID of a dataflow endpoint group.
Details of a dataflow endpoint.
Information about the endpoint details.
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.
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
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
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',
'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.
Tags assigned to a mission profile.
ARN of a tracking Config .
Exceptions
Create a paginator for an operation.
Returns a satellite.
See also: AWS API Documentation
Request Syntax
response = client.get_satellite(
satelliteId='string'
)
[REQUIRED]
UUID of a satellite.
{
'groundStations': [
'string',
],
'noradSatelliteID': 123,
'satelliteArn': 'string',
'satelliteId': 'string'
}
Response Structure
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
Returns an object that can wait for some condition.
Returns a list of Config objects.
See also: AWS API Documentation
Request Syntax
response = client.list_configs(
maxResults=123,
nextToken='string'
)
dict
Response Syntax
{
'configList': [
{
'configArn': 'string',
'configId': 'string',
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'antenna-uplink'|'dataflow-endpoint'|'tracking'|'uplink-echo',
'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
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'|'CANCELLED'|'CANCELLING'|'COMPLETED'|'FAILED'|'FAILED_TO_SCHEDULE'|'PASS'|'POSTPASS'|'PREPASS'|'SCHEDULED'|'SCHEDULING',
]
)
[REQUIRED]
End time of a contact.
[REQUIRED]
Start time of a contact.
[REQUIRED]
Status of a contact reservation.
dict
Response Syntax
{
'contactList': [
{
'contactId': 'string',
'contactStatus': 'AVAILABLE'|'AWS_CANCELLED'|'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.
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.
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
Returns a list of DataflowEndpoint groups.
See also: AWS API Documentation
Request Syntax
response = client.list_dataflow_endpoint_groups(
maxResults=123,
nextToken='string'
)
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
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
Returns a list of mission profiles.
See also: AWS API Documentation
Request Syntax
response = client.list_mission_profiles(
maxResults=123,
nextToken='string'
)
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
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': [
{
'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.
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
Returns 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
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.
[REQUIRED]
Name of a ground station.
[REQUIRED]
ARN of a mission profile.
[REQUIRED]
ARN of a satellite
[REQUIRED]
Start time of a contact.
Tags assigned to a contact.
dict
Response Syntax
{
'contactId': 'string'
}
Response Structure
(dict) --
contactId (string) --
UUID of a contact.
Exceptions
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
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
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'
},
'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',
name='string'
)
[REQUIRED]
Parameters of a Config .
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:
Frequency bandwidth units.
Frequency bandwidth value. AWS Ground Station currently has the following bandwidth limitations:
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:
Frequency bandwidth units.
Frequency bandwidth value. AWS Ground Station currently has the following bandwidth limitations:
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.
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'
}
Response Structure
(dict) --
configArn (string) --
ARN of a Config .
configId (string) --
UUID of a Config .
configType (string) --
Type of a Config .
Exceptions
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',
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.
dict
Response Syntax
{
'missionProfileId': 'string'
}
Response Structure
(dict) --
missionProfileId (string) --
UUID of a mission profile.
Exceptions
The available paginators are:
paginator = client.get_paginator('list_configs')
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',
'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.
paginator = client.get_paginator('list_contacts')
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'|'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.
[REQUIRED]
Start time of a contact.
[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'|'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.
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.
tags (dict) --
Tags assigned to a contact.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_dataflow_endpoint_groups')
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.
paginator = client.get_paginator('list_ground_stations')
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.
paginator = client.get_paginator('list_mission_profiles')
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.
paginator = client.get_paginator('list_satellites')
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': [
{
'groundStations': [
'string',
],
'noradSatelliteID': 123,
'satelliteArn': 'string',
'satelliteId': 'string'
},
],
'NextToken': 'string'
}
Response Structure
List of satellites.
Item in a list of satellites.
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.