GlobalAccelerator / Client / describe_custom_routing_listener

describe_custom_routing_listener#

GlobalAccelerator.Client.describe_custom_routing_listener(**kwargs)#

The description of a listener for a custom routing accelerator.

See also: AWS API Documentation

Request Syntax

response = client.describe_custom_routing_listener(
    ListenerArn='string'
)
Parameters:

ListenerArn (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • Listener (dict) –

      The description of 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.

Exceptions

  • GlobalAccelerator.Client.exceptions.InvalidArgumentException

  • GlobalAccelerator.Client.exceptions.ListenerNotFoundException

  • GlobalAccelerator.Client.exceptions.InternalServiceErrorException