GroundStation / Client / list_configs

list_configs#

GroundStation.Client.list_configs(**kwargs)#

Returns a list of Config objects.

See also: AWS API Documentation

Request Syntax

response = client.list_configs(
    maxResults=123,
    nextToken='string'
)
Parameters:

  • maxResults (integer) – Maximum number of Configs returned.

  • nextToken (string) – Next token returned in the request of a previous ListConfigs call. Used to get the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'configList': [
        {
            'configArn': 'string',
            'configId': 'string',
            'configType': 'antenna-downlink'|'antenna-downlink-demod-decode'|'antenna-uplink'|'dataflow-endpoint'|'tracking'|'uplink-echo'|'s3-recording',
            'name': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • configList (list) –

      List of Config items.

      • (dict) –

        An item in a list of Config objects.

        • configArn (string) –

          ARN of a Config .

        • configId (string) –

          UUID of a Config .

        • configType (string) –

          Type of a Config .

        • name (string) –

          Name of a Config .

    • nextToken (string) –

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

Exceptions

  • GroundStation.Client.exceptions.InvalidParameterException

  • GroundStation.Client.exceptions.DependencyException

  • GroundStation.Client.exceptions.ResourceNotFoundException