指定された顧客マスターキー (CMK) を削除します。

スケジュールされた期間中、CMKはPendingDeletion状態であり、データの暗号化、データの復号化、またはデータキーの生成に使用することはできません。

CMK の削除後は復元できなくなります。 暗号化されたデータおよびCMKを使用して生成されたデータキーは復号できません。 CMKの誤った削除を防ぐために、Key Management Service (KMS) ではキーの削除タスクのみをスケジュールできます。 CMK を直接削除することはできません。 CMKを削除する場合は、[DisableKey] を呼び出してCMKを無効にします。

この操作を呼び出すときは、7日から30日の待機期間を指定する必要があります。 待機期間は、リクエストを送信したときから始まります。 CancelKeyDeletion操作を呼び出して、待機期間が終了する前に削除タスクをキャンセルできます。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 この操作は、OpenAPI Explorer で呼び出すことを推奨します。 OpenAPI Explorer は、さまざまな SDK に対して操作のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須/任意 説明
操作 String 必須 ScheduleKeyDeletion

実行する操作です。 値をScheduleKeyDeletionに設定します。

KeyId String 必須 7906979c-8e06-46a2-be2d-68e3ccbc ****

CMKのID。 IDはグローバルに一意である必要があります。

PendingWindowInDays Integer 必須 7

CMKが削除されるまでの日数。 この期間中、CMKはPendingDeletion状態にあります。 この期間が終了すると、削除タスクをキャンセルすることはできません。

有効な値: 7~30。

単位:日

レスポンスパラメーター

パラメーター データ型 説明
RequestId String 3da5b8cc-8107-40ac-a170-793cd181d7b7

リクエストのID。問題の特定とトラブルシューティングに使用されます。

リクエストの例

http(s):// [エンドポイント]/?Action=ScheduleKeyDeletion
&KeyId=7906979c-8e06-46a2-be2d-68e3ccbc ****
&PendingWindowInDays=7
&<共通リクエストパラメーター>

正常に処理された場合のレスポンス例

XML 形式

HTTP/1.1 200 OK
Content-Type:application/xml

<ScheduleKeyDeletionResponse>
    <RequestId>3da5b8cc-8107-40ac-a170-793cd181d7b7</RequestId>
</ScheduleKeyDeletionResponse>

JSON 形式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "3da5b8cc-8107-40ac-a170-793cd181d7b7"
}

エラーコード

エラーコードリストについては、「API エラーセンター」をご参照ください。