update_secret_version_stage async ¶

async def update_secret_version_stage(
    self,
    secret_id: "capo_secrets_manager.types.secret_id_type.SecretIdType",
    version_stage: "capo_secrets_manager.types.secret_version_stage_type.SecretVersionStageType",
    *,
    config_overrides: Optional[AsyncSecretsManagerClientConfig] = None,
    remove_from_version_id: Optional[
        "capo_secrets_manager.types.secret_version_id_type.SecretVersionIdType"
    ] = None,
    move_to_version_id: Optional[
        "capo_secrets_manager.types.secret_version_id_type.SecretVersionIdType"
    ] = None,
) -> "capo_secrets_manager.types.update_secret_version_stage_response.UpdateSecretVersionStageResponse":
    """<p>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 <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/getting-started.html#term_version">Concepts: Version</a>. </p> <p>The staging labels that you specify in the <code>VersionStage</code> parameter are added to the existing list of staging labels for the version. </p> <p>You can move the <code>AWSCURRENT</code> staging label to this version by including it in this call.</p> <note> <p>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.</p> </note> <p>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.</p> <p>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 <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/retrieve-ct-entries.html">Logging Secrets Manager events with CloudTrail</a>.</p> <p> <b>Required permissions: </b> <code>secretsmanager:UpdateSecretVersionStage</code>. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/reference_iam-permissions.html#reference_iam-permissions_actions"> IAM policy actions for Secrets Manager</a> and <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/auth-and-access.html">Authentication and access control in Secrets Manager</a>. </p>

    Args:
        secret_id: <p>The ARN or the name of the secret with the version and staging labelsto modify.</p> <p>For an ARN, we recommend that you specify a complete ARN rather than a partial ARN. See <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/troubleshoot.html#ARN_secretnamehyphen">Finding a secret from a partial ARN</a>.</p>
        version_stage: <p>The staging label to add to this version.</p>
        remove_from_version_id: <p>The 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.</p>
        move_to_version_id: <p>The ID of the version to add the staging label to. To remove a label from a version, then do not specify this parameter.</p> <p>If the staging label is already attached to a different version of the secret, then you must also specify the <code>RemoveFromVersionId</code> parameter. </p>

    Raises:
        capo_secrets_manager.errors.internal_service_error.InternalServiceError: <p>An error occurred on the server side.</p>
        capo_secrets_manager.errors.invalid_parameter_exception.InvalidParameterException: <p>The parameter name or value is invalid.</p>
        capo_secrets_manager.errors.invalid_request_exception.InvalidRequestException: <p>A parameter value is not valid for the current state of the resource.</p> <p>Possible causes:</p> <ul> <li> <p>The secret is scheduled for deletion.</p> </li> <li> <p>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. </p> </li> <li> <p>The secret is managed by another service, and you must use that service to update it. For more information, see <a href="https://docs.aws.amazon.com/secretsmanager/latest/userguide/service-linked-secrets.html">Secrets managed by other Amazon Web Services services</a>.</p> </li> </ul>
        capo_secrets_manager.errors.limit_exceeded_exception.LimitExceededException: <p>The request failed because it would exceed one of the Secrets Manager quotas.</p>
        capo_secrets_manager.errors.resource_not_found_exception.ResourceNotFoundException: <p>Secrets Manager can't find the resource that you asked for.</p>
        capo_secrets_manager.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To add a staging label attached to a version of a secret
        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.

        >>> await client.update_secret_version_stage(secret_id='MyTestDatabaseSecret', version_stage='STAGINGLABEL1', move_to_version_id='EXAMPLE1-90ab-cdef-fedc-ba987SECRET1')
        To delete a staging label attached to a version of a secret
        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.

        >>> await client.update_secret_version_stage(secret_id='MyTestDatabaseSecret', version_stage='STAGINGLABEL1', remove_from_version_id='EXAMPLE1-90ab-cdef-fedc-ba987SECRET1')
        To move a staging label from one version of a secret to another
        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.

        >>> await client.update_secret_version_stage(secret_id='MyTestDatabaseSecret', version_stage='AWSCURRENT', remove_from_version_id='EXAMPLE1-90ab-cdef-fedc-ba987SECRET1', move_to_version_id='EXAMPLE2-90ab-cdef-fedc-ba987SECRET2')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_secrets_manager.types.update_secret_version_stage_request.UpdateSecretVersionStageRequest]",
    ) -> AsyncOperationResponse[
        "capo_secrets_manager.types.update_secret_version_stage_response.UpdateSecretVersionStageResponse"
    ]:
        import capo_secrets_manager._operations.secretsmanager.update_secret_version_stage

        (
            output,
            http_response,
        ) = await capo_secrets_manager._operations.secretsmanager.update_secret_version_stage.async_update_secret_version_stage(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateSecretVersionStage")
    )
    input_: capo_secrets_manager.types.update_secret_version_stage_request.UpdateSecretVersionStageRequest = {
        "secret_id": secret_id,
        "version_stage": version_stage,
    }
    if remove_from_version_id is not None:
        input_["remove_from_version_id"] = remove_from_version_id
    if move_to_version_id is not None:
        input_["move_to_version_id"] = move_to_version_id

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output