DirectoryService / Paginator / ListCertificates


class DirectoryService.Paginator.ListCertificates#
paginator = client.get_paginator('list_certificates')

Creates an iterator that will paginate through responses from DirectoryService.Client.list_certificates().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • DirectoryId (string) –


    The identifier of the directory.

  • 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:



Response Syntax

    'CertificatesInfo': [
            'CertificateId': 'string',
            'CommonName': 'string',
            'State': 'Registering'|'Registered'|'RegisterFailed'|'Deregistering'|'Deregistered'|'DeregisterFailed',
            'ExpiryDateTime': datetime(2015, 1, 1),
            'Type': 'ClientCertAuth'|'ClientLDAPS'

Response Structure

  • (dict) –

    • CertificatesInfo (list) –

      A list of certificates with basic details including certificate ID, certificate common name, certificate state.

      • (dict) –

        Contains general information about a certificate.

        • CertificateId (string) –

          The identifier of the certificate.

        • CommonName (string) –

          The common name for the certificate.

        • State (string) –

          The state of the certificate.

        • ExpiryDateTime (datetime) –

          The date and time when the certificate will expire.

        • Type (string) –

          The function that the registered certificate performs. Valid values include ClientLDAPS or ClientCertAuth. The default value is ClientLDAPS.