Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ScheduleKeyDeletionCommandOutput

Hierarchy

Index

Properties

$metadata

$metadata: ResponseMetadata

Metadata pertaining to this request.

Optional DeletionDate

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.

Optional KeyId

KeyId: undefined | string

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

Optional KeyState

KeyState: 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.

Optional PendingWindowInDays

PendingWindowInDays: undefined | 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.