GlobalAccelerator / Client / list_custom_routing_endpoint_groups

list_custom_routing_endpoint_groups#

GlobalAccelerator.Client.list_custom_routing_endpoint_groups(**kwargs)#

List the endpoint groups that are associated with a listener for a custom routing accelerator.

See also: AWS API Documentation

Request Syntax

response = client.list_custom_routing_endpoint_groups(
    ListenerArn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • ListenerArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the listener to list endpoint groups for.

  • MaxResults (integer) – The number of endpoint group objects that you want to return with this call. The default value is 10.

  • NextToken (string) – The token for the next set of results. You receive this token from a previous call.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • EndpointGroups (list) –

      The list of the endpoint groups associated with a listener for a custom routing accelerator.

      • (dict) –

        A complex type for the endpoint group for a custom routing accelerator. An Amazon Web Services Region can have only one endpoint group for a specific listener.

        • 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.

    • NextToken (string) –

      The token for the next set of results. You receive this token from a previous call.

Exceptions

  • GlobalAccelerator.Client.exceptions.ListenerNotFoundException

  • GlobalAccelerator.Client.exceptions.InvalidNextTokenException

  • GlobalAccelerator.Client.exceptions.InvalidArgumentException

  • GlobalAccelerator.Client.exceptions.InternalServiceErrorException