GroundStation / Client / list_configs

list_configs¶

GroundStation.Client.list_configs(**kwargs)¶

Returns a list of Config objects.

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

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

Response Structure

(dict) –
- nextToken (string) –
  
  Next token returned in the response of a previous ListConfigs call. Used to get the next page of results.
- configList (list) –
  
  List of Config items.
  - (dict) –
    
    An item in a list of Config objects.
    - configId (string) –
      
      UUID of a Config.
    - configType (string) –
      
      Type of a Config.
    - configArn (string) –
      
      ARN of a Config.
    - name (string) –
      
      Name of a Config.

Exceptions

GroundStation.Client.exceptions.InvalidParameterException
GroundStation.Client.exceptions.DependencyException
GroundStation.Client.exceptions.ResourceNotFoundException