GlobalAccelerator / Client / describe_custom_routing_endpoint_group

describe_custom_routing_endpoint_group

GlobalAccelerator.Client.describe_custom_routing_endpoint_group(**kwargs)

Describe an endpoint group for a custom routing accelerator.

See also: AWS API Documentation

Request Syntax

response = client.describe_custom_routing_endpoint_group(
    EndpointGroupArn='string'
)
Parameters:

EndpointGroupArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the endpoint group to describe.

Return type:

dict

Returns:

Response Syntax

{
    'EndpointGroup': {
        'EndpointGroupArn': 'string',
        'EndpointGroupRegion': 'string',
        'DestinationDescriptions': [
            {
                'FromPort': 123,
                'ToPort': 123,
                'Protocols': [
                    'TCP'|'UDP',
                ]
            },
        ],
        'EndpointDescriptions': [
            {
                'EndpointId': 'string'
            },
        ]
    }
}

Response Structure

  • (dict) –

    • EndpointGroup (dict) –

      The description of an endpoint group for a custom routing accelerator.

      • EndpointGroupArn (string) –

        The Amazon Resource Name (ARN) of the endpoint group.

      • EndpointGroupRegion (string) –

        The Amazon Web Services Region where the endpoint group is located.

      • DestinationDescriptions (list) –

        For a custom routing accelerator, describes the port range and protocol for all endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.

        • (dict) –

          For a custom routing accelerator, describes the port range and protocol for all endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.

          • FromPort (integer) –

            The first port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.

          • ToPort (integer) –

            The last port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.

          • Protocols (list) –

            The protocol for the endpoint group that is associated with a custom routing accelerator. The protocol can be either TCP or UDP.

            • (string) –

      • EndpointDescriptions (list) –

        For a custom routing accelerator, describes the endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.

        • (dict) –

          A complex type for an endpoint for a custom routing accelerator. Each endpoint group can include one or more endpoints, which are virtual private cloud (VPC) subnets.

          • EndpointId (string) –

            An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.

Exceptions