KMS / Paginator / ListKeys

ListKeys

class KMS.Paginator.ListKeys

paginator = client.get_paginator('list_keys')

paginate(**kwargs)

Creates an iterator that will paginate through responses from KMS.Client.list_keys().

See also: AWS API Documentation

Request Syntax

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

Parameters:

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

{
    'Keys': [
        {
            'KeyId': 'string',
            'KeyArn': 'string'
        },
    ],
    'Truncated': True|False,
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • Keys (list) –

    A list of KMS keys.

    • (dict) –

      Contains information about each entry in the key list.

      • KeyId (string) –

        Unique identifier of the key.

      • KeyArn (string) –

        ARN of the key.

  • Truncated (boolean) –

    A flag that indicates whether there are more items in the list. When this value is true, the list in this response is truncated. To get more items, pass the value of the NextMarker element in thisresponse to the Marker parameter in a subsequent request.

  • NextToken (string) –

    A token to resume pagination.