Skip to content

Disable Stage Transition

codepipeline_disable_stage_transition R Documentation

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

Description

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

Usage

codepipeline_disable_stage_transition(pipelineName, stageName,
  transitionType, reason)

Arguments

pipelineName

[required] The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.

stageName

[required] The name of the stage where you want to disable the inbound or outbound transition of artifacts.

transitionType

[required] Specifies whether artifacts are prevented from transitioning into the stage and being processed by the actions in that stage (inbound), or prevented from transitioning from the stage after they have been processed by the actions in that stage (outbound).

reason

[required] The reason given to the user that a stage is disabled, such as waiting for manual approval or manual tests. This message is displayed in the pipeline console UI.

Value

An empty list.

Request syntax

svc$disable_stage_transition(
  pipelineName = "string",
  stageName = "string",
  transitionType = "Inbound"|"Outbound",
  reason = "string"
)