View a markdown version of this page

UpdatePipeline - CodePipeline

UpdatePipeline

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.

Request Syntax

{ "pipeline": { "artifactStore": { "encryptionKey": { "id": "string", "type": "string" }, "location": "string", "type": "string" }, "artifactStores": { "string" : { "encryptionKey": { "id": "string", "type": "string" }, "location": "string", "type": "string" } }, "executionMode": "string", "name": "string", "pipelineType": "string", "roleArn": "string", "stages": [ { "actions": [ { "actionTypeId": { "category": "string", "owner": "string", "provider": "string", "version": "string" }, "commands": [ "string" ], "configuration": { "string" : "string" }, "environmentVariables": [ { "name": "string", "type": "string", "value": "string" } ], "inputArtifacts": [ { "name": "string" } ], "name": "string", "namespace": "string", "outputArtifacts": [ { "files": [ "string" ], "name": "string" } ], "outputVariables": [ "string" ], "region": "string", "roleArn": "string", "runOrder": number, "timeoutInMinutes": number } ], "beforeEntry": { "conditions": [ { "result": "string", "rules": [ { "commands": [ "string" ], "configuration": { "string" : "string" }, "inputArtifacts": [ { "name": "string" } ], "name": "string", "region": "string", "roleArn": "string", "ruleTypeId": { "category": "string", "owner": "string", "provider": "string", "version": "string" }, "timeoutInMinutes": number } ] } ] }, "blockers": [ { "name": "string", "type": "string" } ], "name": "string", "onFailure": { "conditions": [ { "result": "string", "rules": [ { "commands": [ "string" ], "configuration": { "string" : "string" }, "inputArtifacts": [ { "name": "string" } ], "name": "string", "region": "string", "roleArn": "string", "ruleTypeId": { "category": "string", "owner": "string", "provider": "string", "version": "string" }, "timeoutInMinutes": number } ] } ], "result": "string", "retryConfiguration": { "retryMode": "string" } }, "onSuccess": { "conditions": [ { "result": "string", "rules": [ { "commands": [ "string" ], "configuration": { "string" : "string" }, "inputArtifacts": [ { "name": "string" } ], "name": "string", "region": "string", "roleArn": "string", "ruleTypeId": { "category": "string", "owner": "string", "provider": "string", "version": "string" }, "timeoutInMinutes": number } ] } ] } } ], "triggers": [ { "gitConfiguration": { "pullRequest": [ { "branches": { "excludes": [ "string" ], "includes": [ "string" ] }, "events": [ "string" ], "filePaths": { "excludes": [ "string" ], "includes": [ "string" ] } } ], "push": [ { "branches": { "excludes": [ "string" ], "includes": [ "string" ] }, "filePaths": { "excludes": [ "string" ], "includes": [ "string" ] }, "tags": { "excludes": [ "string" ], "includes": [ "string" ] } } ], "sourceActionName": "string" }, "providerType": "string" } ], "variables": [ { "defaultValue": "string", "description": "string", "name": "string" } ], "version": number } }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

pipeline

The name of the pipeline to be updated.

Type: