CodePipeline / Client / disable_stage_transition

disable_stage_transition#

CodePipeline.Client.disable_stage_transition(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.disable_stage_transition(
    pipelineName='string',
    stageName='string',
    transitionType='Inbound'|'Outbound',
    reason='string'
)
Parameters:
  • pipelineName (string) –

    [REQUIRED]

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

  • stageName (string) –

    [REQUIRED]

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

  • transitionType (string) –

    [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 (string) –

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

Returns:

None

Exceptions

  • CodePipeline.Client.exceptions.ValidationException

  • CodePipeline.Client.exceptions.PipelineNotFoundException

  • CodePipeline.Client.exceptions.StageNotFoundException