KMS / Paginator / ListKeyPolicies

ListKeyPolicies#

class KMS.Paginator.ListKeyPolicies#

paginator = client.get_paginator('list_key_policies')

paginate(**kwargs)#

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

Request Syntax

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

Parameters:

KeyId (string) –
[REQUIRED]

Gets the names of key policies for the specified KMS key.

Specify the key ID or key ARN of the KMS key.

For example:
- Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab
- Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab
To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.
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

{
    'PolicyNames': [
        'string',
    ],
    'Truncated': True|False,
    'NextToken': 'string'
}

Response Structure

(dict) –
- PolicyNames (list) –
  
  A list of key policy names. The only valid value is default.
  - (string) –
- 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 this response to the Marker parameter in a subsequent request.
- NextToken (string) –
  
  A token to resume pagination.