GlobalAccelerator / Client / list_custom_routing_listeners

list_custom_routing_listeners#

GlobalAccelerator.Client.list_custom_routing_listeners(**kwargs)#

List the listeners for a custom routing accelerator.

See also: AWS API Documentation

Request Syntax

response = client.list_custom_routing_listeners(
    AcceleratorArn='string',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • AcceleratorArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the accelerator to list listeners for.

  • MaxResults (integer) – The number of listener 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

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

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.

    • NextToken (string) –

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

Exceptions

  • GlobalAccelerator.Client.exceptions.InvalidArgumentException

  • GlobalAccelerator.Client.exceptions.AcceleratorNotFoundException

  • GlobalAccelerator.Client.exceptions.InvalidNextTokenException

  • GlobalAccelerator.Client.exceptions.InternalServiceErrorException