GroundStation / Paginator / ListConfigs

ListConfigs

class GroundStation.Paginator.ListConfigs

paginator = client.get_paginator('list_configs')

paginate(**kwargs)

Creates an iterator that will paginate through responses from GroundStation.Client.list_configs().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

• MaxItems (integer) –

  The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

• PageSize (integer) –

  The size of each page.

• StartingToken (string) –

  A token to specify where to start paginating. This is the NextToken from a previous response.

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

    A token to resume pagination.