GroundStation / Client / describe_ephemeris

describe_ephemeris

GroundStation.Client.describe_ephemeris(**kwargs)

Retrieve information about 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

{
    'ephemerisId': 'string',
    'satelliteId': 'string',
    'status': 'VALIDATING'|'INVALID'|'ERROR'|'ENABLED'|'DISABLED'|'EXPIRED',
    'priority': 123,
    'creationTime': datetime(2015, 1, 1),
    'enabled': True|False,
    'name': 'string',
    'tags': {
        'string': 'string'
    },
    'suppliedData': {
        'tle': {
            'sourceS3Object': {
                'bucket': 'string',
                'key': 'string',
                'version': 'string'
            },
            'ephemerisData': 'string'
        },
        'oem': {
            'sourceS3Object': {
                'bucket': 'string',
                'key': 'string',
                'version': 'string'
            },
            'ephemerisData': 'string'
        },
        'azEl': {
            'sourceS3Object': {
                'bucket': 'string',
                'key': 'string',
                'version': 'string'
            },
            'ephemerisData': 'string'
        }
    },
    'invalidReason': 'METADATA_INVALID'|'TIME_RANGE_INVALID'|'TRAJECTORY_INVALID'|'KMS_KEY_INVALID'|'VALIDATION_ERROR',
    'errorReasons': [
        {
            'errorCode': 'INTERNAL_ERROR'|'MISMATCHED_SATCAT_ID'|'OEM_VERSION_UNSUPPORTED'|'ORIGINATOR_MISSING'|'CREATION_DATE_MISSING'|'OBJECT_NAME_MISSING'|'OBJECT_ID_MISSING'|'REF_FRAME_UNSUPPORTED'|'REF_FRAME_EPOCH_UNSUPPORTED'|'TIME_SYSTEM_UNSUPPORTED'|'CENTER_BODY_UNSUPPORTED'|'INTERPOLATION_MISSING'|'INTERPOLATION_DEGREE_INVALID'|'AZ_EL_SEGMENT_LIST_MISSING'|'INSUFFICIENT_TIME_AZ_EL'|'START_TIME_IN_FUTURE'|'END_TIME_IN_PAST'|'EXPIRATION_TIME_TOO_EARLY'|'START_TIME_METADATA_TOO_EARLY'|'STOP_TIME_METADATA_TOO_LATE'|'AZ_EL_SEGMENT_END_TIME_BEFORE_START_TIME'|'AZ_EL_SEGMENT_TIMES_OVERLAP'|'AZ_EL_SEGMENTS_OUT_OF_ORDER'|'TIME_AZ_EL_ITEMS_OUT_OF_ORDER'|'MEAN_MOTION_INVALID'|'TIME_AZ_EL_AZ_RADIAN_RANGE_INVALID'|'TIME_AZ_EL_EL_RADIAN_RANGE_INVALID'|'TIME_AZ_EL_AZ_DEGREE_RANGE_INVALID'|'TIME_AZ_EL_EL_DEGREE_RANGE_INVALID'|'TIME_AZ_EL_ANGLE_UNITS_INVALID'|'INSUFFICIENT_KMS_PERMISSIONS'|'FILE_FORMAT_INVALID'|'AZ_EL_SEGMENT_REFERENCE_EPOCH_INVALID'|'AZ_EL_SEGMENT_START_TIME_INVALID'|'AZ_EL_SEGMENT_END_TIME_INVALID'|'AZ_EL_SEGMENT_VALID_TIME_RANGE_INVALID'|'AZ_EL_SEGMENT_END_TIME_TOO_LATE'|'AZ_EL_TOTAL_DURATION_EXCEEDED',
            'errorMessage': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • ephemerisId (string) –

      The AWS Ground Station ephemeris ID.

    • satelliteId (string) –

      The AWS Ground Station satellite ID associated with ephemeris.

    • status (string) –

      The status of the ephemeris.

    • priority (integer) –

      A priority score that determines which ephemeris to use when multiple ephemerides overlap.

      Higher numbers take precedence. The default is 1. Must be 1 or greater.

    • creationTime (datetime) –

      The time the ephemeris was uploaded in UTC.

    • enabled (boolean) –

      Whether or not the ephemeris is enabled.

    • name (string) –

      A name that you can use to identify the ephemeris.

    • tags (dict) –

      Tags assigned to an ephemeris.

      • (string) –

        • (string) –

    • suppliedData (dict) –

      Supplied ephemeris data.

      Note

      This is a Tagged Union structure. Only one of the following top level keys will be set: tle, oem, azEl. 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'}

      • tle (dict) –

        Description of ephemeris.

        • sourceS3Object (dict) –

          Source Amazon 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 Amazon S3 objects, the version to use for the ephemeris.

        • ephemerisData (string) –

          Supplied ephemeris data.

      • oem (dict) –

        Description of ephemeris.

        • sourceS3Object (dict) –

          Source Amazon 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 Amazon S3 objects, the version to use for the ephemeris.

        • ephemerisData (string) –

          Supplied ephemeris data.

      • azEl (dict) –

        Description of ephemeris.

        • sourceS3Object (dict) –

          Source Amazon 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 Amazon S3 objects, the version to use for the ephemeris.

        • ephemerisData (string) –

          Supplied ephemeris data.

    • invalidReason (string) –

      Reason that an ephemeris failed validation. Appears only when the status is INVALID.

    • errorReasons (list) –

      Detailed error information for ephemerides with INVALID status.

      Provides specific error codes and messages to help diagnose validation failures.

      • (dict) –

        Detailed error information for ephemeris validation failures.

        Provides an error code and descriptive message to help diagnose and resolve validation issues.

        • errorCode (string) –

          The error code identifying the type of validation failure.

          See the Troubleshooting Invalid Ephemerides guide for error code details.

        • errorMessage (string) –

          A human-readable message describing the validation failure.

          Provides specific details about what failed and may include suggestions for remediation.

Exceptions