KMS / Client / list_key_rotations

list_key_rotations

KMS.Client.list_key_rotations(**kwargs)

Returns information about all completed key material rotations for the specified KMS key.

You must specify the KMS key in all requests. You can refine the key rotations list by limiting the number of rotations returned.

For detailed information about automatic and on-demand key rotations, see Rotating KMS keys in the Key Management Service Developer Guide.

Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

Required permissions: kms:ListKeyRotations (key policy)

Related operations:

• EnableKeyRotation

• DisableKeyRotation

• GetKeyRotationStatus

• RotateKeyOnDemand

Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.

See also: AWS API Documentation

Request Syntax

response = client.list_key_rotations(
    KeyId='string',
    Limit=123,
    Marker='string'
)

Parameters:

• KeyId (string) –

  [REQUIRED]

  Gets the key rotations 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.

• Limit (integer) –

  Use this parameter to specify the maximum number of items to return. When this value is present, KMS does not return more than the specified number of items, but it might return fewer.

  This value is optional. If you include a value, it must be between 1 and 1000, inclusive. If you do not include a value, it defaults to 100.

• Marker (string) – Use this parameter in a subsequent request after you receive a response with truncated results. Set it to the value of NextMarker from the truncated response you just received.

Return type:

dict

Returns:

Response Syntax

{
    'Rotations': [
        {
            'KeyId': 'string',
            'RotationDate': datetime(2015, 1, 1),
            'RotationType': 'AUTOMATIC'|'ON_DEMAND'
        },
    ],
    'NextMarker': 'string',
    'Truncated': True|False
}

Response Structure

• (dict) –

  • Rotations (list) –

    A list of completed key material rotations.

    • (dict) –

      Contains information about completed key material rotations.

      • KeyId (string) –

        Unique identifier of the key.

      • RotationDate (datetime) –

        Date and time that the key material rotation completed. Formatted as Unix time.

      • RotationType (string) –

        Identifies whether the key material rotation was a scheduled automatic rotation or an on-demand rotation.

  • NextMarker (string) –

    When Truncated is true, this element is present and contains the value to use for the Marker parameter in a subsequent request.

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

Exceptions

• KMS.Client.exceptions.NotFoundException

• KMS.Client.exceptions.InvalidArnException

• KMS.Client.exceptions.InvalidMarkerException

• KMS.Client.exceptions.KMSInternalException

• KMS.Client.exceptions.KMSInvalidStateException

• KMS.Client.exceptions.UnsupportedOperationException