ElasticLoadBalancingv2 / Client / describe_listener_attributes

describe_listener_attributes

ElasticLoadBalancingv2.Client.describe_listener_attributes(**kwargs)

Describes the attributes for the specified listener.

See also: AWS API Documentation

Request Syntax

response = client.describe_listener_attributes(
    ListenerArn='string'
)

Parameters:

ListenerArn (string) –

[REQUIRED]

The Amazon Resource Name (ARN) of the listener.

Return type:

dict

Returns:

Response Syntax

{
    'Attributes': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

• (dict) –

  • Attributes (list) –

    Information about the listener attributes.

    • (dict) –

      Information about a listener attribute.

      • Key (string) –

        The name of the attribute.

        The following attribute is supported by Network Load Balancers, and Gateway Load Balancers.

        • tcp.idle_timeout.seconds - The tcp idle timeout value, in seconds. The valid range is 60-6000 seconds. The default is 350 seconds.

        The following attribute is only supported by Gateway Load Balancers:

        • send_tcp_reset.on_idle_timeout.enabled – Specifies whether the Gateway Load Balancer sends a TCP Reset to the sender of traffic when a TCP flow’s idle timeout expires. This attribute also applies to non-SYN TCP packets received for flows that are not in the flow table. The value is true or false. The default is false.

        The following attributes are only supported by Application Load Balancers.

        • routing.http.request.x_amzn_mtls_clientcert_serial_number.header_name - Enables you to modify the header name of the X-Amzn-Mtls-Clientcert-Serial-Number HTTP request header.

        • routing.http.request.x_amzn_mtls_clientcert_issuer.header_name - Enables you to modify the header name of the X-Amzn-Mtls-Clientcert-Issuer HTTP request header.

        • routing.http.request.x_amzn_mtls_clientcert_subject.header_name - Enables you to modify the header name of the X-Amzn-Mtls-Clientcert-Subject HTTP request header.

        • routing.http.request.x_amzn_mtls_clientcert_validity.header_name - Enables you to modify the header name of the X-Amzn-Mtls-Clientcert-Validity HTTP request header.

        • routing.http.request.x_amzn_mtls_clientcert_leaf.header_name - Enables you to modify the header name of the X-Amzn-Mtls-Clientcert-Leaf HTTP request header.

        • routing.http.request.x_amzn_mtls_clientcert.header_name - Enables you to modify the header name of the X-Amzn-Mtls-Clientcert HTTP request header.

        • routing.http.request.x_amzn_tls_version.header_name - Enables you to modify the header name of the X-Amzn-Tls-Version HTTP request header.

        • routing.http.request.x_amzn_tls_cipher_suite.header_name - Enables you to modify the header name of the X-Amzn-Tls-Cipher-Suite HTTP request header.

        • routing.http.response.server.enabled - Enables you to allow or remove the HTTP response server header.

        • routing.http.response.strict_transport_security.header_value - Informs browsers that the site should only be accessed using HTTPS, and that any future attempts to access it using HTTP should automatically be converted to HTTPS.

        • routing.http.response.access_control_allow_origin.header_value - Specifies which origins are allowed to access the server.

        • routing.http.response.access_control_allow_methods.header_value - Returns which HTTP methods are allowed when accessing the server from a different origin.

        • routing.http.response.access_control_allow_headers.header_value - Specifies which headers can be used during the request.

        • routing.http.response.access_control_allow_credentials.header_value - Indicates whether the browser should include credentials such as cookies or authentication when making requests.

        • routing.http.response.access_control_expose_headers.header_value - Returns which headers the browser can expose to the requesting client.

        • routing.http.response.access_control_max_age.header_value - Specifies how long the results of a preflight request can be cached, in seconds.

        • routing.http.response.content_security_policy.header_value - Specifies restrictions enforced by the browser to help minimize the risk of certain types of security threats.

        • routing.http.response.x_content_type_options.header_value - Indicates whether the MIME types advertised in the Content-Type headers should be followed and not be changed.

        • routing.http.response.x_frame_options.header_value - Indicates whether the browser is allowed to render a page in a frame, iframe, embed or object.

      • Value (string) –

        The value of the attribute.

Exceptions

• ElasticLoadBalancingv2.Client.exceptions.ListenerNotFoundException