GroundStation / Client / list_ephemerides

list_ephemerides#

GroundStation.Client.list_ephemerides(**kwargs)#

List existing ephemerides.

See also: AWS API Documentation

Request Syntax

response = client.list_ephemerides(
    endTime=datetime(2015, 1, 1),
    maxResults=123,
    nextToken='string',
    satelliteId='string',
    startTime=datetime(2015, 1, 1),
    statusList=[
        'VALIDATING'|'INVALID'|'ERROR'|'ENABLED'|'DISABLED'|'EXPIRED',
    ]
)
Parameters:

  • endTime (datetime) –

    [REQUIRED]

    The end time to list in UTC. The operation will return an ephemeris if its expiration time is within the time range defined by the startTime and endTime.

  • maxResults (integer) – Maximum number of ephemerides to return.

  • nextToken (string) – Pagination token.

  • satelliteId (string) –

    [REQUIRED]

    The AWS Ground Station satellite ID to list ephemeris for.

  • startTime (datetime) –

    [REQUIRED]

    The start time to list in UTC. The operation will return an ephemeris if its expiration time is within the time range defined by the startTime and endTime.

  • statusList (list) –

    The list of ephemeris status to return.

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'ephemerides': [
        {
            'creationTime': datetime(2015, 1, 1),
            'enabled': True|False,
            'ephemerisId': 'string',
            'name': 'string',
            'priority': 123,
            'sourceS3Object': {
                'bucket': 'string',
                'key': 'string',
                'version': 'string'
            },
            'status': 'VALIDATING'|'INVALID'|'ERROR'|'ENABLED'|'DISABLED'|'EXPIRED'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • ephemerides (list) –

      List of ephemerides.

      • (dict) –

        Ephemeris item.

        • creationTime (datetime) –

          The time the ephemeris was uploaded in UTC.

        • enabled (boolean) –

          Whether or not the ephemeris is enabled.

        • ephemerisId (string) –

          The AWS Ground Station ephemeris ID.

        • name (string) –

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

        • priority (integer) –

          Customer-provided priority score to establish the order in which overlapping ephemerides should be used.

          The default for customer-provided ephemeris priority is 1, and higher numbers take precedence.

          Priority must be 1 or greater

        • sourceS3Object (dict) –

          Source S3 object used for the ephemeris.

          • bucket (string) –

            An Amazon S3 Bucket name.

          • key (string) –

            An Amazon S3 key for the ephemeris.

          • version (string) –

            For versioned S3 objects, the version to use for the ephemeris.

        • status (string) –

          The status of the ephemeris.

    • nextToken (string) –

      Pagination token.

Exceptions

  • GroundStation.Client.exceptions.InvalidParameterException

  • GroundStation.Client.exceptions.DependencyException

  • GroundStation.Client.exceptions.ResourceNotFoundException