GroundStation / Client / get_dataflow_endpoint_group
get_dataflow_endpoint_group#
- GroundStation.Client.get_dataflow_endpoint_group(**kwargs)#
Returns the dataflow endpoint group.
See also: AWS API Documentation
Request Syntax
response = client.get_dataflow_endpoint_group( dataflowEndpointGroupId='string' )
- Parameters:
dataflowEndpointGroupId (string) –
[REQUIRED]
UUID of a dataflow endpoint group.
- Return type:
dict
- Returns:
Response Syntax
{ 'contactPostPassDurationSeconds': 123, 'contactPrePassDurationSeconds': 123, 'dataflowEndpointGroupArn': 'string', 'dataflowEndpointGroupId': 'string', 'endpointsDetails': [ { 'awsGroundStationAgentEndpoint': { 'agentStatus': 'SUCCESS'|'FAILED'|'ACTIVE'|'INACTIVE', 'auditResults': 'HEALTHY'|'UNHEALTHY', 'egressAddress': { 'mtu': 123, 'socketAddress': { 'name': 'string', 'port': 123 } }, 'ingressAddress': { 'mtu': 123, 'socketAddress': { 'name': 'string', 'portRange': { 'maximum': 123, 'minimum': 123 } } }, 'name': 'string' }, 'endpoint': { 'address': { 'name': 'string', 'port': 123 }, 'mtu': 123, 'name': 'string', 'status': 'created'|'creating'|'deleted'|'deleting'|'failed' }, 'healthReasons': [ 'NO_REGISTERED_AGENT'|'INVALID_IP_OWNERSHIP'|'NOT_AUTHORIZED_TO_CREATE_SLR'|'UNVERIFIED_IP_OWNERSHIP'|'INITIALIZING_DATAPLANE'|'DATAPLANE_FAILURE'|'HEALTHY', ], 'healthStatus': 'UNHEALTHY'|'HEALTHY', 'securityDetails': { 'roleArn': 'string', 'securityGroupIds': [ 'string', ], 'subnetIds': [ 'string', ] } }, ], 'tags': { 'string': 'string' } }
Response Structure
(dict) –
contactPostPassDurationSeconds (integer) –
Amount of time, in seconds, after a contact ends that the Ground Station Dataflow Endpoint Group will be in a
POSTPASS
state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits thePOSTPASS
state.contactPrePassDurationSeconds (integer) –
Amount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a
PREPASS
state. A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits thePREPASS
state.dataflowEndpointGroupArn (string) –
ARN of a dataflow endpoint group.
dataflowEndpointGroupId (string) –
UUID of a dataflow endpoint group.
endpointsDetails (list) –
Details of a dataflow endpoint.
(dict) –
Information about the endpoint details.
awsGroundStationAgentEndpoint (dict) –
An agent endpoint.
agentStatus (string) –
The status of AgentEndpoint.
auditResults (string) –
The results of the audit.
egressAddress (dict) –
The egress address of AgentEndpoint.
mtu (integer) –
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
socketAddress (dict) –
A socket address.
name (string) –
Name of a socket address.
port (integer) –
Port of a socket address.
ingressAddress (dict) –
The ingress address of AgentEndpoint.
mtu (integer) –
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
socketAddress (dict) –
A ranged socket address.
name (string) –
IPv4 socket address.
portRange (dict) –
Port range of a socket address.
maximum (integer) –
A maximum value.
minimum (integer) –
A minimum value.
name (string) –
Name string associated with AgentEndpoint. Used as a human-readable identifier for AgentEndpoint.
endpoint (dict) –
A dataflow endpoint.
address (dict) –
Socket address of a dataflow endpoint.
name (string) –
Name of a socket address.
port (integer) –
Port of a socket address.
mtu (integer) –
Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
name (string) –
Name of a dataflow endpoint.
status (string) –
Status of a dataflow endpoint.
healthReasons (list) –
Health reasons for a dataflow endpoint. This field is ignored when calling
CreateDataflowEndpointGroup
.(string) –
healthStatus (string) –
A dataflow endpoint health status. This field is ignored when calling
CreateDataflowEndpointGroup
.securityDetails (dict) –
Endpoint security details including a list of subnets, a list of security groups and a role to connect streams to instances.
roleArn (string) –
ARN to a role needed for connecting streams to your instances.
securityGroupIds (list) –
The security groups to attach to the elastic network interfaces.
(string) –
subnetIds (list) –
A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.
(string) –
tags (dict) –
Tags assigned to a dataflow endpoint group.
(string) –
(string) –
Exceptions
GroundStation.Client.exceptions.InvalidParameterException
GroundStation.Client.exceptions.DependencyException
GroundStation.Client.exceptions.ResourceNotFoundException