CloudTrail / Paginator / ListPublicKeys

ListPublicKeys#

class CloudTrail.Paginator.ListPublicKeys#
paginator = client.get_paginator('list_public_keys')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from CloudTrail.Client.list_public_keys().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • StartTime (datetime) – Optionally specifies, in UTC, the start of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used, and the current public key is returned.

  • EndTime (datetime) – Optionally specifies, in UTC, the end of the time range to look up public keys for CloudTrail digest files. If not specified, the current time is used.

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

    • StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'PublicKeyList': [
        {
            'Value': b'bytes',
            'ValidityStartTime': datetime(2015, 1, 1),
            'ValidityEndTime': datetime(2015, 1, 1),
            'Fingerprint': 'string'
        },
    ],

}

Response Structure

  • (dict) –

    Returns the objects or data listed below if successful. Otherwise, returns an error.

    • PublicKeyList (list) –

      Contains an array of PublicKey objects.

      Note

      The returned public keys may have validity time ranges that overlap.

      • (dict) –

        Contains information about a returned public key.

        • Value (bytes) –

          The DER encoded public key value in PKCS#1 format.

        • ValidityStartTime (datetime) –

          The starting time of validity of the public key.

        • ValidityEndTime (datetime) –

          The ending time of validity of the public key.

        • Fingerprint (string) –

          The fingerprint of the public key.