Skip to content

List Key Rotations

kms_list_key_rotations R Documentation

Returns information about the key materials associated with the specified KMS key

Description

Returns information about the key materials associated with the specified KMS key. You can use the optional IncludeKeyMaterial parameter to control which key materials are included in the response.

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 Rotate 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:

  • enable_key_rotation

  • delete_imported_key_material

  • disable_key_rotation

  • get_key_rotation_status

  • import_key_material

  • rotate_key_on_demand

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

Usage

kms_list_key_rotations(KeyId, IncludeKeyMaterial, Limit, Marker)

Arguments

KeyId

[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 list_keys or describe_key.
IncludeKeyMaterial

Use this optional parameter to control which key materials associated with this key are listed in the response. The default value of this parameter is ROTATIONS_ONLY. If you omit this parameter, KMS returns information on the key materials created by automatic or on-demand key rotation. When you specify a value of ALL_KEY_MATERIAL, KMS adds the first key material and any imported key material pending rotation to the response. This parameter can only be used with KMS keys that support automatic or on-demand key rotation.
Limit

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

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.

Value

A list with the following syntax:

list(
  Rotations = list(
    list(
      KeyId = "string",
      KeyMaterialId = "string",
      KeyMaterialDescription = "string",
      ImportState = "IMPORTED"|"PENDING_IMPORT",
      KeyMaterialState = "NON_CURRENT"|"CURRENT"|"PENDING_ROTATION"|"PENDING_MULTI_REGION_IMPORT_AND_ROTATION",
      ExpirationModel = "KEY_MATERIAL_EXPIRES"|"KEY_MATERIAL_DOES_NOT_EXPIRE",
      ValidTo = as.POSIXct(
        "2015-01-01"
      ),
      RotationDate = as.POSIXct(
        "2015-01-01"
      ),
      RotationType = "AUTOMATIC"|"ON_DEMAND"
    )
  ),
  NextMarker = "string",
  Truncated = TRUE|FALSE
)

Request syntax

svc$list_key_rotations(
  KeyId = "string",
  IncludeKeyMaterial = "ALL_KEY_MATERIAL"|"ROTATIONS_ONLY",
  Limit = 123,
  Marker = "string"
)