Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1439316188.1 KB

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 <code>Stopping</code> state. After all in-progress actions are completed or abandoned, the pipeline execution is in a <code>Stopped</code> state.

post/#X-Amz-Target=CodePipeline_20150709.StopPipelineExecution

Headers

X-Amz-Target'CodePipeline_20150709.StopPipelineExecution' required

Request body

pipelineNamestring required

The name of the pipeline to stop.

pipelineExecutionIdstring required

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

abandonboolean
<p>Use this option to stop the pipeline execution by abandoning, rather than finishing, in-progress actions.</p> <note> <p>This option can lead to failed or out-of-sequence tasks.</p> </note>
reasonstring

Use this option to enter comments, such as the reason the pipeline was stopped.

Response

Success

pipelineExecutionIdstring

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