Stop Pipeline Execution

codepipeline_stop_pipeline_execution

R Documentation

Stops the specified pipeline execution¶

Description¶

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.

Usage¶

codepipeline_stop_pipeline_execution(pipelineName, pipelineExecutionId,
  abandon, reason)

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.

Value¶

A list with the following syntax:

list(
  pipelineExecutionId = "string"
)

Request syntax¶

svc$stop_pipeline_execution(
  pipelineName = "string",
  pipelineExecutionId = "string",
  abandon = TRUE|FALSE,
  reason = "string"
)