SecretsManager / Client / update_secret
update_secret#
- SecretsManager.Client.update_secret(**kwargs)#
Modifies the details of a secret, including metadata and the secret value. To change the secret value, you can also use PutSecretValue.
To change the rotation configuration of a secret, use RotateSecret instead.
To change a secret so that it is managed by another service, you need to recreate the secret in that service. See Secrets Manager secrets managed by other Amazon Web Services services.
We recommend you avoid calling
UpdateSecret
at a sustained rate of more than once every 10 minutes. When you callUpdateSecret
to update the secret value, Secrets Manager creates a new version of the secret. Secrets Manager removes outdated versions when there are more than 100, but it does not remove versions created less than 24 hours ago. If you update the secret value more than once every 10 minutes, you create more versions than Secrets Manager removes, and you will reach the quota for secret versions.If you include
SecretString
orSecretBinary
to create a new secret version, Secrets Manager automatically moves the staging labelAWSCURRENT
to the new version. Then it attaches the labelAWSPREVIOUS
to the version thatAWSCURRENT
was removed from.If you call this operation with a
ClientRequestToken
that matches an existing version’sVersionId
, the operation results in an error. You can’t modify an existing version, you can only create a new version. To remove a version, remove all staging labels from it. See UpdateSecretVersionStage.Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters except
SecretBinary
orSecretString
because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.Required permissions:
secretsmanager:UpdateSecret
. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager. If you use a customer managed key, you must also havekms:GenerateDataKey
,kms:Encrypt
, andkms:Decrypt
permissions on the key. If you change the KMS key and you don’t havekms:Encrypt
permission to the new key, Secrets Manager does not re-ecrypt existing secret versions with the new key. For more information, see Secret encryption and decryption.See also: AWS API Documentation
Request Syntax
response = client.update_secret( SecretId='string', ClientRequestToken='string', Description='string', KmsKeyId='string', SecretBinary=b'bytes', SecretString='string' )
- Parameters:
SecretId (string) –
[REQUIRED]
The ARN or name of the secret.
For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See Finding a secret from a partial ARN.
ClientRequestToken (string) –
If you include
SecretString
orSecretBinary
, then Secrets Manager creates a new version for the secret, and this parameter specifies the unique identifier for the new version.Note
If you use the Amazon Web Services CLI or one of the Amazon Web Services SDKs to call this operation, then you can leave this parameter empty. The CLI or SDK generates a random UUID for you and includes it as the value for this parameter in the request.
If you generate a raw HTTP request to the Secrets Manager service endpoint, then you must generate a
ClientRequestToken
and include it 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 a rotation. We recommend that you generate a UUID-type value to ensure uniqueness of your versions within the specified secret.
This field is autopopulated if not provided.
Description (string) – The description of the secret.
KmsKeyId (string) –
The ARN, key ID, or alias of the KMS key that Secrets Manager uses to encrypt new secret versions as well as any existing versions with the staging labels
AWSCURRENT
,AWSPENDING
, orAWSPREVIOUS
. If you don’t havekms:Encrypt
permission to the new key, Secrets Manager does not re-ecrypt existing secret versions with the new key. For more information about versions and staging labels, see Concepts: Version.A key alias is always prefixed by
alias/
, for examplealias/aws/secretsmanager
. For more information, see About aliases.If you set this to an empty string, Secrets Manager uses the Amazon Web Services managed key
aws/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 Amazon Web Services account automatically have access to useaws/secretsmanager
. Creatingaws/secretsmanager
can result in a one-time significant delay in returning the result.Warning
You can only use the Amazon Web Services managed key
aws/secretsmanager
if you call this operation using credentials from the same Amazon Web Services account that owns the secret. If the secret is in a different account, then you must use a customer managed key and provide the ARN of that KMS key in this field. The user making the call must have permissions to both the secret and the KMS key in their respective accounts.SecretBinary (bytes) –
The binary data to encrypt and store in the new version of the secret. We recommend that you store your binary data in a file and then pass the contents of the file as a parameter.
Either
SecretBinary
orSecretString
must have a value, but not both.You can’t access this parameter in the Secrets Manager console.
SecretString (string) –
The text data to encrypt and store in the new version of the secret. We recommend you use a JSON structure of key/value pairs for your secret value.
Either
SecretBinary
orSecretString
must have a value, but not both.
- Return type:
dict
- Returns:
Response Syntax
{ 'ARN': 'string', 'Name': 'string', 'VersionId': 'string' }
Response Structure
(dict) –
ARN (string) –
The ARN of the secret that was updated.
Name (string) –
The name of the secret that was updated.
VersionId (string) –
If Secrets Manager created a new version of the secret during this operation, then
VersionId
contains the unique identifier of the new version.
Exceptions
SecretsManager.Client.exceptions.InvalidParameterException
SecretsManager.Client.exceptions.InvalidRequestException
SecretsManager.Client.exceptions.LimitExceededException
SecretsManager.Client.exceptions.EncryptionFailure
SecretsManager.Client.exceptions.ResourceExistsException
SecretsManager.Client.exceptions.ResourceNotFoundException
SecretsManager.Client.exceptions.MalformedPolicyDocumentException
SecretsManager.Client.exceptions.InternalServiceError
SecretsManager.Client.exceptions.PreconditionNotMetException
SecretsManager.Client.exceptions.DecryptionFailure
Examples
The following example shows how to modify the description of a secret.
response = client.update_secret( ClientRequestToken='EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE', Description='This is a new description for the secret.', SecretId='MyTestDatabaseSecret', ) print(response)
Expected Output:
{ 'ARN': 'arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3', 'Name': 'MyTestDatabaseSecret', 'ResponseMetadata': { '...': '...', }, }
This example shows how to update the KMS customer managed key (CMK) used to encrypt the secret value. The KMS CMK must be in the same region as the secret.
response = client.update_secret( KmsKeyId='arn:aws:kms:us-west-2:123456789012:key/EXAMPLE2-90ab-cdef-fedc-ba987EXAMPLE', SecretId='MyTestDatabaseSecret', ) print(response)
Expected Output:
{ 'ARN': 'arn:aws:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3', 'Name': 'MyTestDatabaseSecret', 'ResponseMetadata': { '...': '...', }, }
The following example shows how to create a new version of the secret by updating the SecretString field. Alternatively, you can use the put-secret-value operation.
response = client.update_secret( SecretId='MyTestDatabaseSecret', SecretString='{JSON STRING WITH CREDENTIALS}', ) print(response)
Expected Output:
{ 'ARN': 'aws:arn:secretsmanager:us-west-2:123456789012:secret:MyTestDatabaseSecret-a1b2c3', 'Name': 'MyTestDatabaseSecret', 'VersionId': 'EXAMPLE1-90ab-cdef-fedc-ba987EXAMPLE', 'ResponseMetadata': { '...': '...', }, }