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 customer master key (CMK). You may provide a waiting period,
specified in days, before deletion occurs. If you do not provide a waiting period,
the default period of 30 days is used. When this operation is successful, the state
of the CMK changes to
PendingDeletion. Before the waiting period ends,
you can use CancelKeyDeletion to cancel the deletion of the CMK. After the
waiting period ends, AWS KMS deletes the CMK and all AWS KMS data associated with
it, including all aliases that refer to it.
You cannot perform this operation on a CMK in a different AWS account.
Deleting a CMK is a destructive and potentially dangerous operation. When a CMK is deleted, all data that was encrypted under the CMK is rendered unrecoverable. To restrict the use of a CMK without deleting it, use DisableKey.
For more information about scheduling a CMK for deletion, see Deleting Customer Master Keys in the AWS Key Management Service Developer Guide.
The result of this operation varies with the key state of the CMK. For details, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.
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.
public abstract Task<ScheduleKeyDeletionResponse> ScheduleKeyDeletionAsync( String keyId, Int32 pendingWindowInDays, CancellationToken cancellationToken )
The unique identifier of the customer master key (CMK) to delete. 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.
The waiting period, specified in number of days. After the waiting period ends, AWS KMS deletes the customer master key (CMK). This value is optional. If you include a value, it must be between 7 and 30, inclusive. If you do not include a value, it defaults to 30.
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
|DependencyTimeoutException||The system timed out while trying to fulfill the request. The request can be retried.|
|InvalidArnException||The request was rejected because a specified ARN was 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. For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.|
|NotFoundException||The request was rejected because the specified entity or resource could not be found.|
Supported in: 1.3
Supported in: 4.5
Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms