2021/04/21 - AWS Ground Station - 6 updated api methods
Changes Support new S3 Recording Config allowing customers to write downlink data directly to S3.
{'configData': {'s3RecordingConfig': {'bucketArn': 'string',
'prefix': 'string',
'roleArn': 'string'}}}
Response {'configType': {'s3-recording'}}
Creates a Config with the specified configData parameters.
Only one type of configData can be specified.
See also: AWS API Documentation
Request Syntax
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'
}
)
dict
[REQUIRED]
Parameters of a Config.
antennaDownlinkConfig (dict) --
Information about how AWS Ground Station should configure an antenna for downlink during a contact.
spectrumConfig (dict) -- [REQUIRED]
Object that describes a spectral Config.
bandwidth (dict) -- [REQUIRED]
Bandwidth of a spectral Config. AWS Ground Station currently has the following bandwidth limitations:
For AntennaDownlinkDemodDecodeconfig, valid values are between 125 kHz to 650 MHz.
For AntennaDownlinkconfig valid values are between 10 kHz to 54 MHz.
For AntennaUplinkConfig, valid values are between 10 kHz to 54 MHz.
units (string) -- [REQUIRED]
Frequency bandwidth units.
value (float) -- [REQUIRED]
Frequency bandwidth value. AWS Ground Station currently has the following bandwidth limitations:
For AntennaDownlinkDemodDecodeconfig, valid values are between 125 kHz to 650 MHz.
For AntennaDownlinkconfig, valid values are between 10 kHz to 54 MHz.
For AntennaUplinkConfig, valid values are between 10 kHz to 54 MHz.
centerFrequency (dict) -- [REQUIRED]
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) -- [REQUIRED]
Frequency units.
value (float) -- [REQUIRED]
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) -- [REQUIRED]
Information about the decode Config.
unvalidatedJSON (string) -- [REQUIRED]
Unvalidated JSON of a decode Config.
demodulationConfig (dict) -- [REQUIRED]
Information about the demodulation Config.
unvalidatedJSON (string) -- [REQUIRED]
Unvalidated JSON of a demodulation Config.
spectrumConfig (dict) -- [REQUIRED]
Information about the spectral Config.
bandwidth (dict) -- [REQUIRED]
Bandwidth of a spectral Config. AWS Ground Station currently has the following bandwidth limitations:
For AntennaDownlinkDemodDecodeconfig, valid values are between 125 kHz to 650 MHz.
For AntennaDownlinkconfig valid values are between 10 kHz to 54 MHz.
For AntennaUplinkConfig, valid values are between 10 kHz to 54 MHz.
units (string) -- [REQUIRED]
Frequency bandwidth units.
value (float) -- [REQUIRED]
Frequency bandwidth value. AWS Ground Station currently has the following bandwidth limitations:
For AntennaDownlinkDemodDecodeconfig, valid values are between 125 kHz to 650 MHz.
For AntennaDownlinkconfig, valid values are between 10 kHz to 54 MHz.
For AntennaUplinkConfig, valid values are between 10 kHz to 54 MHz.
centerFrequency (dict) -- [REQUIRED]
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) -- [REQUIRED]
Frequency units.
value (float) -- [REQUIRED]
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) -- [REQUIRED]
Information about the uplink spectral Config.
centerFrequency (dict) -- [REQUIRED]
Center frequency of an uplink spectral Config. Valid values are between 2025 to 2120 MHz.
units (string) -- [REQUIRED]
Frequency units.
value (float) -- [REQUIRED]
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) -- [REQUIRED]
EIRP of the target.
units (string) -- [REQUIRED]
Units of an EIRP.
value (float) -- [REQUIRED]
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) -- [REQUIRED]
Name of a dataflow endpoint.
dataflowEndpointRegion (string) --
Region of a dataflow endpoint.
s3RecordingConfig (dict) --
Information about an S3 recording Config.
bucketArn (string) -- [REQUIRED]
ARN of the bucket to record to.
prefix (string) --
S3 Key prefix to prefice data files.
roleArn (string) -- [REQUIRED]
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) -- [REQUIRED]
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) -- [REQUIRED]
ARN of an uplink Config.
enabled (boolean) -- [REQUIRED]
Whether or not an uplink Config is enabled.
string
[REQUIRED]
Name of a Config.
dict
Tags assigned to a Config.
(string) --
(string) --
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.
{'configType': {'s3-recording'}}
Deletes a Config.
See also: AWS API Documentation
Request Syntax
client.delete_config(
configId='string',
configType='antenna-downlink'|'antenna-downlink-demod-decode'|'antenna-uplink'|'dataflow-endpoint'|'tracking'|'uplink-echo'|'s3-recording'
)
string
[REQUIRED]
UUID of a Config.
string
[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.
{'dataflowList': {'destination': {'configDetails': {'s3RecordingDetails': {'bucketArn': 'string',
'keyTemplate': 'string'}},
'configType': {'s3-recording'}},
'source': {'configDetails': {'s3RecordingDetails': {'bucketArn': 'string',
'keyTemplate': 'string'}},
'configType': {'s3-recording'}}}}
Describes an existing contact.
See also: AWS API Documentation
Request Syntax
client.describe_contact(
contactId='string'
)
string
[REQUIRED]
UUID of a contact.
dict
Response Syntax
{
'contactId': 'string',
'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': {
'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': {
'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
(dict) --
contactId (string) --
UUID of a contact.
contactStatus (string) --
Status of a contact.
dataflowList (list) --
List describing source and destination details for each dataflow edge.
(dict) --
Information about a dataflow edge used in a contact.
destination (dict) --
Dataflow details for the destination side.
configDetails (dict) --
Additional details for a Config, if type is dataflow endpoint or antenna demod decode.
antennaDemodDecodeDetails (dict) --
Details for antenna demod decode Config in a contact.
outputNode (string) --
Name of an antenna demod decode output node used in a contact.
endpointDetails (dict) --
Information about the endpoint details.
endpoint (dict) --
A dataflow endpoint.
address (dict) --
Socket address of a dataflow endpoint.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
name (string) --
Name of a dataflow endpoint.
status (string) --
Status of a dataflow endpoint.
securityDetails (dict) --
Endpoint security details.
roleArn (string) --
ARN to a role needed for connecting streams to your instances.
securityGroupIds (list) --
The security groups to attach to the elastic network interfaces.
(string) --
subnetIds (list) --
A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.
(string) --
s3RecordingDetails (dict) --
Details for an S3 recording Config in a contact.
bucketArn (string) --
ARN of the bucket used.
keyTemplate (string) --
Template of the S3 key used.
configId (string) --
UUID of a Config.
configType (string) --
Type of a Config.
dataflowDestinationRegion (string) --
Region of a dataflow destination.
errorMessage (string) --
Error message for a dataflow.
source (dict) --
Dataflow details for the source side.
configDetails (dict) --
Additional details for a Config, if type is dataflow endpoint or antenna demod decode.
antennaDemodDecodeDetails (dict) --
Details for antenna demod decode Config in a contact.
outputNode (string) --
Name of an antenna demod decode output node used in a contact.
endpointDetails (dict) --
Information about the endpoint details.
endpoint (dict) --
A dataflow endpoint.
address (dict) --
Socket address of a dataflow endpoint.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
name (string) --
Name of a dataflow endpoint.
status (string) --
Status of a dataflow endpoint.
securityDetails (dict) --
Endpoint security details.
roleArn (string) --
ARN to a role needed for connecting streams to your instances.
securityGroupIds (list) --
The security groups to attach to the elastic network interfaces.
(string) --
subnetIds (list) --
A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.
(string) --
s3RecordingDetails (dict) --
Details for an S3 recording Config in a contact.
bucketArn (string) --
ARN of the bucket used.
keyTemplate (string) --
Template of the S3 key used.
configId (string) --
UUID of a Config.
configType (string) --
Type of a Config.
dataflowSourceRegion (string) --
Region of a dataflow source.
endTime (datetime) --
End time of a contact.
errorMessage (string) --
Error message for a contact.
groundStation (string) --
Ground station for a contact.
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.
(string) --
(string) --
{'configType': {'s3-recording'}}
Response {'configData': {'s3RecordingConfig': {'bucketArn': 'string',
'prefix': 'string',
'roleArn': 'string'}},
'configType': {'s3-recording'}}
Returns Config information.
Only one Config response can be returned.
See also: AWS API Documentation
Request Syntax
client.get_config(
configId='string',
configType='antenna-downlink'|'antenna-downlink-demod-decode'|'antenna-uplink'|'dataflow-endpoint'|'tracking'|'uplink-echo'|'s3-recording'
)
string
[REQUIRED]
UUID of a Config.
string
[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.
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:
For AntennaDownlinkDemodDecodeconfig, valid values are between 125 kHz to 650 MHz.
For AntennaDownlinkconfig valid values are between 10 kHz to 54 MHz.
For 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:
For AntennaDownlinkDemodDecodeconfig, valid values are between 125 kHz to 650 MHz.
For AntennaDownlinkconfig, valid values are between 10 kHz to 54 MHz.
For 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:
For AntennaDownlinkDemodDecodeconfig, valid values are between 125 kHz to 650 MHz.
For AntennaDownlinkconfig valid values are between 10 kHz to 54 MHz.
For 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:
For AntennaDownlinkDemodDecodeconfig, valid values are between 125 kHz to 650 MHz.
For AntennaDownlinkconfig, valid values are between 10 kHz to 54 MHz.
For 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.
(string) --
(string) --
{'configList': {'configType': {'s3-recording'}}}
Returns a list of Config objects.
See also: AWS API Documentation
Request Syntax
client.list_configs(
maxResults=123,
nextToken='string'
)
integer
Maximum number of Configs returned.
string
Next token returned in the request of a previous 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.
{'configData': {'s3RecordingConfig': {'bucketArn': 'string',
'prefix': 'string',
'roleArn': 'string'}},
'configType': {'s3-recording'}}
Response {'configType': {'s3-recording'}}
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
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'
)
dict
[REQUIRED]
Parameters of a Config.
antennaDownlinkConfig (dict) --
Information about how AWS Ground Station should configure an antenna for downlink during a contact.
spectrumConfig (dict) -- [REQUIRED]
Object that describes a spectral Config.
bandwidth (dict) -- [REQUIRED]
Bandwidth of a spectral Config. AWS Ground Station currently has the following bandwidth limitations:
For AntennaDownlinkDemodDecodeconfig, valid values are between 125 kHz to 650 MHz.
For AntennaDownlinkconfig valid values are between 10 kHz to 54 MHz.
For AntennaUplinkConfig, valid values are between 10 kHz to 54 MHz.
units (string) -- [REQUIRED]
Frequency bandwidth units.
value (float) -- [REQUIRED]
Frequency bandwidth value. AWS Ground Station currently has the following bandwidth limitations:
For AntennaDownlinkDemodDecodeconfig, valid values are between 125 kHz to 650 MHz.
For AntennaDownlinkconfig, valid values are between 10 kHz to 54 MHz.
For AntennaUplinkConfig, valid values are between 10 kHz to 54 MHz.
centerFrequency (dict) -- [REQUIRED]
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) -- [REQUIRED]
Frequency units.
value (float) -- [REQUIRED]
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) -- [REQUIRED]
Information about the decode Config.
unvalidatedJSON (string) -- [REQUIRED]
Unvalidated JSON of a decode Config.
demodulationConfig (dict) -- [REQUIRED]
Information about the demodulation Config.
unvalidatedJSON (string) -- [REQUIRED]
Unvalidated JSON of a demodulation Config.
spectrumConfig (dict) -- [REQUIRED]
Information about the spectral Config.
bandwidth (dict) -- [REQUIRED]
Bandwidth of a spectral Config. AWS Ground Station currently has the following bandwidth limitations:
For AntennaDownlinkDemodDecodeconfig, valid values are between 125 kHz to 650 MHz.
For AntennaDownlinkconfig valid values are between 10 kHz to 54 MHz.
For AntennaUplinkConfig, valid values are between 10 kHz to 54 MHz.
units (string) -- [REQUIRED]
Frequency bandwidth units.
value (float) -- [REQUIRED]
Frequency bandwidth value. AWS Ground Station currently has the following bandwidth limitations:
For AntennaDownlinkDemodDecodeconfig, valid values are between 125 kHz to 650 MHz.
For AntennaDownlinkconfig, valid values are between 10 kHz to 54 MHz.
For AntennaUplinkConfig, valid values are between 10 kHz to 54 MHz.
centerFrequency (dict) -- [REQUIRED]
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) -- [REQUIRED]
Frequency units.
value (float) -- [REQUIRED]
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) -- [REQUIRED]
Information about the uplink spectral Config.
centerFrequency (dict) -- [REQUIRED]
Center frequency of an uplink spectral Config. Valid values are between 2025 to 2120 MHz.
units (string) -- [REQUIRED]
Frequency units.
value (float) -- [REQUIRED]
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) -- [REQUIRED]
EIRP of the target.
units (string) -- [REQUIRED]
Units of an EIRP.
value (float) -- [REQUIRED]
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) -- [REQUIRED]
Name of a dataflow endpoint.
dataflowEndpointRegion (string) --
Region of a dataflow endpoint.
s3RecordingConfig (dict) --
Information about an S3 recording Config.
bucketArn (string) -- [REQUIRED]
ARN of the bucket to record to.
prefix (string) --
S3 Key prefix to prefice data files.
roleArn (string) -- [REQUIRED]
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) -- [REQUIRED]
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) -- [REQUIRED]
ARN of an uplink Config.
enabled (boolean) -- [REQUIRED]
Whether or not an uplink Config is enabled.
string
[REQUIRED]
UUID of a Config.
string
[REQUIRED]
Type of a Config.
string
[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.