disable_stage_transition `async` ¶

disable_stage_transition(
    pipeline_name: PipelineName,
    stage_name: StageName,
    transition_type: StageTransitionType,
    reason: DisabledReason,
    *,
    config_overrides: Optional[AsyncCodePipelineClientConfig] = None,
) -> None

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

Parameters:

pipeline_name (PipelineName) –

The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.
stage_name (StageName) –

The name of the stage where you want to disable the inbound or outbound transition of artifacts.
transition_type (StageTransitionType) –

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 (DisabledReason) –

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.

Raises:

PipelineNotFoundException –

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

The stage was specified in an invalid format or cannot be found.
ValidationException –

The validation was specified in an invalid format.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_codepipeline/_services/async_code_pipeline.py

async def disable_stage_transition(
    self,
    pipeline_name: "capo_codepipeline.types.pipeline_name.PipelineName",
    stage_name: "capo_codepipeline.types.stage_name.StageName",
    transition_type: "capo_codepipeline.types.stage_transition_type.StageTransitionType",
    reason: "capo_codepipeline.types.disabled_reason.DisabledReason",
    *,
    config_overrides: Optional[AsyncCodePipelineClientConfig] = None,
) -> None:
    """<p>Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.</p>

    Args:
        pipeline_name: <p>The name of the pipeline in which you want to disable the flow of artifacts from one stage to another.</p>
        stage_name: <p>The name of the stage where you want to disable the inbound or outbound transition of artifacts.</p>
        transition_type: <p>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).</p>
        reason: <p>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.</p>

    Raises:
        capo_codepipeline.errors.pipeline_not_found_exception.PipelineNotFoundException: <p>The pipeline was specified in an invalid format or cannot be found.</p>
        capo_codepipeline.errors.stage_not_found_exception.StageNotFoundException: <p>The stage was specified in an invalid format or cannot be found.</p>
        capo_codepipeline.errors.validation_exception.ValidationException: <p>The validation was specified in an invalid format.</p>
        capo_codepipeline.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_codepipeline.types.disable_stage_transition_input.DisableStageTransitionInput]",
    ) -> AsyncOperationResponse[None]:
        import capo_codepipeline._operations.code_pipeline_20150709.disable_stage_transition

        (
            output,
            http_response,
        ) = await capo_codepipeline._operations.code_pipeline_20150709.disable_stage_transition.async_disable_stage_transition(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DisableStageTransition")
    )
    input_: capo_codepipeline.types.disable_stage_transition_input.DisableStageTransitionInput = {
        "pipeline_name": pipeline_name,
        "stage_name": stage_name,
        "transition_type": transition_type,
        "reason": reason,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

disable_stage_transition async ¶

disable_stage_transition `async` ¶