CodePipeline / Client / stop_pipeline_execution

stop_pipeline_execution

CodePipeline.Client.stop_pipeline_execution(**kwargs)

Stops the specified pipeline execution. You choose to either stop the pipeline execution by completing in-progress actions without starting subsequent actions, or by abandoning in-progress actions. While completing or abandoning in-progress actions, the pipeline execution is in a Stopping state. After all in-progress actions are completed or abandoned, the pipeline execution is in a Stopped state.

See also: AWS API Documentation

Request Syntax

response = client.stop_pipeline_execution(
    pipelineName='string',
    pipelineExecutionId='string',
    abandon=True|False,
    reason='string'
)

Parameters:

• pipelineName (string) –

  [REQUIRED]

  The name of the pipeline to stop.

• pipelineExecutionId (string) –

  [REQUIRED]

  The ID of the pipeline execution to be stopped in the current stage. Use the GetPipelineState action to retrieve the current pipelineExecutionId.

• abandon (boolean) –

  Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.

  Note

  This option can lead to failed or out-of-sequence tasks.

• reason (string) – Use this option to enter comments, such as the reason the pipeline was stopped.

Return type:

dict

Returns:

Response Syntax

{
    'pipelineExecutionId': 'string'
}

Response Structure

• (dict) –

  • pipelineExecutionId (string) –

    The unique system-generated ID of the pipeline execution that was stopped.

Exceptions

• CodePipeline.Client.exceptions.ValidationException

• CodePipeline.Client.exceptions.ConflictException

• CodePipeline.Client.exceptions.PipelineNotFoundException

• CodePipeline.Client.exceptions.PipelineExecutionNotStoppableException

• CodePipeline.Client.exceptions.DuplicatedStopRequestException