GlobalAccelerator / Paginator / ListCustomRoutingEndpointGroups

ListCustomRoutingEndpointGroups

class GlobalAccelerator.Paginator.ListCustomRoutingEndpointGroups

paginator = client.get_paginator('list_custom_routing_endpoint_groups')

paginate(**kwargs)

Creates an iterator that will paginate through responses from GlobalAccelerator.Client.list_custom_routing_endpoint_groups().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ListenerArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• ListenerArn (string) –

  [REQUIRED]

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

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'EndpointGroups': [
        {
            'EndpointGroupArn': 'string',
            'EndpointGroupRegion': 'string',
            'DestinationDescriptions': [
                {
                    'FromPort': 123,
                    'ToPort': 123,
                    'Protocols': [
                        'TCP'|'UDP',
                    ]
                },
            ],
            'EndpointDescriptions': [
                {
                    'EndpointId': '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.