Transfer / Paginator / ListCertificates


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

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'

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

    'Certificates': [
            'Arn': 'string',
            'CertificateId': 'string',
            'Usage': 'SIGNING'|'ENCRYPTION',
            'Status': 'ACTIVE'|'PENDING_ROTATION'|'INACTIVE',
            'ActiveDate': datetime(2015, 1, 1),
            'InactiveDate': datetime(2015, 1, 1),
            'Description': 'string'

Response Structure

  • (dict) –

    • Certificates (list) –

      Returns an array of the certificates that are specified in the ListCertificates call.

      • (dict) –

        Describes the properties of a certificate.

        • Arn (string) –

          The Amazon Resource Name (ARN) of the specified certificate.

        • CertificateId (string) –

          An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

        • Usage (string) –

          Specifies whether this certificate is used for signing or encryption.

        • Status (string) –

          The certificate can be either ACTIVE, PENDING_ROTATION, or INACTIVE. PENDING_ROTATION means that this certificate will replace the current certificate when it expires.

        • ActiveDate (datetime) –

          An optional date that specifies when the certificate becomes active.

        • InactiveDate (datetime) –

          An optional date that specifies when the certificate becomes inactive.

        • Type (string) –

          The type for the certificate. If a private key has been specified for the certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type is CERTIFICATE.

        • Description (string) –

          The name or short description that’s used to identify the certificate.