新しいバージョンのシークレット値をシークレットに格納します。

この操作は、新しいバージョンの秘密値を格納するために使用されます。 既存のバージョンのシークレット値の変更には使用できません。

デフォルトでは、新しく格納されたシークレット値はACSCurrentでマークされ、シークレット値の以前のバージョンのマークはACSCurrentからACSPreviousに変更されます。 VersionStageパラメーターを指定した場合、新しく格納されたシークレット値は、指定したstageラベルでマークされます。

操作を呼び出すときは、バージョン番号を指定する必要があります。 Secrets Managerは、次のルールに基づいて操作を実行します。

  • 指定されたバージョン番号がシークレットに存在しない場合、Secrets Managerはバージョンを作成し、シークレット値を保存します。
  • 指定されたバージョン番号がすでにシークレットに存在し、既存のバージョンのシークレット値が指定したシークレット値と同じである場合、Secrets Managerはリクエストを無視して成功メッセージを返します。 リクエストはべき等です。
  • 指定されたバージョン番号がすでにシークレットに存在するが、既存のバージョンのシークレット値が指定したシークレット値と異なる場合、Secrets Managerはリクエストを拒否し、失敗メッセージを返します。

制限: この操作は、標準シークレットでのみ使用できます。

この例では、secret001シークレットに新しいバージョンのシークレット値が格納されます。 The VersionId parameter is set to 00000000000000000000000000000000203 as the new version, and the SecretData parameter is set to importantdata.

デバッグ

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

リクエストパラメーター

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

実行する操作です。 Set the value to PutSecretValue.

VersionId String 必須 00000000000000000000000000000000203

シークレット値の新しいバージョン。The new version of the secret value. バージョン番号は各シークレットで一意である必要があります。

SecretName String 必須 secret001

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

SecretData String 必須 importantdata

秘密の値。The secret value. 値は暗号化され、新しいバージョンに保存されます。

SecretDataType String 任意 text

シークレット値の型。 設定可能な値は以下のとおりです。

  • text: これはデフォルト値です。
  • binary
VersionStages String 任意 ["ACSCurrent","ACSNext"]

新しいバージョンをマークするために使用されるステージラベル。 このパラメーターを指定しない場合、Secrets Managerは新しいバージョンをACSCurrentでマークします。

共通リクエストパラメーターの詳細については、「共通パラメーター」をご参照ください。

レスポンスパラメーター

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

The name of the secret.

VersionId String 00000000000000000000000000000000203

シークレット値の新しいバージョン。The new version of the secret value.

RequestId String f94ec9d3-2d10-4922-9a5c-5dcd5ebcb5e8

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

VersionStages Array of String {"VersionStage": [ "ACSCurrent", "ACSTnext" ] }

新しいバージョンをマークするために使用されるステージラベル。

例

リクエストの例

http(s)://[Endpoint]/?Action=PutSecretValue
&VersionId=00000000000000000000000000000000203
&SecretName=secret001
&SecretData=importantdata
&SecretDataType=テキスト
&VersionStages=["ACSCurrent","ACSTnext"]
&共通リクエストパラメータ

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

XML 形式 

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

<PutSecretValueResponse>
    <SecretName>secret001</SecretName>
    <VersionId>00000000000000000000000000000000203</VersionId>
    <RequestId>f94ec9d3-2d10-4922-9a5c-5dcd5ebcb5e8</RequestId>
    <VersionStages>{ "VersionStage": [ "ACSCurrent", "ACSTnext" ] }</VersionStages>
</PutSecretValueResponse>

JSON 形式 

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

{
  "SecretName" : "secret001" 、
  "VersionId" : "00000000000000000000000000000000203" 、
  "RequestId" : "f94ec9d3-2d10-4922-9a5c-5dcd5ebcb5e8",
  "VersionStages" : [ "{ \"VersionStage\": [ \"ACSCurrent\", \"ACSNext\" ] }" ]
}

エラーコード

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