Skip to content

rollback_stage 

rollback_stage(
    pipeline_name: PipelineName,
    stage_name: StageName,
    target_pipeline_execution_id: PipelineExecutionId,
    *,
    config_overrides: Optional[CodePipelineClientConfig] = None,
) -> RollbackStageOutput

Rolls back a stage execution.

Parameters:

  • pipeline_name (PipelineName) –

    The name of the pipeline for which the stage will be rolled back.

  • stage_name (StageName) –

    The name of the stage in the pipeline to be rolled back.

  • target_pipeline_execution_id (PipelineExecutionId) –

    The pipeline execution ID for the stage to be rolled back to.

Raises:

  • ConflictException –

    Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.

  • PipelineExecutionNotFoundException –

    The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline.

  • PipelineExecutionOutdatedException –

    The specified pipeline execution is outdated and cannot be used as a target pipeline execution for rollback.

  • PipelineNotFoundException –

    The pipeline was specified in an invalid format or cannot be found.

  • StageNotFoundException –

    The stage was specified in an invalid format or cannot be found.

  • UnableToRollbackStageException –

    Unable to roll back the stage. The cause might be if the pipeline version has changed since the target pipeline execution was deployed, the stage is currently running, or an incorrect target pipeline execution ID was provided.

  • ValidationException –

    The validation was specified in an invalid format.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Source code in docs_src/capo_codepipeline/_services/code_pipeline.py 
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
def rollback_stage(
    self,
    pipeline_name: "capo_codepipeline.types.pipeline_name.PipelineName",
    stage_name: "capo_codepipeline.types.stage_name.StageName",
    target_pipeline_execution_id: "capo_codepipeline.types.pipeline_execution_id.PipelineExecutionId",
    *,
    config_overrides: Optional[CodePipelineClientConfig] = None,
) -> "capo_codepipeline.types.rollback_stage_output.RollbackStageOutput":
    """<p>Rolls back a stage execution.</p>

    Args:
        pipeline_name: <p>The name of the pipeline for which the stage will be rolled back. </p>
        stage_name: <p>The name of the stage in the pipeline to be rolled back. </p>
        target_pipeline_execution_id: <p>The pipeline execution ID for the stage to be rolled back to. </p>

    Raises:
        capo_codepipeline.errors.conflict_exception.ConflictException: <p>Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.</p>
        capo_codepipeline.errors.pipeline_execution_not_found_exception.PipelineExecutionNotFoundException: <p>The pipeline execution was specified in an invalid format or cannot be found, or an execution ID does not belong to the specified pipeline. </p>
        capo_codepipeline.errors.pipeline_execution_outdated_exception.PipelineExecutionOutdatedException: <p>The specified pipeline execution is outdated and cannot be used as a target pipeline execution for rollback.</p>
        capo_codepipeline.errors.pipeline_not_found_exception.PipelineNotFoundException: <p>The pipeline was specified in an invalid format or cannot be found.</p>
        capo_codepipeline.errors.stage_not_found_exception.StageNotFoundException: <p>The stage was specified in an invalid format or cannot be found.</p>
        capo_codepipeline.errors.unable_to_rollback_stage_exception.UnableToRollbackStageException: <p>Unable to roll back the stage. The cause might be if the pipeline version has changed since the target pipeline execution was deployed, the stage is currently running, or an incorrect target pipeline execution ID was provided.</p>
        capo_codepipeline.errors.validation_exception.ValidationException: <p>The validation was specified in an invalid format.</p>
        capo_codepipeline.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_codepipeline.types.rollback_stage_input.RollbackStageInput]",
    ) -> OperationResponse[
        "capo_codepipeline.types.rollback_stage_output.RollbackStageOutput"
    ]:
        import capo_codepipeline._operations.code_pipeline_20150709.rollback_stage

        output, http_response = (
            capo_codepipeline._operations.code_pipeline_20150709.rollback_stage.rollback_stage(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("RollbackStage")
    )
    input_: capo_codepipeline.types.rollback_stage_input.RollbackStageInput = {
        "pipeline_name": pipeline_name,
        "stage_name": stage_name,
        "target_pipeline_execution_id": target_pipeline_execution_id,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output