GroundStation / Paginator / ListGroundStations

ListGroundStations

class GroundStation.Paginator.ListGroundStations

paginator = client.get_paginator('list_ground_stations')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

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

Parameters:

• satelliteId (string) – Satellite ID to retrieve on-boarded ground stations.

• 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

{
    'groundStationList': [
        {
            'groundStationId': 'string',
            'groundStationName': 'string',
            'region': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • groundStationList (list) –

    List of ground stations.

    • (dict) –

      Information about the ground station data.

      • groundStationId (string) –

        UUID of a ground station.

      • groundStationName (string) –

        Name of a ground station.

      • region (string) –

        Ground station Region.

  • NextToken (string) –

    A token to resume pagination.