updateSecretVersionStage method

Future<UpdateSecretVersionStageResponse> updateSecretVersionStage({ required String secretId, required String versionStage, String? moveToVersionId, String? removeFromVersionId, })

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.

May throw ResourceNotFoundException. May throw InvalidParameterException. May throw InvalidRequestException. May throw LimitExceededException. May throw InternalServiceError.

Parameter secretId : Specifies the secret with the version with the list of staging labels you want to modify. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

Parameter versionStage : The staging label to add to this version.

Parameter moveToVersionId : (Optional) The secret version ID that you want to add the staging label. If you want to remove a label from a version, then do not specify this parameter.

If the staging label is already attached to a different version of the secret, then you must also specify the RemoveFromVersionId parameter.

Parameter removeFromVersionId : Specifies the secret version ID of the version that the staging label is to be removed from. If the staging label you are trying to attach to one version is already attached to a different version, then you must include this parameter and specify the version that the label is to be removed from. If the label is attached and you either do not specify this parameter, or the version ID does not match, then the operation fails.

Implementation

Future<UpdateSecretVersionStageResponse> updateSecretVersionStage({
  required String secretId,
  required String versionStage,
  String? moveToVersionId,
  String? removeFromVersionId,
}) async {
  ArgumentError.checkNotNull(secretId, 'secretId');
  _s.validateStringLength(
    'secretId',
    secretId,
    1,
    2048,
    isRequired: true,
  );
  ArgumentError.checkNotNull(versionStage, 'versionStage');
  _s.validateStringLength(
    'versionStage',
    versionStage,
    1,
    256,
    isRequired: true,
  );
  _s.validateStringLength(
    'moveToVersionId',
    moveToVersionId,
    32,
    64,
  );
  _s.validateStringLength(
    'removeFromVersionId',
    removeFromVersionId,
    32,
    64,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'secretsmanager.UpdateSecretVersionStage'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'SecretId': secretId,
      'VersionStage': versionStage,
      if (moveToVersionId != null) 'MoveToVersionId': moveToVersionId,
      if (removeFromVersionId != null)
        'RemoveFromVersionId': removeFromVersionId,
    },
  );

  return UpdateSecretVersionStageResponse.fromJson(jsonResponse.body);
}