GlobalAccelerator / Client / list_listeners

list_listeners#

GlobalAccelerator.Client.list_listeners(**kwargs)#

List the listeners for an accelerator.

See also: AWS API Documentation

Request Syntax

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

  • AcceleratorArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the accelerator for which you want to list listener objects.

  • 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
                },
            ],
            'Protocol': 'TCP'|'UDP',
            'ClientAffinity': 'NONE'|'SOURCE_IP'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Listeners (list) –

      The list of listeners for an accelerator.

      • (dict) –

        A complex type for a listener.

        • ListenerArn (string) –

          The Amazon Resource Name (ARN) of the listener.

        • PortRanges (list) –

          The list of port ranges for the connections from clients to the accelerator.

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

        • Protocol (string) –

          The protocol for the connections from clients to the accelerator.

        • ClientAffinity (string) –

          Client affinity lets you direct all requests from a user to the same endpoint, if you have stateful applications, regardless of the port and protocol of the client request. Client affinity gives you control over whether to always route each client to the same specific endpoint.

          Global Accelerator uses a consistent-flow hashing algorithm to choose the optimal endpoint for a connection. If client affinity is NONE, Global Accelerator uses the “five-tuple” (5-tuple) properties—source IP address, source port, destination IP address, destination port, and protocol—to select the hash value, and then chooses the best endpoint. However, with this setting, if someone uses different ports to connect to Global Accelerator, their connections might not be always routed to the same endpoint because the hash value changes.

          If you want a given client to always be routed to the same endpoint, set client affinity to SOURCE_IP instead. When you use the SOURCE_IP setting, Global Accelerator uses the “two-tuple” (2-tuple) properties— source (client) IP address and destination IP address—to select the hash value.

          The default value is NONE.

    • NextToken (string) –

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

Exceptions