Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface StopPipelineExecutionCommandInput

Hierarchy

Index

Properties

Optional abandon

abandon: undefined | false | true

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.

pipelineExecutionId

pipelineExecutionId: string | undefined

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

pipelineName

pipelineName: string | undefined

The name of the pipeline to stop.

Optional reason

reason: undefined | string

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