UpdateSecret
Modifies many of the details of the specified secret. If you include a
ClientRequestToken
and either
SecretString
or SecretBinary
then it also creates a new version
attached to the secret.
To modify the rotation configuration of a secret, use RotateSecret instead.
The Secrets Manager console uses only the SecretString
parameter and therefore limits
you to encrypting and storing only a text string. To encrypt and store binary data
as part
of the version of a secret, you must use either the AWS CLI or one of the AWS
SDKs.
-
If a version with a
VersionId
with the same value as theClientRequestToken
parameter already exists, the operation results in an error. You cannot modify an existing version, you can only create a new version. -
If you include
SecretString
orSecretBinary
to create a new secret version, Secrets Manager automatically attaches the staging labelAWSCURRENT
to the new version.
-
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:UpdateSecret
-
kms:GenerateDataKey - needed only if you use a custom AWS KMS key to encrypt the secret. You do not need this permission to use the account's AWS managed CMK for Secrets Manager.
-
kms:Decrypt - needed only if you use a custom AWS KMS key to encrypt the secret. You do not need this permission to use the account's AWS managed CMK for Secrets Manager.
Related operations
-
To create a new secret, use CreateSecret.
-
To add only a new version to an existing secret, use PutSecretValue.
-
To get the details for a secret, use DescribeSecret.
-
To list the versions contained in a secret, use ListSecretVersionIds.
Request Syntax
{
"ClientRequestToken": "string
",
"Description": "string
",
"KmsKeyId": "string
",
"SecretBinary": blob
,
"SecretId": "string
",
"SecretString": "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) If you want to add a new version to the secret, this parameter specifies a unique identifier for the new version that helps ensure idempotency.
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.You typically only need to interact with this value if you implement your own retry logic and want to ensure that a given secret is not created twice. We recommend that you generate a UUID-type
value to ensure uniqueness within the specified secret. 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.
-
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
andSecretBinary
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 that version's
SecretString
andSecretBinary
values are different from the request then an error occurs because you cannot modify an existing secret value.
This value becomes the
VersionId
of the new version.Type: String
Length Constraints: Minimum length of 32. Maximum length of 64.
Required: No
-
- Description
-
(Optional) Specifies an updated user-provided description of the secret.
Type: String
Length Constraints: Maximum length of 2048.
Required: No
- KmsKeyId
-
(Optional) Specifies an updated ARN or alias of the AWS KMS customer master key (CMK) to be used to encrypt the protected text in new versions of this secret.
Important You can only use the account's default CMK to encrypt and decrypt if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and provide the ARN of that CMK in this field. The user making the call must have permissions to both the secret and the CMK in their respective accounts.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No
- SecretBinary
-
(Optional) Specifies updated 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 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 that you want to modify or 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.
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 updated text data that you want to encrypt and store in this new version of the secret. Either
SecretBinary
orSecretString
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. You can also 'escape' the double quote character in the embedded JSON text by prefacing each with a backslash. For example, the following string is surrounded by double-quotes. All of the embedded double quotes are escaped:
"[{\"username\":\"bob\"},{\"password\":\"abc123xyz456\"}]"
Type: String
Length Constraints: Minimum length of 0. Maximum length of 65536.
Required: No
Response Syntax
{
"ARN": "string",
"Name": "string",
"VersionId": "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 ARN of the secret that was updated.
Note Secrets Manager automatically adds several random characters to the name at the end of the ARN when you initially create a secret. This affects only the ARN and not the actual friendly name. This ensures that if you create a new secret with the same name as an old secret that you previously deleted, then users with access to the old secret don't automatically get access to the new secret because the ARNs are different.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
- Name
-
The friendly name of the secret that was updated.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
- VersionId
-
If a new version of the secret was created by this operation, then
VersionId
contains the unique identifier of the new version.Type: String
Length Constraints: Minimum length of 32. Maximum length of 64.
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
- MalformedPolicyDocumentException
-
You provided a resource-based policy with syntax errors.
HTTP Status Code: 400
- PreconditionNotMetException
-
The request failed because you did not complete all the prerequisite steps.
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
The following examples show how to modify individual components of the secret. Alternatively, you can combine all of the parameters into a single command to do them all in one operation.
Example
The following example shows how to modify the description of a secret. 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.UpdateSecret
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",
"Description": "This is a new description for the secret.",
"ClientRequestToken": "EXAMPLE1-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"
}
Example
This example shows how to update the AWS KMS customer managed key (CMK) used to encrypt the secret value. The AWS KMS CMK must be in the same region as the secret. 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.UpdateSecret
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",
"KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/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"
}
Example
The following example shows how to create a new version of the secret by updating
the
SecretString
field. The ClientRequestToken
parameter becomes
the VersionId
of the new version. Alternatively, you can use the PutSecretValue operation. 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.UpdateSecret
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": "{<JSON STRING WITH CREDENTIALS>}",
"ClientRequestToken": "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1"
}
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":"EXAMPLE1-90ab-cdef-fedc-ba987SECRET1"
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: