Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Interface ScheduleKeyDeletionCommandOutputProtected

Hierarchy

Properties

$metadata: ResponseMetadata

Metadata pertaining to this request.

DeletionDate?: Date

The date and time after which KMS deletes the KMS key.

If the KMS key is a multi-Region primary key with replica keys, this field does not appear. The deletion date for the primary key isn't known until its last replica key is deleted.

KeyId?: string

The Amazon Resource Name (key ARN) of the KMS key whose deletion is scheduled.

KeyState?: string

The current status of the KMS key.

For more information about how key state affects the use of a KMS key, see Key states of KMS keys in the Key Management Service Developer Guide.

PendingWindowInDays?: number

The waiting period before the KMS key is deleted.

If the KMS key is a multi-Region primary key with replicas, the waiting period begins when the last of its replica keys is deleted. Otherwise, the waiting period begins immediately.