GroundStation / Paginator / ListSatellites

ListSatellites

class GroundStation.Paginator.ListSatellites

paginator = client.get_paginator('list_satellites')

paginate(**kwargs)

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

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

{
    'satellites': [
        {
            'currentEphemeris': {
                'ephemerisId': 'string',
                'epoch': datetime(2015, 1, 1),
                'name': 'string',
                'source': 'CUSTOMER_PROVIDED'|'SPACE_TRACK'
            },
            'groundStations': [
                'string',
            ],
            'noradSatelliteID': 123,
            'satelliteArn': 'string',
            'satelliteId': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • satellites (list) –

    List of satellites.

    • (dict) –

      Item in a list of satellites.

      • currentEphemeris (dict) –

        The current ephemeris being used to compute the trajectory of the satellite.

        • ephemerisId (string) –

          UUID of a customer-provided ephemeris.

          This field is not populated for default ephemerides from Space Track.

        • epoch (datetime) –

          The epoch of a default, ephemeris from Space Track in UTC.

          This field is not populated for customer-provided ephemerides.

        • name (string) –

          A name string associated with the ephemeris. Used as a human-readable identifier for the ephemeris.

          A name is only returned for customer-provider ephemerides that have a name associated.

        • source (string) –

          The EphemerisSource that generated a given ephemeris.

      • groundStations (list) –

        A list of ground stations to which the satellite is on-boarded.

        • (string) –

      • noradSatelliteID (integer) –

        NORAD satellite ID number.

      • satelliteArn (string) –

        ARN of a satellite.

      • satelliteId (string) –

        UUID of a satellite.

  • NextToken (string) –

    A token to resume pagination.