PutSecretValue
Stores a new encrypted secret value in the specified secret. To do this, the operation
creates a new version and attaches it to the secret. The version can contain a new
SecretString
value or a new SecretBinary
value. You can also
specify the staging labels that are initially attached to the new version.
The Secrets Manager console uses only the SecretString
field. To add binary data to a
secret with the SecretBinary
field you must use the AWS CLI or one of the
AWS SDKs.
-
If this operation creates the first version for the secret then Secrets Manager automatically attaches the staging label
AWSCURRENT
to the new version. -
If you do not specify a value for VersionStages then Secrets Manager automatically moves the staging label
AWSCURRENT
to this new version. -
If this operation moves the staging label
AWSCURRENT
from another version to this version, then Secrets Manager also automatically moves the staging labelAWSPREVIOUS
to the version thatAWSCURRENT
was removed from. -
This operation is idempotent. If a version with a
VersionId
with the same value as theClientRequestToken
parameter already exists and you specify the same secret data, the operation succeeds but does nothing. However, if the secret data is different, then the operation fails because you cannot modify an existing version; you can only create new ones.
-
If you call an operation to encrypt or decrypt the
SecretString
orSecretBinary
for a secret in the same account as the calling user and that secret doesn't specify a AWS KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the aliasaws/secretsmanager
. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users and roles in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS creating the account's AWS-managed CMK, it can result in a one-time significant delay in returning the result. -
If the secret resides in a different AWS account from the credentials calling an API that requires encryption or decryption of the secret value then you must create and use a custom AWS KMS CMK because you can't access the default CMK for the account using credentials from a different AWS account. Store the ARN of the CMK in the secret when you create the secret or when you update it by including it in the
KMSKeyId
. If you call an API that must encrypt or decryptSecretString
orSecretBinary
using credentials from a different account then the AWS KMS key policy must grant cross-account access to that other account's user or role for both the kms:GenerateDataKey and kms:Decrypt operations.
Minimum permissions
To run this command, you must have the following permissions:
-
secretsmanager:PutSecretValue
-
kms:GenerateDataKey - needed only if you use a customer-managed AWS KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.
Related operations
-
To retrieve the encrypted value you store in the version of a secret, use GetSecretValue.
-
To create a secret, use CreateSecret.
-
To get the details for a secret, use DescribeSecret.
-
To list the versions attached to a secret, use ListSecretVersionIds.
Request Syntax
{
"ClientRequestToken": "string
",
"SecretBinary": blob
,
"SecretId": "string
",
"SecretString": "string
",
"VersionStages": [ "string
" ]
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- ClientRequestToken
-
(Optional) Specifies a unique identifier for the new version of the secret.
Note If you use the AWS CLI or one of the AWS SDK to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes that in the request. If you don't use the SDK and instead generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a
ClientRequestToken
yourself for new versions and include that value in the request.This value helps ensure idempotency. Secrets Manager uses this value to prevent the accidental creation of duplicate versions if there are failures and retries during the Lambda rotation function's processing. We recommend that you generate a UUID-type
value to ensure uniqueness within the specified secret. -
If the
ClientRequestToken
value isn't already associated with a version of the secret then a new version of the secret is created. -
If a version with this value already exists and that version's
SecretString
orSecretBinary
values are the same as those in the request then the request is ignored (the operation is idempotent). -
If a version with this value already exists and the version of the
SecretString
andSecretBinary
values are different from those in the request then the request fails because you cannot modify an existing secret version. You can only create new versions to store new secret values.
This value becomes the
VersionId
of the new version.Type: String
Length Constraints: Minimum length of 32. Maximum length of 64.
Required: No
-
- SecretBinary
-
(Optional) Specifies binary data that you want to encrypt and store in the new version of the secret. To use this parameter in the command-line tools, we recommend that you store your binary data in a file and then use the appropriate technique for your tool to pass the contents of the file as a parameter. Either
SecretBinary
orSecretString
must have a value, but not both. They cannot both be empty.This parameter is not accessible if the secret using the Secrets Manager console.
Type: Base64-encoded binary data object
Length Constraints: Minimum length of 0. Maximum length of 65536.
Required: No
- SecretId
-
Specifies the secret to which you want to add a new version. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. The secret must already exist.
Note If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.
If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: Yes
- SecretString
-
(Optional) Specifies text data that you want to encrypt and store in this new version of the secret. Either
SecretString
orSecretBinary
must have a value, but not both. They cannot both be empty.If you create this secret by using the Secrets Manager console then Secrets Manager puts the protected secret text in only the
SecretString
parameter. The Secrets Manager console stores the information as a JSON structure of key/value pairs that the default Lambda rotation function knows how to parse.For storing multiple values, we recommend that you use a JSON text string argument and specify key/value pairs. For information on how to format a JSON parameter for the various command line tool environments, see Using JSON for Parameters in the AWS CLI User Guide.
For example:
[{"username":"bob"},{"password":"abc123xyz456"}]
If your command-line tool or SDK requires quotation marks around the parameter, you should use single quotes to avoid confusion with the double quotes required in the JSON text.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 65536.
Required: No
- VersionStages
-
(Optional) Specifies a list of staging labels that are attached to this version of the secret. These staging labels are used to track the versions through the rotation process by the Lambda rotation function.
A staging label must be unique to a single version of the secret. If you specify a staging label that's already associated with a different version of the same secret then that staging label is automatically removed from the other version and attached to this version.
If you do not specify a value for
VersionStages
then Secrets Manager automatically moves the staging labelAWSCURRENT
to this new version.Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 20 items.
Length Constraints: Minimum length of 1. Maximum length of 256.
Required: No
Response Syntax
{
"ARN": "string",
"Name": "string",
"VersionId": "string",
"VersionStages": [ "string" ]
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ARN
-
The Amazon Resource Name (ARN) for the secret for which you just created a version.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
- Name
-
The friendly name of the secret for which you just created or updated a version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
- VersionId
-
The unique identifier of the version of the secret you just created or updated.
Type: String
Length Constraints: Minimum length of 32. Maximum length of 64.
- VersionStages
-
The list of staging labels that are currently attached to this version of the secret. Staging labels are used to track a version as it progresses through the secret rotation process.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 20 items.
Length Constraints: Minimum length of 1. Maximum length of 256.
Errors
For information about the errors that are common to all actions, see Common Errors.
- EncryptionFailure
-
Secrets Manager can't encrypt the protected secret text using the provided KMS key. Check that the customer master key (CMK) is available, enabled, and not in an invalid state. For more information, see How Key State Affects Use of a Customer Master Key.
HTTP Status Code: 400
- InternalServiceError
-
An error occurred on the server side.
HTTP Status Code: 500
- InvalidParameterException
-
You provided an invalid value for a parameter.
HTTP Status Code: 400
- InvalidRequestException
-
You provided a parameter value that is not valid for the current state of the resource.
Possible causes:
-
You tried to perform the operation on a secret that's currently marked deleted.
-
You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call.
HTTP Status Code: 400
-
- LimitExceededException
-
The request failed because it would exceed one of the Secrets Manager internal limits.
HTTP Status Code: 400
- ResourceExistsException
-
A resource with the ID you requested already exists.
HTTP Status Code: 400
- ResourceNotFoundException
-
We can't find the resource that you asked for.
HTTP Status Code: 400
Examples
Example
The following example shows how to create a new version of the secret. The
ClientRequestToken
becomes the VersionId
of the new version.
Alternatively, you can use UpdateSecret. The JSON request string input and response output displays formatted code
with white space and line breaks for better readability. Submit your input as a single
line
JSON string.
Sample Request
POST / HTTP/1.1
Host: secretsmanager.region.domain
Accept-Encoding: identity
X-Amz-Target: secretsmanager.PutSecretValue
Content-Type: application/x-amz-json-1.1
User-Agent: <user-agent-string>
X-Amz-Date: <date>
Authorization: AWS4-HMAC-SHA256 Credential=<credentials>,SignedHeaders=<headers>, Signature=<signature>
Content-Length: <payload-size-bytes>
{
"SecretId": "MyTestDatabaseSecret",
"SecretString": "{\"username\":\"david\",\"password\":\"BnQw!XDWgaEeT9XGTT29\"}",
"ClientRequestToken": "EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE"
}
Sample Response
HTTP/1.1 200 OK
Date: <date>
Content-Type: application/x-amz-json-1.1
Content-Length: <response-size-bytes>
Connection: keep-alive
x-amzn-RequestId: <request-id-guid>
{
"ARN":"arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3",
"Name":"MyTestDatabaseSecret",
"VersionId":"EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE",
"VersionStages":[
"AWSCURRENT"
]
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: