GroundStation / Client / get_config

get_config

GroundStation.Client.get_config(**kwargs)

Returns Config information.

Only one Config response can be returned.

See also: AWS API Documentation

Request Syntax

response = client.get_config(
    configId='string',
    configType='antenna-downlink'|'antenna-downlink-demod-decode'|'antenna-uplink'|'dataflow-endpoint'|'tracking'|'uplink-echo'|'s3-recording'
)

Parameters:

• configId (string) –

  [REQUIRED]

  UUID of a Config.

• configType (string) –

  [REQUIRED]

  Type of a Config.

Return type:

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
            },
            'transmitDisabled': True|False
        },
        'dataflowEndpointConfig': {
            'dataflowEndpointName': 'string',
            'dataflowEndpointRegion': 'string'
        },
        's3RecordingConfig': {
            'bucketArn': 'string',
            'prefix': 'string',
            'roleArn': 'string'
        },
        'trackingConfig': {
            'autotrack': 'PREFERRED'|'REMOVED'|'REQUIRED'
        },
        'uplinkEchoConfig': {
            'antennaUplinkConfigArn': 'string',
            'enabled': True|False
        }
    },
    'configId': 'string',
    'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'antenna-uplink'|'dataflow-endpoint'|'tracking'|'uplink-echo'|'s3-recording',
    'name': 'string',
    'tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) –

  • configArn (string) –

    ARN of a Config

  • configData (dict) –

    Data elements in a Config.

    Note

    This is a Tagged Union structure. Only one of the following top level keys will be set: antennaDownlinkConfig, antennaDownlinkDemodDecodeConfig, antennaUplinkConfig, dataflowEndpointConfig, s3RecordingConfig, trackingConfig, uplinkEchoConfig. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
    

    • antennaDownlinkConfig (dict) –

      Information about how AWS Ground Station should configure an antenna for downlink during a contact.

      • spectrumConfig (dict) –

        Object that describes a spectral Config.

        • bandwidth (dict) –

          Bandwidth of a spectral Config. AWS Ground Station currently has the following bandwidth limitations:

          • 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) –

Exceptions

• GroundStation.Client.exceptions.InvalidParameterException

• GroundStation.Client.exceptions.DependencyException

• GroundStation.Client.exceptions.ResourceNotFoundException