CodePipeline / Client / rollback_stage
rollback_stage#
- CodePipeline.Client.rollback_stage(**kwargs)#
Rolls back a stage execution.
See also: AWS API Documentation
Request Syntax
response = client.rollback_stage( pipelineName='string', stageName='string', targetPipelineExecutionId='string' )
- Parameters:
pipelineName (string) –
[REQUIRED]
The name of the pipeline for which the stage will be rolled back.
stageName (string) –
[REQUIRED]
The name of the stage in the pipeline to be rolled back.
targetPipelineExecutionId (string) –
[REQUIRED]
The pipeline execution ID for the stage to be rolled back to.
- Return type:
dict
- Returns:
Response Syntax
{ 'pipelineExecutionId': 'string' }
Response Structure
(dict) –
pipelineExecutionId (string) –
The execution ID of the pipeline execution for the stage that has been rolled back.
Exceptions
CodePipeline.Client.exceptions.ValidationException
CodePipeline.Client.exceptions.ConflictException
CodePipeline.Client.exceptions.PipelineNotFoundException
CodePipeline.Client.exceptions.PipelineExecutionNotFoundException
CodePipeline.Client.exceptions.PipelineExecutionOutdatedException
CodePipeline.Client.exceptions.StageNotFoundException
CodePipeline.Client.exceptions.UnableToRollbackStageException