kms_delete_imported_key_material: Deletes key material that you previously imported

Description Usage Arguments Details Request syntax Examples

View source: R/kms_operations.R

Description

Deletes key material that you previously imported. This operation makes the specified customer master key (CMK) unusable. For more information about importing key material into AWS KMS, see Importing Key Material in the AWS Key Management Service Developer Guide. You cannot perform this operation on a CMK in a different AWS account.

Usage

1

Arguments

KeyId

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

Specify the key ID or the Amazon Resource Name (ARN) of the CMK.

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 CMK, use ListKeys or DescribeKey.

Details

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

After you delete key material, you can use ImportKeyMaterial to reimport the same key material into the CMK.

The CMK that you use for this operation must be in a compatible key state. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

Request syntax

1
2
3
svc$delete_imported_key_material(
  KeyId = "string"
)

Examples

1
2
3
4
5
# The following example deletes the imported key material from the
# specified customer master key (CMK).
svc$delete_imported_key_material(
  KeyId = "1234abcd-12ab-34cd-56ef-1234567890ab"
)

paws.security.identity documentation built on Jan. 14, 2020, 5:08 p.m.