delete_imported_key_material

delete_imported_key_material(**kwargs)

Deletes key material that you previously imported. This operation makes the specified KMS key unusable. 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 .

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

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:

• GetParametersForImport
• ImportKeyMaterial

See also: AWS API Documentation

Request Syntax

response = client.delete_imported_key_material(
    KeyId='string'
)

Parameters

KeyId (string) --

[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 ListKeys or DescribeKey.

Returns

None

Exceptions

• KMS.Client.exceptions.InvalidArnException
• KMS.Client.exceptions.UnsupportedOperationException
• KMS.Client.exceptions.DependencyTimeoutException
• KMS.Client.exceptions.NotFoundException
• KMS.Client.exceptions.KMSInternalException
• KMS.Client.exceptions.KMSInvalidStateException

Examples

The following example deletes the imported key material from the specified KMS key.

response = client.delete_imported_key_material(
    # The identifier of the KMS key whose imported key material you are deleting. You can use the key ID or the Amazon Resource Name (ARN) of the KMS key.
    KeyId='1234abcd-12ab-34cd-56ef-1234567890ab',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}