AmazonSecretsManagerClient.UpdateSecretVersionStage Method (UpdateSecretVersionStageRequest)

Modifies the staging labels attached to a version of a secret. Secrets Manager uses staging labels to track a version as it progresses through the secret rotation process. Each staging label can be attached to only one version at a time. To add a staging label to a version when it is already attached to another version, Secrets Manager first removes it from the other version first and then attaches it to this one. For more information about versions and staging labels, see Concepts: Version.

The staging labels that you specify in the VersionStage parameter are added to the existing list of staging labels for the version.

You can move the AWSCURRENT staging label to this version by including it in this call.

Whenever you move AWSCURRENT, Secrets Manager automatically moves the label AWSPREVIOUS to the version that AWSCURRENT was removed from.

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.

Secrets Manager generates a CloudTrail log entry when you call this action. Do not include sensitive information in request parameters because it might be logged. For more information, see Logging Secrets Manager events with CloudTrail.

Required permissions: secretsmanager:UpdateSecretVersionStage. For more information, see IAM policy actions for Secrets Manager and Authentication and access control in Secrets Manager.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to UpdateSecretVersionStageAsync.

Namespace: Amazon.SecretsManager
Assembly: AWSSDK.SecretsManager.dll
Version: 3.x.y.z

Syntax

public virtual UpdateSecretVersionStageResponse UpdateSecretVersionStage(
         UpdateSecretVersionStageRequest request
)

Parameters

request: Type: Amazon.SecretsManager.Model.UpdateSecretVersionStageRequest

Container for the necessary parameters to execute the UpdateSecretVersionStage service method.

Return Value

Type: UpdateSecretVersionStageResponse

The response from the UpdateSecretVersionStage service method, as returned by SecretsManager.

Exceptions

Exception	Condition
InternalServiceErrorException	An error occurred on the server side.
InvalidParameterException	The parameter name or value is invalid.
InvalidRequestException	A parameter value is not valid for the current state of the resource. Possible causes: The secret is scheduled for deletion. You tried to enable rotation on a secret that doesn't already have a Lambda function ARN configured and you didn't include such an ARN as a parameter in this call. The secret is managed by another service, and you must use that service to update it. For more information, see Secrets managed by other Amazon Web Services services.
LimitExceededException	The request failed because it would exceed one of the Secrets Manager quotas.
ResourceNotFoundException	Secrets Manager can't find the resource that you asked for.

Examples

The following example shows you how to add a staging label to a version of a secret. You can review the results by running the operation ListSecretVersionIds and viewing the VersionStages response field for the affected version.

To add a staging label attached to a version of a secret


var client = new AmazonSecretsManagerClient();
var response = client.UpdateSecretVersionStage(new UpdateSecretVersionStageRequest 
{
    MoveToVersionId = "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1",
    SecretId = "MyTestDatabaseSecret",
    VersionStage = "STAGINGLABEL1"
});

string arn = response.ARN;
string name = response.Name;

The following example shows you how to delete a staging label that is attached to a version of a secret. You can review the results by running the operation ListSecretVersionIds and viewing the VersionStages response field for the affected version.

To delete a staging label attached to a version of a secret


var client = new AmazonSecretsManagerClient();
var response = client.UpdateSecretVersionStage(new UpdateSecretVersionStageRequest 
{
    RemoveFromVersionId = "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1",
    SecretId = "MyTestDatabaseSecret",
    VersionStage = "STAGINGLABEL1"
});

string arn = response.ARN;
string name = response.Name;

The following example shows you how to move a staging label that is attached to one version of a secret to a different version. You can review the results by running the operation ListSecretVersionIds and viewing the VersionStages response field for the affected version.

To move a staging label from one version of a secret to another


var client = new AmazonSecretsManagerClient();
var response = client.UpdateSecretVersionStage(new UpdateSecretVersionStageRequest 
{
    MoveToVersionId = "EXAMPLE2-90ab-cdef-fedc-ba987SECRET2",
    RemoveFromVersionId = "EXAMPLE1-90ab-cdef-fedc-ba987SECRET1",
    SecretId = "MyTestDatabaseSecret",
    VersionStage = "AWSCURRENT"
});

string arn = response.ARN;
string name = response.Name;

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

AmazonSecretsManagerClient.UpdateSecretVersionStage (UpdateSecretVersionStageRequest)

Method