GroundStation / Paginator / ListAntennas

ListAntennas

class GroundStation.Paginator.ListAntennas

paginator = client.get_paginator('list_antennas')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• groundStationId (string) –

  [REQUIRED]

  ID of a ground station.

• 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

{
    'antennaList': [
        {
            'groundStationName': 'string',
            'antennaName': 'string',
            'region': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • antennaList (list) –

    List of antennas.

    • (dict) –

      An antenna at a ground station.

      • groundStationName (string) –

        Name of the ground station the antenna is associated with.

      • antennaName (string) –

        Name of the antenna.

      • region (string) –

        Region of the antenna.

  • NextToken (string) –

    A token to resume pagination.