Skip to content

DescribeEphemerisResponse

Source code in docs_src/capo_groundstation/types/describe_ephemeris_response.py
class DescribeEphemerisResponse(TypedDict, closed=True):
    ephemeris_id: NotRequired["capo_groundstation.types.uuid.Uuid"]
    """<p>The AWS Ground Station ephemeris ID.</p>"""
    satellite_id: NotRequired["capo_groundstation.types.uuid.Uuid"]
    """<p>The AWS Ground Station satellite ID associated with ephemeris.</p>"""
    status: NotRequired["capo_groundstation.types.ephemeris_status.EphemerisStatus"]
    """<p>The status of the ephemeris.</p>"""
    priority: NotRequired[
        "capo_groundstation.types.ephemeris_priority.EphemerisPriority"
    ]
    """<p>A priority score that determines which ephemeris to use when multiple ephemerides overlap.</p> <p>Higher numbers take precedence. The default is 1. Must be 1 or greater.</p>"""
    creation_time: NotRequired["datetime.datetime"]
    """<p>The time the ephemeris was uploaded in UTC.</p>"""
    enabled: NotRequired["bool"]
    """<p>Whether or not the ephemeris is enabled.</p>"""
    name: NotRequired["capo_groundstation.types.safe_name.SafeName"]
    """<p>A name that you can use to identify the ephemeris.</p>"""
    tags: NotRequired["capo_groundstation.types.tags_map.TagsMap"]
    """<p>Tags assigned to an ephemeris.</p>"""
    supplied_data: NotRequired[
        "capo_groundstation.types.ephemeris_type_description.EphemerisTypeDescription"
    ]
    """<p>Supplied ephemeris data.</p>"""
    invalid_reason: NotRequired[
        "capo_groundstation.types.ephemeris_invalid_reason.EphemerisInvalidReason"
    ]
    """<p>Reason that an ephemeris failed validation. Appears only when the status is <code>INVALID</code>.</p>"""
    error_reasons: NotRequired[
        "capo_groundstation.types.ephemeris_error_reason_list.EphemerisErrorReasonList"
    ]
    """<p>Detailed error information for ephemerides with <code>INVALID</code> status.</p> <p>Provides specific error codes and messages to help diagnose validation failures.</p>"""

creation_time instance-attribute

creation_time: NotRequired[datetime]

The time the ephemeris was uploaded in UTC.

enabled instance-attribute

enabled: NotRequired[bool]

Whether or not the ephemeris is enabled.

ephemeris_id instance-attribute

ephemeris_id: NotRequired[Uuid]

The AWS Ground Station ephemeris ID.

error_reasons instance-attribute

error_reasons: NotRequired[EphemerisErrorReasonList]

Detailed error information for ephemerides with INVALID status.

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

invalid_reason instance-attribute

invalid_reason: NotRequired[EphemerisInvalidReason]

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

name instance-attribute

name: NotRequired[SafeName]

A name that you can use to identify the ephemeris.

priority instance-attribute

priority: NotRequired[EphemerisPriority]

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.

satellite_id instance-attribute

satellite_id: NotRequired[Uuid]

The AWS Ground Station satellite ID associated with ephemeris.

status instance-attribute

status: NotRequired[EphemerisStatus]

The status of the ephemeris.

supplied_data instance-attribute

supplied_data: NotRequired[EphemerisTypeDescription]

Supplied ephemeris data.

tags instance-attribute

tags: NotRequired[TagsMap]

Tags assigned to an ephemeris.