Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1432172211.2 KB

Lists the keys in the caller's Amazon Web Services account and Amazon Web Services Region. You can filter the list of keys.

This is a paginated operation, which means that each response might contain only a subset of all the keys. When the response contains only a subset of keys, it includes a NextToken value. Use this value in a subsequent ListKeys request to get more keys. When you receive a response with no NextToken (or an empty or null value), that means there are no more keys to get.

Cross-account use: This operation can't be used across different Amazon Web Services accounts.

Related operations:

post/#X-Amz-Target=PaymentCryptographyControlPlane.ListKeys

Headers

X-Amz-Target'PaymentCryptographyControlPlane.ListKeys' required

Request body

KeyState'CREATE_IN_PROGRESS' | 'CREATE_COMPLETE' | 'DELETE_PENDING' | 'DELETE_COMPLETE'

The key state of the keys you want to list.

NextTokenstring

Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of <code>NextToken</code> from the truncated response you just received.

MaxResultsinteger
<p>Use this parameter to specify the maximum number of items to return. When this value is present, Amazon Web Services Payment Cryptography does not return more than the specified number of items, but it might return fewer.</p> <p>This value is optional. If you include a value, it must be between 1 and 100, inclusive. If you do not include a value, it defaults to 50.</p>

Response

Success

NextTokenstring

The token for the next set of results, or an empty or null value if there are no more results.