2018/04/04 - AWS Secrets Manager - 15 new api methods
Changes Update secretsmanager client to latest version
Modifies many of the details of a 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.
If this update creates the first version of the secret or if you did not include the VersionStages parameter then Secrets Manager automatically attaches the staging label AWSCURRENT to the new version and removes it from any version that had it previously. The previous version (if any) is then given the staging label AWSPREVIOUS.
If a version with a SecretVersionId with the same value as the ClientRequestToken parameter already exists, the operation generates an error. You cannot modify an existing version, you can only create new ones.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:UpdateSecret
kms:GenerateDataKey - needed only if you use a custom 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 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.
See also: AWS API Documentation
Request Syntax
client.update_secret(
SecretId='string',
ClientRequestToken='string',
Description='string',
KmsKeyId='string',
SecretBinary=b'bytes',
SecretString='string'
)
string
[REQUIRED]
Specifies the secret that you want to update 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.
string
(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 AWS 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 and SecretBinary 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 and SecretBinary values are different from the request then an error occurs because you cannot modify an existing secret value.
This value becomes the SecretVersionId of the new version.
This field is autopopulated if not provided.
string
(Optional) Specifies a user-provided description of the secret.
string
(Optional) Specifies the ARN or alias of the KMS customer master key (CMK) to be used to encrypt the protected text in the versions of this secret.
If you don't specify this value, then Secrets Manager defaults to using the default CMK in the account (the one named aws/secretsmanager). If a KMS CMK with that name doesn't exist, then AWS Secrets Manager creates it for you automatically the first time it needs to encrypt a version's Plaintext or PlaintextString fields.
bytes
(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 or SecretString must have a value. They cannot both be empty.
This parameter is not accessible using the Secrets Manager console.
string
(Optional) Specifies text data that you want to encrypt and store in this new version of the secret. Either SecretBinary or SecretString must have a value. 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.
dict
Response Syntax
{
'ARN': 'string',
'Name': 'string',
'VersionId': 'string'
}
Response Structure
(dict) --
ARN (string) --
The ARN of this secret.
Name (string) --
The friendly name of this secret.
VersionId (string) --
If a version of the secret was created or updated by this operation, then its unique identifier is returned.
Generates a random password of the specified complexity. This operation is intended for use in the Lambda rotation function. Per best practice, we recommend that you specify the maximum length and include every character type that the system you are generating a password for can support.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:GetRandomPassword
See also: AWS API Documentation
Request Syntax
client.get_random_password(
PasswordLength=123,
ExcludeCharacters='string',
ExcludeNumbers=True|False,
ExcludePunctuation=True|False,
ExcludeUppercase=True|False,
ExcludeLowercase=True|False,
IncludeSpace=True|False,
RequireEachIncludedType=True|False
)
integer
The desired length of the generated password. The default value if you do not include this parameter is 32 characters.
string
A string that includes characters that should not be included in the generated password. The default is that all characters from the included sets can be used.
boolean
Specifies that the generated password should not include digits. The default if you do not include this switch parameter is that digits can be included.
boolean
Specifies that the generated password should not include punctuation characters. The default if you do not include this switch parameter is that punctuation characters can be included.
boolean
Specifies that the generated password should not include uppercase letters. The default if you do not include this switch parameter is that uppercase letters can be included.
boolean
Specifies that the generated password should not include lowercase letters. The default if you do not include this switch parameter is that lowercase letters can be included.
boolean
Specifies that the generated password can include the space character. The default if you do not include this switch parameter is that the space character is not included.
boolean
A boolean value that specifies whether the generated password must include at least one of every allowed character type. The default value is True and the operation requires at least one of every character type.
dict
Response Syntax
{
'RandomPassword': 'string'
}
Response Structure
(dict) --
RandomPassword (string) --
A string with the generated password.
Creates a new secret. A secret in AWS Secrets Manager consists of both the protected secret data and the important information needed to manage the secret.
Secrets Manager stores the encrypted secret data in one of a collection of "versions" associated with the secret. Each version contains a copy of the encrypted secret data. Each version is associated with one or more "staging labels" that identify where the version is in the rotation cycle. The SecretVersionsToStages field of the secret contains the mapping of staging labels to the active versions of the secret. Versions without a staging label are considered deprecated and are not included in the list.
You provide the secret data to be encrypted by putting text in the SecretString parameter or binary data in the SecretBinary parameter. If you include SecretString or SecretBinary then Secrets Manager also creates an initial secret version and, if you don't supply a staging label, automatically maps the new version's ID to the staging label AWSCURRENT.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:CreateSecret
kms:GenerateDataKey - needed only if you use a customer-created KMS key to encrypt the secret. You do not need this permission to use the account's default AWS managed CMK for Secrets Manager.
kms:Encrypt - needed only if you use a customer-created 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 delete a secret, use DeleteSecret.
To modify an existing secret, use UpdateSecret.
To create a new version of a secret, use PutSecretValue.
To retrieve the encrypted secure string and secure binary values, use GetSecretValue.
To retrieve all other details for a secret, use DescribeSecret. This does not include the encrypted secure string and secure binary values.
To retrieve the list of secret versions associated with the current secret, use DescribeSecret and examine the SecretVersionsToStages response value.
See also: AWS API Documentation
Request Syntax
client.create_secret(
Name='string',
ClientRequestToken='string',
Description='string',
KmsKeyId='string',
SecretBinary=b'bytes',
SecretString='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
Specifies the friendly name of the new secret. The secret name can consist of uppercase letters, lowercase letters, digits, and any of the following characters: /_+=.@- Spaces are not permitted.
string
(Optional) If you include SecretString or SecretBinary, then an initial version is created as part of the secret, and this parameter specifies a unique identifier for the new version.
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.
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 and SecretBinary 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 and SecretBinary values are different from those in the request then the request fails because you cannot modify an existing version. Instead, use PutSecretValue to create a new version.
This value becomes the SecretVersionId of the new version.
This field is autopopulated if not provided.
string
(Optional) Specifies a user-provided description of the secret.
string
(Optional) Specifies the ARN or alias of the AWS KMS customer master key (CMK) to be used to encrypt the SecretString and SecretBinary values in the versions stored in this secret.
If you don't specify this value, then Secrets Manager defaults to using the AWS account's default CMK (the one named aws/secretsmanager). If a KMS CMK with that name doesn't yet exist, then AWS Secrets Manager creates it for you automatically the first time it needs to encrypt a version's SecretString or SecretBinary fields.
bytes
(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 SecretString, SecretBinary, or both must have a value. They cannot both be empty.
This SecretBinary value is stored separately from the SecretString, but the two parameters jointly share a maximum size limit.
This parameter is not available using the Secrets Manager console. It can be accessed only by using the AWS CLI or one of the AWS SDKs.
string
(Optional) Specifies text data that you want to encrypt and store in this new version of the secret.
Either SecretString, SecretBinary, or both must have a value. They cannot both be empty.
This string value is stored separately from the SecretBinary, but the two parameters jointly share a maximum size limit.
If you create a 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 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:
[{"Key":"username","Value":"bob"},{"Key":"password","Value":"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.
list
(Optional) Specifies a list of user-defined tags that are attached to the secret. Each tag is a "Key" and "Value" pair of strings. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.
This parameter requires a JSON text string argument. 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:
[{"Key":"CostCenter","Value":"12345"},{"Key":"environment","Value":"production"}]
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.
The following basic restrictions apply to tags:
Maximum number of tags per secret—50
Maximum key length—127 Unicode characters in UTF-8
Maximum value length—255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws: prefix in your tag names or values because it is reserved for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If your tagging schema will be used across multiple services and resources, remember that other services might have restrictions on allowed characters. Generally allowed characters are: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
(dict) --
A structure that contains information about a tag.
Key (string) --
The key identifier, or name, of the tag.
Value (string) --
The string value that's associated with the key of the tag.
dict
Response Syntax
{
'ARN': 'string',
'Name': 'string',
'VersionId': 'string'
}
Response Structure
(dict) --
ARN (string) --
The Amazon Resource Name (ARN) of the secret that you just created.
Name (string) --
The friendly name of the secret that you just created.
VersionId (string) --
The unique identifier that's associated with the version of the secret you just created.
Attaches one or more tags, each consisting of a key name and a value, to the specified secret. Tags are part of the secret's overall metadata, and are not associated with any specific version of the secret. This operation only appends tags to the existing list of tags. To remove tags, you must use UntagResource.
The following basic restrictions apply to tags:
Maximum number of tags per secret—50
Maximum key length—127 Unicode characters in UTF-8
Maximum value length—255 Unicode characters in UTF-8
Tag keys and values are case sensitive.
Do not use the aws: prefix in your tag names or values because it is reserved for AWS use. You can't edit or delete tag names or values with this prefix. Tags with this prefix do not count against your tags per secret limit.
If your tagging schema will be used across multiple services and resources, remember that other services might have restrictions on allowed characters. Generally allowed characters are: letters, spaces, and numbers representable in UTF-8, plus the following special characters: + - = . _ : / @.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:TagResource
Related operations
To remove one or more tags from the collection attached to a secret, use UntagResource.
To view the list of tags attached to a secret, use DescribeSecret.
See also: AWS API Documentation
Request Syntax
client.tag_resource(
SecretId='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
The identifier for the secret that you want to attach tags to. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
list
[REQUIRED]
The tags to attach to the secret. Each element in the list consists of a Key and a Value.
This parameter to the API requires a JSON text string argument. 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 the AWS CLI, you can also use the syntax: --Tags Key="Key1",Value="Value1",Key="Key2",Value="Value2"[,…]
(dict) --
A structure that contains information about a tag.
Key (string) --
The key identifier, or name, of the tag.
Value (string) --
The string value that's associated with the key of the tag.
None
Disables automatic scheduled rotation and cancels the rotation of a secret if one is currently in progress.
To re-enable scheduled rotation, call RotateSecret with AutomaticallyRotateAfterDays set to a value greater than 0. This will immediately rotate your secret and then enable the automatic schedule.
To successfully start a rotation, the staging label AWSPENDING must be in one of the following states:
Not be attached to any version at all
Attached to the same version as the staging label AWSCURRENT
If the staging label AWSPENDING is attached to a different version than the version with AWSCURRENT then the attempt to rotate fails.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:CancelRotateSecret
Related operations
To configure rotation for a secret or to manually trigger a rotation, use RotateSecret.
To get the rotation configuration details for a secret, use DescribeSecret.
To list all of the currently available secrets, use ListSecrets.
To list all of the versions currently associated with a secret, use ListSecretVersionIds.
See also: AWS API Documentation
Request Syntax
client.cancel_rotate_secret(
SecretId='string'
)
string
[REQUIRED]
Specifies the secret for which you want to cancel a rotation request. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
dict
Response Syntax
{
'ARN': 'string',
'Name': 'string',
'VersionId': 'string'
}
Response Structure
(dict) --
ARN (string) --
The ARN of the secret for which rotation was canceled.
Name (string) --
The friendly name of the secret for which rotation was canceled.
VersionId (string) --
The unique identifier of the version of the secret that was created during the rotation. This version might not be complete, and should be evaluated for possible deletion. At the very least, you should remove the VersionStage value AWSPENDING to enable this version to be deleted. Failing to clean up a cancelled rotation can block you from successfully starting future rotations.
Modifies the staging labels attached to a version of a secret. Staging labels are used to track a version as it progresses through the secret rotation process. You can attach a staging label to only one version of a secret at a time. If a staging label to be added is already attached to another version, then it is moved--removed from the other version first and then attached to this one. For more information about staging labels, see Staging Labels in the AWS Secrets Manager User Guide.
The staging labels that you specify in the VersionStage parameter are added to the existing list of staging labels--they don't replace it.
You can move the AWSCURRENT staging label to this version by including it in this call.
If this action results in the last label being removed from a version, then the version is considered to be 'deprecated' and can be deleted by Secrets Manager.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:UpdateSecretVersionStage
Related operations
To get the list of staging labels that are currently associated with a version of a secret, use DescribeSecret and examine the SecretVersionsToStages response value.
See also: AWS API Documentation
Request Syntax
client.update_secret_version_stage(
SecretId='string',
VersionStage='string',
RemoveFromVersionId='string',
MoveToVersionId='string'
)
string
[REQUIRED]
Specifies the secret with the version whose list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
string
[REQUIRED]
The list of staging labels to add to this version.
string
(Optional) Specifies the secret version ID of the version that the staging labels are to be removed from.
If you want to move a label to a new version, you do not have to explicitly remove it with this parameter. Adding a label using the MoveToVersionId parameter automatically removes it from the old version. However, if you do include both the "MoveTo" and "RemoveFrom" parameters, then the move is successful only if the staging labels are actually present on the "RemoveFrom" version. If a staging label was on a different version than "RemoveFrom", then the request fails.
string
(Optional) The secret version ID that you want to add the staging labels to.
If any of the staging labels are already attached to a different version of the secret, then they are removed from that version before adding them to this version.
dict
Response Syntax
{
'ARN': 'string',
'Name': 'string'
}
Response Structure
(dict) --
ARN (string) --
The ARN of the secret with the staging labels that were modified.
Name (string) --
The friendly name of the secret with the staging labels that were modified.
Retrieves the contents of the encrypted fields SecretString and SecretBinary from the specified version of a secret.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:GetSecretValue
kms:Decrypt - required only if you use a customer-created 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 create a new version of the secret with different encrypted information, use PutSecretValue.
To retrieve the non-encrypted details for the secret, use DescribeSecret.
See also: AWS API Documentation
Request Syntax
client.get_secret_value(
SecretId='string',
VersionId='string',
VersionStage='string'
)
string
[REQUIRED]
Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
string
Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify this parameter then don't specify VersionStage. If you don't specify either a VersionStage or SecretVersionId then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT.
This value is typically a UUID-type value with 32 hexadecimal digits.
string
Specifies the secret version that you want to retrieve by the staging label attached to the version.
Staging labels are used to keep track of different versions during the rotation process. If you use this parameter then don't specify SecretVersionId. If you don't specify either a VersionStage or SecretVersionId, then the default is to perform the operation on the version with the VersionStage value of AWSCURRENT.
dict
Response Syntax
{
'ARN': 'string',
'Name': 'string',
'VersionId': 'string',
'SecretBinary': b'bytes',
'SecretString': 'string',
'VersionStages': [
'string',
],
'CreatedDate': datetime(2015, 1, 1)
}
Response Structure
(dict) --
ARN (string) --
The ARN of the secret.
Name (string) --
The friendly name of the secret.
VersionId (string) --
The unique identifier of this version of the secret.
SecretBinary (bytes) --
The decrypted part of the protected secret information that was originally provided as binary data in the form of a byte array. The response parameter represents the binary data as a base64-encoded string.
This parameter is not used if the secret is created by the Secrets Manager console.
If you store custom information in this field of the secret, then you must code your Lambda rotation function to parse and interpret whatever you store in the SecretString or SecretBinary fields.
SecretString (string) --
The decrypted part of the protected secret information that was originally provided as a string.
If you create this secret by using the Secrets Manager console then only the SecretString parameter contains data. Secrets Manager stores the information as a JSON structure of key/value pairs that the Lambda rotation function knows how to parse.
If you store custom information in the secret by using the CreateSecret, UpdateSecret, or PutSecretValue API operations instead of the AWS Secrets Manager console, or by using the Other secret type in the console, then you must code your Lambda rotation function to parse and interpret those values.
VersionStages (list) --
A list of all of the staging labels currently attached to this version of the secret.
(string) --
CreatedDate (datetime) --
The date and time that this version of the secret was created.
Removes one or more tags from the specified secret.
This operation is idempotent. If a requested tag is not attached to the secret, no error is returned and the secret metadata is unchanged.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:UntagResource
Related operations
To add one or more tags to the collection attached to a secret, use TagResource.
To view the list of tags attached to a secret, use DescribeSecret.
See also: AWS API Documentation
Request Syntax
client.untag_resource(
SecretId='string',
TagKeys=[
'string',
]
)
string
[REQUIRED]
The identifier for the secret that you want to remove tags from. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
list
[REQUIRED]
A list of tag key names to remove from the secret. You don't specify the value. Both the key and its associated value are removed.
This parameter to the API requires a JSON text string argument. 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.
(string) --
None
Retrieves the details of a secret. It does not include the encrypted fields. Only those fields that are populated with a value are returned in the response.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:DescribeSecret
Related operations
To create a secret, use CreateSecret.
To modify a secret, use UpdateSecret.
To retrieve the encrypted secret information in a version of the secret, use GetSecretValue.
To list all of the secrets in the AWS account, use ListSecrets.
See also: AWS API Documentation
Request Syntax
client.describe_secret(
SecretId='string'
)
string
[REQUIRED]
The identifier of the secret whose details you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
dict
Response Syntax
{
'ARN': 'string',
'Name': 'string',
'Description': 'string',
'KmsKeyId': 'string',
'RotationEnabled': True|False,
'RotationLambdaARN': 'string',
'RotationRules': {
'AutomaticallyAfterDays': 123
},
'LastRotatedDate': datetime(2015, 1, 1),
'LastChangedDate': datetime(2015, 1, 1),
'LastAccessedDate': datetime(2015, 1, 1),
'DeletedDate': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'VersionIdsToStages': {
'string': [
'string',
]
}
}
Response Structure
(dict) --
ARN (string) --
The ARN of the secret.
Name (string) --
The user-provided friendly name of the secret.
Description (string) --
The user-provided description of the secret.
KmsKeyId (string) --
The ARN or alias of the AWS KMS customer master key (CMK) that's used to encrypt the SecretString and SecretBinary fields in each version of the secret. If you don't provide a key, then AWS Secrets Manager defaults to encrypting the secret fields with the default KMS CMK (the one named awssecretsmanager) for this account.
RotationEnabled (boolean) --
Specifies whether automatic rotation is enabled for this secret.
To enable rotation, use RotateSecret with AutomaticallyRotateAfterDays set to a value greater than 0. To disable rotation, use CancelRotateSecret.
RotationLambdaARN (string) --
The ARN of a Lambda function that's invoked by AWS Secrets Manager to rotate the secret either automatically per the schedule or manually by a call to RotateSecret.
RotationRules (dict) --
A structure that contains the rotation configuration for this secret.
AutomaticallyAfterDays (integer) --
Specifies the number of days between automatic scheduled rotations of the secret.
LastRotatedDate (datetime) --
The last date and time that the Secrets Manager rotation process for this secret was invoked.
LastChangedDate (datetime) --
The last date and time that this secret was modified in any way.
LastAccessedDate (datetime) --
The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.
DeletedDate (datetime) --
This value exists if the secret is scheduled for deletion. Some time after the specified date and time, Secrets Manager deletes the secret and all of its versions.
If a secret is scheduled for deletion, then its details, including the encrypted secret information, is not accessible. To cancel a scheduled deletion and restore access, use RestoreSecret.
Tags (list) --
The list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
(dict) --
A structure that contains information about a tag.
Key (string) --
The key identifier, or name, of the tag.
Value (string) --
The string value that's associated with the key of the tag.
VersionIdsToStages (dict) --
A list of all of the currently assigned VersionStage staging labels and the SecretVersionId that each is attached to. Staging labels are used to keep track of the different versions during the rotation process.
(string) --
(list) --
(string) --
Lists all of the versions attached to the specified secret. The output does not include the SecretString or SecretBinary fields. By default, the list includes only versions that have at least one staging label in VersionStage attached.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:ListSecretVersionIds
Related operations
To list the secrets in an account, use ListSecrets.
See also: AWS API Documentation
Request Syntax
client.list_secret_version_ids(
SecretId='string',
MaxResults=123,
NextToken='string',
IncludeDeprecated=True|False
)
string
[REQUIRED]
The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
integer
(Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (isn't null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that AWS Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
string
(Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.
boolean
(Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.
dict
Response Syntax
{
'Versions': [
{
'VersionId': 'string',
'VersionStages': [
'string',
],
'LastAccessedDate': datetime(2015, 1, 1),
'CreatedDate': datetime(2015, 1, 1)
},
],
'NextToken': 'string',
'ARN': 'string',
'Name': 'string'
}
Response Structure
(dict) --
Versions (list) --
The list of the currently available versions of the specified secret.
(dict) --
A structure that contains information about one version of a secret.
VersionId (string) --
The unique version identifier of this version of the secret.
VersionStages (list) --
An array of staging labels that are currently associated with this version of the secret.
(string) --
LastAccessedDate (datetime) --
The date that this version of the secret was last accessed. Note that the resolution of this field is at the date level and does not include the time.
CreatedDate (datetime) --
The date and time this version of the secret was created.
NextToken (string) --
If present in the response, this value indicates that there's more output available than what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null).
ARN (string) --
The Amazon Resource Name (ARN) for the secret.
Name (string) --
The friendly name of the secret.
Lists all of the secrets that are stored by AWS Secrets Manager in the AWS account. To list the versions currently stored for a specific secret, use ListSecretVersionIds. The encrypted fields SecretString and SecretBinary are not included in the output. To get that information, call the GetSecretValue operation.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:ListSecrets
Related operations
To list the versions attached to a secret, use ListSecretVersionIds.
See also: AWS API Documentation
Request Syntax
client.list_secrets(
MaxResults=123,
NextToken='string'
)
integer
(Optional) Limits the number of results that you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (isn't null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that AWS Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.
string
(Optional) Use this parameter in a request if you receive a NextToken response in a previous request that indicates that there's more output available. In a subsequent call, set it to the value of the previous call's NextToken response to indicate where the output should continue from.
dict
Response Syntax
{
'SecretList': [
{
'ARN': 'string',
'Name': 'string',
'Description': 'string',
'KmsKeyId': 'string',
'RotationEnabled': True|False,
'RotationLambdaARN': 'string',
'RotationRules': {
'AutomaticallyAfterDays': 123
},
'LastRotatedDate': datetime(2015, 1, 1),
'LastChangedDate': datetime(2015, 1, 1),
'LastAccessedDate': datetime(2015, 1, 1),
'DeletedDate': datetime(2015, 1, 1),
'Tags': [
{
'Key': 'string',
'Value': 'string'
},
],
'SecretVersionsToStages': {
'string': [
'string',
]
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
SecretList (list) --
A list of the secrets in the account.
(dict) --
A structure that contains the details about a secret. It does not include the encrypted SecretString and SecretBinary values. To get those values, use the GetSecretValue operation.
ARN (string) --
The Amazon Resource Name (ARN) of the secret.
For more information about ARNs in AWS Secrets Manager, see Policy Resources in the AWS Secrets Manager User Guide.
Name (string) --
The friendly name of the secret. You can use forward slashes in the name to represent a path hierarchy. For example, /prod/databases/dbserver1 could represent the secret for a server named dbserver1 in the folder databases in the folder prod.
Description (string) --
The user-provided description of the secret.
KmsKeyId (string) --
The ARN or alias of the AWS KMS customer master key (CMK) that's used to encrypt the SecretString and SecretBinary fields in each version of the secret. If you don't provide a key, then AWS Secrets Manager defaults to encrypting the secret fields with the default KMS CMK (the one named awssecretsmanager) for this account.
RotationEnabled (boolean) --
Indicated whether automatic, scheduled rotation is enabled for this secret.
RotationLambdaARN (string) --
The ARN of an AWS Lambda function that's invoked by AWS Secrets Manager to rotate and expire the secret either automatically per the schedule or manually by a call to RotateSecret.
RotationRules (dict) --
A structure that defines the rotation configuration for the secret.
AutomaticallyAfterDays (integer) --
Specifies the number of days between automatic scheduled rotations of the secret.
LastRotatedDate (datetime) --
The last date and time that the rotation process for this secret was invoked.
LastChangedDate (datetime) --
The last date and time that this secret was modified in any way.
LastAccessedDate (datetime) --
The last date that this secret was accessed. This value is truncated to midnight of the date and therefore shows only the date, not the time.
DeletedDate (datetime) --
The date and time on which this secret was deleted. Not present on active secrets. The secret can be recovered until the number of days in the recovery window has passed, as specified in the RecoveryWindowInDays parameter of the DeleteSecret operation.
Tags (list) --
The list of user-defined tags that are associated with the secret. To add tags to a secret, use TagResource. To remove tags, use UntagResource.
(dict) --
A structure that contains information about a tag.
Key (string) --
The key identifier, or name, of the tag.
Value (string) --
The string value that's associated with the key of the tag.
SecretVersionsToStages (dict) --
A list of all of the currently assigned SecretVersionStage staging labels and the SecretVersionId that each is attached to. Staging labels are used to keep track of the different versions during the rotation process.
(string) --
(list) --
(string) --
NextToken (string) --
If present in the response, this value indicates that there's more output available than what's included in the current response. This can occur even when the response includes no values at all, such as when you ask for a filtered view of a very long list. Use this value in the NextToken request parameter in a subsequent call to the operation to continue processing and get the next part of the output. You should repeat this until the NextToken response element comes back empty (as null).
Configures and starts the asynchronous process of rotating this secret. If you include the configuration parameters, the operation sets those values for the secret and then immediately starts a rotation. If you do not include the configuration parameters, the operation starts a rotation with the values already stored in the secret. After the rotation completes, the protected service and its clients all use the new version of the secret.
This required configuration information includes the ARN of an AWS Lambda function and the time between scheduled rotations. The Lambda rotation function creates a new version of the secret and creates or updates the credentials on the protected service to match. After testing the new credentials, the function marks the new secret with the staging label AWSCURRENT so that your clients all immediately begin to use the new version. For more information about rotating secrets and how to configure a Lambda function to rotate the secrets for your protected service, see Rotating Secrets in AWS Secrets Manager in the AWS Secrets Manager User Guide.
The rotation function must end with the versions of the secret in one of two states:
The AWSPENDING and AWSCURRENT staging labels are attached to the same version of the secret, or
The AWSPENDING staging label is not attached to any version of the secret.
If instead the AWSPENDING staging label is present but is not attached to the same version as AWSCURRENT then any later invocation of RotateSecret assumes that a previous rotation request is still in progress and returns an error.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:RotateSecret
lambda:InvokeFunction (on the function specified in the secret's metadata)
Related operations
To list the secrets in your account, use ListSecrets.
To get the details for a version of a secret, use DescribeSecret.
To create a new version of a secret, use CreateSecret.
To attach staging labels to or remove staging labels from a version of a secret, use UpdateSecretVersionStage.
See also: AWS API Documentation
Request Syntax
client.rotate_secret(
SecretId='string',
ClientRequestToken='string',
RotationLambdaARN='string',
RotationRules={
'AutomaticallyAfterDays': 123
}
)
string
[REQUIRED]
Specifies the secret that you want to rotate. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
string
(Optional) Specifies a unique identifier for the new version of the secret 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 for this parameter. If you don't use the SDK and instead generate a raw HTTP request to the AWS Secrets Manager service endpoint, then you must generate a ClientRequestToken yourself for new versions and include that value in the request.
You only need to specify your own value if you are implementing 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 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 and SecretBinary values are the same as the request, then the request is ignored (the operation is idempotent).
If a version with this value already exists and that version's SecretString and SecretBinary values are different from the request then an error occurs because you cannot modify an existing secret value.
This value becomes the SecretVersionId of the new version.
This field is autopopulated if not provided.
string
(Optional) Specifies the ARN of the Lambda function that can rotate the secret.
dict
A structure that defines the rotation configuration for this secret.
AutomaticallyAfterDays (integer) --
Specifies the number of days between automatic scheduled rotations of the secret.
dict
Response Syntax
{
'ARN': 'string',
'Name': 'string',
'VersionId': 'string'
}
Response Structure
(dict) --
ARN (string) --
The ARN of the secret.
Name (string) --
The friendly name of the secret.
VersionId (string) --
The ID of the new version of the secret created by the rotation started by this request.
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.
If this operation creates the first version for the secret then Secrets Manager automatically attaches the staging label AWSCURRENT to the new version.
If another version of this secret already exists, then this operation does not automatically move any staging labels other than those that you specify in the VersionStages parameter.
This operation is idempotent. If a version with a SecretVersionId with the same value as the ClientRequestToken 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 this operation moves the staging label AWSCURRENT to this version (because you included it in the StagingLabels parameter) then Secrets Manager also automatically moves the staging label AWSPREVIOUS to the version that AWSCURRENT was removed from.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:PutSecretValue
kms:GenerateDataKey - needed only if you use a customer-created KMS key to encrypt the secret. You do not need this permission to use the account's AWS managed CMK for Secrets Manager.
kms:Encrypt - needed only if you use a customer-created 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 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.
See also: AWS API Documentation
Request Syntax
client.put_secret_value(
SecretId='string',
ClientRequestToken='string',
SecretBinary=b'bytes',
SecretString='string',
VersionStages=[
'string',
]
)
string
[REQUIRED]
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.
The secret name can consist of uppercase letters, lowercase letters, digits, and any of the following characters: /_+=.@- Spaces are not permitted.
string
(Optional) Specifies a unique identifier for the new version of the secret.
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 or SecretBinary 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 and SecretBinary 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 SecretVersionId of the new version.
This field is autopopulated if not provided.
bytes
(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 or SecretString must have a value. They cannot both be empty.
This parameter is not accessible if the secret using the Secrets Manager console.
string
(Optional) Specifies text data that you want to encrypt and store in this new version of the secret. Either SecretString or SecretBinary must have a value. 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.
list
(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 AWS Secrets Manager automatically moves the staging label AWSCURRENT to this new version.
(string) --
dict
Response Syntax
{
'ARN': 'string',
'Name': 'string',
'VersionId': 'string',
'VersionStages': [
'string',
]
}
Response Structure
(dict) --
ARN (string) --
The Amazon Resource Name (ARN) for the secret for which you just created a version.
Name (string) --
The friendly name of the secret for which you just created or updated a version.
VersionId (string) --
The unique identifier of the version of the secret you just created or updated.
VersionStages (list) --
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.
(string) --
Cancels the scheduled deletion of a secret by removing the DeletedDate time stamp. This makes the secret accessible to query once again.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:RestoreSecret
Related operations
To delete a secret, use DeleteSecret.
See also: AWS API Documentation
Request Syntax
client.restore_secret(
SecretId='string'
)
string
[REQUIRED]
Specifies the secret that you want to restore from a previously scheduled deletion. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
dict
Response Syntax
{
'ARN': 'string',
'Name': 'string'
}
Response Structure
(dict) --
ARN (string) --
The ARN of the secret that was restored.
Name (string) --
The friendly name of the secret that was restored.
Deletes an entire secret and all of its versions. You can optionally include a recovery window during which you can restore the secret. If you don't provide a recovery window value, the operation defaults to 30 days. Secrets Manager attaches a DeletionDate stamp to the secret that specifies the end of the recovery window. At the end of the recovery window, Secrets Manager deletes the secret permanently.
At any time before recovery period ends, you can use RestoreSecret to remove the DeletionDate and cancel the deletion of the secret.
You cannot access the encrypted secret information in any secret that is scheduled for deletion. If you need to access that information, you can cancel the deletion with RestoreSecret and then retrieve the information.
Minimum permissions
To run this command, you must have the following permissions:
secretsmanager:DeleteSecret
Related operations
To create a secret, use CreateSecret.
To cancel deletion of a version of a secret before the recovery period has expired, use RestoreSecret.
See also: AWS API Documentation
Request Syntax
client.delete_secret(
SecretId='string',
RecoveryWindowInDays=123
)
string
[REQUIRED]
Specifies the secret that you want to delete. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.
integer
(Optional) Specifies the number of days that AWS Secrets Manager waits before it can delete the secret.
This value can range from 7 to 30 days. The default value is 30.
dict
Response Syntax
{
'ARN': 'string',
'Name': 'string',
'DeletionDate': datetime(2015, 1, 1)
}
Response Structure
(dict) --
ARN (string) --
The ARN of the secret that is now scheduled for deletion.
Name (string) --
The friendly name of the secret that is now scheduled for deletion.
DeletionDate (datetime) --
The date and time after which this secret will be deleted by AWS Secrets Manager and is no longer recoverable. This value is the date and time of the delete request plus the number of days specified in RecoveryWindowInDays.