AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Note:

For PCL this operation is only available in asynchronous form. Please refer to DisableStageTransitionAsync.

Namespace: Amazon.CodePipeline
Assembly: AWSSDK.CodePipeline.dll
Version: 3.x.y.z

Syntax

C#
public virtual DisableStageTransitionResponse DisableStageTransition(
         DisableStageTransitionRequest request
)
Parameters
request
Type: Amazon.CodePipeline.Model.DisableStageTransitionRequest

Container for the necessary parameters to execute the DisableStageTransition service method.

Return Value
The response from the DisableStageTransition service method, as returned by CodePipeline.

Exceptions

ExceptionCondition
PipelineNotFoundException The specified pipeline was specified in an invalid format or cannot be found.
StageNotFoundException The specified stage was specified in an invalid format or cannot be found.
ValidationException The validation was specified in an invalid format.

Examples

This example disables transitions into the Beta stage of the MyFirstPipeline pipeline in AWS CodePipeline.

Disable transitions into or out of a stage


var response = client.DisableStageTransition(new DisableStageTransitionRequest 
{
    PipelineName = "MyFirstPipeline",
    Reason = "An example reason",
    StageName = "Beta",
    TransitionType = "Inbound" // Valid values are Inbound, which prevents artifacts from transitioning into the stage and being processed by the actions in that stage, or Outbound, which prevents artifacts from transitioning out of the stage after they have been processed by the actions in that stage.
});


            

Version Information

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms

See Also