ElasticLoadBalancingv2 / Client / describe_listener_certificates

describe_listener_certificates#

ElasticLoadBalancingv2.Client.describe_listener_certificates(**kwargs)#

Describes the default certificate and the certificate list for the specified HTTPS or TLS listener.

If the default certificate is also in the certificate list, it appears twice in the results (once with IsDefault set to true and once with IsDefault set to false).

For more information, see SSL certificates in the Application Load Balancers Guide or Server certificates in the Network Load Balancers Guide.

See also: AWS API Documentation

Request Syntax

response = client.describe_listener_certificates(
    ListenerArn='string',
    Marker='string',
    PageSize=123
)
Parameters:

  • ListenerArn (string) –

    [REQUIRED]

    The Amazon Resource Names (ARN) of the listener.

  • Marker (string) – The marker for the next set of results. (You received this marker from a previous call.)

  • PageSize (integer) – The maximum number of results to return with this call.

Return type:

dict

Returns:

Response Syntax

{
    'Certificates': [
        {
            'CertificateArn': 'string',
            'IsDefault': True|False
        },
    ],
    'NextMarker': 'string'
}

Response Structure

  • (dict) –

    • Certificates (list) –

      Information about the certificates.

      • (dict) –

        Information about an SSL server certificate.

        • CertificateArn (string) –

          The Amazon Resource Name (ARN) of the certificate.

        • IsDefault (boolean) –

          Indicates whether the certificate is the default certificate. Do not set this value when specifying a certificate as an input. This value is not included in the output when describing a listener, but is included when describing listener certificates.

    • NextMarker (string) –

      If there are additional results, this is the marker for the next set of results. Otherwise, this is null.

Exceptions