IAM / Paginator / ListSigningCertificates

ListSigningCertificates

class IAM.Paginator.ListSigningCertificates

paginator = client.get_paginator('list_signing_certificates')

paginate(**kwargs)

Creates an iterator that will paginate through responses from IAM.Client.list_signing_certificates().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    UserName='string',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• UserName (string) –

  The name of the IAM user whose signing certificates you want to examine.

  This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

• 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': [
        {
            'UserName': 'string',
            'CertificateId': 'string',
            'CertificateBody': 'string',
            'Status': 'Active'|'Inactive',
            'UploadDate': datetime(2015, 1, 1)
        },
    ],
    'IsTruncated': True|False,
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Contains the response to a successful ListSigningCertificates request.

  • Certificates (list) –

    A list of the user’s signing certificate information.

    • (dict) –

      Contains information about an X.509 signing certificate.

      This data type is used as a response element in the UploadSigningCertificate and ListSigningCertificates operations.

      • UserName (string) –

        The name of the user the signing certificate is associated with.

      • CertificateId (string) –

        The ID for the signing certificate.

      • CertificateBody (string) –

        The contents of the signing certificate.

      • Status (string) –

        The status of the signing certificate. Active means that the key is valid for API calls, while Inactive means it is not.

      • UploadDate (datetime) –

        The date when the signing certificate was uploaded.

  • IsTruncated (boolean) –

    A flag that indicates whether there are more items to return. If your results were truncated, you can make a subsequent pagination request using the Marker request parameter to retrieve more items. Note that IAM might return fewer than the MaxItems number of results even when there are more results available. We recommend that you check IsTruncated after every call to ensure that you receive all your results.

  • NextToken (string) –

    A token to resume pagination.