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 and UpdatePipeline to provide the full structure of the pipeline. Updating the pipeline increases the version number of the pipeline by 1.

Note:

For .NET Core 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 abstract 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 action declaration was specified in an invalid format.
InvalidBlockerDeclarationException Reserved for future use.
InvalidStageDeclarationException The stage declaration was specified in an invalid format.
InvalidStructureException The structure was specified in an invalid format.
LimitExceededException The number of pipelines associated with the Amazon Web Services account has exceeded the limit allowed for the account.
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 client = new AmazonCodePipelineClient();
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<StageDeclaration> {
            new StageDeclaration {
                Name = "Source",
                Actions = new List<ActionDeclaration> {
                    new ActionDeclaration {
                        Name = "Source",
                        ActionTypeId = new ActionTypeId {
                            Version = "1",
                            Category = "Source",
                            Owner = "AWS",
                            Provider = "S3"
                        },
                        Configuration = new Dictionary<string, string> {
                            { "S3Bucket", "awscodepipeline-demo-bucket2" },
                            { "S3ObjectKey", "aws-codepipeline-s3-aws-codedeploy_linux.zip" }
                        },
                        InputArtifacts = new List<InputArtifact> {
                                        
                        },
                        OutputArtifacts = new List<OutputArtifact> {
                            new OutputArtifact { Name = "MyApp" }
                        },
                        RunOrder = 1
                    }
                }
            },
            new StageDeclaration {
                Name = "Beta",
                Actions = new List<ActionDeclaration> {
                    new ActionDeclaration {
                        Name = "CodePipelineDemoFleet",
                        ActionTypeId = new ActionTypeId {
                            Version = "1",
                            Category = "Deploy",
                            Owner = "AWS",
                            Provider = "CodeDeploy"
                        },
                        Configuration = new Dictionary<string, string> {
                            { "ApplicationName", "CodePipelineDemoApplication" },
                            { "DeploymentGroupName", "CodePipelineDemoFleet" }
                        },
                        InputArtifacts = new List<InputArtifact> {
                            new InputArtifact { Name = "MyApp" }
                        },
                        OutputArtifacts = new List<OutputArtifact> {
                                        
                        },
                        RunOrder = 1
                    }
                }
            }
        }
    }
});

PipelineDeclaration pipeline = response.Pipeline;

            

Version Information

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

See Also