AWS CodePipeline

Stop 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.

Inputs

フィールド

種類

説明

region [required]

enum

default: us-east-1

pipelineName [required]

string

The name of the pipeline to stop.

pipelineExecutionId [required]

string

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. 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.

Outputs

フィールド

種類

説明

amzRequestId [required]

string

pipelineExecutionId

string

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