AWS API Changes

2020/02/05 - AWS Ground Station - 8 updated api methods

Changes Adds dataflowEndpointRegion property to DataflowEndpointConfig. The dateCreated, lastUpdated, and tags properties on GetSatellite have been deprecated.

CreateConfig (updated)

Link ¶
Changes (request)

{'configData': {'dataflowEndpointConfig': {'dataflowEndpointRegion': 'string'}}}

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
            }
        },
        'dataflowEndpointConfig': {
            'dataflowEndpointName': 'string',
            'dataflowEndpointRegion': 'string'
        },
        'trackingConfig': {
            'autotrack': 'PREFERRED'|'REMOVED'|'REQUIRED'
        },
        'uplinkEchoConfig': {
            'antennaUplinkConfigArn': 'string',
            'enabled': True|False
        }
    },
    name='string',
    tags={
        'string': 'string'
    }
)

type configData

dict

param configData

[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 .
    - units (string) -- [REQUIRED]
      
      Frequency bandwidth units.
    - value (float) -- [REQUIRED]
      
      Frequency bandwidth value.
  - centerFrequency (dict) -- [REQUIRED]
    
    Center frequency of a spectral Config .
    - units (string) -- [REQUIRED]
      
      Frequency units.
    - value (float) -- [REQUIRED]
      
      Frequency value.
  - polarization (string) --
    
    Polarization of a spectral Config .
antennaDownlinkDemodDecodeConfig (dict) --

Information about how AWS Ground Station should conﬁgure 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 .
    - units (string) -- [REQUIRED]
      
      Frequency bandwidth units.
    - value (float) -- [REQUIRED]
      
      Frequency bandwidth value.
  - centerFrequency (dict) -- [REQUIRED]
    
    Center frequency of a spectral Config .
    - units (string) -- [REQUIRED]
      
      Frequency units.
    - value (float) -- [REQUIRED]
      
      Frequency value.
  - polarization (string) --
    
    Polarization of a spectral Config .
antennaUplinkConfig (dict) --

Information about how AWS Ground Station should conﬁgure 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 .
    - units (string) -- [REQUIRED]
      
      Frequency units.
    - value (float) -- [REQUIRED]
      
      Frequency value.
  - polarization (string) --
    
    Polarization of an uplink spectral Config .
- targetEirp (dict) -- [REQUIRED]
  
  EIRP of the target.
  - units (string) -- [REQUIRED]
    
    Units of an EIRP.
  - value (float) -- [REQUIRED]
    
    Value of an EIRP.
dataflowEndpointConfig (dict) --

Information about the dataflow endpoint Config .
- dataflowEndpointName (string) -- [REQUIRED]
  
  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) -- [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.

type name

string

param name

[REQUIRED]

Name of a Config .

type tags

dict

param tags

Tags assigned to a Config .

(string) --
- (string) --

rtype

dict

returns

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 .

DescribeContact (updated)

Link ¶
Changes (response)

{'contactStatus': {'CANCELLING'}, 'region': 'string'}

Describes an existing contact.

See also: AWS API Documentation

Request Syntax

client.describe_contact(
    contactId='string'
)

type contactId

string

param contactId

[REQUIRED]

UUID of a contact.

rtype

dict

returns

Response Syntax

{
    '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'
    }
}

Response Structure

(dict) --
- contactId (string) --
  
  UUID of a contact.
- contactStatus (string) --
  
  Status of a contact.
- 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) --

GetConfig (updated)

Link ¶
Changes (response)

{'configData': {'dataflowEndpointConfig': {'dataflowEndpointRegion': 'string'}}}

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'
)

type configId

string

param configId

[REQUIRED]

UUID of a Config .

type configType

string

param configType

[REQUIRED]

Type of a Config .

rtype

dict

returns

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
            }
        },
        '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 .
        
        units (string) --
        
        Frequency bandwidth units.
        
        value (float) --
        
        Frequency bandwidth value.
      - centerFrequency (dict) --
        
        Center frequency of a spectral Config .
        
        units (string) --
        
        Frequency units.
        
        value (float) --
        
        Frequency value.
      - polarization (string) --
        
        Polarization of a spectral Config .
  - antennaDownlinkDemodDecodeConfig (dict) --
    
    Information about how AWS Ground Station should conﬁgure 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 .
        
        units (string) --
        
        Frequency bandwidth units.
        
        value (float) --
        
        Frequency bandwidth value.
      - centerFrequency (dict) --
        
        Center frequency of a spectral Config .
        
        units (string) --
        
        Frequency units.
        
        value (float) --
        
        Frequency value.
      - polarization (string) --
        
        Polarization of a spectral Config .
  - antennaUplinkConfig (dict) --
    
    Information about how AWS Ground Station should conﬁgure an antenna for uplink during a contact.
    - spectrumConfig (dict) --
      
      Information about the uplink spectral Config .
      - centerFrequency (dict) --
        
        Center frequency of an uplink spectral Config .
        
        units (string) --
        
        Frequency units.
        
        value (float) --
        
        Frequency value.
      - polarization (string) --
        
        Polarization of an uplink spectral Config .
    - targetEirp (dict) --
      
      EIRP of the target.
      - units (string) --
        
        Units of an EIRP.
      - value (float) --
        
        Value of an EIRP.
  - 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 .
  - (string) --
    - (string) --

GetSatellite (updated)

Link ¶
Changes (response)

{'groundStations': ['string']}

Returns a satellite.

See also: AWS API Documentation

Request Syntax

client.get_satellite(
    satelliteId='string'
)

type satelliteId

string

param satelliteId

[REQUIRED]

UUID of a satellite.

rtype

dict

returns

Response Syntax

{
    'groundStations': [
        'string',
    ],
    'noradSatelliteID': 123,
    'satelliteArn': 'string',
    'satelliteId': 'string'
}

Response Structure

(dict) --
- groundStations (list) --
  
  A list of ground stations to which the satellite is on-boarded.
  - (string) --
- noradSatelliteID (integer) --
  
  NORAD satellite ID number.
- satelliteArn (string) --
  
  ARN of a satellite.
- satelliteId (string) --
  
  UUID of a satellite.

ListContacts (updated)

Link ¶
Changes (request, response)
Request

{'statusList': {'CANCELLING'}}

Response

{'contactList': {'contactStatus': {'CANCELLING'}, 'region': 'string'}}

Returns a list of contacts.

If statusList contains AVAILABLE, the request must include groundStation , missionprofileArn , and satelliteArn .

See also: AWS API Documentation

Request Syntax

client.list_contacts(
    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',
    ]
)

type endTime

datetime

param endTime

[REQUIRED]

End time of a contact.

type groundStation

string

param groundStation

Name of a ground station.

type maxResults

integer

param maxResults

Maximum number of contacts returned.

type missionProfileArn

string

param missionProfileArn

ARN of a mission profile.

type nextToken

string

param nextToken

Next token returned in the request of a previous ListContacts call. Used to get the next page of results.

type satelliteArn

string

param satelliteArn

ARN of a satellite.

type startTime

datetime

param startTime

[REQUIRED]

Start time of a contact.

type statusList

list

param statusList

[REQUIRED]

Status of a contact reservation.

(string) --

rtype

dict

returns

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.
      - (string) --
        
        (string) --
- nextToken (string) --
  
  Next token returned in the response of a previous ListContacts call. Used to get the next page of results.

ListGroundStations (updated)

Link ¶
Changes (request)

{'satelliteId': 'string'}

Returns a list of ground stations.

See also: AWS API Documentation

Request Syntax

client.list_ground_stations(
    maxResults=123,
    nextToken='string',
    satelliteId='string'
)

type maxResults

integer

param maxResults

Maximum number of ground stations returned.

type nextToken

string

param nextToken

Next token that can be supplied in the next call to get the next page of ground stations.

type satelliteId

string

param satelliteId

Satellite ID to retrieve on-boarded ground stations.

rtype

dict

returns

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.

ListSatellites (updated)

Link ¶
Changes (response)

{'satellites': {'groundStations': ['string']}}

Returns a list of satellites.

See also: AWS API Documentation

Request Syntax

client.list_satellites(
    maxResults=123,
    nextToken='string'
)

type maxResults

integer

param maxResults

Maximum number of satellites returned.

type nextToken

string

param nextToken

Next token that can be supplied in the next call to get the next page of satellites.

rtype

dict

returns

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.
      - (string) --
    - noradSatelliteID (integer) --
      
      NORAD satellite ID number.
    - satelliteArn (string) --
      
      ARN of a satellite.
    - satelliteId (string) --
      
      UUID of a satellite.

UpdateConfig (updated)

Link ¶
Changes (request)

{'configData': {'dataflowEndpointConfig': {'dataflowEndpointRegion': 'string'}}}

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
            }
        },
        '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'
)

type configData

dict

param configData

[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 .
    - units (string) -- [REQUIRED]
      
      Frequency bandwidth units.
    - value (float) -- [REQUIRED]
      
      Frequency bandwidth value.
  - centerFrequency (dict) -- [REQUIRED]
    
    Center frequency of a spectral Config .
    - units (string) -- [REQUIRED]
      
      Frequency units.
    - value (float) -- [REQUIRED]
      
      Frequency value.
  - polarization (string) --
    
    Polarization of a spectral Config .
antennaDownlinkDemodDecodeConfig (dict) --

Information about how AWS Ground Station should conﬁgure 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 .
    - units (string) -- [REQUIRED]
      
      Frequency bandwidth units.
    - value (float) -- [REQUIRED]
      
      Frequency bandwidth value.
  - centerFrequency (dict) -- [REQUIRED]
    
    Center frequency of a spectral Config .
    - units (string) -- [REQUIRED]
      
      Frequency units.
    - value (float) -- [REQUIRED]
      
      Frequency value.
  - polarization (string) --
    
    Polarization of a spectral Config .
antennaUplinkConfig (dict) --

Information about how AWS Ground Station should conﬁgure 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 .
    - units (string) -- [REQUIRED]
      
      Frequency units.
    - value (float) -- [REQUIRED]
      
      Frequency value.
  - polarization (string) --
    
    Polarization of an uplink spectral Config .
- targetEirp (dict) -- [REQUIRED]
  
  EIRP of the target.
  - units (string) -- [REQUIRED]
    
    Units of an EIRP.
  - value (float) -- [REQUIRED]
    
    Value of an EIRP.
dataflowEndpointConfig (dict) --

Information about the dataflow endpoint Config .
- dataflowEndpointName (string) -- [REQUIRED]
  
  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) -- [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.

type configId

string

param configId

[REQUIRED]

UUID of a Config .

type configType

string

param configType

[REQUIRED]

Type of a Config .

type name

string

param name

[REQUIRED]

Name of a Config .

rtype

dict

returns

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 .