Skip to content

EndpointDetails

Source code in docs_src/capo_groundstation/types/endpoint_details.py
class EndpointDetails(TypedDict, closed=True):
    security_details: NotRequired[
        "capo_groundstation.types.security_details.SecurityDetails"
    ]
    """<p>Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.</p>"""
    endpoint: NotRequired["capo_groundstation.types.dataflow_endpoint.DataflowEndpoint"]
    """<p>A dataflow endpoint.</p>"""
    aws_ground_station_agent_endpoint: NotRequired[
        "capo_groundstation.types.aws_ground_station_agent_endpoint.AwsGroundStationAgentEndpoint"
    ]
    """<p>An agent endpoint.</p>"""
    uplink_aws_ground_station_agent_endpoint: NotRequired[
        "capo_groundstation.types.uplink_aws_ground_station_agent_endpoint_details.UplinkAwsGroundStationAgentEndpointDetails"
    ]
    """<p>Definition for an uplink agent endpoint</p>"""
    downlink_aws_ground_station_agent_endpoint: NotRequired[
        "capo_groundstation.types.downlink_aws_ground_station_agent_endpoint_details.DownlinkAwsGroundStationAgentEndpointDetails"
    ]
    """<p>Definition for a downlink agent endpoint</p>"""
    health_status: NotRequired[
        "capo_groundstation.types.capability_health.CapabilityHealth"
    ]
    """<p>A dataflow endpoint health status. This field is ignored when calling <code>CreateDataflowEndpointGroup</code>.</p>"""
    health_reasons: NotRequired[
        "capo_groundstation.types.capability_health_reason_list.CapabilityHealthReasonList"
    ]
    """<p>Health reasons for a dataflow endpoint. This field is ignored when calling <code>CreateDataflowEndpointGroup</code>.</p>"""

aws_ground_station_agent_endpoint instance-attribute

aws_ground_station_agent_endpoint: NotRequired[AwsGroundStationAgentEndpoint]

An agent endpoint.

downlink_aws_ground_station_agent_endpoint: NotRequired[
    DownlinkAwsGroundStationAgentEndpointDetails
]

Definition for a downlink agent endpoint

endpoint instance-attribute

endpoint: NotRequired[DataflowEndpoint]

A dataflow endpoint.

health_reasons instance-attribute

health_reasons: NotRequired[CapabilityHealthReasonList]

Health reasons for a dataflow endpoint. This field is ignored when calling CreateDataflowEndpointGroup.

health_status instance-attribute

health_status: NotRequired[CapabilityHealth]

A dataflow endpoint health status. This field is ignored when calling CreateDataflowEndpointGroup.

security_details instance-attribute

security_details: NotRequired[SecurityDetails]

Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.

uplink_aws_ground_station_agent_endpoint: NotRequired[
    UplinkAwsGroundStationAgentEndpointDetails
]

Definition for an uplink agent endpoint