Class StopPipelineExecutionCommandProtected

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.

Example

Use a bare-bones client and the command you need to make an API call.

import { CodePipelineClient, StopPipelineExecutionCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import
// const { CodePipelineClient, StopPipelineExecutionCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import
const client = new CodePipelineClient(config);
const input = { // StopPipelineExecutionInput
  pipelineName: "STRING_VALUE", // required
  pipelineExecutionId: "STRING_VALUE", // required
  abandon: true || false,
  reason: "STRING_VALUE",
};
const command = new StopPipelineExecutionCommand(input);
const response = await client.send(command);
// { // StopPipelineExecutionOutput
//   pipelineExecutionId: "STRING_VALUE",
// };

Param

StopPipelineExecutionCommandInput

Returns

StopPipelineExecutionCommandOutput

See

• StopPipelineExecutionCommandInput for command's input shape.
• StopPipelineExecutionCommandOutput for command's response shape.
• config for CodePipelineClient's config shape.

Throws

ConflictException (client fault)

Your request cannot be handled because the pipeline is busy handling ongoing activities. Try again later.

Throws

DuplicatedStopRequestException (client fault)

The pipeline execution is already in a Stopping state. If you already chose to stop and wait, you cannot make that request again. You can choose to stop and abandon now, but be aware that this option can lead to failed tasks or out of sequence tasks. If you already chose to stop and abandon, you cannot make that request again.

Throws

PipelineExecutionNotStoppableException (client fault)

Unable to stop the pipeline execution. The execution might already be in a Stopped state, or it might no longer be in progress.

Throws

PipelineNotFoundException (client fault)

The pipeline was specified in an invalid format or cannot be found.

Throws

ValidationException (client fault)

The validation was specified in an invalid format.

Throws

CodePipelineServiceException

Base exception class for all service exceptions from CodePipeline service.