Skip to content

Delete Imported Key Material

kms_delete_imported_key_material R Documentation

Deletes key material that was previously imported

Description

Deletes key material that was previously imported. This operation makes the specified KMS key temporarily unusable. To restore the usability of the KMS key, reimport the same key material. For more information about importing key material into KMS, see Importing Key Material in the Key Management Service Developer Guide.

When the specified KMS key is in the PendingDeletion state, this operation does not change the KMS key's state. Otherwise, it changes the KMS key's state to PendingImport.

Considerations for multi-Region symmetric encryption keys

  • When you delete the key material of a primary Region key that is in PENDING_ROTATION or PENDING_MULTI_REGION_IMPORT_AND_ROTATIONstate, you'll also be deleting the key materials for the replica Region keys.

  • If you delete any key material of a replica Region key, the primary Region key and other replica Region keys remain unchanged.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of 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:DeleteImportedKeyMaterial (key policy)

Related operations:

  • get_parameters_for_import

  • list_key_rotations

  • import_key_material

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

Usage

kms_delete_imported_key_material(KeyId, KeyMaterialId)

Arguments

KeyId

[required] Identifies the KMS key from which you are deleting imported key material. The Origin of the KMS key must be EXTERNAL.

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

Identifies the imported key material you are deleting.

If no KeyMaterialId is specified, KMS deletes the current key material.

To get the list of key material IDs associated with a KMS key, use list_key_rotations.

Value

A list with the following syntax:

list(
  KeyId = "string",
  KeyMaterialId = "string"
)

Request syntax

svc$delete_imported_key_material(
  KeyId = "string",
  KeyMaterialId = "string"
)

Examples

## Not run: 
# The following example deletes the imported key material from the
# specified KMS key.
svc$delete_imported_key_material(
  KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab"
)

## End(Not run)