2026/01/26 - AWS Ground Station - 9 updated api methods
Changes Adds support for AWS Ground Station Telemetry.
{'configData': {'telemetrySinkConfig': {'telemetrySinkData': {'kinesisDataStreamData': {'kinesisDataStreamArn': 'string',
'kinesisRoleArn': 'string'}},
'telemetrySinkType': 'KINESIS_DATA_STREAM'}}}
Response {'configType': {'telemetry-sink'}}
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(
name='string',
configData={
'antennaDownlinkConfig': {
'spectrumConfig': {
'centerFrequency': {
'value': 123.0,
'units': 'GHz'|'MHz'|'kHz'
},
'bandwidth': {
'value': 123.0,
'units': 'GHz'|'MHz'|'kHz'
},
'polarization': 'RIGHT_HAND'|'LEFT_HAND'|'NONE'
}
},
'trackingConfig': {
'autotrack': 'REQUIRED'|'PREFERRED'|'REMOVED'
},
'dataflowEndpointConfig': {
'dataflowEndpointName': 'string',
'dataflowEndpointRegion': 'string'
},
'antennaDownlinkDemodDecodeConfig': {
'spectrumConfig': {
'centerFrequency': {
'value': 123.0,
'units': 'GHz'|'MHz'|'kHz'
},
'bandwidth': {
'value': 123.0,
'units': 'GHz'|'MHz'|'kHz'
},
'polarization': 'RIGHT_HAND'|'LEFT_HAND'|'NONE'
},
'demodulationConfig': {
'unvalidatedJSON': 'string'
},
'decodeConfig': {
'unvalidatedJSON': 'string'
}
},
'antennaUplinkConfig': {
'transmitDisabled': True|False,
'spectrumConfig': {
'centerFrequency': {
'value': 123.0,
'units': 'GHz'|'MHz'|'kHz'
},
'polarization': 'RIGHT_HAND'|'LEFT_HAND'|'NONE'
},
'targetEirp': {
'value': 123.0,
'units': 'dBW'
}
},
'uplinkEchoConfig': {
'enabled': True|False,
'antennaUplinkConfigArn': 'string'
},
's3RecordingConfig': {
'bucketArn': 'string',
'roleArn': 'string',
'prefix': 'string'
},
'telemetrySinkConfig': {
'telemetrySinkType': 'KINESIS_DATA_STREAM',
'telemetrySinkData': {
'kinesisDataStreamData': {
'kinesisRoleArn': 'string',
'kinesisDataStreamArn': 'string'
}
}
}
},
tags={
'string': 'string'
}
)
string
[REQUIRED]
Name of a Config.
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.
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.
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.
units (string) -- [REQUIRED]
Frequency units.
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.
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.
units (string) -- [REQUIRED]
Frequency bandwidth units.
polarization (string) --
Polarization of a spectral Config. Capturing both "RIGHT_HAND" and "LEFT_HAND" polarization requires two separate configs.
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.
dataflowEndpointConfig (dict) --
Information about the dataflow endpoint Config.
dataflowEndpointName (string) -- [REQUIRED]
Name of a dataflow endpoint.
dataflowEndpointRegion (string) --
Region of a dataflow endpoint.
antennaDownlinkDemodDecodeConfig (dict) --
Information about how AWS Ground Station should configure an antenna for downlink demod decode during a contact.
spectrumConfig (dict) -- [REQUIRED]
Information about the spectral Config.
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.
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.
units (string) -- [REQUIRED]
Frequency units.
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.
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.
units (string) -- [REQUIRED]
Frequency bandwidth units.
polarization (string) --
Polarization of a spectral Config. Capturing both "RIGHT_HAND" and "LEFT_HAND" polarization requires two separate configs.
demodulationConfig (dict) -- [REQUIRED]
Information about the demodulation Config.
unvalidatedJSON (string) -- [REQUIRED]
Unvalidated JSON of a demodulation Config.
decodeConfig (dict) -- [REQUIRED]
Information about the decode Config.
unvalidatedJSON (string) -- [REQUIRED]
Unvalidated JSON of a decode Config.
antennaUplinkConfig (dict) --
Information about how AWS Ground Station should configure an antenna for uplink during a contact.
transmitDisabled (boolean) --
Whether or not uplink transmit is disabled.
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.
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.
units (string) -- [REQUIRED]
Frequency units.
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.
value (float) -- [REQUIRED]
Value of an EIRP. Valid values are between 20.0 to 50.0 dBW.
units (string) -- [REQUIRED]
Units of an EIRP.
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.
enabled (boolean) -- [REQUIRED]
Whether or not an uplink Config is enabled.
antennaUplinkConfigArn (string) -- [REQUIRED]
ARN of an uplink Config.
s3RecordingConfig (dict) --
Information about an S3 recording Config.
bucketArn (string) -- [REQUIRED]
ARN of the bucket to record to.
roleArn (string) -- [REQUIRED]
ARN of the role Ground Station assumes to write data to the bucket.
prefix (string) --
S3 Key prefix to prefice data files.
telemetrySinkConfig (dict) --
Information about a telemetry sink Config.
telemetrySinkType (string) -- [REQUIRED]
The type of telemetry sink.
telemetrySinkData (dict) -- [REQUIRED]
Information about the telemetry sink specified by the telemetrySinkType.
kinesisDataStreamData (dict) --
Information about a telemetry sink of type KINESIS_DATA_STREAM.
kinesisRoleArn (string) -- [REQUIRED]
ARN of the IAM Role used by AWS Ground Station to deliver telemetry.
kinesisDataStreamArn (string) -- [REQUIRED]
ARN of the Kinesis Data Stream to deliver telemetry to.
dict
Tags assigned to a Config.
(string) --
(string) --
dict
Response Syntax
{
'configId': 'string',
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'tracking'|'dataflow-endpoint'|'antenna-uplink'|'uplink-echo'|'s3-recording'|'telemetry-sink',
'configArn': 'string'
}
Response Structure
(dict) --
configId (string) --
UUID of a Config.
configType (string) --
Type of a Config.
configArn (string) --
ARN of a Config.
{'telemetrySinkConfigArn': 'string'}
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
client.create_mission_profile(
name='string',
contactPrePassDurationSeconds=123,
contactPostPassDurationSeconds=123,
minimumViableContactDurationSeconds=123,
dataflowEdges=[
[
'string',
],
],
trackingConfigArn='string',
telemetrySinkConfigArn='string',
tags={
'string': 'string'
},
streamsKmsKey={
'kmsKeyArn': 'string',
'kmsAliasArn': 'string',
'kmsAliasName': 'string'
},
streamsKmsRole='string'
)
string
[REQUIRED]
Name of a mission profile.
integer
Amount of time prior to contact start you’d like to receive a Ground Station Contact State Change event indicating an upcoming pass.
integer
Amount of time after a contact ends that you’d like to receive a Ground Station Contact State Change event indicating the pass has finished.
integer
[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.
list
[REQUIRED]
A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config.
(list) --
(string) --
string
[REQUIRED]
ARN of a tracking Config.
string
ARN of a telemetry sink Config.
dict
Tags assigned to a mission profile.
(string) --
(string) --
dict
KMS key to use for encrypting streams.
kmsKeyArn (string) --
KMS Key Arn.
kmsAliasArn (string) --
KMS Alias Arn.
kmsAliasName (string) --
KMS Alias Name.
string
Role to use for encrypting streams with KMS key.
dict
Response Syntax
{
'missionProfileId': 'string'
}
Response Structure
(dict) --
missionProfileId (string) --
UUID of a mission profile.
{'configType': {'telemetry-sink'}}
Deletes a Config.
See also: AWS API Documentation
Request Syntax
client.delete_config(
configId='string',
configType='antenna-downlink'|'antenna-downlink-demod-decode'|'tracking'|'dataflow-endpoint'|'antenna-uplink'|'uplink-echo'|'s3-recording'|'telemetry-sink'
)
string
[REQUIRED]
UUID of a Config.
string
[REQUIRED]
Type of a Config.
dict
Response Syntax
{
'configId': 'string',
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'tracking'|'dataflow-endpoint'|'antenna-uplink'|'uplink-echo'|'s3-recording'|'telemetry-sink',
'configArn': 'string'
}
Response Structure
(dict) --
configId (string) --
UUID of a Config.
configType (string) --
Type of a Config.
configArn (string) --
ARN of a Config.
{'dataflowList': {'destination': {'configType': {'telemetry-sink'}},
'source': {'configType': {'telemetry-sink'}}}}
Describes an existing contact.
See also: AWS API Documentation
Request Syntax
client.describe_contact(
contactId='string'
)
string
[REQUIRED]
UUID of a contact.
dict
Response Syntax
{
'contactId': 'string',
'missionProfileArn': 'string',
'satelliteArn': 'string',
'startTime': datetime(2015, 1, 1),
'endTime': datetime(2015, 1, 1),
'prePassStartTime': datetime(2015, 1, 1),
'postPassEndTime': datetime(2015, 1, 1),
'groundStation': 'string',
'contactStatus': 'SCHEDULING'|'FAILED_TO_SCHEDULE'|'SCHEDULED'|'CANCELLED'|'AWS_CANCELLED'|'PREPASS'|'PASS'|'POSTPASS'|'COMPLETED'|'FAILED'|'AVAILABLE'|'CANCELLING'|'AWS_FAILED',
'errorMessage': 'string',
'maximumElevation': {
'value': 123.0,
'unit': 'DEGREE_ANGLE'|'RADIAN'
},
'tags': {
'string': 'string'
},
'region': 'string',
'dataflowList': [
{
'source': {
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'tracking'|'dataflow-endpoint'|'antenna-uplink'|'uplink-echo'|'s3-recording'|'telemetry-sink',
'configId': 'string',
'configDetails': {
'endpointDetails': {
'securityDetails': {
'subnetIds': [
'string',
],
'securityGroupIds': [
'string',
],
'roleArn': 'string'
},
'endpoint': {
'name': 'string',
'address': {
'name': 'string',
'port': 123
},
'status': 'created'|'creating'|'deleted'|'deleting'|'failed',
'mtu': 123
},
'awsGroundStationAgentEndpoint': {
'name': 'string',
'egressAddress': {
'socketAddress': {
'name': 'string',
'port': 123
},
'mtu': 123
},
'ingressAddress': {
'socketAddress': {
'name': 'string',
'portRange': {
'minimum': 123,
'maximum': 123
}
},
'mtu': 123
},
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY'
},
'uplinkAwsGroundStationAgentEndpoint': {
'name': 'string',
'dataflowDetails': {
'agentConnectionDetails': {
'ingressAddressAndPort': {
'socketAddress': {
'name': 'string',
'port': 123
},
'mtu': 123
},
'agentIpAndPortAddress': {
'socketAddress': {
'name': 'string',
'portRange': {
'minimum': 123,
'maximum': 123
}
},
'mtu': 123
}
}
},
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY'
},
'downlinkAwsGroundStationAgentEndpoint': {
'name': 'string',
'dataflowDetails': {
'agentConnectionDetails': {
'agentIpAndPortAddress': {
'socketAddress': {
'name': 'string',
'portRange': {
'minimum': 123,
'maximum': 123
}
},
'mtu': 123
},
'egressAddressAndPort': {
'socketAddress': {
'name': 'string',
'port': 123
},
'mtu': 123
}
}
},
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY'
},
'healthStatus': 'HEALTHY'|'UNHEALTHY',
'healthReasons': [
'NO_REGISTERED_AGENT'|'INVALID_IP_OWNERSHIP'|'NOT_AUTHORIZED_TO_CREATE_SLR'|'UNVERIFIED_IP_OWNERSHIP'|'INITIALIZING_DATAPLANE'|'DATAPLANE_FAILURE'|'HEALTHY',
]
},
'antennaDemodDecodeDetails': {
'outputNode': 'string'
},
's3RecordingDetails': {
'bucketArn': 'string',
'keyTemplate': 'string'
}
},
'dataflowSourceRegion': 'string'
},
'destination': {
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'tracking'|'dataflow-endpoint'|'antenna-uplink'|'uplink-echo'|'s3-recording'|'telemetry-sink',
'configId': 'string',
'configDetails': {
'endpointDetails': {
'securityDetails': {
'subnetIds': [
'string',
],
'securityGroupIds': [
'string',
],
'roleArn': 'string'
},
'endpoint': {
'name': 'string',
'address': {
'name': 'string',
'port': 123
},
'status': 'created'|'creating'|'deleted'|'deleting'|'failed',
'mtu': 123
},
'awsGroundStationAgentEndpoint': {
'name': 'string',
'egressAddress': {
'socketAddress': {
'name': 'string',
'port': 123
},
'mtu': 123
},
'ingressAddress': {
'socketAddress': {
'name': 'string',
'portRange': {
'minimum': 123,
'maximum': 123
}
},
'mtu': 123
},
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY'
},
'uplinkAwsGroundStationAgentEndpoint': {
'name': 'string',
'dataflowDetails': {
'agentConnectionDetails': {
'ingressAddressAndPort': {
'socketAddress': {
'name': 'string',
'port': 123
},
'mtu': 123
},
'agentIpAndPortAddress': {
'socketAddress': {
'name': 'string',
'portRange': {
'minimum': 123,
'maximum': 123
}
},
'mtu': 123
}
}
},
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY'
},
'downlinkAwsGroundStationAgentEndpoint': {
'name': 'string',
'dataflowDetails': {
'agentConnectionDetails': {
'agentIpAndPortAddress': {
'socketAddress': {
'name': 'string',
'portRange': {
'minimum': 123,
'maximum': 123
}
},
'mtu': 123
},
'egressAddressAndPort': {
'socketAddress': {
'name': 'string',
'port': 123
},
'mtu': 123
}
}
},
'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE',
'auditResults': 'HEALTHY'|'UNHEALTHY'
},
'healthStatus': 'HEALTHY'|'UNHEALTHY',
'healthReasons': [
'NO_REGISTERED_AGENT'|'INVALID_IP_OWNERSHIP'|'NOT_AUTHORIZED_TO_CREATE_SLR'|'UNVERIFIED_IP_OWNERSHIP'|'INITIALIZING_DATAPLANE'|'DATAPLANE_FAILURE'|'HEALTHY',
]
},
'antennaDemodDecodeDetails': {
'outputNode': 'string'
},
's3RecordingDetails': {
'bucketArn': 'string',
'keyTemplate': 'string'
}
},
'dataflowDestinationRegion': 'string'
},
'errorMessage': 'string'
},
],
'visibilityStartTime': datetime(2015, 1, 1),
'visibilityEndTime': datetime(2015, 1, 1),
'trackingOverrides': {
'programTrackSettings': {
'azEl': {
'ephemerisId': 'string'
}
}
},
'ephemeris': {
'ephemerisId': 'string',
'ephemerisType': 'TLE'|'OEM'|'AZ_EL'|'SERVICE_MANAGED'
}
}
Response Structure
(dict) --
contactId (string) --
UUID of a contact.
missionProfileArn (string) --
ARN of a mission profile.
satelliteArn (string) --
ARN of a satellite.
startTime (datetime) --
Start time of a contact in UTC.
endTime (datetime) --
End time of a contact in UTC.
prePassStartTime (datetime) --
Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
postPassEndTime (datetime) --
Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
groundStation (string) --
Ground station for a contact.
contactStatus (string) --
Status of a contact.
errorMessage (string) --
Error message for a contact.
maximumElevation (dict) --
Maximum elevation angle of a contact.
value (float) --
Elevation angle value.
unit (string) --
Elevation angle units.
tags (dict) --
Tags assigned to a contact.
(string) --
(string) --
region (string) --
Region of a contact.
dataflowList (list) --
List describing source and destination details for each dataflow edge.
(dict) --
Information about a dataflow edge used in a contact.
source (dict) --
Dataflow details for the source side.
configType (string) --
Type of a Config.
configId (string) --
UUID of a Config.
configDetails (dict) --
Additional details for a Config, if type is dataflow-endpoint or antenna-downlink-demod-decode
endpointDetails (dict) --
Information about the endpoint details.
securityDetails (dict) --
Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.
subnetIds (list) --
A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.
(string) --
securityGroupIds (list) --
The security groups to attach to the elastic network interfaces.
(string) --
roleArn (string) --
ARN to a role needed for connecting streams to your instances.
endpoint (dict) --
A dataflow endpoint.
name (string) --
Name of a dataflow endpoint.
address (dict) --
Socket address of a dataflow endpoint.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
status (string) --
Status of a dataflow endpoint.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
awsGroundStationAgentEndpoint (dict) --
An agent endpoint.
name (string) --
Name string associated with AgentEndpoint. Used as a human-readable identifier for AgentEndpoint.
egressAddress (dict) --
The egress address of AgentEndpoint.
socketAddress (dict) --
A socket address.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
ingressAddress (dict) --
The ingress address of AgentEndpoint.
socketAddress (dict) --
A ranged socket address.
name (string) --
IPv4 socket address.
portRange (dict) --
Port range of a socket address.
minimum (integer) --
A minimum value.
maximum (integer) --
A maximum value.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentStatus (string) --
The status of AgentEndpoint.
auditResults (string) --
The results of the audit.
uplinkAwsGroundStationAgentEndpoint (dict) --
Definition for an uplink agent endpoint
name (string) --
Uplink dataflow endpoint name
dataflowDetails (dict) --
Dataflow details for the uplink endpoint
agentConnectionDetails (dict) --
Uplink connection details for customer to Agent and Agent to Ground Station
ingressAddressAndPort (dict) --
Egress address of AgentEndpoint with an optional mtu.
socketAddress (dict) --
A socket address.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentIpAndPortAddress (dict) --
Ingress address of AgentEndpoint with a port range and an optional mtu.
socketAddress (dict) --
A ranged socket address.
name (string) --
IPv4 socket address.
portRange (dict) --
Port range of a socket address.
minimum (integer) --
A minimum value.
maximum (integer) --
A maximum value.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentStatus (string) --
Status of the agent associated with the uplink dataflow endpoint
auditResults (string) --
Health audit results for the uplink dataflow endpoint
downlinkAwsGroundStationAgentEndpoint (dict) --
Definition for a downlink agent endpoint
name (string) --
Downlink dataflow endpoint name
dataflowDetails (dict) --
Dataflow details for the downlink endpoint
agentConnectionDetails (dict) --
Downlink connection details for customer to Agent and Agent to Ground Station
agentIpAndPortAddress (dict) --
Ingress address of AgentEndpoint with a port range and an optional mtu.
socketAddress (dict) --
A ranged socket address.
name (string) --
IPv4 socket address.
portRange (dict) --
Port range of a socket address.
minimum (integer) --
A minimum value.
maximum (integer) --
A maximum value.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
egressAddressAndPort (dict) --
Egress address of AgentEndpoint with an optional mtu.
socketAddress (dict) --
A socket address.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentStatus (string) --
Status of the agent associated with the downlink dataflow endpoint
auditResults (string) --
Health audit results for the downlink dataflow endpoint
healthStatus (string) --
A dataflow endpoint health status. This field is ignored when calling CreateDataflowEndpointGroup.
healthReasons (list) --
Health reasons for a dataflow endpoint. This field is ignored when calling CreateDataflowEndpointGroup.
(string) --
antennaDemodDecodeDetails (dict) --
Details for antenna demod decode Config in a contact.
outputNode (string) --
Name of an antenna demod decode output node used in a contact.
s3RecordingDetails (dict) --
Details for an S3 recording Config in a contact.
bucketArn (string) --
ARN of the bucket used.
keyTemplate (string) --
Key template used for the S3 Recording Configuration
dataflowSourceRegion (string) --
Region of a dataflow source.
destination (dict) --
Dataflow details for the destination side.
configType (string) --
Type of a Config.
configId (string) --
UUID of a Config.
configDetails (dict) --
Additional details for a Config, if type is dataflow endpoint or antenna demod decode.
endpointDetails (dict) --
Information about the endpoint details.
securityDetails (dict) --
Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.
subnetIds (list) --
A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.
(string) --
securityGroupIds (list) --
The security groups to attach to the elastic network interfaces.
(string) --
roleArn (string) --
ARN to a role needed for connecting streams to your instances.
endpoint (dict) --
A dataflow endpoint.
name (string) --
Name of a dataflow endpoint.
address (dict) --
Socket address of a dataflow endpoint.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
status (string) --
Status of a dataflow endpoint.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
awsGroundStationAgentEndpoint (dict) --
An agent endpoint.
name (string) --
Name string associated with AgentEndpoint. Used as a human-readable identifier for AgentEndpoint.
egressAddress (dict) --
The egress address of AgentEndpoint.
socketAddress (dict) --
A socket address.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
ingressAddress (dict) --
The ingress address of AgentEndpoint.
socketAddress (dict) --
A ranged socket address.
name (string) --
IPv4 socket address.
portRange (dict) --
Port range of a socket address.
minimum (integer) --
A minimum value.
maximum (integer) --
A maximum value.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentStatus (string) --
The status of AgentEndpoint.
auditResults (string) --
The results of the audit.
uplinkAwsGroundStationAgentEndpoint (dict) --
Definition for an uplink agent endpoint
name (string) --
Uplink dataflow endpoint name
dataflowDetails (dict) --
Dataflow details for the uplink endpoint
agentConnectionDetails (dict) --
Uplink connection details for customer to Agent and Agent to Ground Station
ingressAddressAndPort (dict) --
Egress address of AgentEndpoint with an optional mtu.
socketAddress (dict) --
A socket address.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentIpAndPortAddress (dict) --
Ingress address of AgentEndpoint with a port range and an optional mtu.
socketAddress (dict) --
A ranged socket address.
name (string) --
IPv4 socket address.
portRange (dict) --
Port range of a socket address.
minimum (integer) --
A minimum value.
maximum (integer) --
A maximum value.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentStatus (string) --
Status of the agent associated with the uplink dataflow endpoint
auditResults (string) --
Health audit results for the uplink dataflow endpoint
downlinkAwsGroundStationAgentEndpoint (dict) --
Definition for a downlink agent endpoint
name (string) --
Downlink dataflow endpoint name
dataflowDetails (dict) --
Dataflow details for the downlink endpoint
agentConnectionDetails (dict) --
Downlink connection details for customer to Agent and Agent to Ground Station
agentIpAndPortAddress (dict) --
Ingress address of AgentEndpoint with a port range and an optional mtu.
socketAddress (dict) --
A ranged socket address.
name (string) --
IPv4 socket address.
portRange (dict) --
Port range of a socket address.
minimum (integer) --
A minimum value.
maximum (integer) --
A maximum value.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
egressAddressAndPort (dict) --
Egress address of AgentEndpoint with an optional mtu.
socketAddress (dict) --
A socket address.
name (string) --
Name of a socket address.
port (integer) --
Port of a socket address.
mtu (integer) --
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
agentStatus (string) --
Status of the agent associated with the downlink dataflow endpoint
auditResults (string) --
Health audit results for the downlink dataflow endpoint
healthStatus (string) --
A dataflow endpoint health status. This field is ignored when calling CreateDataflowEndpointGroup.
healthReasons (list) --
Health reasons for a dataflow endpoint. This field is ignored when calling CreateDataflowEndpointGroup.
(string) --
antennaDemodDecodeDetails (dict) --
Details for antenna demod decode Config in a contact.
outputNode (string) --
Name of an antenna demod decode output node used in a contact.
s3RecordingDetails (dict) --
Details for an S3 recording Config in a contact.
bucketArn (string) --
ARN of the bucket used.
keyTemplate (string) --
Key template used for the S3 Recording Configuration
dataflowDestinationRegion (string) --
Region of a dataflow destination.
errorMessage (string) --
Error message for a dataflow.
visibilityStartTime (datetime) --
Projected time in UTC your satellite will rise above the receive mask. This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts.
visibilityEndTime (datetime) --
Projected time in UTC your satellite will set below the receive mask. This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts.
trackingOverrides (dict) --
Tracking configuration overrides specified when the contact was reserved.
programTrackSettings (dict) --
Program track settings to override for antenna tracking during the contact.
azEl (dict) --
Program track settings for AzElEphemeris.
ephemerisId (string) --
Unique identifier of the azimuth elevation ephemeris.
ephemeris (dict) --
The ephemeris that determines antenna pointing directions for the contact.
ephemerisId (string) --
Unique identifier of the ephemeris. Appears only for custom ephemerides.
ephemerisType (string) --
Type of ephemeris.
{'configType': {'telemetry-sink'}}
Response {'configData': {'telemetrySinkConfig': {'telemetrySinkData': {'kinesisDataStreamData': {'kinesisDataStreamArn': 'string',
'kinesisRoleArn': 'string'}},
'telemetrySinkType': 'KINESIS_DATA_STREAM'}},
'configType': {'telemetry-sink'}}
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'|'tracking'|'dataflow-endpoint'|'antenna-uplink'|'uplink-echo'|'s3-recording'|'telemetry-sink'
)
string
[REQUIRED]
UUID of a Config.
string
[REQUIRED]
Type of a Config.
dict
Response Syntax
{
'configId': 'string',
'configArn': 'string',
'name': 'string',
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'tracking'|'dataflow-endpoint'|'antenna-uplink'|'uplink-echo'|'s3-recording'|'telemetry-sink',
'configData': {
'antennaDownlinkConfig': {
'spectrumConfig': {
'centerFrequency': {
'value': 123.0,
'units': 'GHz'|'MHz'|'kHz'
},
'bandwidth': {
'value': 123.0,
'units': 'GHz'|'MHz'|'kHz'
},
'polarization': 'RIGHT_HAND'|'LEFT_HAND'|'NONE'
}
},
'trackingConfig': {
'autotrack': 'REQUIRED'|'PREFERRED'|'REMOVED'
},
'dataflowEndpointConfig': {
'dataflowEndpointName': 'string',
'dataflowEndpointRegion': 'string'
},
'antennaDownlinkDemodDecodeConfig': {
'spectrumConfig': {
'centerFrequency': {
'value': 123.0,
'units': 'GHz'|'MHz'|'kHz'
},
'bandwidth': {
'value': 123.0,
'units': 'GHz'|'MHz'|'kHz'
},
'polarization': 'RIGHT_HAND'|'LEFT_HAND'|'NONE'
},
'demodulationConfig': {
'unvalidatedJSON': 'string'
},
'decodeConfig': {
'unvalidatedJSON': 'string'
}
},
'antennaUplinkConfig': {
'transmitDisabled': True|False,
'spectrumConfig': {
'centerFrequency': {
'value': 123.0,
'units': 'GHz'|'MHz'|'kHz'
},
'polarization': 'RIGHT_HAND'|'LEFT_HAND'|'NONE'
},
'targetEirp': {
'value': 123.0,
'units': 'dBW'
}
},
'uplinkEchoConfig': {
'enabled': True|False,
'antennaUplinkConfigArn': 'string'
},
's3RecordingConfig': {
'bucketArn': 'string',
'roleArn': 'string',
'prefix': 'string'
},
'telemetrySinkConfig': {
'telemetrySinkType': 'KINESIS_DATA_STREAM',
'telemetrySinkData': {
'kinesisDataStreamData': {
'kinesisRoleArn': 'string',
'kinesisDataStreamArn': 'string'
}
}
}
},
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
configId (string) --
UUID of a Config.
configArn (string) --
ARN of a Config
name (string) --
Name of a Config.
configType (string) --
Type 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.
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.
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.
units (string) --
Frequency units.
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.
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.
units (string) --
Frequency bandwidth units.
polarization (string) --
Polarization of a spectral Config. Capturing both "RIGHT_HAND" and "LEFT_HAND" polarization requires two separate configs.
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.
dataflowEndpointConfig (dict) --
Information about the dataflow endpoint Config.
dataflowEndpointName (string) --
Name of a dataflow endpoint.
dataflowEndpointRegion (string) --
Region of a dataflow endpoint.
antennaDownlinkDemodDecodeConfig (dict) --
Information about how AWS Ground Station should configure an antenna for downlink demod decode during a contact.
spectrumConfig (dict) --
Information about the spectral Config.
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.
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.
units (string) --
Frequency units.
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.
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.
units (string) --
Frequency bandwidth units.
polarization (string) --
Polarization of a spectral Config. Capturing both "RIGHT_HAND" and "LEFT_HAND" polarization requires two separate configs.
demodulationConfig (dict) --
Information about the demodulation Config.
unvalidatedJSON (string) --
Unvalidated JSON of a demodulation Config.
decodeConfig (dict) --
Information about the decode Config.
unvalidatedJSON (string) --
Unvalidated JSON of a decode Config.
antennaUplinkConfig (dict) --
Information about how AWS Ground Station should configure an antenna for uplink during a contact.
transmitDisabled (boolean) --
Whether or not uplink transmit is disabled.
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.
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.
units (string) --
Frequency units.
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.
value (float) --
Value of an EIRP. Valid values are between 20.0 to 50.0 dBW.
units (string) --
Units of an EIRP.
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.
enabled (boolean) --
Whether or not an uplink Config is enabled.
antennaUplinkConfigArn (string) --
ARN of an uplink Config.
s3RecordingConfig (dict) --
Information about an S3 recording Config.
bucketArn (string) --
ARN of the bucket to record to.
roleArn (string) --
ARN of the role Ground Station assumes to write data to the bucket.
prefix (string) --
S3 Key prefix to prefice data files.
telemetrySinkConfig (dict) --
Information about a telemetry sink Config.
telemetrySinkType (string) --
The type of telemetry sink.
telemetrySinkData (dict) --
Information about the telemetry sink specified by the telemetrySinkType.
kinesisDataStreamData (dict) --
Information about a telemetry sink of type KINESIS_DATA_STREAM.
kinesisRoleArn (string) --
ARN of the IAM Role used by AWS Ground Station to deliver telemetry.
kinesisDataStreamArn (string) --
ARN of the Kinesis Data Stream to deliver telemetry to.
tags (dict) --
Tags assigned to a Config.
(string) --
(string) --
{'telemetrySinkConfigArn': 'string'}
Returns a mission profile.
See also: AWS API Documentation
Request Syntax
client.get_mission_profile(
missionProfileId='string'
)
string
[REQUIRED]
UUID of a mission profile.
dict
Response Syntax
{
'missionProfileId': 'string',
'missionProfileArn': 'string',
'name': 'string',
'region': 'string',
'contactPrePassDurationSeconds': 123,
'contactPostPassDurationSeconds': 123,
'minimumViableContactDurationSeconds': 123,
'dataflowEdges': [
[
'string',
],
],
'trackingConfigArn': 'string',
'telemetrySinkConfigArn': 'string',
'tags': {
'string': 'string'
},
'streamsKmsKey': {
'kmsKeyArn': 'string',
'kmsAliasArn': 'string',
'kmsAliasName': 'string'
},
'streamsKmsRole': 'string'
}
Response Structure
(dict) --
missionProfileId (string) --
UUID of a mission profile.
missionProfileArn (string) --
ARN of a mission profile.
name (string) --
Name of a mission profile.
region (string) --
Region of a mission profile.
contactPrePassDurationSeconds (integer) --
Amount of time prior to contact start you’d like to receive a CloudWatch event indicating an upcoming pass.
contactPostPassDurationSeconds (integer) --
Amount of time after a contact ends that you’d like to receive a CloudWatch event indicating the pass has finished.
minimumViableContactDurationSeconds (integer) --
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.
dataflowEdges (list) --
A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config.
(list) --
(string) --
trackingConfigArn (string) --
ARN of a tracking Config.
telemetrySinkConfigArn (string) --
ARN of a telemetry sink Config.
tags (dict) --
Tags assigned to a mission profile.
(string) --
(string) --
streamsKmsKey (dict) --
KMS key to use for encrypting streams.
kmsKeyArn (string) --
KMS Key Arn.
kmsAliasArn (string) --
KMS Alias Arn.
kmsAliasName (string) --
KMS Alias Name.
streamsKmsRole (string) --
Role to use for encrypting streams with KMS key.
{'configList': {'configType': {'telemetry-sink'}}}
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
{
'nextToken': 'string',
'configList': [
{
'configId': 'string',
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'tracking'|'dataflow-endpoint'|'antenna-uplink'|'uplink-echo'|'s3-recording'|'telemetry-sink',
'configArn': 'string',
'name': 'string'
},
]
}
Response Structure
(dict) --
nextToken (string) --
Next token returned in the response of a previous ListConfigs call. Used to get the next page of results.
configList (list) --
List of Config items.
(dict) --
An item in a list of Config objects.
configId (string) --
UUID of a Config.
configType (string) --
Type of a Config.
configArn (string) --
ARN of a Config.
name (string) --
Name of a Config.
{'configData': {'telemetrySinkConfig': {'telemetrySinkData': {'kinesisDataStreamData': {'kinesisDataStreamArn': 'string',
'kinesisRoleArn': 'string'}},
'telemetrySinkType': 'KINESIS_DATA_STREAM'}},
'configType': {'telemetry-sink'}}
Response {'configType': {'telemetry-sink'}}
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(
configId='string',
name='string',
configType='antenna-downlink'|'antenna-downlink-demod-decode'|'tracking'|'dataflow-endpoint'|'antenna-uplink'|'uplink-echo'|'s3-recording'|'telemetry-sink',
configData={
'antennaDownlinkConfig': {
'spectrumConfig': {
'centerFrequency': {
'value': 123.0,
'units': 'GHz'|'MHz'|'kHz'
},
'bandwidth': {
'value': 123.0,
'units': 'GHz'|'MHz'|'kHz'
},
'polarization': 'RIGHT_HAND'|'LEFT_HAND'|'NONE'
}
},
'trackingConfig': {
'autotrack': 'REQUIRED'|'PREFERRED'|'REMOVED'
},
'dataflowEndpointConfig': {
'dataflowEndpointName': 'string',
'dataflowEndpointRegion': 'string'
},
'antennaDownlinkDemodDecodeConfig': {
'spectrumConfig': {
'centerFrequency': {
'value': 123.0,
'units': 'GHz'|'MHz'|'kHz'
},
'bandwidth': {
'value': 123.0,
'units': 'GHz'|'MHz'|'kHz'
},
'polarization': 'RIGHT_HAND'|'LEFT_HAND'|'NONE'
},
'demodulationConfig': {
'unvalidatedJSON': 'string'
},
'decodeConfig': {
'unvalidatedJSON': 'string'
}
},
'antennaUplinkConfig': {
'transmitDisabled': True|False,
'spectrumConfig': {
'centerFrequency': {
'value': 123.0,
'units': 'GHz'|'MHz'|'kHz'
},
'polarization': 'RIGHT_HAND'|'LEFT_HAND'|'NONE'
},
'targetEirp': {
'value': 123.0,
'units': 'dBW'
}
},
'uplinkEchoConfig': {
'enabled': True|False,
'antennaUplinkConfigArn': 'string'
},
's3RecordingConfig': {
'bucketArn': 'string',
'roleArn': 'string',
'prefix': 'string'
},
'telemetrySinkConfig': {
'telemetrySinkType': 'KINESIS_DATA_STREAM',
'telemetrySinkData': {
'kinesisDataStreamData': {
'kinesisRoleArn': 'string',
'kinesisDataStreamArn': 'string'
}
}
}
}
)
string
[REQUIRED]
UUID of a Config.
string
[REQUIRED]
Name of a Config.
string
[REQUIRED]
Type of a Config.
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.
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.
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.
units (string) -- [REQUIRED]
Frequency units.
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.
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.
units (string) -- [REQUIRED]
Frequency bandwidth units.
polarization (string) --
Polarization of a spectral Config. Capturing both "RIGHT_HAND" and "LEFT_HAND" polarization requires two separate configs.
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.
dataflowEndpointConfig (dict) --
Information about the dataflow endpoint Config.
dataflowEndpointName (string) -- [REQUIRED]
Name of a dataflow endpoint.
dataflowEndpointRegion (string) --
Region of a dataflow endpoint.
antennaDownlinkDemodDecodeConfig (dict) --
Information about how AWS Ground Station should configure an antenna for downlink demod decode during a contact.
spectrumConfig (dict) -- [REQUIRED]
Information about the spectral Config.
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.
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.
units (string) -- [REQUIRED]
Frequency units.
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.
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.
units (string) -- [REQUIRED]
Frequency bandwidth units.
polarization (string) --
Polarization of a spectral Config. Capturing both "RIGHT_HAND" and "LEFT_HAND" polarization requires two separate configs.
demodulationConfig (dict) -- [REQUIRED]
Information about the demodulation Config.
unvalidatedJSON (string) -- [REQUIRED]
Unvalidated JSON of a demodulation Config.
decodeConfig (dict) -- [REQUIRED]
Information about the decode Config.
unvalidatedJSON (string) -- [REQUIRED]
Unvalidated JSON of a decode Config.
antennaUplinkConfig (dict) --
Information about how AWS Ground Station should configure an antenna for uplink during a contact.
transmitDisabled (boolean) --
Whether or not uplink transmit is disabled.
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.
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.
units (string) -- [REQUIRED]
Frequency units.
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.
value (float) -- [REQUIRED]
Value of an EIRP. Valid values are between 20.0 to 50.0 dBW.
units (string) -- [REQUIRED]
Units of an EIRP.
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.
enabled (boolean) -- [REQUIRED]
Whether or not an uplink Config is enabled.
antennaUplinkConfigArn (string) -- [REQUIRED]
ARN of an uplink Config.
s3RecordingConfig (dict) --
Information about an S3 recording Config.
bucketArn (string) -- [REQUIRED]
ARN of the bucket to record to.
roleArn (string) -- [REQUIRED]
ARN of the role Ground Station assumes to write data to the bucket.
prefix (string) --
S3 Key prefix to prefice data files.
telemetrySinkConfig (dict) --
Information about a telemetry sink Config.
telemetrySinkType (string) -- [REQUIRED]
The type of telemetry sink.
telemetrySinkData (dict) -- [REQUIRED]
Information about the telemetry sink specified by the telemetrySinkType.
kinesisDataStreamData (dict) --
Information about a telemetry sink of type KINESIS_DATA_STREAM.
kinesisRoleArn (string) -- [REQUIRED]
ARN of the IAM Role used by AWS Ground Station to deliver telemetry.
kinesisDataStreamArn (string) -- [REQUIRED]
ARN of the Kinesis Data Stream to deliver telemetry to.
dict
Response Syntax
{
'configId': 'string',
'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'tracking'|'dataflow-endpoint'|'antenna-uplink'|'uplink-echo'|'s3-recording'|'telemetry-sink',
'configArn': 'string'
}
Response Structure
(dict) --
configId (string) --
UUID of a Config.
configType (string) --
Type of a Config.
configArn (string) --
ARN of a Config.
{'telemetrySinkConfigArn': 'string'}
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
client.update_mission_profile(
missionProfileId='string',
name='string',
contactPrePassDurationSeconds=123,
contactPostPassDurationSeconds=123,
minimumViableContactDurationSeconds=123,
dataflowEdges=[
[
'string',
],
],
trackingConfigArn='string',
telemetrySinkConfigArn='string',
streamsKmsKey={
'kmsKeyArn': 'string',
'kmsAliasArn': 'string',
'kmsAliasName': 'string'
},
streamsKmsRole='string'
)
string
[REQUIRED]
UUID of a mission profile.
string
Name of a mission profile.
integer
Amount of time after a contact ends that you’d like to receive a Ground Station Contact State Change event indicating the pass has finished.
integer
Amount of time after a contact ends that you’d like to receive a Ground Station Contact State Change event indicating the pass has finished.
integer
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.
list
A list of lists of ARNs. Each list of ARNs is an edge, with a from Config and a to Config.
(list) --
(string) --
string
ARN of a tracking Config.
string
ARN of a telemetry sink Config.
dict
KMS key to use for encrypting streams.
kmsKeyArn (string) --
KMS Key Arn.
kmsAliasArn (string) --
KMS Alias Arn.
kmsAliasName (string) --
KMS Alias Name.
string
Role to use for encrypting streams with KMS key.
dict
Response Syntax
{
'missionProfileId': 'string'
}
Response Structure
(dict) --
missionProfileId (string) --
UUID of a mission profile.