Stops the specified pipeline execution

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 https://www.paws-r-sdk.com/docs/codepipeline_stop_pipeline_execution/ for full documentation.

Usage

codepipeline_stop_pipeline_execution(
  pipelineName,
  pipelineExecutionId,
  abandon = NULL,
  reason = NULL
)

Arguments

pipelineName

[required] The name of the pipeline to stop.

pipelineExecutionId

[required] The ID of the pipeline execution to be stopped in the current stage. Use the get_pipeline_state action to retrieve the current pipelineExecutionId.

abandon

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

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

reason

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