GlobalAccelerator / Paginator / ListCustomRoutingListeners

ListCustomRoutingListeners#

class GlobalAccelerator.Paginator.ListCustomRoutingListeners#
paginator = client.get_paginator('list_custom_routing_listeners')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AcceleratorArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • AcceleratorArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the accelerator to list listeners 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

{
    'Listeners': [
        {
            'ListenerArn': 'string',
            'PortRanges': [
                {
                    'FromPort': 123,
                    'ToPort': 123
                },
            ]
        },
    ],

}

Response Structure

  • (dict) –

    • Listeners (list) –

      The list of listeners for a custom routing accelerator.

      • (dict) –

        A complex type for a listener for a custom routing accelerator.

        • ListenerArn (string) –

          The Amazon Resource Name (ARN) of the listener.

        • PortRanges (list) –

          The port range to support for connections from clients to your accelerator.

          Separately, you set port ranges for endpoints. For more information, see About endpoints for custom routing accelerators.

          • (dict) –

            A complex type for a range of ports for a listener.

            • FromPort (integer) –

              The first port in the range of ports, inclusive.

            • ToPort (integer) –

              The last port in the range of ports, inclusive.