GetConfig - AWS Ground Station
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

GetConfig

Returns Config information.

Only one Config response can be returned.

Request Syntax

GET /config/configType/configId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

configId

UUID of a Config.

Required: Yes

configType

Type of a Config.

Valid Values: antenna-downlink | antenna-downlink-demod-decode | antenna-uplink | dataflow-endpoint | tracking | uplink-echo | s3-recording

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "configArn": "string",
   "configData": { 
      "antennaDownlinkConfig": { 
         "spectrumConfig": { 
            "bandwidth": { 
               "units": "string",
               "value": number
            },
            "centerFrequency": { 
               "units": "string",
               "value": number
            },
            "polarization": "string"
         }
      },
      "antennaDownlinkDemodDecodeConfig": { 
         "decodeConfig": { 
            "unvalidatedJSON": "string"
         },
         "demodulationConfig": { 
            "unvalidatedJSON": "string"
         },
         "spectrumConfig": { 
            "bandwidth": { 
               "units": "string",
               "value": number
            },
            "centerFrequency": { 
               "units": "string",
               "value": number
            },
            "polarization": "string"
         }
      },
      "antennaUplinkConfig": { 
         "spectrumConfig": { 
            "centerFrequency": { 
               "units": "string",
               "value": number
            },
            "polarization": "string"
         },
         "targetEirp": { 
            "units": "string",
            "value": number
         },
         "transmitDisabled": boolean
      },
      "dataflowEndpointConfig": { 
         "dataflowEndpointName": "string",
         "dataflowEndpointRegion": "string"
      },
      "s3RecordingConfig": { 
         "bucketArn": "string",
         "prefix": "string",
         "roleArn": "string"
      },
      "trackingConfig": { 
         "autotrack": "string"
      },
      "uplinkEchoConfig": { 
         "antennaUplinkConfigArn": "string",
         "enabled": boolean
      }
   },
   "configId": "string",
   "configType": "string",
   "name": "string",
   "tags": { 
      "string" : "string" 
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

configArn

ARN of a Config

Type: String

configData

Data elements in a Config.

Type: ConfigTypeData object

configId

UUID of a Config.

Type: String

configType

Type of a Config.

Type: String

Valid Values: antenna-downlink | antenna-downlink-demod-decode | antenna-uplink | dataflow-endpoint | tracking | uplink-echo | s3-recording

name

Name of a Config.

Type: String

tags

Tags assigned to a Config.

Type: String to string map

Errors

For information about the errors that are common to all actions, see Common Errors.

DependencyException

Dependency encountered an error.

HTTP Status Code: 531

InvalidParameterException

One or more parameters are not valid.

HTTP Status Code: 431

ResourceNotFoundException

Resource was not found.

HTTP Status Code: 434

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: