describe_ephemeris

GroundStation.Client.describe_ephemeris(**kwargs)

Describes an existing ephemeris.

See also: AWS API Documentation

Request Syntax

response = client.describe_ephemeris(
    ephemerisId='string'
)

Parameters

ephemerisId (string) --

[REQUIRED]

The AWS Ground Station ephemeris ID.

Return type

dict

Returns

Response Syntax

{
    'creationTime': datetime(2015, 1, 1),
    'enabled': True|False,
    'ephemerisId': 'string',
    'invalidReason': 'METADATA_INVALID'|'TIME_RANGE_INVALID'|'TRAJECTORY_INVALID'|'KMS_KEY_INVALID'|'VALIDATION_ERROR',
    'name': 'string',
    'priority': 123,
    'satelliteId': 'string',
    'status': 'VALIDATING'|'INVALID'|'ERROR'|'ENABLED'|'DISABLED'|'EXPIRED',
    'suppliedData': {
        'oem': {
            'ephemerisData': 'string',
            'sourceS3Object': {
                'bucket': 'string',
                'key': 'string',
                'version': 'string'
            }
        },
        'tle': {
            'ephemerisData': 'string',
            'sourceS3Object': {
                'bucket': 'string',
                'key': 'string',
                'version': 'string'
            }
        }
    },
    'tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) --
  • 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.

  • invalidReason (string) --

    Reason that an ephemeris failed validation. Only provided for ephemerides with INVALID status.

  • 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

  • satelliteId (string) --

    The AWS Ground Station satellite ID associated with ephemeris.

  • status (string) --

    The status of the ephemeris.

  • suppliedData (dict) --

    Supplied ephemeris data.

    Note

    This is a Tagged Union structure. Only one of the following top level keys will be set: oem, tle. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

    'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
    

    • oem (dict) --

      Description of ephemeris.

      • ephemerisData (string) --

        Supplied ephemeris data.

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

    • tle (dict) --

      Description of ephemeris.

      • ephemerisData (string) --

        Supplied ephemeris data.

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

  • tags (dict) --

    Tags assigned to an ephemeris.

    • (string) --
      • (string) --

Exceptions

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