Skip to content

DescribeContactResponse

Source code in docs_src/capo_groundstation/types/describe_contact_response.py
class DescribeContactResponse(TypedDict, closed=True):
    contact_id: NotRequired["capo_groundstation.types.uuid.Uuid"]
    """<p>UUID of a contact.</p>"""
    mission_profile_arn: NotRequired[
        "capo_groundstation.types.mission_profile_arn.MissionProfileArn"
    ]
    """<p>ARN of a mission profile.</p>"""
    satellite_arn: NotRequired["capo_groundstation.types.satellite_arn.satelliteArn"]
    """<p>ARN of a satellite.</p>"""
    start_time: NotRequired["datetime.datetime"]
    """<p>Start time of a contact in UTC.</p>"""
    end_time: NotRequired["datetime.datetime"]
    """<p>End time of a contact in UTC.</p>"""
    pre_pass_start_time: NotRequired["datetime.datetime"]
    """<p>Start time in UTC of the pre-pass period, at which you receive a CloudWatch event indicating an upcoming pass.</p>"""
    post_pass_end_time: NotRequired["datetime.datetime"]
    """<p>End time in UTC of the post-pass period, at which you receive a CloudWatch event indicating the pass has finished.</p>"""
    ground_station: NotRequired["str"]
    """<p>Ground station for a contact.</p>"""
    contact_status: NotRequired["capo_groundstation.types.contact_status.ContactStatus"]
    """<p>Status of a contact.</p>"""
    error_message: NotRequired["str"]
    """<p>Error message for a contact.</p>"""
    maximum_elevation: NotRequired["capo_groundstation.types.elevation.Elevation"]
    """<p>Maximum elevation angle of a contact.</p>"""
    tags: NotRequired["capo_groundstation.types.tags_map.TagsMap"]
    """<p>Tags assigned to a contact.</p>"""
    region: NotRequired["str"]
    """<p>Region where the <code>ReserveContact</code> API was called to schedule this contact.</p>"""
    dataflow_list: NotRequired["capo_groundstation.types.dataflow_list.DataflowList"]
    """<p>List describing source and destination details for each dataflow edge.</p>"""
    visibility_start_time: NotRequired["datetime.datetime"]
    """<p> Projected time in UTC your satellite will rise above the <a href="https://docs.aws.amazon.com/ground-station/latest/ug/site-masks.html">receive mask</a>. This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts.</p>"""
    visibility_end_time: NotRequired["datetime.datetime"]
    """<p> Projected time in UTC your satellite will set below the <a href="https://docs.aws.amazon.com/ground-station/latest/ug/site-masks.html">receive mask</a>. This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts.</p>"""
    tracking_overrides: NotRequired[
        "capo_groundstation.types.tracking_overrides.TrackingOverrides"
    ]
    """<p>Tracking configuration overrides specified when the contact was reserved.</p>"""
    ephemeris: NotRequired[
        "capo_groundstation.types.ephemeris_response_data.EphemerisResponseData"
    ]
    """<p>The ephemeris that determines antenna pointing directions for the contact.</p>"""
    version: NotRequired["capo_groundstation.types.contact_version.ContactVersion"]
    """<p>Version information for a contact.</p>"""

contact_id instance-attribute

contact_id: NotRequired[Uuid]

UUID of a contact.

contact_status instance-attribute

contact_status: NotRequired[ContactStatus]

Status of a contact.

dataflow_list instance-attribute

dataflow_list: NotRequired[DataflowList]

List describing source and destination details for each dataflow edge.

end_time instance-attribute

end_time: NotRequired[datetime]

End time of a contact in UTC.

ephemeris instance-attribute

ephemeris: NotRequired[EphemerisResponseData]

The ephemeris that determines antenna pointing directions for the contact.

error_message instance-attribute

error_message: NotRequired[str]

Error message for a contact.

ground_station instance-attribute

ground_station: NotRequired[str]

Ground station for a contact.

maximum_elevation instance-attribute

maximum_elevation: NotRequired[Elevation]

Maximum elevation angle of a contact.

mission_profile_arn instance-attribute

mission_profile_arn: NotRequired[MissionProfileArn]

ARN of a mission profile.

post_pass_end_time instance-attribute

post_pass_end_time: NotRequired[datetime]

End time in UTC of the post-pass period, at which you receive a CloudWatch event indicating the pass has finished.

pre_pass_start_time instance-attribute

pre_pass_start_time: NotRequired[datetime]

Start time in UTC of the pre-pass period, at which you receive a CloudWatch event indicating an upcoming pass.

region instance-attribute

region: NotRequired[str]

Region where the ReserveContact API was called to schedule this contact.

satellite_arn instance-attribute

satellite_arn: NotRequired[satelliteArn]

ARN of a satellite.

start_time instance-attribute

start_time: NotRequired[datetime]

Start time of a contact in UTC.

tags instance-attribute

tags: NotRequired[TagsMap]

Tags assigned to a contact.

tracking_overrides instance-attribute

tracking_overrides: NotRequired[TrackingOverrides]

Tracking configuration overrides specified when the contact was reserved.

version instance-attribute

version: NotRequired[ContactVersion]

Version information for a contact.

visibility_end_time instance-attribute

visibility_end_time: NotRequired[datetime]

Projected time in UTC your satellite will set below the receive mask. This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts.

visibility_start_time instance-attribute

visibility_start_time: NotRequired[datetime]

Projected time in UTC your satellite will rise above the receive mask. This time is based on the satellite's current active ephemeris for future contacts and the ephemeris that was active during contact execution for completed contacts.