:doc:`CodePipeline <../../codepipeline>` / Client / rollback_stage

**************
rollback_stage
**************



.. py:method:: CodePipeline.Client.rollback_stage(**kwargs)

  

  Rolls back a stage execution.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/codepipeline-2015-07-09/RollbackStage>`_  


  **Request Syntax**
  ::

    response = client.rollback_stage(
        pipelineName='string',
        stageName='string',
        targetPipelineExecutionId='string'
    )
    
  :type pipelineName: string
  :param pipelineName: **[REQUIRED]** 

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

    

  
  :type stageName: string
  :param stageName: **[REQUIRED]** 

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

    

  
  :type targetPipelineExecutionId: string
  :param targetPipelineExecutionId: **[REQUIRED]** 

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

    

  
  
  :rtype: 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**
  
  *   :py:class:`CodePipeline.Client.exceptions.ValidationException`

  
  *   :py:class:`CodePipeline.Client.exceptions.ConflictException`

  
  *   :py:class:`CodePipeline.Client.exceptions.PipelineNotFoundException`

  
  *   :py:class:`CodePipeline.Client.exceptions.PipelineExecutionNotFoundException`

  
  *   :py:class:`CodePipeline.Client.exceptions.PipelineExecutionOutdatedException`

  
  *   :py:class:`CodePipeline.Client.exceptions.StageNotFoundException`

  
  *   :py:class:`CodePipeline.Client.exceptions.UnableToRollbackStageException`

  