AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Schedules the deletion of a KMS key. By default, KMS applies a waiting period of 30
days, but you can specify a waiting period of 7-30 days. When this operation is successful,
the key state of the KMS key changes to
Deleting a KMS key is a destructive and potentially dangerous operation. When a KMS
key is deleted, all data that was encrypted under the KMS key is unrecoverable. (The
only exception is a multi-Region
replica key, or an asymmetric
or HMAC KMS key with imported key material.) To prevent the use of a KMS key without
deleting it, use DisableKey.
PendingDeletion and the key can't be
used in any cryptographic operations. It remains in this state for the duration of
the waiting period. Before the waiting period ends, you can use CancelKeyDeletion
to cancel the deletion of the KMS key. After the waiting period ends, KMS deletes
the KMS key, its key material, and all KMS data associated with it, including all
aliases that refer to it.
You can schedule the deletion of a multi-Region primary key and its replica keys at
any time. However, KMS will not delete a multi-Region primary key with existing replica
keys. If you schedule the deletion of a primary key with replicas, its key state changes
to PendingReplicaDeletion and it cannot be replicated or used in cryptographic
operations. This status can continue indefinitely. When the last of its replicas keys
is deleted (not just scheduled), the key state of the primary key changes to PendingDeletion
and its waiting period (PendingWindowInDays) begins. For details, see Deleting
multi-Region keys in the Key Management Service Developer Guide.
When KMS deletes a KMS key from an CloudHSM key store, it makes a best effort to delete the associated key material from the associated CloudHSM cluster. However, you might need to manually delete the orphaned key material from the cluster and its backups. Deleting a KMS key from an external key store has no effect on the associated external key. However, for both types of custom key stores, deleting a KMS key is destructive and irreversible. You cannot decrypt ciphertext encrypted under the KMS key by using only its associated external key or CloudHSM key. Also, you cannot recreate a KMS key in an external key store by creating a new KMS key with the same key material.
For more information about scheduling a KMS key for deletion, see Deleting KMS keys in the Key Management Service Developer Guide.
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:ScheduleKeyDeletion (key policy)
Related operations
Eventual consistency: The KMS API follows an eventual consistency model. For more information, see KMS eventual consistency.
This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginScheduleKeyDeletion and EndScheduleKeyDeletion.
Namespace: Amazon.KeyManagementService
Assembly: AWSSDK.KeyManagementService.dll
Version: 3.x.y.z
public virtual Task<ScheduleKeyDeletionResponse> ScheduleKeyDeletionAsync( String keyId, CancellationToken cancellationToken )
The unique identifier of the KMS key to delete. 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.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
| Exception | Condition |
|---|---|
| DependencyTimeoutException | The system timed out while trying to fulfill the request. You can retry the request. |
| InvalidArnException | The request was rejected because a specified ARN, or an ARN in a key policy, is not valid. |
| KMSInternalException | The request was rejected because an internal exception occurred. The request can be retried. |
| KMSInvalidStateException | The request was rejected because the state of the specified resource is not valid for this request. This exceptions means one of the following: The key state of the KMS key is not compatible with the operation. To find the key state, use the DescribeKey operation. For more information about which key states are compatible with each KMS operation, see Key states of KMS keys in the Key Management Service Developer Guide. For cryptographic operations on KMS keys in custom key stores, this exception represents a general failure with many possible causes. To identify the cause, see the error message that accompanies the exception. |
| NotFoundException | The request was rejected because the specified entity or resource could not be found. |
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer