Skip to content

KMS  >  Operations  >  delete_imported_key_material

delete_imported_key_material

Operation

delete_imported_key_material async 

delete_imported_key_material(input: DeleteImportedKeyMaterialInput, plugins: list[Plugin] | None = None) -> DeleteImportedKeyMaterialOutput

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:

  • GetParametersForImport

  • ListKeyRotations

  • ImportKeyMaterial

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

Parameters:

Name Type Description Default
input DeleteImportedKeyMaterialInput

An instance of DeleteImportedKeyMaterialInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
DeleteImportedKeyMaterialOutput

An instance of DeleteImportedKeyMaterialOutput.

Input

DeleteImportedKeyMaterialInput dataclass

Bases: _SerdeShape

Dataclass for DeleteImportedKeyMaterialInput structure.

Attributes

key_id class-attribute instance-attribute 
key_id: str | None = ...

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.

key_material_id class-attribute instance-attribute 
key_material_id: str | None = ...

Identifies the imported key material you are deleting.

Warning

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

Output

DeleteImportedKeyMaterialOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteImportedKeyMaterialOutput structure.

Attributes

key_id class-attribute instance-attribute 
key_id: str | None = ...

The Amazon Resource Name (key ARN) of the KMS key from which the key material was deleted.

key_material_id class-attribute instance-attribute 
key_material_id: str | None = ...

Identifies the deleted key material.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.