list_satellites

GroundStation.Client.list_satellites(**kwargs)

Returns a list of satellites.

See also: AWS API Documentation

Request Syntax

response = client.list_satellites(
    maxResults=123,
    nextToken='string'
)

Parameters

• maxResults (integer) -- Maximum number of satellites returned.
• nextToken (string) -- Next token that can be supplied in the next call to get the next page of satellites.

Return type

dict

Returns

Response Syntax

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

Response Structure

• (dict) --

  • nextToken (string) --

    Next token that can be supplied in the next call to get the next page of satellites.

  • 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.

Exceptions

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