ElasticLoadBalancingv2 / Paginator / DescribeListenerCertificates

DescribeListenerCertificates#

class ElasticLoadBalancingv2.Paginator.DescribeListenerCertificates#
paginator = client.get_paginator('describe_listener_certificates')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from ElasticLoadBalancingv2.Client.describe_listener_certificates().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    ListenerArn='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • ListenerArn (string) –

    [REQUIRED]

    The Amazon Resource Names (ARN) of the listener.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • PageSize (integer) –

      The size of each page.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'Certificates': [
        {
            'CertificateArn': 'string',
            'IsDefault': True|False
        },
    ],
    'NextToken': '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.

    • NextToken (string) –

      A token to resume pagination.