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.

Updates a specified pipeline with edits or changes to its structure. Use a JSON file with the pipeline structure in conjunction with UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.

Note:

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

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

Syntax

C#
public virtual UpdatePipelineResponse UpdatePipeline(
         UpdatePipelineRequest request
)
Parameters
request
Type: Amazon.CodePipeline.Model.UpdatePipelineRequest

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

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

Exceptions

ExceptionCondition
InvalidActionDeclarationException The specified action declaration was specified in an invalid format.
InvalidBlockerDeclarationException Reserved for future use.
InvalidStageDeclarationException The specified stage declaration was specified in an invalid format.
InvalidStructureException The specified structure was specified in an invalid format.
ValidationException The validation was specified in an invalid format.

Examples

This example updates the structure of a pipeline. The entire structure of the pipeline must be supplied, either by passing all of the parameters, or by using a pre-defined JSON file.

Update the structure of a pipeline


var response = client.UpdatePipeline(new UpdatePipelineRequest 
{
    Pipeline = new PipelineDeclaration {
        Version = 2,
        Name = "MyFirstPipeline",
        ArtifactStore = new ArtifactStore {
            Type = "S3",
            Location = "codepipeline-us-east-1-11EXAMPLE11"
        },
        RoleArn = "arn:aws:iam::111111111111:role/AWS-CodePipeline-Service",
        Stages = new List {
            new StageDeclaration {
                Name = "Source",
                Actions = new List {
                    new ActionDeclaration {
                        Name = "Source",
                        ActionTypeId = new ActionTypeId {
                            Version = "1",
                            Category = "Source",
                            Owner = "AWS",
                            Provider = "S3"
                        },
                        Configuration = new Dictionary {
                            { "S3Bucket", "awscodepipeline-demo-bucket2" },
                            { "S3ObjectKey", "aws-codepipeline-s3-aws-codedeploy_linux.zip" }
                        },
                        InputArtifacts = new List {
                                        
                        },
                        OutputArtifacts = new List {
                            new OutputArtifact { Name = "MyApp" }
                        },
                        RunOrder = 1
                    }
                }
            },
            new StageDeclaration {
                Name = "Beta",
                Actions = new List {
                    new ActionDeclaration {
                        Name = "CodePipelineDemoFleet",
                        ActionTypeId = new ActionTypeId {
                            Version = "1",
                            Category = "Deploy",
                            Owner = "AWS",
                            Provider = "CodeDeploy"
                        },
                        Configuration = new Dictionary {
                            { "ApplicationName", "CodePipelineDemoApplication" },
                            { "DeploymentGroupName", "CodePipelineDemoFleet" }
                        },
                        InputArtifacts = new List {
                            new InputArtifact { Name = "MyApp" }
                        },
                        OutputArtifacts = new List {
                                        
                        },
                        RunOrder = 1
                    }
                }
            }
        }
    }
});

PipelineDeclaration pipeline = response.Pipeline;

            

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