[ aws . groundstation ]

get-config

Description

Returns Config information.

Only one Config response can be returned.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-config
--config-id <value>
--config-type <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--config-id (string)

UUID of a Config .

--config-type (string)

Type of a Config .

Possible values:

  • antenna-downlink

  • antenna-downlink-demod-decode

  • antenna-uplink

  • dataflow-endpoint

  • tracking

  • uplink-echo

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

configArn -> (string)

ARN of a Config

configData -> (structure)

Data elements in a Config .

antennaDownlinkConfig -> (structure)

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

spectrumConfig -> (structure)

Object that describes a spectral Config .

bandwidth -> (structure)

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 -> (double)

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 -> (structure)

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 -> (double)

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 -> (structure)

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

decodeConfig -> (structure)

Information about the decode Config .

unvalidatedJSON -> (string)

Unvalidated JSON of a decode Config .

demodulationConfig -> (structure)

Information about the demodulation Config .

unvalidatedJSON -> (string)

Unvalidated JSON of a demodulation Config .

spectrumConfig -> (structure)

Information about the spectral Config .

bandwidth -> (structure)

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 -> (double)

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 -> (structure)

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 -> (double)

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 -> (structure)

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

spectrumConfig -> (structure)

Information about the uplink spectral Config .

centerFrequency -> (structure)

Center frequency of an uplink spectral Config . Valid values are between 2025 to 2120 MHz.

units -> (string)

Frequency units.

value -> (double)

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 -> (structure)

EIRP of the target.

units -> (string)

Units of an EIRP.

value -> (double)

Value of an EIRP. Valid values are between 20.0 to 50.0 dBW.

transmitDisabled -> (boolean)

Whether or not uplink transmit is disabled.

dataflowEndpointConfig -> (structure)

Information about the dataflow endpoint Config .

dataflowEndpointName -> (string)

Name of a dataflow endpoint.

dataflowEndpointRegion -> (string)

Region of a dataflow endpoint.

trackingConfig -> (structure)

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 -> (structure)

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 -> (map)

Tags assigned to a Config .

key -> (string)

value -> (string)