Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

get_dataflow_endpoint_group

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'
            },
            'securityDetails': {
                'roleArn': 'string',
                'securityGroupIds': [
                    'string',
                ],
                'subnetIds': [
                    'string',
                ]
            }
        },
    ],
    'tags': {
        'string': 'string'
    }
}

Response Structure

  • (dict) --
    • contactPostPassDurationSeconds (integer) --

      Amount of time, in seconds, after a contact ends for the contact to remain in a POSTPASS state. A CloudWatch event is emitted when the contact enters and exits the POSTPASS state.

    • contactPrePassDurationSeconds (integer) --

      Amount of time, in seconds, prior to contact start for the contact to remain in a PREPASS state. A CloudWatch event is emitted when the contact enters and exits the PREPASS 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.

        • 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