Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Class DisableStageTransitionCommandProtected

Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.

Example

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

import { CodePipelineClient, DisableStageTransitionCommand } from "@aws-sdk/client-codepipeline"; // ES Modules import
// const { CodePipelineClient, DisableStageTransitionCommand } = require("@aws-sdk/client-codepipeline"); // CommonJS import
const client = new CodePipelineClient(config);
const input = { // DisableStageTransitionInput
pipelineName: "STRING_VALUE", // required
stageName: "STRING_VALUE", // required
transitionType: "Inbound" || "Outbound", // required
reason: "STRING_VALUE", // required
};
const command = new DisableStageTransitionCommand(input);
const response = await client.send(command);
// {};

Param

DisableStageTransitionCommandInput

Returns

DisableStageTransitionCommandOutput

See

Throws

PipelineNotFoundException (client fault)

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

Throws

StageNotFoundException (client fault)

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

Hierarchy

Constructors

Properties

Methods