シークレットを削除します。

回復期間を指定せずにこの操作を呼び出すと、削除されたシークレットは30日以内に回復できます。

回復期間を指定した場合、削除されたシークレットは回復期間内に回復できます。 シークレットを強制的に削除することもできます。 強制的に削除されたシークレットは復元できません。

デバッグ

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

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
操作 String 必須 DeleteSecret

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

SecretName String 必須 secret001

秘密の名前。The name of the secret.

ForceDeleteWithoutRecovery String 任意 false

シークレットを強制的に削除するかどうかを指定します。 このパラメーターがtrueに設定されている場合、シークレットは復元できません。

設定可能な値は以下のとおりです。

  • true
  • false (デフォルト値)
RecoveryWindowInDays String 任意 10

シークレットを強制的に削除しない場合の回復期間を指定します。 デフォルト値：30。 単位: 日数。

レスポンスパラメーター

パラメーター データ型 例 説明
SecretName String secret001

秘密の名前。The name of the secret.

RequestId String 38bbed2a-15e0-45ad-98d4-816ad2ccf4ea

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

PlannedDeleteTime String 2022-09-15T07:02:14Z

シークレットが削除される予定の時刻。

例

リクエストの例

http(s)://[Endpoint]/?Action=DeleteSecret
&SecretName=secret001
&ForceDeleteWithoutRecovery=false
&RecoveryWindowInDays=10
&<共通リクエストパラメーター>

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

XML 形式 

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

<DeleteSecretResponse>
    <SecretName>secret001</SecretName>
    <RequestId>38bbed2a-15e0-45ad-98d4-816ad2ccf4ea</RequestId>
    <PlannedDeleteTime>2022-09-15T07:02:14Z</PlannedDeleteTime>
</DeleteSecretResponse>

JSON 形式 

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

{
  "SecretName" : "secret001" 、
  "RequestId" : "38bbed2a-15e0-45ad-98d4-816ad2ccf4ea" 、
  "PlannedDeleteTime" : "2022-09-15T07:02:14Z"
}

エラーコード

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