SecretsManagerClient Class

Member Function Documentation

SecretsManagerClient::SecretsManagerClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

Constructs a SecretsManagerClient object.

The new client object will region, credentials, and manager for network operations.

The new object will be owned by parent, if set.

SecretsManagerClient::SecretsManagerClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)

This function overloads SecretsManagerClient().

This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).

See also QtAws::Core::AwsEndpoint::getEndpoint.

[slot] CancelRotateSecretResponse *SecretsManagerClient::cancelRotateSecret(const CancelRotateSecretRequest &request)

Sends request to the SecretsManagerClient service, and returns a pointer to an CancelRotateSecretResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Disables automatic scheduled rotation and cancels the rotation of a secret if one is currently in

progress>

To re-enable scheduled rotation, call <a>RotateSecret</a> with <code>AutomaticallyRotateAfterDays</code> set to a value greater than 0. This will immediately rotate your secret and then enable the automatic

schedule> <note>

If you cancel a rotation that is in progress, it can leave the <code>VersionStage</code> labels in an unexpected state. Depending on what step of the rotation was in progress, you might need to remove the staging label <code>AWSPENDING</code> from the partially created version, specified by the <code>SecretVersionId</code> response value. You should also evaluate the partially rotated new version to see if it should be deleted, which you can do by removing all staging labels from the new version's <code>VersionStage</code>

field> </note>

To successfully start a rotation, the staging label <code>AWSPENDING</code> must be in one of the following

states> <ul> <li>

Not be attached to any version at

al> </li> <li>

Attached to the same version as the staging label <code>AWSCURRENT</code>

</p </li> </ul>

If the staging label <code>AWSPENDING</code> is attached to a different version than the version with <code>AWSCURRENT</code> then the attempt to rotate

fails>

<b>Minimum permissions</b>

</p

To run this command, you must have the following

permissions> <ul> <li>

secretsmanager:CancelRotateSecre> </li> </ul>

<b>Related operations</b>

</p <ul> <li>

To configure rotation for a secret or to manually trigger a rotation, use

<a>RotateSecret</a>> </li> <li>

To get the rotation configuration details for a secret, use

<a>DescribeSecret</a>> </li> <li>

To list all of the currently available secrets, use

<a>ListSecrets</a>> </li> <li>

To list all of the versions currently associated with a secret, use

[slot] CreateSecretResponse *SecretsManagerClient::createSecret(const CreateSecretRequest &request)

Sends request to the SecretsManagerClient service, and returns a pointer to an CreateSecretResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Creates a new secret. A secret in 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 <code>SecretVersionsToStages</code> 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 either the <code>SecretString</code> parameter or binary data in the <code>SecretBinary</code> parameter, but not both. If you include <code>SecretString</code> or <code>SecretBinary</code> then Secrets Manager also creates an initial secret version and automatically attaches the staging label <code>AWSCURRENT</code> to the new

version> <note> <ul> <li>

If you call an operation that needs to encrypt or decrypt the <code>SecretString</code> or <code>SecretBinary</code> for a secret in the same account as the calling user and that secret doesn't specify a KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias <code>aws/secretsmanager</code>. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS having to create the account's AWS-managed CMK, it can result in a one-time significant delay in returning the

result> </li> <li>

If the secret is 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 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 <code>KMSKeyId</code>. If you call an API that must encrypt or decrypt <code>SecretString</code> or <code>SecretBinary</code> using credentials from a different account then the 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> </li> </ul> </note>

</p

<b>Minimum permissions</b>

</p

To run this command, you must have the following

permissions> <ul> <li>

secretsmanager:CreateSecre> </li> <li>

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> </li> <li>

kms:Decrypt - 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> </li> </ul>

<b>Related operations</b>

</p <ul> <li>

To delete a secret, use

<a>DeleteSecret</a>> </li> <li>

To modify an existing secret, use

<a>UpdateSecret</a>> </li> <li>

To create a new version of a secret, use

<a>PutSecretValue</a>> </li> <li>

To retrieve the encrypted secure string and secure binary values, use

<a>GetSecretValue</a>> </li> <li>

To retrieve all other details for a secret, use <a>DescribeSecret</a>. This does not include the encrypted secure string and secure binary

values> </li> <li>

To retrieve the list of secret versions associated with the current secret, use <a>DescribeSecret</a> and examine the <code>SecretVersionsToStages</code> response

[slot] DeleteSecretResponse *SecretsManagerClient::deleteSecret(const DeleteSecretRequest &request)

Sends request to the SecretsManagerClient service, and returns a pointer to an DeleteSecretResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 specify a recovery window value, the operation defaults to 30 days. Secrets Manager attaches a <code>DeletionDate</code> 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 window ends, you can use <a>RestoreSecret</a> to remove the <code>DeletionDate</code> 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 must cancel the deletion with <a>RestoreSecret</a> and then retrieve the

information> <note> <ul> <li>

There is no explicit operation to delete a version of a secret. Instead, remove all staging labels from the <code>VersionStage</code> field of a version. That marks the version as deprecated and allows Secrets Manager to delete it as needed. Versions that do not have any staging labels do not show up in <a>ListSecretVersionIds</a> unless you specify

<code>IncludeDeprecated</code>> </li> <li>

The permanent secret deletion at the end of the waiting period is performed as a background task with low priority. There is no guarantee of a specific time after the recovery window for the actual delete operation to

occur> </li> </ul> </note>

<b>Minimum permissions</b>

</p

To run this command, you must have the following

permissions> <ul> <li>

secretsmanager:DeleteSecre> </li> </ul>

<b>Related operations</b>

</p <ul> <li>

To create a secret, use

<a>CreateSecret</a>> </li> <li>

To cancel deletion of a version of a secret before the recovery window has expired, use

[slot] DescribeSecretResponse *SecretsManagerClient::describeSecret(const DescribeSecretRequest &request)

Sends request to the SecretsManagerClient service, and returns a pointer to an DescribeSecretResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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.

</p

<b>Minimum permissions</b>

</p

To run this command, you must have the following

permissions> <ul> <li>

secretsmanager:DescribeSecre> </li> </ul>

<b>Related operations</b>

</p <ul> <li>

To create a secret, use

<a>CreateSecret</a>> </li> <li>

To modify a secret, use

<a>UpdateSecret</a>> </li> <li>

To retrieve the encrypted secret information in a version of the secret, use

<a>GetSecretValue</a>> </li> <li>

To list all of the secrets in the AWS account, use

[slot] GetRandomPasswordResponse *SecretsManagerClient::getRandomPassword(const GetRandomPasswordRequest &request)

Sends request to the SecretsManagerClient service, and returns a pointer to an GetRandomPasswordResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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>

<b>Minimum permissions</b>

</p

To run this command, you must have the following

permissions> <ul> <li>

[slot] GetSecretValueResponse *SecretsManagerClient::getSecretValue(const GetSecretValueRequest &request)

Sends request to the SecretsManagerClient service, and returns a pointer to an GetSecretValueResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Retrieves the contents of the encrypted fields <code>SecretString</code> or <code>SecretBinary</code> from the specified version of a secret, whichever contains

content>

<b>Minimum permissions</b>

</p

To run this command, you must have the following

permissions> <ul> <li>

secretsmanager:GetSecretValu> </li> <li>

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> </li> </ul>

<b>Related operations</b>

</p <ul> <li>

To create a new version of the secret with different encrypted information, use

<a>PutSecretValue</a>> </li> <li>

To retrieve the non-encrypted details for the secret, use

[slot] ListSecretVersionIdsResponse *SecretsManagerClient::listSecretVersionIds(const ListSecretVersionIdsRequest &request)

Sends request to the SecretsManagerClient service, and returns a pointer to an ListSecretVersionIdsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists all of the versions attached to the specified secret. The output does not include the <code>SecretString</code> or <code>SecretBinary</code> fields. By default, the list includes only versions that have at least one staging label in <code>VersionStage</code>

attached> <note>

Always check the <code>NextToken</code> response parameter when calling any of the <code>List*</code> operations. These operations can occasionally return an empty or shorter than expected list of results even when there are more results available. When this happens, the <code>NextToken</code> response parameter contains a value to pass to the next call to the same API to request the next part of the

list> </note>

<b>Minimum permissions</b>

</p

To run this command, you must have the following

permissions> <ul> <li>

secretsmanager:ListSecretVersionId> </li> </ul>

<b>Related operations</b>

</p <ul> <li>

To list the secrets in an account, use

[slot] ListSecretsResponse *SecretsManagerClient::listSecrets(const ListSecretsRequest &request)

Sends request to the SecretsManagerClient service, and returns a pointer to an ListSecretsResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Lists all of the secrets that are stored by Secrets Manager in the AWS account. To list the versions currently stored for a specific secret, use <a>ListSecretVersionIds</a>. The encrypted fields <code>SecretString</code> and <code>SecretBinary</code> are not included in the output. To get that information, call the <a>GetSecretValue</a>

operation> <note>

Always check the <code>NextToken</code> response parameter when calling any of the <code>List*</code> operations. These operations can occasionally return an empty or shorter than expected list of results even when there are more results available. When this happens, the <code>NextToken</code> response parameter contains a value to pass to the next call to the same API to request the next part of the

list> </note>

<b>Minimum permissions</b>

</p

To run this command, you must have the following

permissions> <ul> <li>

secretsmanager:ListSecret> </li> </ul>

<b>Related operations</b>

</p <ul> <li>

To list the versions attached to a secret, use

[slot] PutSecretValueResponse *SecretsManagerClient::putSecretValue(const PutSecretValueRequest &request)

Sends request to the SecretsManagerClient service, and returns a pointer to an PutSecretValueResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <code>SecretString</code> value or a new <code>SecretBinary</code> value. You can also specify the staging labels that are initially attached to the new

version> <note>

The Secrets Manager console uses only the <code>SecretString</code> field. To add binary data to a secret with the <code>SecretBinary</code> field you must use the AWS CLI or one of the AWS

SDKs> </note> <ul> <li>

If this operation creates the first version for the secret then Secrets Manager automatically attaches the staging label <code>AWSCURRENT</code> to the new

version> </li> <li>

If another version of this secret already exists, then this operation does not automatically move any staging labels other than those that you explicitly specify in the <code>VersionStages</code>

parameter> </li> <li>

If this operation moves the staging label <code>AWSCURRENT</code> from another version to this version (because you included it in the <code>StagingLabels</code> parameter) then Secrets Manager also automatically moves the staging label <code>AWSPREVIOUS</code> to the version that <code>AWSCURRENT</code> was removed

from> </li> <li>

This operation is idempotent. If a version with a <code>SecretVersionId</code> with the same value as the <code>ClientRequestToken</code> 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> </li> </ul> <note> <ul> <li>

If you call an operation that needs to encrypt or decrypt the <code>SecretString</code> or <code>SecretBinary</code> for a secret in the same account as the calling user and that secret doesn't specify a KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias <code>aws/secretsmanager</code>. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS having to create the account's AWS-managed CMK, it can result in a one-time significant delay in returning the

result> </li> <li>

If the secret is 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 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 <code>KMSKeyId</code>. If you call an API that must encrypt or decrypt <code>SecretString</code> or <code>SecretBinary</code> using credentials from a different account then the 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> </li> </ul> </note>

<b>Minimum permissions</b>

</p

To run this command, you must have the following

permissions> <ul> <li>

secretsmanager:PutSecretValu> </li> <li>

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> </li> <li>

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> </li> </ul>

<b>Related operations</b>

</p <ul> <li>

To retrieve the encrypted value you store in the version of a secret, use

<a>GetSecretValue</a>> </li> <li>

To create a secret, use

<a>CreateSecret</a>> </li> <li>

To get the details for a secret, use

<a>DescribeSecret</a>> </li> <li>

To list the versions attached to a secret, use

[slot] RestoreSecretResponse *SecretsManagerClient::restoreSecret(const RestoreSecretRequest &request)

Sends request to the SecretsManagerClient service, and returns a pointer to an RestoreSecretResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Cancels the scheduled deletion of a secret by removing the <code>DeletedDate</code> time stamp. This makes the secret accessible to query once

again>

<b>Minimum permissions</b>

</p

To run this command, you must have the following

permissions> <ul> <li>

secretsmanager:RestoreSecre> </li> </ul>

<b>Related operations</b>

</p <ul> <li>

To delete a secret, use

[slot] RotateSecretResponse *SecretsManagerClient::rotateSecret(const RotateSecretRequest &request)

Sends request to the SecretsManagerClient service, and returns a pointer to an RotateSecretResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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.

</p

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 <code>AWSCURRENT</code> 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 <a href="http://docs.aws.amazon.com/secretsmanager/latest/userguide/rotating-secrets.html">Rotating Secrets in AWS Secrets Manager</a> in the <i>AWS Secrets Manager User

Guide</i>>

The rotation function must end with the versions of the secret in one of two

states> <ul> <li>

The <code>AWSPENDING</code> and <code>AWSCURRENT</code> staging labels are attached to the same version of the secret,

o> </li> <li>

The <code>AWSPENDING</code> staging label is not attached to any version of the

secret> </li> </ul>

If instead the <code>AWSPENDING</code> staging label is present but is not attached to the same version as <code>AWSCURRENT</code> then any later invocation of <code>RotateSecret</code> assumes that a previous rotation request is still in progress and returns an

error>

<b>Minimum permissions</b>

</p

To run this command, you must have the following

permissions> <ul> <li>

secretsmanager:RotateSecre> </li> <li>

lambda:InvokeFunction (on the function specified in the secret's

metadata> </li> </ul>

<b>Related operations</b>

</p <ul> <li>

To list the secrets in your account, use

<a>ListSecrets</a>> </li> <li>

To get the details for a version of a secret, use

<a>DescribeSecret</a>> </li> <li>

To create a new version of a secret, use

<a>CreateSecret</a>> </li> <li>

To attach staging labels to or remove staging labels from a version of a secret, use

[slot] TagResourceResponse *SecretsManagerClient::tagResource(const TagResourceRequest &request)

Sends request to the SecretsManagerClient service, and returns a pointer to an TagResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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

<a>UntagResource</a>>

The following basic restrictions apply to

tags> <ul> <li>

Maximum number of tags per

secret—5> </li> <li>

Maximum key length—127 Unicode characters in

UTF-> </li> <li>

Maximum value length—255 Unicode characters in

UTF-> </li> <li>

Tag keys and values are case

sensitive> </li> <li>

Do not use the <code>aws:</code> 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> </li> <li>

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: + - = . _ : /

@> </li> </ul> <b>

If you use tags as part of your security strategy, then adding or removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied

error> </b>

<b>Minimum permissions</b>

</p

To run this command, you must have the following

permissions> <ul> <li>

secretsmanager:TagResourc> </li> </ul>

<b>Related operations</b>

</p <ul> <li>

To remove one or more tags from the collection attached to a secret, use

<a>UntagResource</a>> </li> <li>

To view the list of tags attached to a secret, use

[slot] UntagResourceResponse *SecretsManagerClient::untagResource(const UntagResourceRequest &request)

Sends request to the SecretsManagerClient service, and returns a pointer to an UntagResourceResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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> <b>

If you use tags as part of your security strategy, then removing a tag can change permissions. If successfully completing this operation would result in you losing your permissions for this secret, then the operation is blocked and returns an Access Denied

error> </b>

<b>Minimum permissions</b>

</p

To run this command, you must have the following

permissions> <ul> <li>

secretsmanager:UntagResourc> </li> </ul>

<b>Related operations</b>

</p <ul> <li>

To add one or more tags to the collection attached to a secret, use

<a>TagResource</a>> </li> <li>

To view the list of tags attached to a secret, use

[slot] UpdateSecretResponse *SecretsManagerClient::updateSecret(const UpdateSecretRequest &request)

Sends request to the SecretsManagerClient service, and returns a pointer to an UpdateSecretResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

Modifies many of the details of a secret. If you include a <code>ClientRequestToken</code> and either <code>SecretString</code> or <code>SecretBinary</code> then it also creates a new version attached to the

secret>

To modify the rotation configuration of a secret, use <a>RotateSecret</a>

instead> <note>

The Secrets Manager console uses only the <code>SecretString</code> 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> </note> <ul> <li>

If a version with a <code>SecretVersionId</code> with the same value as the <code>ClientRequestToken</code> parameter already exists, the operation generates an error. You cannot modify an existing version, you can only create new

ones> </li> <li>

If you include <code>SecretString</code> or <code>SecretBinary</code> to create a new secret version, Secrets Manager automatically attaches the staging label <code>AWSCURRENT</code> to the new version.

</p </li> </ul> <note> <ul> <li>

If you call an operation that needs to encrypt or decrypt the <code>SecretString</code> or <code>SecretBinary</code> for a secret in the same account as the calling user and that secret doesn't specify a KMS encryption key, Secrets Manager uses the account's default AWS managed customer master key (CMK) with the alias <code>aws/secretsmanager</code>. If this key doesn't already exist in your account then Secrets Manager creates it for you automatically. All users in the same AWS account automatically have access to use the default CMK. Note that if an Secrets Manager API call results in AWS having to create the account's AWS-managed CMK, it can result in a one-time significant delay in returning the

result> </li> <li>

If the secret is 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 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 <code>KMSKeyId</code>. If you call an API that must encrypt or decrypt <code>SecretString</code> or <code>SecretBinary</code> using credentials from a different account then the 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> </li> </ul> </note>

<b>Minimum permissions</b>

</p

To run this command, you must have the following

permissions> <ul> <li>

secretsmanager:UpdateSecre> </li> <li>

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> </li> <li>

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> </li> </ul>

<b>Related operations</b>

</p <ul> <li>

To create a new secret, use

<a>CreateSecret</a>> </li> <li>

To add only a new version to an existing secret, use

<a>PutSecretValue</a>> </li> <li>

To get the details for a secret, use

<a>DescribeSecret</a>> </li> <li>

To list the versions contained in a secret, use

[slot] UpdateSecretVersionStageResponse *SecretsManagerClient::updateSecretVersionStage(const UpdateSecretVersionStageRequest &request)

Sends request to the SecretsManagerClient service, and returns a pointer to an UpdateSecretVersionStageResponse object to track the result.

Note: The caller is to take responsbility for the resulting pointer.

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 <a href="http://docs.aws.amazon.com/secretsmanager/latest/userguide/terms-concepts.html#term_staging-label">Staging Labels</a> in the <i>AWS Secrets Manager User Guide</i>.

</p

The staging labels that you specify in the <code>VersionStage</code> parameter are added to the existing list of staging labels--they don't replace

it>

You can move the <code>AWSCURRENT</code> staging label to this version by including it in this

call> <note>

Whenever you move <code>AWSCURRENT</code>, Secrets Manager automatically moves the label <code>AWSPREVIOUS</code> to the version that <code>AWSCURRENT</code> was removed

from> </note>

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>

<b>Minimum permissions</b>

</p

To run this command, you must have the following

permissions> <ul> <li>

secretsmanager:UpdateSecretVersionStag> </li> </ul>

<b>Related operations</b>

</p <ul> <li>

To get the list of staging labels that are currently associated with a version of a secret, use <code> <a>DescribeSecret</a> </code> and examine the <code>SecretVersionsToStages</code> response