0% found this document useful (0 votes)

10 views

Codepipeline API

This document provides an API reference for CodePipeline and includes documentation for actions like acknowledging jobs, creating pipelines, custom action types, and more. It contains request and response syntax, parameters, elements, examples, and errors for each CodePipeline API. The document is copyrighted by Amazon Web Services and includes a table of contents to help developers navigate to the specific API documentation they need.

Uploaded by

samifiaz

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

10 views

Codepipeline API

Uploaded by

samifiaz

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 353

API Reference

CodePipeline

API Version 2015-07-09

CodePipeline: API Reference

Amazon's trademarks and trade dress may not be used in connection with any product or service
that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any
manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are
the property of their respective owners, who may or may not be aﬃliated with, connected to, or
sponsored by Amazon.
CodePipeline API Reference

Table of Contents
Welcome ........................................................................................................................................... 1
Actions .............................................................................................................................................. 4
AcknowledgeJob ........................................................................................................................................... 6
Request Syntax ........................................................................................................................................ 6
Request Parameters ................................................................................................................................ 6
Response Syntax ...................................................................................................................................... 7
Response Elements ................................................................................................................................. 7
Errors .......................................................................................................................................................... 7
Examples ................................................................................................................................................... 8
See Also ..................................................................................................................................................... 8
AcknowledgeThirdPartyJob ...................................................................................................................... 10
Request Syntax ...................................................................................................................................... 10
Request Parameters .............................................................................................................................. 10
Response Syntax ................................................................................................................................... 11
Response Elements ............................................................................................................................... 11
Errors ....................................................................................................................................................... 11
See Also .................................................................................................................................................. 12
CreateCustomActionType .......................................................................................................................... 13
Request Syntax ...................................................................................................................................... 13
Request Parameters .............................................................................................................................. 14
Response Syntax ................................................................................................................................... 16
Response Elements ............................................................................................................................... 17
Errors ....................................................................................................................................................... 17
Examples ................................................................................................................................................. 18
See Also .................................................................................................................................................. 20
CreatePipeline ............................................................................................................................................. 21
Request Syntax ...................................................................................................................................... 21
Request Parameters .............................................................................................................................. 23
Response Syntax ................................................................................................................................... 24
Response Elements ............................................................................................................................... 26
Errors ....................................................................................................................................................... 26
Examples ................................................................................................................................................. 28
See Also .................................................................................................................................................. 31
DeleteCustomActionType .......................................................................................................................... 33

API Version 2015-07-09 iii

CodePipeline API Reference

Request Syntax ...................................................................................................................................... 33

Request Parameters .............................................................................................................................. 33
Response Elements ............................................................................................................................... 34
Errors ....................................................................................................................................................... 34
Examples ................................................................................................................................................. 34
See Also .................................................................................................................................................. 35
DeletePipeline ............................................................................................................................................. 37
Request Syntax ...................................................................................................................................... 37
Request Parameters .............................................................................................................................. 37
Response Elements ............................................................................................................................... 37
Errors ....................................................................................................................................................... 37
Examples ................................................................................................................................................. 38
See Also .................................................................................................................................................. 38
DeleteWebhook ........................................................................................................................................... 40
Request Syntax ...................................................................................................................................... 40
Request Parameters .............................................................................................................................. 40
Response Elements ............................................................................................................................... 40
Errors ....................................................................................................................................................... 40
See Also .................................................................................................................................................. 41
DeregisterWebhookWithThirdParty ........................................................................................................ 42
Request Syntax ...................................................................................................................................... 42
Request Parameters .............................................................................................................................. 42
Response Elements ............................................................................................................................... 42
Errors ....................................................................................................................................................... 42
See Also .................................................................................................................................................. 43
DisableStageTransition .............................................................................................................................. 44
Request Syntax ...................................................................................................................................... 44
Request Parameters .............................................................................................................................. 44
Response Elements ............................................................................................................................... 45
Errors ....................................................................................................................................................... 45
Examples ................................................................................................................................................. 46
See Also .................................................................................................................................................. 47
EnableStageTransition ............................................................................................................................... 48
Request Syntax ...................................................................................................................................... 48
Request Parameters .............................................................................................................................. 48
Response Elements ............................................................................................................................... 49

API Version 2015-07-09 iv

CodePipeline API Reference

Errors ....................................................................................................................................................... 49
Examples ................................................................................................................................................. 49
See Also .................................................................................................................................................. 50
GetActionType ............................................................................................................................................. 52
Request Syntax ...................................................................................................................................... 52
Request Parameters .............................................................................................................................. 52
Response Syntax ................................................................................................................................... 53
Response Elements ............................................................................................................................... 55
Errors ....................................................................................................................................................... 55
See Also .................................................................................................................................................. 55
GetJobDetails .............................................................................................................................................. 57
Request Syntax ...................................................................................................................................... 57
Request Parameters .............................................................................................................................. 57
Response Syntax ................................................................................................................................... 57
Response Elements ............................................................................................................................... 59
Errors ....................................................................................................................................................... 59
Examples ................................................................................................................................................. 60
See Also .................................................................................................................................................. 62
GetPipeline ................................................................................................................................................... 63
Request Syntax ...................................................................................................................................... 63
Request Parameters .............................................................................................................................. 63
Response Syntax ................................................................................................................................... 64
Response Elements ............................................................................................................................... 66
Errors ....................................................................................................................................................... 66
Examples ................................................................................................................................................. 67
See Also .................................................................................................................................................. 69
GetPipelineExecution ................................................................................................................................. 70
Request Syntax ...................................................................................................................................... 70
Request Parameters .............................................................................................................................. 70
Response Syntax ................................................................................................................................... 70
Response Elements ............................................................................................................................... 71
Errors ....................................................................................................................................................... 72
Examples ................................................................................................................................................. 72
See Also .................................................................................................................................................. 73
GetPipelineState ......................................................................................................................................... 75
Request Syntax ...................................................................................................................................... 75

API Version 2015-07-09 v

CodePipeline API Reference

Request Parameters .............................................................................................................................. 75

Response Syntax ................................................................................................................................... 75
Response Elements ............................................................................................................................... 77
Errors ....................................................................................................................................................... 78
Examples ................................................................................................................................................. 78
See Also .................................................................................................................................................. 80
GetThirdPartyJobDetails ........................................................................................................................... 81
Request Syntax ...................................................................................................................................... 81
Request Parameters .............................................................................................................................. 81
Response Syntax ................................................................................................................................... 82
Response Elements ............................................................................................................................... 83
Errors ....................................................................................................................................................... 84
See Also .................................................................................................................................................. 84
ListActionExecutions .................................................................................................................................. 86
Request Syntax ...................................................................................................................................... 86
Request Parameters .............................................................................................................................. 86
Response Syntax ................................................................................................................................... 87
Response Elements ............................................................................................................................... 89
Errors ....................................................................................................................................................... 89
See Also .................................................................................................................................................. 90
ListActionTypes ........................................................................................................................................... 91
Request Syntax ...................................................................................................................................... 91
Request Parameters .............................................................................................................................. 91
Response Syntax ................................................................................................................................... 92
Response Elements ............................................................................................................................... 93
Errors ....................................................................................................................................................... 93
Examples ................................................................................................................................................. 94
See Also ................................................................................................................................................ 100
ListPipelineExecutions ............................................................................................................................. 101
Request Syntax .................................................................................................................................... 101
Request Parameters ........................................................................................................................... 101
Response Syntax ................................................................................................................................. 102
Response Elements ............................................................................................................................ 102
Errors ..................................................................................................................................................... 103
See Also ................................................................................................................................................ 103
ListPipelines .............................................................................................................................................. 105

API Version 2015-07-09 vi

CodePipeline API Reference

Request Syntax .................................................................................................................................... 105

Request Parameters ........................................................................................................................... 105
Response Syntax ................................................................................................................................. 106
Response Elements ............................................................................................................................ 106
Errors ..................................................................................................................................................... 106
Examples ............................................................................................................................................... 107
See Also ................................................................................................................................................ 108
ListTagsForResource ................................................................................................................................ 109
Request Syntax .................................................................................................................................... 109
Request Parameters ........................................................................................................................... 109
Response Syntax ................................................................................................................................. 110
Response Elements ............................................................................................................................ 110
Errors ..................................................................................................................................................... 110
See Also ................................................................................................................................................ 111
ListWebhooks ............................................................................................................................................ 112
Request Syntax .................................................................................................................................... 112
Request Parameters ........................................................................................................................... 112
Response Syntax ................................................................................................................................. 113
Response Elements ............................................................................................................................ 113
Errors ..................................................................................................................................................... 114
See Also ................................................................................................................................................ 114
PollForJobs ................................................................................................................................................ 116
Request Syntax .................................................................................................................................... 116
Request Parameters ........................................................................................................................... 116
Response Syntax ................................................................................................................................. 117
Response Elements ............................................................................................................................ 119
Errors ..................................................................................................................................................... 119
Examples ............................................................................................................................................... 120
See Also ................................................................................................................................................ 122
PollForThirdPartyJobs ............................................................................................................................. 123
Request Syntax .................................................................................................................................... 123
Request Parameters ........................................................................................................................... 123
Response Syntax ................................................................................................................................. 124
Response Elements ............................................................................................................................ 124
Errors ..................................................................................................................................................... 124
See Also ................................................................................................................................................ 125

API Version 2015-07-09 vii

CodePipeline API Reference

PutActionRevision .................................................................................................................................... 126

Request Syntax .................................................................................................................................... 126
Request Parameters ........................................................................................................................... 126
Response Syntax ................................................................................................................................. 127
Response Elements ............................................................................................................................ 127
Errors ..................................................................................................................................................... 128
Examples ............................................................................................................................................... 128
See Also ................................................................................................................................................ 129
PutApprovalResult ................................................................................................................................... 131
Request Syntax .................................................................................................................................... 131
Request Parameters ........................................................................................................................... 131
Response Syntax ................................................................................................................................. 132
Response Elements ............................................................................................................................ 133
Errors ..................................................................................................................................................... 133
Examples ............................................................................................................................................... 134
See Also ................................................................................................................................................ 135
PutJobFailureResult ................................................................................................................................. 136
Request Syntax .................................................................................................................................... 136
Request Parameters ........................................................................................................................... 136
Response Elements ............................................................................................................................ 137
Errors ..................................................................................................................................................... 137
See Also ................................................................................................................................................ 137
PutJobSuccessResult ................................................................................................................................ 139
Request Syntax .................................................................................................................................... 139
Request Parameters ........................................................................................................................... 139
Response Elements ............................................................................................................................ 140
Errors ..................................................................................................................................................... 141
See Also ................................................................................................................................................ 141
PutThirdPartyJobFailureResult .............................................................................................................. 143
Request Syntax .................................................................................................................................... 143
Request Parameters ........................................................................................................................... 143
Response Elements ............................................................................................................................ 144
Errors ..................................................................................................................................................... 144
See Also ................................................................................................................................................ 145
PutThirdPartyJobSuccessResult ............................................................................................................ 146
Request Syntax .................................................................................................................................... 146

API Version 2015-07-09 viii

CodePipeline API Reference

Request Parameters ........................................................................................................................... 146

Response Elements ............................................................................................................................ 147
Errors ..................................................................................................................................................... 148
See Also ................................................................................................................................................ 148
PutWebhook .............................................................................................................................................. 150
Request Syntax .................................................................................................................................... 150
Request Parameters ........................................................................................................................... 150
Response Syntax ................................................................................................................................. 151
Response Elements ............................................................................................................................ 152
Errors ..................................................................................................................................................... 152
See Also ................................................................................................................................................ 153
RegisterWebhookWithThirdParty ......................................................................................................... 155
Request Syntax .................................................................................................................................... 155
Request Parameters ........................................................................................................................... 155
Response Elements ............................................................................................................................ 155
Errors ..................................................................................................................................................... 155
See Also ................................................................................................................................................ 156
RetryStageExecution ............................................................................................................................... 157
Request Syntax .................................................................................................................................... 157
Request Parameters ........................................................................................................................... 157
Response Syntax ................................................................................................................................. 158
Response Elements ............................................................................................................................ 158
Errors ..................................................................................................................................................... 159
Examples ............................................................................................................................................... 160
See Also ................................................................................................................................................ 160
StartPipelineExecution ............................................................................................................................ 162
Request Syntax .................................................................................................................................... 162
Request Parameters ........................................................................................................................... 162
Response Syntax ................................................................................................................................. 163
Response Elements ............................................................................................................................ 164
Errors ..................................................................................................................................................... 164
Examples ............................................................................................................................................... 164
See Also ................................................................................................................................................ 165
StopPipelineExecution ............................................................................................................................ 167
Request Syntax .................................................................................................................................... 167
Request Parameters ........................................................................................................................... 167

API Version 2015-07-09 ix

CodePipeline API Reference

Response Syntax ................................................................................................................................. 168

Response Elements ............................................................................................................................ 168
Errors ..................................................................................................................................................... 169
See Also ................................................................................................................................................ 170
TagResource .............................................................................................................................................. 171
Request Syntax .................................................................................................................................... 171
Request Parameters ........................................................................................................................... 171
Response Elements ............................................................................................................................ 172
Errors ..................................................................................................................................................... 172
See Also ................................................................................................................................................ 173
UntagResource .......................................................................................................................................... 174
Request Syntax .................................................................................................................................... 174
Request Parameters ........................................................................................................................... 174
Response Elements ............................................................................................................................ 174
Errors ..................................................................................................................................................... 175
See Also ................................................................................................................................................ 175
UpdateActionType .................................................................................................................................... 177
Request Syntax .................................................................................................................................... 177
Request Parameters ........................................................................................................................... 178
Response Elements ............................................................................................................................ 178
Errors ..................................................................................................................................................... 178
See Also ................................................................................................................................................ 179
UpdatePipeline ......................................................................................................................................... 180
Request Syntax .................................................................................................................................... 180
Request Parameters ........................................................................................................................... 182
Response Syntax ................................................................................................................................. 182
Response Elements ............................................................................................................................ 184
Errors ..................................................................................................................................................... 185
Examples ............................................................................................................................................... 185
See Also ................................................................................................................................................ 189
Data Types ................................................................................................................................... 190
ActionConﬁguration ................................................................................................................................ 193
Contents ............................................................................................................................................... 193
See Also ................................................................................................................................................ 193
ActionConﬁgurationProperty ................................................................................................................. 194
Contents ............................................................................................................................................... 194

API Version 2015-07-09 x

CodePipeline API Reference

API Version 2015-07-09 xi

CodePipeline API Reference

API Version 2015-07-09 xii

CodePipeline API Reference

API Version 2015-07-09 xiii

CodePipeline API Reference

API Version 2015-07-09 xiv

CodePipeline API Reference

API Version 2015-07-09 xv

CodePipeline API Reference

API Version 2015-07-09 xvi

CodePipeline API Reference

API Version 2015-07-09 xvii

CodePipeline API Reference

Welcome
Overview

This is the AWS CodePipeline API Reference. This guide provides descriptions of the actions and
data types for CodePipeline. Some functionality for your pipeline can only be conﬁgured through
the API. For more information, see the AWS CodePipeline User Guide.

You can use the AWS CodePipeline API to work with pipelines, stages, actions, and transitions.

Pipelines are models of automated release processes. Each pipeline is uniquely named, and consists
of stages, actions, and transitions.

You can work with pipelines by calling:

• CreatePipeline, which creates a uniquely named pipeline.

• DeletePipeline, which deletes the specified pipeline.
• GetPipeline, which returns information about the pipeline structure and pipeline metadata,
including the pipeline Amazon Resource Name (ARN).
• GetPipelineExecution, which returns information about a specific execution of a pipeline.
• GetPipelineState, which returns information about the current state of the stages and actions of
a pipeline.
• ListActionExecutions, which returns action-level details for past executions. The details include
full stage and action-level details, including individual action duration, status, any errors that
occurred during the execution, and input and output artifact location details.
• ListPipelines, which gets a summary of all of the pipelines associated with your account.
• ListPipelineExecutions, which gets a summary of the most recent executions for a pipeline.
• StartPipelineExecution, which runs the most recent revision of an artifact through the pipeline.
• StopPipelineExecution, which stops the specified pipeline execution from continuing through the
pipeline.
• UpdatePipeline, which updates a pipeline with edits or changes to the structure of the pipeline.

Pipelines include stages. Each stage contains one or more actions that must complete before
the next stage begins. A stage results in success or failure. If a stage fails, the pipeline stops at

API Version 2015-07-09 1

CodePipeline API Reference

that stage and remains stopped until either a new version of an artifact appears in the source
location, or a user takes action to rerun the most recent artifact through the pipeline. You can
call GetPipelineState, which displays the status of a pipeline, including the status of stages in
the pipeline, or GetPipeline, which returns the entire structure of the pipeline, including the
stages of that pipeline. For more information about the structure of stages and actions, see AWS
CodePipeline Pipeline Structure Reference.

Pipeline stages include actions that are categorized into categories such as source or build actions
performed in a stage of a pipeline. For example, you can use a source action to import artifacts
into a pipeline from a source such as Amazon S3. Like stages, you do not work with actions directly
in most cases, but you do deﬁne and interact with actions when working with pipeline operations
such as CreatePipeline and GetPipelineState. Valid action categories are:

• Source
• Build
• Test
• Deploy
• Approval
• Invoke

Pipelines also include transitions, which allow the transition of artifacts from one stage to the next
in a pipeline after the actions in one stage complete.

You can work with transitions by calling:

• DisableStageTransition, which prevents artifacts from transitioning to the next stage in a

pipeline.
• EnableStageTransition, which enables transition of artifacts between stages in a pipeline.

Using the API to integrate with AWS CodePipeline

For third-party integrators or developers who want to create their own integrations with
CodePipeline, the expected sequence varies from the standard API user. To integrate with
CodePipeline, developers need to work with the following items:

Jobs, which are instances of an action. For example, a job for a source action might import a
revision of an artifact from a source.

API Version 2015-07-09 2

CodePipeline API Reference

You can work with jobs by calling:

• AcknowledgeJob, which conﬁrms whether a job worker has received the speciﬁed job.
• GetJobDetails, which returns the details of a job.
• PollForJobs, which determines whether there are any jobs to act on.
• PutJobFailureResult, which provides details of a job failure.
• PutJobSuccessResult, which provides details of a job success.

Third party jobs, which are instances of an action created by a partner action and integrated into
CodePipeline. Partner actions are created by members of the AWS Partner Network.

You can work with third party jobs by calling:

• AcknowledgeThirdPartyJob, which conﬁrms whether a job worker has received the speciﬁed job.
• GetThirdPartyJobDetails, which requests the details of a job for a partner action.
• PollForThirdPartyJobs, which determines whether there are any jobs to act on.
• PutThirdPartyJobFailureResult, which provides details of a job failure.
• PutThirdPartyJobSuccessResult, which provides details of a job success.

This document was last published on February 5, 2024.

API Version 2015-07-09 3

CodePipeline API Reference

Actions
The following actions are supported:

• AcknowledgeJob
• AcknowledgeThirdPartyJob
• CreateCustomActionType
• CreatePipeline
• DeleteCustomActionType
• DeletePipeline
• DeleteWebhook
• DeregisterWebhookWithThirdParty
• DisableStageTransition
• EnableStageTransition
• GetActionType
• GetJobDetails
• GetPipeline
• GetPipelineExecution
• GetPipelineState
• GetThirdPartyJobDetails
• ListActionExecutions
• ListActionTypes
• ListPipelineExecutions
• ListPipelines
• ListTagsForResource
• ListWebhooks
• PollForJobs
• PollForThirdPartyJobs
• PutActionRevision
• PutApprovalResult
• PutJobFailureResult

API Version 2015-07-09 4

CodePipeline API Reference

• PutJobSuccessResult
• PutThirdPartyJobFailureResult
• PutThirdPartyJobSuccessResult
• PutWebhook
• RegisterWebhookWithThirdParty
• RetryStageExecution
• StartPipelineExecution
• StopPipelineExecution
• TagResource
• UntagResource
• UpdateActionType
• UpdatePipeline

API Version 2015-07-09 5

CodePipeline API Reference

AcknowledgeJob
Returns information about a speciﬁed job and whether that job has been received by the job
worker. Used for custom actions only.

Request Syntax

{
"jobId": "string",
"nonce": "string"
}

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.

jobId

The unique system-generated ID of the job for which you want to conﬁrm receipt.

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

nonce

A system-generated random number that CodePipeline uses to ensure that the job is being
worked on by only one job worker. Get this number from the response of the PollForJobs
request that returned this job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Required: Yes

AcknowledgeJob API Version 2015-07-09 6

CodePipeline API Reference

Response Syntax

{
"status": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

status

Whether the job worker has received the speciﬁed job.

Type: String

Valid Values: Created | Queued | Dispatched | InProgress | TimedOut |

Succeeded | Failed

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidNonceException

The nonce was speciﬁed in an invalid format.

HTTP Status Code: 400

JobNotFoundException

The job was speciﬁed in an invalid format or cannot be found.

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

Response Syntax API Version 2015-07-09 7

CodePipeline API Reference

Examples

Example

This example illustrates one usage of AcknowledgeJob.

Sample Request

POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 63
X-Amz-Target: CodePipeline_20150709.AcknowledgeJob
X-Amz-Date: 20160707T205252Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20160707/us-east-1/
codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-
target, Signature=8d9b5998EXAMPLE

{
"nonce": "3",
"jobId": "f4f4ff82-2d11-EXAMPLE"
}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 23

{
"status": "InProgress"
}

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

Examples API Version 2015-07-09 8

CodePipeline API Reference

• AWS SDK for .NET

• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

The request accepts the following data in JSON format.

clientToken

The clientToken portion of the clientId and clientToken pair used to verify that the calling entity
is allowed access to the job and its details.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes
jobId

The unique system-generated ID of the job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Required: Yes
nonce

A system-generated random number that CodePipeline uses to ensure that the job
is being worked on by only one job worker. Get this number from the response to a
GetThirdPartyJobDetails request.

AcknowledgeThirdPartyJob API Version 2015-07-09 10

CodePipeline API Reference

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Required: Yes

Response Syntax

{
"status": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

status

The status information for the third party job, if any.

Type: String

Valid Values: Created | Queued | Dispatched | InProgress | TimedOut |

Succeeded | Failed

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidClientTokenException

The client token was speciﬁed in an invalid format

HTTP Status Code: 400

InvalidNonceException

The nonce was speciﬁed in an invalid format.

Response Syntax API Version 2015-07-09 11

CodePipeline API Reference

HTTP Status Code: 400

JobNotFoundException

The job was speciﬁed in an invalid format or cannot be found.

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

CreateCustomActionType API Version 2015-07-09 13

CodePipeline API Reference

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.

Valid Values: Source | Build | Deploy | Test | Invoke | Approval

Required: Yes
conﬁgurationProperties

The conﬁguration properties for the custom action.

Note
You can refer to a name in the configuration properties of the custom action within the
URL templates by following the format of {Config:name}, as long as the configuration
property is both required and not secret. For more information, see Create a Custom
Action for a Pipeline.

Type: Array of ActionConﬁgurationProperty objects

Array Members: Maximum number of 10 items.

Required: No
inputArtifactDetails

The details of the input artifact for the action, such as its commit ID.

Type: ArtifactDetails object

Required: Yes

Request Parameters API Version 2015-07-09 14

CodePipeline API Reference

outputArtifactDetails

The details of the output artifact of the action, such as its commit ID.

Type: ArtifactDetails object

Required: Yes
provider

The provider of the service used in the custom action, such as CodeDeploy.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 35.

Pattern: [0-9A-Za-z_-]+

Required: Yes
settings

URLs that provide users information about this custom action.

Type: ActionTypeSettings object

Required: No
tags

The tags for the custom action.

Type: Array of Tag objects

Required: No
version

The version identiﬁer of the custom action.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 9.

Pattern: [0-9A-Za-z_-]+

Required: Yes

Request Parameters API Version 2015-07-09 15

CodePipeline API Reference

Response Syntax

{
"actionType": {
"actionConfigurationProperties": [
{
"description": "string",
"key": boolean,
"name": "string",
"queryable": boolean,
"required": boolean,
"secret": boolean,
"type": "string"
}
],
"id": {
"category": "string",
"owner": "string",
"provider": "string",
"version": "string"
},
"inputArtifactDetails": {
"maximumCount": number,
"minimumCount": number
},
"outputArtifactDetails": {
"maximumCount": number,
"minimumCount": number
},
"settings": {
"entityUrlTemplate": "string",
"executionUrlTemplate": "string",
"revisionUrlTemplate": "string",
"thirdPartyConfigurationUrl": "string"
}
},
"tags": [
{
"key": "string",
"value": "string"
}
]
}

Response Syntax API Version 2015-07-09 16

CodePipeline API Reference

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

actionType

Returns information about the details of an action type.

Type: ActionType object

tags

Speciﬁes the tags applied to the custom action.

Type: Array of Tag objects

Errors

For information about the errors that are common to all actions, see Common Errors.

ConcurrentModiﬁcationException

Unable to modify the tag due to a simultaneous update request.

HTTP Status Code: 400

InvalidTagsException

The speciﬁed resource tags are invalid.

HTTP Status Code: 400

LimitExceededException

The number of pipelines associated with the AWS account has exceeded the limit allowed for
the account.

HTTP Status Code: 400

TooManyTagsException

The tags limit for a resource has been exceeded.

Response Elements API Version 2015-07-09 17

CodePipeline API Reference

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of CreateCustomActionType.

Sample Request

POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 665
X-Amz-Target: CodePipeline_20150709.CreateCustomActionType
X-Amz-Date: 20160707T203658Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20160707/us-east-1/
codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-
target, Signature=8d9b5998EXAMPLE

{
"category": "Build",
"settings": {
"entityUrlTemplate": "https://192.0.2.4/job/{Config:ProjectName}/",
"executionUrlTemplate": "https://192.0.2.4/job/{Config:ProjectName}/
lastSuccessfulBuild/{ExternalExecutionId}/"
},
"configurationProperties": [
{
"description": "The name of the build project must be provided when this action
is added to the pipeline.",
"required": true,
"secret": false,
"key": true,
"type": "String",

Examples API Version 2015-07-09 18

CodePipeline API Reference

"queryable": false,
"name": "ProjectName"
}
],
"version": "1",
"provider": "JenkinsProviderName",
"inputArtifactDetails": {
"maximumCount": 1,
"minimumCount": 0
},
"outputArtifactDetails": {
"maximumCount": 1,
"minimumCount": 0
}
}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 683

{
"actionType": {
"actionConfigurationProperties": [
{
"description": "The name of the build project must be provided when this action
is added to the pipeline.",
"key": true,
"name": "ProjectName",
"queryable": false,
"required": true,
"secret": false
}
],
"id": {
"__type": "ActionTypeId",
"category": "Build",
"owner": "Custom",
"provider": "JenkinsProviderName",
"version": "1"
},

Examples API Version 2015-07-09 19

CodePipeline API Reference

"inputArtifactDetails": {
"maximumCount": 1,
"minimumCount": 0
},
"outputArtifactDetails": {
"maximumCount": 1,
"minimumCount": 0
},
"settings": {
"entityUrlTemplate": "https://192.0.2.4/job/{Config:ProjectName}/",
"executionUrlTemplate": "https://192.0.2.4/job/{Config:ProjectName}/
lastSuccessfulBuild/{ExternalExecutionId}/"
}
}
}

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

CreatePipeline API Version 2015-07-09 21

CodePipeline API Reference

"owner": "string",
"provider": "string",
"version": "string"
},
"configuration": {
"string" : "string"
},
"inputArtifacts": [
{
"name": "string"
}
],
"name": "string",
"namespace": "string",
"outputArtifacts": [
{
"name": "string"
}
],
"region": "string",
"roleArn": "string",
"runOrder": number
}
],
"blockers": [
{
"name": "string",
"type": "string"
}
],
"name": "string"
}
],
"triggers": [
{
"gitConfiguration": {
"push": [
{
"tags": {
"excludes": [ "string" ],
"includes": [ "string" ]
}
}
],

Request Syntax API Version 2015-07-09 22

CodePipeline API Reference

"sourceActionName": "string"
},
"providerType": "string"
}
],
"variables": [
{
"defaultValue": "string",
"description": "string",
"name": "string"
}
],
"version": number
},
"tags": [
{
"key": "string",
"value": "string"
}
]
}

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

Represents the structure of actions and stages to be performed in the pipeline.

Type: PipelineDeclaration object

Required: Yes
tags

The tags for the pipeline.

Type: Array of Tag objects

Required: No

Request Parameters API Version 2015-07-09 23

CodePipeline API Reference

Response Syntax

Response Syntax API Version 2015-07-09 24

CodePipeline API Reference

"name": "string",
"namespace": "string",
"outputArtifacts": [
{
"name": "string"
}
],
"region": "string",
"roleArn": "string",
"runOrder": number
}
],
"blockers": [
{
"name": "string",
"type": "string"
}
],
"name": "string"
}
],
"triggers": [
{
"gitConfiguration": {
"push": [
{
"tags": {
"excludes": [ "string" ],
"includes": [ "string" ]
}
}
],
"sourceActionName": "string"
},
"providerType": "string"
}
],
"variables": [
{
"defaultValue": "string",
"description": "string",
"name": "string"
}
],

Response Syntax API Version 2015-07-09 25

CodePipeline API Reference

"version": number
},
"tags": [
{
"key": "string",
"value": "string"
}
]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

pipeline

Represents the structure of actions and stages to be performed in the pipeline.

Type: PipelineDeclaration object

tags

Speciﬁes the tags applied to the pipeline.

Type: Array of Tag objects

Errors

For information about the errors that are common to all actions, see Common Errors.

ConcurrentModiﬁcationException

Unable to modify the tag due to a simultaneous update request.

HTTP Status Code: 400

InvalidActionDeclarationException

The action declaration was speciﬁed in an invalid format.

HTTP Status Code: 400

Response Elements API Version 2015-07-09 26

CodePipeline API Reference

InvalidBlockerDeclarationException

Reserved for future use.

HTTP Status Code: 400

InvalidStageDeclarationException

The stage declaration was speciﬁed in an invalid format.

HTTP Status Code: 400

InvalidStructureException

The structure was speciﬁed in an invalid format.

HTTP Status Code: 400

InvalidTagsException

The speciﬁed resource tags are invalid.

HTTP Status Code: 400

LimitExceededException

The number of pipelines associated with the AWS account has exceeded the limit allowed for
the account.

HTTP Status Code: 400

PipelineNameInUseException

The speciﬁed pipeline name is already in use.

HTTP Status Code: 400

TooManyTagsException

The tags limit for a resource has been exceeded.

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

Errors API Version 2015-07-09 27

CodePipeline API Reference

Examples

Example

This example illustrates one usage of CreatePipeline.

Sample Request

POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 923
X-Amz-Target: CodePipeline_20150709.CreatePipeline
X-Amz-Date: 20160707T175936Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20160707/us-east-1/
codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-
target, Signature=8d9b5998EXAMPLE

{
"pipeline": {
"roleArn": "arn:aws:iam::111111111111:role/AWS-CodePipeline-Service",
"stages": [
{
"name": "Source",
"actions": [
{
"inputArtifacts": [],
"name": "Source",
"actionTypeId": {
"category": "Source",
"owner": "AWS",
"version": "1",
"provider": "S3"
},
"outputArtifacts": [
{
"name": "MyApp"
}
],
"configuration": {
"S3Bucket": "awscodepipeline-demo-bucket",

Examples API Version 2015-07-09 28

CodePipeline API Reference

"S3ObjectKey": "aws-codepipeline-s3-aws-codedeploy_linux.zip"
},
"runOrder": 1
}
]
},
{
"name": "Staging",
"actions": [
{
"inputArtifacts": [
{
"name": "MyApp"
}
],
"name": "CodePipelineDemoFleet",
"actionTypeId": {
"category": "Deploy",
"owner": "AWS",
"version": "1",
"provider": "CodeDeploy"
},
"outputArtifacts": [],
"configuration": {
"ApplicationName": "CodePipelineDemoApplication",
"DeploymentGroupName": "CodePipelineDemoFleet"
},
"runOrder": 1
}
]
}
],
"artifactStore": {
"type": "S3",
"location": "codepipeline-us-east-1-11EXAMPLE11"
},
"name": "MySecondPipeline",
"version": 1
}
}

Examples API Version 2015-07-09 29

CodePipeline API Reference

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 907

{
"pipeline": {
"artifactStore": {
"location": "codepipeline-us-east-1-11EXAMPLE11",
"type": "S3"
},
"name": "MySecondPipeline",
"roleArn": "arn:aws:iam::111111111111:role/AWS-CodePipeline-Service",
"stages": [
{
"actions": [
{
"actionTypeId": {
"__type": "ActionTypeId",
"category": "Source",
"owner": "AWS",
"provider": "S3",
"version": "1"
},
"configuration": {
"S3Bucket": "awscodepipeline-demo-bucket",
"S3ObjectKey": "aws-codepipeline-s3-aws-codedeploy_linux.zip"
},
"inputArtifacts": [],
"name": "Source",
"outputArtifacts": [
{
"name": "MyApp"
}
],
"runOrder": 1
}
],
"name": "Source"
},
{
"actions": [

Examples API Version 2015-07-09 30

CodePipeline API Reference

{
"actionTypeId": {
"__type": "ActionTypeId",
"category": "Deploy",
"owner": "AWS",
"provider": "CodeDeploy",
"version": "1"
},
"configuration": {
"ApplicationName": "CodePipelineDemoApplication",
"DeploymentGroupName": "CodePipelineDemoFleet"
},
"inputArtifacts": [
{
"name": "MyApp"
}
],
"name": "CodePipelineDemoFleet",
"outputArtifacts": [],
"runOrder": 1
}
],
"name": "Staging"
}
],
"version": 1
}
}

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript V3

• AWS SDK for PHP V3

• AWS SDK for Python
• AWS SDK for Ruby V3

The request accepts the following data in JSON format.

Valid Values: Source | Build | Deploy | Test | Invoke | Approval

Required: Yes
provider

The provider of the service used in the custom action, such as CodeDeploy.

Type: String

DeleteCustomActionType API Version 2015-07-09 33

CodePipeline API Reference

Length Constraints: Minimum length of 1. Maximum length of 35.

Pattern: [0-9A-Za-z_-]+

Required: Yes
version

The version of the custom action to delete.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 9.

Pattern: [0-9A-Za-z_-]+

Required: Yes

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors.

ConcurrentModiﬁcationException

Unable to modify the tag due to a simultaneous update request.

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DeleteCustomActionType.

Response Elements API Version 2015-07-09 34

CodePipeline API Reference

Sample Request

POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 68
X-Amz-Target: CodePipeline_20150709.DeleteCustomActionType
X-Amz-Date: 20151030T233944Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20151030/us-east-1/
codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-
target, Signature=8d9b5998EXAMPLE

{
"category": "Build",
"version": "1",
"provider": "JenkinsProviderName"
}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 0

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

The request accepts the following data in JSON format.

name

The name of the pipeline to be deleted.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: Yes

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors.

ConcurrentModiﬁcationException

Unable to modify the tag due to a simultaneous update request.

HTTP Status Code: 400

DeletePipeline API Version 2015-07-09 37

CodePipeline API Reference

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DeletePipeline.

Sample Request

POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 25
X-Amz-Target: CodePipeline_20150709.DeletePipeline
X-Amz-Date: 20160707T202402Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20160707/us-east-1/
codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-
target, Signature=8d9b5998EXAMPLE

{
"name": "MySecondPipeline"
}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 0

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

Examples API Version 2015-07-09 38

CodePipeline API Reference

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

The request accepts the following data in JSON format.

name

The name of the webhook you want to delete.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

DeleteWebhook API Version 2015-07-09 40

CodePipeline API Reference

ConcurrentModiﬁcationException

Unable to modify the tag due to a simultaneous update request.

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

The request accepts the following data in JSON format.

webhookName

The name of the webhook you want to deregister.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: No

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors.

ValidationException

The validation was speciﬁed in an invalid format.

DeregisterWebhookWithThirdParty API Version 2015-07-09 42

CodePipeline API Reference

HTTP Status Code: 400

WebhookNotFoundException

The speciﬁed webhook was entered in an invalid format or cannot be found.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

The request accepts the following data in JSON format.

pipelineName

The name of the pipeline in which you want to disable the ﬂow of artifacts from one stage to
another.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: Yes
reason

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 300.

Pattern: [a-zA-Z0-9!@ \.\*\?\-]+

DisableStageTransition API Version 2015-07-09 44

CodePipeline API Reference

Required: Yes
stageName

The name of the stage where you want to disable the inbound or outbound transition of
artifacts.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: Yes
transitionType

Speciﬁes 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).

Type: String

Valid Values: Inbound | Outbound

Required: Yes

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors.

PipelineNotFoundException

The pipeline was speciﬁed in an invalid format or cannot be found.

HTTP Status Code: 400

StageNotFoundException

The stage was speciﬁed in an invalid format or cannot be found.

Response Elements API Version 2015-07-09 45

CodePipeline API Reference

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of DisableStageTransition.

Sample Request

POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 108
X-Amz-Target: CodePipeline_20150709.DisableStageTransition
X-Amz-Date: 20160707T182043Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20160707/us-east-1/
codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-
target, Signature=8d9b5998EXAMPLE

{
"reason": "An example reason",
"pipelineName": "MyFirstPipeline",
"stageName": "Staging",
"transitionType": "Inbound"
}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 0

Examples API Version 2015-07-09 46

CodePipeline API Reference

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

The request accepts the following data in JSON format.

pipelineName

The name of the pipeline in which you want to enable the ﬂow of artifacts from one stage to
another.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: Yes
stageName

The name of the stage where you want to enable the transition of artifacts, either into the
stage (inbound) or from that stage to the next stage (outbound).

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: Yes

EnableStageTransition API Version 2015-07-09 48

CodePipeline API Reference

transitionType

Speciﬁes whether artifacts are allowed to enter the stage and be processed by the actions in
that stage (inbound) or whether already processed artifacts are allowed to transition to the next
stage (outbound).

Type: String

Valid Values: Inbound | Outbound

Required: Yes

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors.

PipelineNotFoundException

The pipeline was speciﬁed in an invalid format or cannot be found.

HTTP Status Code: 400

StageNotFoundException

The stage was speciﬁed in an invalid format or cannot be found.

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of EnableStageTransition.

Response Elements API Version 2015-07-09 49

CodePipeline API Reference

Sample Request

POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 85
X-Amz-Target: CodePipeline_20150709.EnableStageTransition
X-Amz-Date: 20160707T182342Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20160707/us-east-1/
codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-
target, Signature=8d9b5998EXAMPLE

{
"pipelineName": "MyFirstPipeline",
"stageName": "Staging",
"transitionType": "Inbound"
}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 0

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

The request accepts the following data in JSON format.

Valid Values: Source | Build | Deploy | Test | Invoke | Approval

Required: Yes

GetActionType API Version 2015-07-09 52

CodePipeline API Reference

owner

The creator of an action type that was created with any supported integration model. There are
two valid values: AWS and ThirdParty.

Type: String

Pattern: AWS|ThirdParty

Required: Yes
provider

The provider of the action type being called. The provider name is speciﬁed when the action
type is created.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 35.

Pattern: [0-9A-Za-z_-]+

Required: Yes
version

A string that describes the action type version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 9.

Pattern: [0-9A-Za-z_-]+

Required: Yes

Response Syntax

{
"actionType": {
"description": "string",
"executor": {
"configuration": {
"jobWorkerExecutorConfiguration": {
"pollingAccounts": [ "string" ],

Response Syntax API Version 2015-07-09 53

CodePipeline API Reference

"pollingServicePrincipals": [ "string" ]
},
"lambdaExecutorConfiguration": {
"lambdaFunctionArn": "string"
}
},
"jobTimeout": number,
"policyStatementsTemplate": "string",
"type": "string"
},
"id": {
"category": "string",
"owner": "string",
"provider": "string",
"version": "string"
},
"inputArtifactDetails": {
"maximumCount": number,
"minimumCount": number
},
"outputArtifactDetails": {
"maximumCount": number,
"minimumCount": number
},
"permissions": {
"allowedAccounts": [ "string" ]
},
"properties": [
{
"description": "string",
"key": boolean,
"name": "string",
"noEcho": boolean,
"optional": boolean,
"queryable": boolean
}
],
"urls": {
"configurationUrl": "string",
"entityUrlTemplate": "string",
"executionUrlTemplate": "string",
"revisionUrlTemplate": "string"
}
}

Response Syntax API Version 2015-07-09 54

CodePipeline API Reference

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

actionType

The action type information for the requested action type, such as the action type ID.

Type: ActionTypeDeclaration object

Errors
For information about the errors that are common to all actions, see Common Errors.

ActionTypeNotFoundException

The speciﬁed action type cannot be found.

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2

Response Elements API Version 2015-07-09 55

CodePipeline API Reference

• AWS SDK for JavaScript V3

• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

The request accepts the following data in JSON format.

jobId

The unique system-generated ID for the job.

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

Response Syntax

{
"jobDetails": {
"accountId": "string",
"data": {
"actionConfiguration": {
"configuration": {

GetJobDetails API Version 2015-07-09 57

CodePipeline API Reference

"string" : "string"
}
},
"actionTypeId": {
"category": "string",
"owner": "string",
"provider": "string",
"version": "string"
},
"artifactCredentials": {
"accessKeyId": "string",
"secretAccessKey": "string",
"sessionToken": "string"
},
"continuationToken": "string",
"encryptionKey": {
"id": "string",
"type": "string"
},
"inputArtifacts": [
{
"location": {
"s3Location": {
"bucketName": "string",
"objectKey": "string"
},
"type": "string"
},
"name": "string",
"revision": "string"
}
],
"outputArtifacts": [
{
"location": {
"s3Location": {
"bucketName": "string",
"objectKey": "string"
},
"type": "string"
},
"name": "string",
"revision": "string"
}

Response Syntax API Version 2015-07-09 58

CodePipeline API Reference

],
"pipelineContext": {
"action": {
"actionExecutionId": "string",
"name": "string"
},
"pipelineArn": "string",
"pipelineExecutionId": "string",
"pipelineName": "string",
"stage": {
"name": "string"
}
}
},
"id": "string"
}
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

jobDetails

The details of the job.

Note
If AWSSessionCredentials is used, a long-running job can call GetJobDetails again to
obtain new credentials.

Type: JobDetails object

Errors

For information about the errors that are common to all actions, see Common Errors.

Response Elements API Version 2015-07-09 59

CodePipeline API Reference

JobNotFoundException

The job was speciﬁed in an invalid format or cannot be found.

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of GetJobDetails.

Sample Request

POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 49
X-Amz-Target: CodePipeline_20150709.GetJobDetails
X-Amz-Date: 20151030T230237Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20151030/us-east-1/
codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-
target, Signature=8d9b5998EXAMPLE

{
"jobId": "ef66c259-EXAMPLE"
}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 1822

Examples API Version 2015-07-09 60

CodePipeline API Reference

{
"jobDetails": {
"accountId": "111111111111",
"data": {
"actionConfiguration": {
"__type": "ActionConfiguration",
"configuration": {
"ProjectName": "JenkinsTestProject"
}
},
"actionTypeId": {
"__type": "ActionTypeId",
"category": "Test",
"owner": "Custom",
"provider": "JenkinsProviderName",
"version": "1"
},
"artifactCredentials": {
"__type": "AWSSessionCredentials",
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"secretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
"sessionToken":
"fICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZW
+a4GmWIWJ21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/
f0wYK8m9TrDHudUZg3qX4waLG5M43q7Wgc/
MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpEIbb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADg
+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0FkbFFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fL
},
"inputArtifacts": [
{
"__type": "Artifact",
"location": {
"s3Location": {
"bucketName": "codepipeline-us-east-1-11EXAMPLE11",
"objectKey": "MySecondPipeline/MyAppBuild/EXAMPLE"
},
"type": "S3"
},
"name": "MyAppBuild"
}
],
"outputArtifacts": [],
"pipelineContext": {
"__type": "PipelineContext",

Examples API Version 2015-07-09 61

CodePipeline API Reference

"action": {
"name": "JenkinsTestAction"
},
"pipelineName": "MySecondPipeline",
"stage": {
"name": "Testing"
}
}
},
"id": "ef66c259-EXAMPLE"
}
}

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

The request accepts the following data in JSON format.

name

The name of the pipeline for which you want to get information. Pipeline names must be
unique in an AWS account.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: Yes
version

The version number of the pipeline. If you do not specify a version, defaults to the current
version.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

GetPipeline API Version 2015-07-09 63

CodePipeline API Reference

Response Syntax

{
"metadata": {
"created": number,
"pipelineArn": "string",
"pollingDisabledAt": number,
"updated": number
},
"pipeline": {
"artifactStore": {
"encryptionKey": {
"id": "string",
"type": "string"
},
"location": "string",
"type": "string"
},
"artifactStores": {
"string" : {
"encryptionKey": {
"id": "string",
"type": "string"
},
"location": "string",
"type": "string"
}
},
"name": "string",
"pipelineType": "string",
"roleArn": "string",
"stages": [
{
"actions": [
{
"actionTypeId": {
"category": "string",
"owner": "string",
"provider": "string",
"version": "string"
},
"configuration": {
"string" : "string"

Response Syntax API Version 2015-07-09 64

CodePipeline API Reference

},
"inputArtifacts": [
{
"name": "string"
}
],
"name": "string",
"namespace": "string",
"outputArtifacts": [
{
"name": "string"
}
],
"region": "string",
"roleArn": "string",
"runOrder": number
}
],
"blockers": [
{
"name": "string",
"type": "string"
}
],
"name": "string"
}
],
"triggers": [
{
"gitConfiguration": {
"push": [
{
"tags": {
"excludes": [ "string" ],
"includes": [ "string" ]
}
}
],
"sourceActionName": "string"
},
"providerType": "string"
}
],
"variables": [

Response Syntax API Version 2015-07-09 65

CodePipeline API Reference

{
"defaultValue": "string",
"description": "string",
"name": "string"
}
],
"version": number
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

metadata

Represents the pipeline metadata information returned as part of the output of a

GetPipeline action.

Type: PipelineMetadata object

pipeline

Represents the structure of actions and stages to be performed in the pipeline.

Type: PipelineDeclaration object

Errors
For information about the errors that are common to all actions, see Common Errors.

PipelineNotFoundException

The pipeline was speciﬁed in an invalid format or cannot be found.

HTTP Status Code: 400

PipelineVersionNotFoundException

The pipeline version was speciﬁed in an invalid format or cannot be found.

HTTP Status Code: 400

Response Elements API Version 2015-07-09 66

CodePipeline API Reference

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

Examples
Example

This example illustrates one usage of GetPipeline.

Sample Request

POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 27
X-Amz-Target: CodePipeline_20150709.GetPipeline
X-Amz-Date: 20160707T171559Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20160707/us-east-1/
codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-
target, Signature=8d9b5998EXAMPLE

{
"name": "MyFirstPipeline"
}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 898

{
"pipeline": {
"roleArn": "arn:aws:iam::11111EXAMPLE:role/AWS-CodePipeline-Service",
"stages": [
{
"name": "Source",

Examples API Version 2015-07-09 67

CodePipeline API Reference

"actions": [
{
"actionTypeId": {
"category": "Source",
"owner": "AWS",
"provider": "S3",
"version": "1"
},
"configuration": {
"PollForSourceChanges": "true",
"S3Bucket": "awscodepipeline-demo-bucket",
"S3ObjectKey": "aws-codepipeline-s3-aws-
codedeploy_linux.zip"
},
"inputArtifacts": [],
"name": "Source",
"outputArtifacts": [
{
"name": "MyApp"
}
],
"runOrder": 1
}
]
},
{
"name": "Build",
"actions": [
{
"actionTypeId": {
"category": "Build",
"owner": "AWS",
"provider": "CodeBuild",
"version": "1"
},
"configuration": {
"ProjectName": "BuildProject"
},
"inputArtifacts": [
{
"name": "MyApp"
}
],
"name": "CodeBuild",

Examples API Version 2015-07-09 68

CodePipeline API Reference

"outputArtifacts": [
{
"name": "MyAppBuild"
}
],
"runOrder": 1
}
]
}
],
"artifactStore": {
"type": "S3",
"location": "codepipeline-us-east-2-250656481468"
},
"name": "MyFirstPipeline",
"version": 1
},
"metadata": {
"pipelineArn": "arn:aws:codepipeline:us-east-2:80398EXAMPLE:MyFirstPipeline",
"updated": 1501626591.112,
"created": 1501626591.112
}
}

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

The request accepts the following data in JSON format.

pipelineExecutionId

The ID of the pipeline execution about which you want to get execution details.

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes
pipelineName

The name of the pipeline about which you want to get execution details.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: Yes

Response Syntax

GetPipelineExecution API Version 2015-07-09 70

CodePipeline API Reference

"pipelineExecution": {
"artifactRevisions": [
{
"created": number,
"name": "string",
"revisionChangeIdentifier": "string",
"revisionId": "string",
"revisionSummary": "string",
"revisionUrl": "string"
}
],
"pipelineExecutionId": "string",
"pipelineName": "string",
"pipelineVersion": number,
"status": "string",
"statusSummary": "string",
"trigger": {
"triggerDetail": "string",
"triggerType": "string"
},
"variables": [
{
"name": "string",
"resolvedValue": "string"
}
]
}
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

pipelineExecution

Represents information about the execution of a pipeline.

Type: PipelineExecution object

Response Elements API Version 2015-07-09 71

CodePipeline API Reference

Errors

For information about the errors that are common to all actions, see Common Errors.

PipelineExecutionNotFoundException

The pipeline execution was speciﬁed in an invalid format or cannot be found, or an execution ID
does not belong to the speciﬁed pipeline.

HTTP Status Code: 400

PipelineNotFoundException

The pipeline was speciﬁed in an invalid format or cannot be found.

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of GetPipelineExecution.

Sample Request

POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 27
X-Amz-Target: CodePipeline_20150709.GetPipelineExecution
X-Amz-Date: 20160707T171559Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20160707/us-east-1/
codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-
target, Signature=8d9b5998EXAMPLE

Errors API Version 2015-07-09 72

CodePipeline API Reference

{
"pipelineExecutionId": "42ee4d10-e4de-a37c-82b7-36c11EXAMPLE",
"pipelineName": "MyFirstPipeline"
}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 318

{
"pipelineExecution": {
"artifactRevisions": [
{
"created": 1427298837.7689769,
"name": "MyApp",
"revisionChangeIdentifier": "1427298921.3976923",
"revisionId": "7636d59f3c461cEXAMPLE8417dbc6371",
"revisionSummary": "Updating the application for feature 12-4820",
"revisionUrl": "https://api.github.com/repos/anycompany/MyApp/git/
commits/7636d59f3c461cEXAMPLE8417dbc6371"
}
],
"pipelineExecutionId": "3137f7cb-7cf7-039j-s83l-d7eu3EXAMPLE",
"pipelineName": "MyFirstPipeline",
"pipelineVersion": 2,
"status": "Succeeded"
}
}

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

The request accepts the following data in JSON format.

name

The name of the pipeline about which you want to get information.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: Yes

Response Syntax

{
"created": number,
"pipelineName": "string",
"pipelineVersion": number,
"stageStates": [

GetPipelineState API Version 2015-07-09 75

CodePipeline API Reference

{
"actionStates": [
{
"actionName": "string",
"currentRevision": {
"created": number,
"revisionChangeId": "string",
"revisionId": "string"
},
"entityUrl": "string",
"latestExecution": {
"actionExecutionId": "string",
"errorDetails": {
"code": "string",
"message": "string"
},
"externalExecutionId": "string",
"externalExecutionUrl": "string",
"lastStatusChange": number,
"lastUpdatedBy": "string",
"percentComplete": number,
"status": "string",
"summary": "string",
"token": "string"
},
"revisionUrl": "string"
}
],
"inboundExecution": {
"pipelineExecutionId": "string",
"status": "string"
},
"inboundTransitionState": {
"disabledReason": "string",
"enabled": boolean,
"lastChangedAt": number,
"lastChangedBy": "string"
},
"latestExecution": {
"pipelineExecutionId": "string",
"status": "string"
},
"stageName": "string"
}

Response Syntax API Version 2015-07-09 76

CodePipeline API Reference

],
"updated": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

created

The date and time the pipeline was created, in timestamp format.

Type: Timestamp
pipelineName

The name of the pipeline for which you want to get the state.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+
pipelineVersion

The version number of the pipeline.

Note
A newly created pipeline is always assigned a version number of 1.

Type: Integer

Valid Range: Minimum value of 1.

stageStates

A list of the pipeline stage output information, including stage name, state, most recent run
details, whether the stage is disabled, and other data.

Response Elements API Version 2015-07-09 77

CodePipeline API Reference

Type: Array of StageState objects

updated

The date and time the pipeline was last updated, in timestamp format.

Type: Timestamp

Errors
For information about the errors that are common to all actions, see Common Errors.

PipelineNotFoundException

The pipeline was speciﬁed in an invalid format or cannot be found.

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of GetPipelineState.

Sample Request

POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 27
X-Amz-Target: CodePipeline_20150709.GetPipelineState
X-Amz-Date: 20160707T172005Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20160707/us-east-1/
codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-
target, Signature=8d9b5998EXAMPLE

Errors API Version 2015-07-09 78

CodePipeline API Reference

{
"name": "MyFirstPipeline"
}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 827

{
"created": 1446137312.204,
"pipelineName": "MyFirstPipeline",
"pipelineVersion": 1,
"stageStates": [
{
"actionStates": [
{
"actionName": "Source",
"currentRevision": {
"created": 1446726163.571,
"revisionId": "HYGp7zmwbCPPwo234xsCEM7d6ToeAqIl"
},
"entityUrl": "https://console.aws.amazon.com/s3/home?#",
"latestExecution": {
"lastStatusChange": 1446137358.328,
"status": "Succeeded"
}
}
],
"stageName": "Source"
},
{
"actionStates": [
{
"actionName": "CodePipelineDemoFleet",
"currentRevision": {
"created": 1466726263.189,
"revisionId": "{\"bucket\":\"codepipeline-us-east-1-2770EXAMPLE
\",\"key\":\"MyFirstPipeline/MyApp/QI8RTZY.zip\",\"bundleType\":\"zip\",\"version
\":null,\"etag\":\"f51889bff5402b0249676e48cEXAMPLE\"}"

Examples API Version 2015-07-09 79

CodePipeline API Reference

},
"entityUrl": "https://console.aws.amazon.com/codedeploy/home?#/
applications/CodePipelineDemoApplication/deployment-groups/CodePipelineDemoFleet",
"latestExecution": {
"externalExecutionId": "d-EXAMPLE",
"externalExecutionUrl": "https://console.aws.amazon.com/
codedeploy/home?#/deployments/d-EXAMPLE",
"lastStatusChange": 1446137493.131,
"status": "Succeeded",
"summary": "Deployment Succeeded"
}
}
],
"inboundTransitionState": {
"enabled": true,
"lastChangedAt": 1470779534.135,
"lastChangedBy": "arn:aws:iam::111111111111:user/johndoe"
},
"stageName": "Staging"
}
],
"updated": 1446137312.204
}

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

The request accepts the following data in JSON format.

clientToken

The clientToken portion of the clientId and clientToken pair used to verify that the calling entity
is allowed access to the job and its details.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes
jobId

The unique system-generated ID used for identifying the job.

Type: String

GetThirdPartyJobDetails API Version 2015-07-09 81

CodePipeline API Reference

Length Constraints: Minimum length of 1. Maximum length of 512.

Required: Yes

Response Syntax

{
"jobDetails": {
"data": {
"actionConfiguration": {
"configuration": {
"string" : "string"
}
},
"actionTypeId": {
"category": "string",
"owner": "string",
"provider": "string",
"version": "string"
},
"artifactCredentials": {
"accessKeyId": "string",
"secretAccessKey": "string",
"sessionToken": "string"
},
"continuationToken": "string",
"encryptionKey": {
"id": "string",
"type": "string"
},
"inputArtifacts": [
{
"location": {
"s3Location": {
"bucketName": "string",
"objectKey": "string"
},
"type": "string"
},
"name": "string",
"revision": "string"
}
],

Response Syntax API Version 2015-07-09 82

CodePipeline API Reference

"outputArtifacts": [
{
"location": {
"s3Location": {
"bucketName": "string",
"objectKey": "string"
},
"type": "string"
},
"name": "string",
"revision": "string"
}
],
"pipelineContext": {
"action": {
"actionExecutionId": "string",
"name": "string"
},
"pipelineArn": "string",
"pipelineExecutionId": "string",
"pipelineName": "string",
"stage": {
"name": "string"
}
}
},
"id": "string",
"nonce": "string"
}
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

jobDetails

The details of the job, including any protected values deﬁned for the job.

Type: ThirdPartyJobDetails object

Response Elements API Version 2015-07-09 83

CodePipeline API Reference

Errors
For information about the errors that are common to all actions, see Common Errors.

InvalidClientTokenException

The client token was speciﬁed in an invalid format

HTTP Status Code: 400

InvalidJobException

The job was speciﬁed in an invalid format or cannot be found.

HTTP Status Code: 400

JobNotFoundException

The job was speciﬁed in an invalid format or cannot be found.

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python

Errors API Version 2015-07-09 84

CodePipeline API Reference

• AWS SDK for Ruby V3

The request accepts the following data in JSON format.

ﬁlter

Input information used to ﬁlter action execution history.

Type: ActionExecutionFilter object

Required: No
maxResults

The maximum number of results to return in a single call. To retrieve the remaining results,
make another call with the returned nextToken value. Action execution history is retained for up
to 12 months, based on action execution start times. Default value is 100.

Note
Detailed execution history is available for executions run on or after February 21, 2019.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

ListActionExecutions API Version 2015-07-09 86

CodePipeline API Reference

Required: No
nextToken

The token that was returned from the previous ListActionExecutions call, which can be
used to return the next set of action executions in the list.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No
pipelineName

The name of the pipeline for which you want to list action execution history.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: Yes

Response Syntax

{
"actionExecutionDetails": [
{
"actionExecutionId": "string",
"actionName": "string",
"input": {
"actionTypeId": {
"category": "string",
"owner": "string",
"provider": "string",
"version": "string"
},
"configuration": {
"string" : "string"
},
"inputArtifacts": [
{
"name": "string",

Response Syntax API Version 2015-07-09 87

CodePipeline API Reference

"s3location": {
"bucket": "string",
"key": "string"
}
}
],
"namespace": "string",
"region": "string",
"resolvedConfiguration": {
"string" : "string"
},
"roleArn": "string"
},
"lastUpdateTime": number,
"output": {
"executionResult": {
"externalExecutionId": "string",
"externalExecutionSummary": "string",
"externalExecutionUrl": "string"
},
"outputArtifacts": [
{
"name": "string",
"s3location": {
"bucket": "string",
"key": "string"
}
}
],
"outputVariables": {
"string" : "string"
}
},
"pipelineExecutionId": "string",
"pipelineVersion": number,
"stageName": "string",
"startTime": number,
"status": "string"
}
],
"nextToken": "string"
}

Response Syntax API Version 2015-07-09 88

CodePipeline API Reference

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

actionExecutionDetails

The details for a list of recent executions, such as action execution ID.

Type: Array of ActionExecutionDetail objects

nextToken

If the amount of returned information is signiﬁcantly large, an identiﬁer is also returned and
can be used in a subsequent ListActionExecutions call to return the next set of action
executions in the list.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidNextTokenException

The next token was speciﬁed in an invalid format. Make sure that the next token you provide is
the token returned by a previous call.

HTTP Status Code: 400

PipelineExecutionNotFoundException

The pipeline execution was speciﬁed in an invalid format or cannot be found, or an execution ID
does not belong to the speciﬁed pipeline.

HTTP Status Code: 400

PipelineNotFoundException

The pipeline was speciﬁed in an invalid format or cannot be found.

Response Elements API Version 2015-07-09 89

CodePipeline API Reference

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

The request accepts the following data in JSON format.

actionOwnerFilter

Filters the list of action types to those created by a speciﬁed entity.

Type: String

Valid Values: AWS | ThirdParty | Custom

Required: No
nextToken

An identiﬁer that was returned from the previous list action types call, which can be used to
return the next set of action types in the list.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No
regionFilter

The Region to ﬁlter on for the list of action types.

ListActionTypes API Version 2015-07-09 91

CodePipeline API Reference

Type: String

Length Constraints: Minimum length of 4. Maximum length of 30.

Required: No

Response Syntax

{
"actionTypes": [
{
"actionConfigurationProperties": [
{
"description": "string",
"key": boolean,
"name": "string",
"queryable": boolean,
"required": boolean,
"secret": boolean,
"type": "string"
}
],
"id": {
"category": "string",
"owner": "string",
"provider": "string",
"version": "string"
},
"inputArtifactDetails": {
"maximumCount": number,
"minimumCount": number
},
"outputArtifactDetails": {
"maximumCount": number,
"minimumCount": number
},
"settings": {
"entityUrlTemplate": "string",
"executionUrlTemplate": "string",
"revisionUrlTemplate": "string",
"thirdPartyConfigurationUrl": "string"
}
}

Response Syntax API Version 2015-07-09 92

CodePipeline API Reference

],
"nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

actionTypes

Provides details of the action types.

Type: Array of ActionType objects

nextToken

If the amount of returned information is signiﬁcantly large, an identiﬁer is also returned. It can
be used in a subsequent list action types call to return the next set of action types in the list.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidNextTokenException

The next token was speciﬁed in an invalid format. Make sure that the next token you provide is
the token returned by a previous call.

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

Response Elements API Version 2015-07-09 93

CodePipeline API Reference

Examples

Example

This example illustrates one usage of ListActionTypes.

Sample Request

POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 2
X-Amz-Target: CodePipeline_20150709.ListActionTypes
X-Amz-Date: 20160707T160551Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20160707/us-east-1/
codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-
target, Signature=8d9b5998EXAMPLE

{}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 8363

{
"actionTypes": [
{
"inputArtifactDetails": {
"maximumCount": 0,
"minimumCount": 0
},
"actionConfigurationProperties": [
{
"description": "The S3 Bucket",
"required": true,
"secret": false,
"key": true,
"queryable": false,

Examples API Version 2015-07-09 94

CodePipeline API Reference

"name": "S3Bucket"
},
{
"description": "The Amazon S3 object key",
"required": true,
"secret": false,
"key": true,
"queryable": false,
"name": "S3ObjectKey"
}
],
"outputArtifactDetails": {
"maximumCount": 1,
"minimumCount": 1
},
"id": {
"category": "Source",
"owner": "AWS",
"version": "1",
"provider": "S3"
},
"settings": {
"entityUrlTemplate": "https://console.aws.amazon.com/s3/home?#"
}
},
{
"inputArtifactDetails": {
"maximumCount": 1,
"minimumCount": 1
},
"actionConfigurationProperties": [
{
"description": "The Elastic Beanstalk Application name",
"required": true,
"secret": false,
"key": true,
"queryable": false,
"name": "ApplicationName"
},
{
"description": "The Elastic Beanstalk Environment name",
"required": true,
"secret": false,
"key": true,

Examples API Version 2015-07-09 95

CodePipeline API Reference

"queryable": false,
"name": "EnvironmentName"
}
],
"outputArtifactDetails": {
"maximumCount": 0,
"minimumCount": 0
},
"id": {
"category": "Deploy",
"owner": "AWS",
"version": "1",
"provider": "ElasticBeanstalk"
},
"settings": {
"entityUrlTemplate": "https://console.aws.amazon.com/elasticbeanstalk/
r/application/{Config:ApplicationName}",
"executionUrlTemplate": "https://console.aws.amazon.com/
elasticbeanstalk/r/application/{Config:ApplicationName}"
}
},
{
"inputArtifactDetails": {
"maximumCount": 1,
"minimumCount": 1
},
"actionConfigurationProperties": [
{
"description": "The deployment application name",
"required": true,
"secret": false,
"key": true,
"queryable": false,
"name": "ApplicationName"
},
{
"description": "The deployment group name",
"required": true,
"secret": false,
"key": true,
"queryable": false,
"name": "DeploymentGroupName"
}
],

Examples API Version 2015-07-09 96

CodePipeline API Reference

"outputArtifactDetails": {
"maximumCount": 0,
"minimumCount": 0
},
"id": {
"category": "Deploy",
"owner": "AWS",
"version": "1",
"provider": "CodeDeploy"
},
"settings": {
"entityUrlTemplate": "https://console.aws.amazon.com/codedeploy/home?#/
applications/{Config:ApplicationName}/deployment-groups/{Config:DeploymentGroupName}",
"executionUrlTemplate": "https://console.aws.amazon.com/codedeploy/
home?#/deployments/{ExternalExecutionId}"
}
},
{
"inputArtifactDetails": {
"maximumCount": 0,
"minimumCount": 0
},
"actionConfigurationProperties": [
{
"description": "The repository owner (username or organization)",
"required": true,
"secret": false,
"key": true,
"queryable": false,
"name": "Owner"
},
{
"description": "The name of the repository",
"required": true,
"secret": false,
"key": true,
"queryable": false,
"name": "Repo"
},
{
"description": "The tracked branch",
"required": true,
"secret": false,
"key": true,

Examples API Version 2015-07-09 97

CodePipeline API Reference

"queryable": false,
"name": "Branch"
},
{
"description": "The OAuth2 token",
"required": true,
"secret": true,
"key": false,
"queryable": false,
"name": "OAuthToken"
}
],
"outputArtifactDetails": {
"maximumCount": 1,
"minimumCount": 1
},
"id": {
"category": "Source",
"owner": "ThirdParty",
"version": "1",
"provider": "GitHub"
},
"settings": {
"entityUrlTemplate": "https://github.com/{Config:Owner}/{Config:Repo}/
tree/{Config:Branch}",
"revisionUrlTemplate": "https://github.com/{Config:Owner}/
{Config:Repo}/commit/{RevisionId}"
}
},
{
"inputArtifactDetails": {
"maximumCount": 5,
"minimumCount": 0
},
"actionConfigurationProperties": [
{
"secret": false,
"required": true,
"name": "JenkinsBuildProject",
"key": true,
"queryable": true
}
],
"outputArtifactDetails": {

Examples API Version 2015-07-09 98

CodePipeline API Reference

"maximumCount": 5,
"minimumCount": 0
},
"id": {
"category": "Build",
"owner": "Custom",
"version": "1",
"provider": "JenkinsProviderName"
},
"settings": {
"entityUrlTemplate": "http://192.0.2.4/job/{Config:ProjectName}",
"executionUrlTemplate": "http://192.0.2.4/job/{Config:ProjectName}/
{ExternalExecutionId}"
}
},
{
"inputArtifactDetails": {
"maximumCount": 5,
"minimumCount": 0
},
"actionConfigurationProperties": [
{
"secret": false,
"required": true,
"name": "JenkinsTestProject",
"key": true,
"queryable": true
}
],
"outputArtifactDetails": {
"maximumCount": 5,
"minimumCount": 0
},
"id": {
"category": "Test",
"owner": "Custom",
"version": "1",
"provider": "JenkinsProviderName"
},
"settings": {
"entityUrlTemplate": "http://192.0.2.4/job/{Config:ProjectName}",
"executionUrlTemplate": "http://192.0.2.4/job/{Config:ProjectName}/
{ExternalExecutionId}"
}

Examples API Version 2015-07-09 99

CodePipeline API Reference

}
]
}

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

The request accepts the following data in JSON format.

maxResults

The maximum number of results to return in a single call. To retrieve the remaining results,
make another call with the returned nextToken value. Pipeline history is limited to the most
recent 12 months, based on pipeline execution start times. Default value is 100.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No
nextToken

The token that was returned from the previous ListPipelineExecutions call, which can be
used to return the next set of pipeline executions in the list.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No
pipelineName

The name of the pipeline for which you want to get execution summary information.

ListPipelineExecutions API Version 2015-07-09 101

CodePipeline API Reference

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: Yes

Response Syntax

{
"nextToken": "string",
"pipelineExecutionSummaries": [
{
"lastUpdateTime": number,
"pipelineExecutionId": "string",
"sourceRevisions": [
{
"actionName": "string",
"revisionId": "string",
"revisionSummary": "string",
"revisionUrl": "string"
}
],
"startTime": number,
"status": "string",
"stopTrigger": {
"reason": "string"
},
"trigger": {
"triggerDetail": "string",
"triggerType": "string"
}
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Response Syntax API Version 2015-07-09 102

CodePipeline API Reference

nextToken

A token that can be used in the next ListPipelineExecutions call. To view all items in the
list, continue to call this operation with each subsequent token until no more nextToken values
are returned.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

pipelineExecutionSummaries

A list of executions in the history of a pipeline.

Type: Array of PipelineExecutionSummary objects

Errors
For information about the errors that are common to all actions, see Common Errors.

InvalidNextTokenException

The next token was speciﬁed in an invalid format. Make sure that the next token you provide is
the token returned by a previous call.

HTTP Status Code: 400

PipelineNotFoundException

The pipeline was speciﬁed in an invalid format or cannot be found.

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

Errors API Version 2015-07-09 103

CodePipeline API Reference

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

The request accepts the following data in JSON format.

maxResults

The maximum number of pipelines to return in a single call. To retrieve the remaining pipelines,
make another call with the returned nextToken value. The minimum value you can specify is 1.
The maximum accepted value is 1000.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 1000.

Required: No

nextToken

An identiﬁer that was returned from the previous list pipelines call. It can be used to return the
next set of pipelines in the list.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

ListPipelines API Version 2015-07-09 105

CodePipeline API Reference

Response Syntax

{
"nextToken": "string",
"pipelines": [
{
"created": number,
"name": "string",
"pipelineType": "string",
"updated": number,
"version": number
}
]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

If the amount of returned information is signiﬁcantly large, an identiﬁer is also returned. It can
be used in a subsequent list pipelines call to return the next set of pipelines in the list.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

pipelines

The list of pipelines.

Type: Array of PipelineSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

Response Syntax API Version 2015-07-09 106

CodePipeline API Reference

InvalidNextTokenException

The next token was speciﬁed in an invalid format. Make sure that the next token you provide is
the token returned by a previous call.

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of ListPipelines.

Sample Request

POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 2
X-Amz-Target: CodePipeline_20150709.ListPipelines
X-Amz-Date: 20160707T160211Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20160707/us-east-1/
codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-
target, Signature=8d9b5998EXAMPLE

{}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 668

Examples API Version 2015-07-09 107

CodePipeline API Reference

{
"pipelines": [
{
"updated": 1444681408.094,
"version": 1,
"name": "MyFirstPipeline",
"created": 1444681408.094
},
{
"updated": 1443048299.639,
"version": 3,
"name": "MySecondPipeline",
"created": 1443046290.003
}
]
}

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

The request accepts the following data in JSON format.

maxResults

The maximum number of results to return in a single call.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No
nextToken

The token that was returned from the previous API call, which would be used to return the next
page of the list. The ListTagsforResource call lists all available tags in one call and does not use
pagination.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No
resourceArn

The Amazon Resource Name (ARN) of the resource to get tags for.

Type: String

ListTagsForResource API Version 2015-07-09 109

CodePipeline API Reference

Pattern: arn:aws(-[\w]+)*:codepipeline:.+:[0-9]{12}:.+

Required: Yes

Response Syntax

{
"nextToken": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

If the amount of returned information is signiﬁcantly large, an identiﬁer is also returned and
can be used in a subsequent API call to return the next page of the list. The ListTagsforResource
call lists all available tags in one call and does not use pagination.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

tags

The tags for the resource.

Type: Array of Tag objects

Errors
For information about the errors that are common to all actions, see Common Errors.

Response Syntax API Version 2015-07-09 110

CodePipeline API Reference

InvalidArnException

The speciﬁed resource ARN is invalid.

HTTP Status Code: 400

InvalidNextTokenException

The next token was speciﬁed in an invalid format. Make sure that the next token you provide is
the token returned by a previous call.

HTTP Status Code: 400

ResourceNotFoundException

The resource was speciﬁed in an invalid format.

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

The request accepts the following data in JSON format.

MaxResults

The maximum number of results to return in a single call. To retrieve the remaining results,
make another call with the returned nextToken value.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

The token that was returned from the previous ListWebhooks call, which can be used to return
the next set of webhooks in the list.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

ListWebhooks API Version 2015-07-09 112

CodePipeline API Reference

Response Syntax

{
"NextToken": "string",
"webhooks": [
{
"arn": "string",
"definition": {
"authentication": "string",
"authenticationConfiguration": {
"AllowedIPRange": "string",
"SecretToken": "string"
},
"filters": [
{
"jsonPath": "string",
"matchEquals": "string"
}
],
"name": "string",
"targetAction": "string",
"targetPipeline": "string"
},
"errorCode": "string",
"errorMessage": "string",
"lastTriggered": number,
"tags": [
{
"key": "string",
"value": "string"
}
],
"url": "string"
}
]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Response Syntax API Version 2015-07-09 113

CodePipeline API Reference

NextToken

If the amount of returned information is signiﬁcantly large, an identiﬁer is also returned and
can be used in a subsequent ListWebhooks call to return the next set of webhooks in the list.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

webhooks

The JSON detail returned for each webhook in the list output for the ListWebhooks call.

Type: Array of ListWebhookItem objects

Errors
For information about the errors that are common to all actions, see Common Errors.

InvalidNextTokenException

The next token was speciﬁed in an invalid format. Make sure that the next token you provide is
the token returned by a previous call.

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go

Errors API Version 2015-07-09 114

CodePipeline API Reference

• AWS SDK for Java V2

• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

The request accepts the following data in JSON format.

actionTypeId

Represents information about an action type.

Type: ActionTypeId object

Required: Yes

PollForJobs API Version 2015-07-09 116

CodePipeline API Reference

maxBatchSize

The maximum number of jobs to return in a poll for jobs call.

Type: Integer

Valid Range: Minimum value of 1.

Required: No
queryParam

A map of property names and values. For an action type with no queryable properties, this
value must be null or an empty map. For an action type with a queryable property, you must
supply that property as a key in the map. Only jobs whose action conﬁguration matches the
mapped value are returned.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 1 item.

Key Length Constraints: Minimum length of 1. Maximum length of 50.

Value Length Constraints: Minimum length of 1. Maximum length of 50.

Value Pattern: [a-zA-Z0-9_-]+

Required: No

Response Syntax

{
"jobs": [
{
"accountId": "string",
"data": {
"actionConfiguration": {
"configuration": {
"string" : "string"
}
},
"actionTypeId": {
"category": "string",
"owner": "string",

Response Syntax API Version 2015-07-09 117

CodePipeline API Reference

"provider": "string",
"version": "string"
},
"artifactCredentials": {
"accessKeyId": "string",
"secretAccessKey": "string",
"sessionToken": "string"
},
"continuationToken": "string",
"encryptionKey": {
"id": "string",
"type": "string"
},
"inputArtifacts": [
{
"location": {
"s3Location": {
"bucketName": "string",
"objectKey": "string"
},
"type": "string"
},
"name": "string",
"revision": "string"
}
],
"outputArtifacts": [
{
"location": {
"s3Location": {
"bucketName": "string",
"objectKey": "string"
},
"type": "string"
},
"name": "string",
"revision": "string"
}
],
"pipelineContext": {
"action": {
"actionExecutionId": "string",
"name": "string"
},

Response Syntax API Version 2015-07-09 118

CodePipeline API Reference

"pipelineArn": "string",
"pipelineExecutionId": "string",
"pipelineName": "string",
"stage": {
"name": "string"
}
}
},
"id": "string",
"nonce": "string"
}
]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

jobs

Information about the jobs to take action on.

Type: Array of Job objects

Errors

For information about the errors that are common to all actions, see Common Errors.

ActionTypeNotFoundException

The speciﬁed action type cannot be found.

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

Response Elements API Version 2015-07-09 119

CodePipeline API Reference

Examples

Example

This example illustrates one usage of PollForJobs.

Sample Request

POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 173
X-Amz-Target: CodePipeline_20150709.PollForJobs
X-Amz-Date: 20151030T230047Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20151030/us-east-1/
codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-
target, Signature=8d9b5998EXAMPLE

{
"actionTypeId": {
"category": "Test",
"owner": "Custom",
"version": "1",
"provider": "JenkinsProviderName"
},
"maxBatchSize": 5,
"queryParam": {
"ProjectName": "JenkinsTestProject"
}
}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 1830

{
"jobs": [
{

Examples API Version 2015-07-09 120

CodePipeline API Reference

"accountId": "111111111111",
"data": {
"actionConfiguration": {
"__type": "ActionConfiguration",
"configuration": {
"ProjectName": "JenkinsTestProject"
}
},
"actionTypeId": {
"__type": "ActionTypeId",
"category": "Test",
"owner": "Custom",
"provider": "JenkinsProviderName",
"version": "1"
},
"artifactCredentials": {
"__type": "AWSSessionCredentials",
"accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"secretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
"sessionToken":
"fICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZW
+a4GmWIWJ21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/
f0wYK8m9TrDHudUZg3qX4waLG5M43q7Wgc/
MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpEIbb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADg
+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0FkbFFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fL
},
"inputArtifacts": [
{
"__type": "Artifact",
"location": {
"s3Location": {
"bucketName": "codepipeline-us-east-1-11EXAMPLE11",
"objectKey": "MySecondPipeline/MyAppBuild/EXAMPLE"
},
"type": "S3"
},
"name": "MyAppBuild"
}
],
"outputArtifacts": [],
"pipelineContext": {
"__type": "PipelineContext",
"action": {
"name": "JenkinsTestAction"

Examples API Version 2015-07-09 121

CodePipeline API Reference

},
"pipelineName": "MySecondPipeline",
"stage": {
"name": "Testing"
}
}
},
"id": "ef66c259-64f9-EXAMPLE",
"nonce": "3"
}
]
}

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

The request accepts the following data in JSON format.

actionTypeId

Represents information about an action type.

Type: ActionTypeId object

Required: Yes
maxBatchSize

The maximum number of jobs to return in a poll for jobs call.

PollForThirdPartyJobs API Version 2015-07-09 123

CodePipeline API Reference

Type: Integer

Valid Range: Minimum value of 1.

Required: No

Response Syntax

{
"jobs": [
{
"clientId": "string",
"jobId": "string"
}
]
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

jobs

Information about the jobs to take action on.

Type: Array of ThirdPartyJob objects

Errors
For information about the errors that are common to all actions, see Common Errors.

ActionTypeNotFoundException

The speciﬁed action type cannot be found.

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

Response Syntax API Version 2015-07-09 124

CodePipeline API Reference

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

The request accepts the following data in JSON format.

actionName

The name of the action that processes the revision.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: Yes
actionRevision

Represents information about the version (or revision) of an action.

Type: ActionRevision object

Required: Yes

PutActionRevision API Version 2015-07-09 126

CodePipeline API Reference

pipelineName

The name of the pipeline that starts processing the revision to the source.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: Yes
stageName

The name of the stage that contains the action that acts on the revision.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: Yes

Response Syntax

{
"newRevision": boolean,
"pipelineExecutionId": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

newRevision

Indicates whether the artifact revision was previously used in an execution of the speciﬁed
pipeline.

Type: Boolean

Response Syntax API Version 2015-07-09 127

CodePipeline API Reference

pipelineExecutionId

The ID of the current workﬂow state of the pipeline.

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Errors
For information about the errors that are common to all actions, see Common Errors.

ActionNotFoundException

The speciﬁed action cannot be found.

HTTP Status Code: 400

PipelineNotFoundException

The pipeline was speciﬁed in an invalid format or cannot be found.

HTTP Status Code: 400

StageNotFoundException

The stage was speciﬁed in an invalid format or cannot be found.

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of PutActionRevision.

Sample Request

POST / HTTP/1.1

Errors API Version 2015-07-09 128

CodePipeline API Reference

Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 173
X-Amz-Target: CodePipeline_20150709.PutActionRevision
X-Amz-Date: 20151030T230047Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20151030/us-east-1/
codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-
target, Signature=8d9b5998EXAMPLE

{
"actionName": "Source",
"actionRevision": {
"created": 1446726163.571,
"revisionChangeId": "3fdd7b9196697a096d5af1d649e26a4a",
"revisionId": "HYGp7zmwbCPPwo234xsCEM7d6ToeAqIl"
},
"pipelineName": "MyFirstPipeline",
"stageName": "Staging"
}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 1830

{
"newRevision": true,
"pipelineExecutionId": "42ee4d10-e4de-a37c-82b7-36c11EXAMPLE"
}

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

The request accepts the following data in JSON format.

actionName

The name of the action for which approval is requested.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: Yes
pipelineName

The name of the pipeline that contains the action.

Type: String

PutApprovalResult API Version 2015-07-09 131

CodePipeline API Reference

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: Yes
result

Represents information about the result of the approval request.

Type: ApprovalResult object

Required: Yes
stageName

The name of the stage that contains the action.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: Yes
token

The system-generated token used to identify a unique approval request. The token for each
open approval request can be obtained using the GetPipelineState action. It is used to validate
that the approval request corresponding to this token is still valid.

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

Response Syntax

{
"approvedAt": number
}

Response Syntax API Version 2015-07-09 132

CodePipeline API Reference

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

approvedAt

The timestamp showing when the approval or rejection was submitted.

Type: Timestamp

Errors
For information about the errors that are common to all actions, see Common Errors.

ActionNotFoundException

The speciﬁed action cannot be found.

HTTP Status Code: 400

ApprovalAlreadyCompletedException

The approval action has already been approved or rejected.

HTTP Status Code: 400

InvalidApprovalTokenException

The approval request already received a response or has expired.

HTTP Status Code: 400

PipelineNotFoundException

The pipeline was speciﬁed in an invalid format or cannot be found.

HTTP Status Code: 400

StageNotFoundException

The stage was speciﬁed in an invalid format or cannot be found.

HTTP Status Code: 400

Response Elements API Version 2015-07-09 133

CodePipeline API Reference

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of PutApprovalResult.

Sample Request

POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 173
X-Amz-Target: CodePipeline_20150709.PutApprovalResult
X-Amz-Date: 20151030T230047Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20151030/us-east-1/
codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-
target, Signature=8d9b5998EXAMPLE

{
"actionName": "MyApprovalAction",
"pipelineName": "MyFirstPipeline",
"result": {
"status": "Approved",
"summary": "Latest changes meet the bar. Ship it!"
},
"stageName": "MyApprovalStage",
"token": "1a2b3c4d-573f-4ea7-a67E-XAMPLETOKEN"
}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1

Examples API Version 2015-07-09 134

CodePipeline API Reference

Content-Length: 24

{
"approvedAt": 1466137312.204
}

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

The request accepts the following data in JSON format.

failureDetails

The details about the failure of a job.

Type: FailureDetails object

Required: Yes
jobId

The unique system-generated ID of the job that failed. This is the same ID returned from
PollForJobs.

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

PutJobFailureResult API Version 2015-07-09 136

CodePipeline API Reference

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors.

InvalidJobStateException

The job state was speciﬁed in an invalid format.

HTTP Status Code: 400

JobNotFoundException

The job was speciﬁed in an invalid format or cannot be found.

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

Response Elements API Version 2015-07-09 137

CodePipeline API Reference

The request accepts the following data in JSON format.

continuationToken

A token generated by a job worker, such as a CodeDeploy deployment ID, that a successful
job provides to identify a custom action in progress. Future jobs use this token to identify the
running instance of the action. It can be reused to return more information about the progress
of the custom action. When the action is complete, no continuation token should be supplied.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

PutJobSuccessResult API Version 2015-07-09 139

CodePipeline API Reference

Required: No
currentRevision

The ID of the current revision of the artifact successfully worked on by the job.

Type: CurrentRevision object

Required: No
executionDetails

The execution details of the successful job, such as the actions taken by the job worker.

Type: ExecutionDetails object

Required: No
jobId

The unique system-generated ID of the job that succeeded. This is the same ID returned from
PollForJobs.

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes
outputVariables

Key-value pairs produced as output by a job worker that can be made available to a
downstream action conﬁguration. outputVariables can be included only when there is no
continuation token on the request.

Type: String to string map

Key Pattern: [A-Za-z0-9@\-_]+

Required: No

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Response Elements API Version 2015-07-09 140

CodePipeline API Reference

Errors
For information about the errors that are common to all actions, see Common Errors.

InvalidJobStateException

The job state was speciﬁed in an invalid format.

HTTP Status Code: 400

JobNotFoundException

The job was speciﬁed in an invalid format or cannot be found.

HTTP Status Code: 400

OutputVariablesSizeExceededException

Exceeded the total size limit for all variables in the pipeline.

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python

Errors API Version 2015-07-09 141

CodePipeline API Reference

• AWS SDK for Ruby V3

The request accepts the following data in JSON format.

clientToken

The clientToken portion of the clientId and clientToken pair used to verify that the calling entity
is allowed access to the job and its details.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes
failureDetails

Represents information about failure details.

Type: FailureDetails object

Required: Yes

PutThirdPartyJobFailureResult API Version 2015-07-09 143

CodePipeline API Reference

jobId

The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidClientTokenException

The client token was speciﬁed in an invalid format

HTTP Status Code: 400

InvalidJobStateException

The job state was speciﬁed in an invalid format.

HTTP Status Code: 400

JobNotFoundException

The job was speciﬁed in an invalid format or cannot be found.

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

Response Elements API Version 2015-07-09 144

CodePipeline API Reference

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

The request accepts the following data in JSON format.

clientToken

The clientToken portion of the clientId and clientToken pair used to verify that the calling entity
is allowed access to the job and its details.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

PutThirdPartyJobSuccessResult API Version 2015-07-09 146

CodePipeline API Reference

continuationToken

A token generated by a job worker, such as a CodeDeploy deployment ID, that a successful
job provides to identify a partner action in progress. Future jobs use this token to identify the
running instance of the action. It can be reused to return more information about the progress
of the partner action. When the action is complete, no continuation token should be supplied.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No
currentRevision

Represents information about a current revision.

Type: CurrentRevision object

Required: No
executionDetails

The details of the actions taken and results produced on an artifact as it passes through stages
in the pipeline.

Type: ExecutionDetails object

Required: No
jobId

The ID of the job that successfully completed. This is the same ID returned from
PollForThirdPartyJobs.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Required: Yes

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Response Elements API Version 2015-07-09 147

CodePipeline API Reference

Errors
For information about the errors that are common to all actions, see Common Errors.

InvalidClientTokenException

The client token was speciﬁed in an invalid format

HTTP Status Code: 400

InvalidJobStateException

The job state was speciﬁed in an invalid format.

HTTP Status Code: 400

JobNotFoundException

The job was speciﬁed in an invalid format or cannot be found.

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python

Errors API Version 2015-07-09 148

CodePipeline API Reference

• AWS SDK for Ruby V3

PutWebhook API Version 2015-07-09 150

CodePipeline API Reference

The request accepts the following data in JSON format.

tags

The tags for the webhook.

Type: Array of Tag objects

Required: No
webhook

The detail provided in an input ﬁle to create the webhook, such as the webhook name, the
pipeline name, and the action name. Give the webhook a unique name that helps you identify
it. You might name the webhook after the pipeline and action it targets so that you can easily
recognize what it's used for later.

Type: WebhookDeﬁnition object

Required: Yes

Response Syntax

{
"webhook": {
"arn": "string",
"definition": {
"authentication": "string",
"authenticationConfiguration": {
"AllowedIPRange": "string",
"SecretToken": "string"
},
"filters": [
{
"jsonPath": "string",
"matchEquals": "string"
}
],
"name": "string",
"targetAction": "string",
"targetPipeline": "string"
},
"errorCode": "string",

Response Syntax API Version 2015-07-09 151

CodePipeline API Reference

"errorMessage": "string",
"lastTriggered": number,
"tags": [
{
"key": "string",
"value": "string"
}
],
"url": "string"
}
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

webhook

The detail returned from creating the webhook, such as the webhook name, webhook URL, and
webhook ARN.

Type: ListWebhookItem object

Errors
For information about the errors that are common to all actions, see Common Errors.

ConcurrentModiﬁcationException

Unable to modify the tag due to a simultaneous update request.

HTTP Status Code: 400

InvalidTagsException

The speciﬁed resource tags are invalid.

HTTP Status Code: 400

InvalidWebhookAuthenticationParametersException

The speciﬁed authentication type is in an invalid format.

Response Elements API Version 2015-07-09 152

CodePipeline API Reference

HTTP Status Code: 400

InvalidWebhookFilterPatternException

The speciﬁed event ﬁlter rule is in an invalid format.

HTTP Status Code: 400

LimitExceededException

The number of pipelines associated with the AWS account has exceeded the limit allowed for
the account.

HTTP Status Code: 400

PipelineNotFoundException

The pipeline was speciﬁed in an invalid format or cannot be found.

HTTP Status Code: 400

TooManyTagsException

The tags limit for a resource has been exceeded.

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2

• AWS SDK for JavaScript V3

• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

The request accepts the following data in JSON format.

webhookName

The name of an existing webhook created with PutWebhook to register with a supported third
party.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: No

Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors
For information about the errors that are common to all actions, see Common Errors.

ValidationException

The validation was speciﬁed in an invalid format.

RegisterWebhookWithThirdParty API Version 2015-07-09 155

CodePipeline API Reference

HTTP Status Code: 400

WebhookNotFoundException

The speciﬁed webhook was entered in an invalid format or cannot be found.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

The request accepts the following data in JSON format.

pipelineExecutionId

The ID of the pipeline execution in the failed stage to be retried. Use the GetPipelineState
action to retrieve the current pipelineExecutionId of the failed stage

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes
pipelineName

The name of the pipeline that contains the failed stage.

Type: String

RetryStageExecution API Version 2015-07-09 157

CodePipeline API Reference

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: Yes
retryMode

The scope of the retry attempt.

Type: String

Valid Values: FAILED_ACTIONS | ALL_ACTIONS

Required: Yes
stageName

The name of the failed stage to be retried.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: Yes

Response Syntax

{
"pipelineExecutionId": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

pipelineExecutionId

The ID of the current workﬂow execution in the failed stage.

Response Syntax API Version 2015-07-09 158

CodePipeline API Reference

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Errors
For information about the errors that are common to all actions, see Common Errors.

ConﬂictException

Your request cannot be handled because the pipeline is busy handling ongoing activities. Try
again later.

HTTP Status Code: 400

NotLatestPipelineExecutionException

The stage has failed in a later run of the pipeline and the pipelineExecutionId associated
with the request is out of date.

HTTP Status Code: 400

PipelineNotFoundException

The pipeline was speciﬁed in an invalid format or cannot be found.

HTTP Status Code: 400

StageNotFoundException

The stage was speciﬁed in an invalid format or cannot be found.

HTTP Status Code: 400

StageNotRetryableException

Unable to retry. The pipeline structure or stage state might have changed while actions awaited
retry, or the stage contains no failed actions.

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

Errors API Version 2015-07-09 159

CodePipeline API Reference

Examples

Example

This example illustrates one usage of RetryStageExecution.

Sample Request

POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 173
X-Amz-Target: CodePipeline_20150709.RetryStageExecution
X-Amz-Date: 20151030T230047Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20151030/us-east-1/
codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-
target, Signature=8d9b5998EXAMPLE

{
"pipelineExecutionId": "3137f7cb-7cf7-EXAMPLE",
"pipelineName": "MyFirstPipeline",
"retryMode": "FAILED_ACTIONS",
"stageName": "Staging"
}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 30

{
"pipelineExecutionId": "3137f7cb-7cf7-EXAMPLE"
}

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

Examples API Version 2015-07-09 160

CodePipeline API Reference

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

The request accepts the following data in JSON format.

clientRequestToken

The system-generated unique ID used to identify a unique execution request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: ^[a-zA-Z0-9-]+$

Required: No

StartPipelineExecution API Version 2015-07-09 162

CodePipeline API Reference

name

The name of the pipeline to start.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: Yes
sourceRevisions

A list that allows you to specify, or override, the source revision for a pipeline execution that's
being started. A source revision is the version with all the changes to your application code, or
source artifact, for the pipeline execution.

Type: Array of SourceRevisionOverride objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No
variables

A list that overrides pipeline variables for a pipeline execution that's being started. Variable
names must match [A-Za-z0-9@\-_]+, and the values can be anything except an empty
string.

Type: Array of PipelineVariable objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: No

Response Syntax

{
"pipelineExecutionId": "string"
}

Response Syntax API Version 2015-07-09 163

CodePipeline API Reference

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

pipelineExecutionId

The unique system-generated ID of the pipeline execution that was started.

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Errors

For information about the errors that are common to all actions, see Common Errors.

ConﬂictException

Your request cannot be handled because the pipeline is busy handling ongoing activities. Try
again later.

HTTP Status Code: 400

PipelineNotFoundException

The pipeline was speciﬁed in an invalid format or cannot be found.

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of StartPipelineExecution.

Response Elements API Version 2015-07-09 164

CodePipeline API Reference

Sample Request

POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 27
X-Amz-Target: CodePipeline_20150709.StartPipelineExecution
X-Amz-Date: 20160707T172713Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20160707/us-east-1/
codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-
target, Signature=8d9b5998EXAMPLE

{
"name": "MyFirstPipeline"
}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 62

{
"pipelineExecutionId": "3137f7cb-7cf7-EXAMPLE"
}

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript V3

• AWS SDK for PHP V3

• AWS SDK for Python
• AWS SDK for Ruby V3

The request accepts the following data in JSON format.

abandon

Use this option to stop the pipeline execution by abandoning, rather than ﬁnishing, in-progress
actions.

Note
This option can lead to failed or out-of-sequence tasks.

Type: Boolean

Required: No
pipelineExecutionId

The ID of the pipeline execution to be stopped in the current stage. Use the
GetPipelineState action to retrieve the current pipelineExecutionId.

StopPipelineExecution API Version 2015-07-09 167

CodePipeline API Reference

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes
pipelineName

The name of the pipeline to stop.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: Yes
reason

Use this option to enter comments, such as the reason the pipeline was stopped.

Type: String

Length Constraints: Maximum length of 200.

Required: No

Response Syntax

{
"pipelineExecutionId": "string"
}

Response Elements
If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

pipelineExecutionId

The unique system-generated ID of the pipeline execution that was stopped.

Response Syntax API Version 2015-07-09 168

CodePipeline API Reference

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Errors

For information about the errors that are common to all actions, see Common Errors.

ConﬂictException

Your request cannot be handled because the pipeline is busy handling ongoing activities. Try
again later.

HTTP Status Code: 400

DuplicatedStopRequestException

The pipeline execution is already in a Stopping state. If you already chose to stop and wait,
you cannot make that request again. You can choose to stop and abandon now, but be aware
that this option can lead to failed tasks or out of sequence tasks. If you already chose to stop
and abandon, you cannot make that request again.

HTTP Status Code: 400

PipelineExecutionNotStoppableException

Unable to stop the pipeline execution. The execution might already be in a Stopped state, or it
might no longer be in progress.

HTTP Status Code: 400

PipelineNotFoundException

The pipeline was speciﬁed in an invalid format or cannot be found.

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

Errors API Version 2015-07-09 169

CodePipeline API Reference

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

The request accepts the following data in JSON format.

resourceArn

The Amazon Resource Name (ARN) of the resource you want to add tags to.

Type: String

Pattern: arn:aws(-[\w]+)*:codepipeline:.+:[0-9]{12}:.+

Required: Yes

tags

The tags you want to modify or add to the resource.

Type: Array of Tag objects

Required: Yes

TagResource API Version 2015-07-09 171

CodePipeline API Reference

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

ConcurrentModiﬁcationException

Unable to modify the tag due to a simultaneous update request.

HTTP Status Code: 400

InvalidArnException

The speciﬁed resource ARN is invalid.

HTTP Status Code: 400

InvalidTagsException

The speciﬁed resource tags are invalid.

HTTP Status Code: 400

ResourceNotFoundException

The resource was speciﬁed in an invalid format.

HTTP Status Code: 400

TooManyTagsException

The tags limit for a resource has been exceeded.

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

Response Elements API Version 2015-07-09 172

CodePipeline API Reference

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

The request accepts the following data in JSON format.

resourceArn

The Amazon Resource Name (ARN) of the resource to remove tags from.

Type: String

Pattern: arn:aws(-[\w]+)*:codepipeline:.+:[0-9]{12}:.+

Required: Yes
tagKeys

The list of keys for the tags to be removed from the resource.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

UntagResource API Version 2015-07-09 174

CodePipeline API Reference

Errors

For information about the errors that are common to all actions, see Common Errors.

ConcurrentModiﬁcationException

Unable to modify the tag due to a simultaneous update request.

HTTP Status Code: 400

InvalidArnException

The speciﬁed resource ARN is invalid.

HTTP Status Code: 400

InvalidTagsException

The speciﬁed resource tags are invalid.

HTTP Status Code: 400

ResourceNotFoundException

The resource was speciﬁed in an invalid format.

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go

Errors API Version 2015-07-09 175

CodePipeline API Reference

• AWS SDK for Java V2

• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

UpdateActionType API Version 2015-07-09 177

CodePipeline API Reference

"properties": [
{
"description": "string",
"key": boolean,
"name": "string",
"noEcho": boolean,
"optional": boolean,
"queryable": boolean
}
],
"urls": {
"configurationUrl": "string",
"entityUrlTemplate": "string",
"executionUrlTemplate": "string",
"revisionUrlTemplate": "string"
}
}
}

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.

actionType

The action type deﬁnition for the action type to be updated.

Type: ActionTypeDeclaration object

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

Request Parameters API Version 2015-07-09 178

CodePipeline API Reference

ActionTypeNotFoundException

The speciﬁed action type cannot be found.

HTTP Status Code: 400

RequestFailedException

The request failed because of an unknown error, exception, or failure.

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

UpdatePipeline API Version 2015-07-09 180

CodePipeline API Reference

"string" : "string"
},
"inputArtifacts": [
{
"name": "string"
}
],
"name": "string",
"namespace": "string",
"outputArtifacts": [
{
"name": "string"
}
],
"region": "string",
"roleArn": "string",
"runOrder": number
}
],
"blockers": [
{
"name": "string",
"type": "string"
}
],
"name": "string"
}
],
"triggers": [
{
"gitConfiguration": {
"push": [
{
"tags": {
"excludes": [ "string" ],
"includes": [ "string" ]
}
}
],
"sourceActionName": "string"
},
"providerType": "string"
}
],

Request Syntax API Version 2015-07-09 181

CodePipeline API Reference

"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: PipelineDeclaration object

Required: Yes

Response Syntax

Request Parameters API Version 2015-07-09 182

CodePipeline API Reference

"location": "string",
"type": "string"
}
},
"name": "string",
"pipelineType": "string",
"roleArn": "string",
"stages": [
{
"actions": [
{
"actionTypeId": {
"category": "string",
"owner": "string",
"provider": "string",
"version": "string"
},
"configuration": {
"string" : "string"
},
"inputArtifacts": [
{
"name": "string"
}
],
"name": "string",
"namespace": "string",
"outputArtifacts": [
{
"name": "string"
}
],
"region": "string",
"roleArn": "string",
"runOrder": number
}
],
"blockers": [
{
"name": "string",
"type": "string"
}
],
"name": "string"

Response Syntax API Version 2015-07-09 183

CodePipeline API Reference

}
],
"triggers": [
{
"gitConfiguration": {
"push": [
{
"tags": {
"excludes": [ "string" ],
"includes": [ "string" ]
}
}
],
"sourceActionName": "string"
},
"providerType": "string"
}
],
"variables": [
{
"defaultValue": "string",
"description": "string",
"name": "string"
}
],
"version": number
}
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

pipeline

The structure of the updated pipeline.

Type: PipelineDeclaration object

Response Elements API Version 2015-07-09 184

CodePipeline API Reference

Errors
For information about the errors that are common to all actions, see Common Errors.

InvalidActionDeclarationException

The action declaration was speciﬁed in an invalid format.

HTTP Status Code: 400

InvalidBlockerDeclarationException

Reserved for future use.

HTTP Status Code: 400

InvalidStageDeclarationException

The stage declaration was speciﬁed in an invalid format.

HTTP Status Code: 400

InvalidStructureException

The structure was speciﬁed in an invalid format.

HTTP Status Code: 400

LimitExceededException

The number of pipelines associated with the AWS account has exceeded the limit allowed for
the account.

HTTP Status Code: 400

ValidationException

The validation was speciﬁed in an invalid format.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of UpdatePipeline.

Errors API Version 2015-07-09 185

CodePipeline API Reference

Sample Request

POST / HTTP/1.1
Host: codepipeline.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 914
X-Amz-Target: CodePipeline_20150709.UpdatePipeline
X-Amz-Date: 20160707T174930Z
User-Agent: aws-cli/1.7.38 Python/2.7.9 Windows/7
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAI44QH8DHBEXAMPLE/20160707/us-east-1/
codepipeline/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-
target, Signature=8d9b5998EXAMPLE

Examples API Version 2015-07-09 186

CodePipeline API Reference

"name": "Staging",
"actions": [
{
"inputArtifacts": [
{
"name": "MyApp"
}
],
"name": "CodePipelineDemoFleet",
"actionTypeId": {
"category": "Deploy",
"owner": "AWS",
"version": "1",
"provider": "CodeDeploy"
},
"outputArtifacts": [],
"configuration": {
"ApplicationName": "CodePipelineDemoApplication",
"DeploymentGroupName": "CodePipelineDemoFleet"
},
"runOrder": 1
}
]
}
],
"artifactStore": {
"type": "S3",
"location": "codepipeline-us-east-1-11EXAMPLE11"
},
"name": "MyFirstPipeline",
"version": 1
}
}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: 620484b7-88cb-11e5-b497-75c49EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 898

{
"pipeline": {

Examples API Version 2015-07-09 187

CodePipeline API Reference

"artifactStore": {
"location": "codepipeline-us-east-1-11EXAMPLE11",
"type": "S3"
},
"name": "MyFirstPipeline",
"roleArn": "arn:aws:iam::111111111111:role/AWS-CodePipeline-Service",
"stages": [
{
"actions": [
{
"actionTypeId": {
"__type": "ActionTypeId",
"category": "Source",
"owner": "AWS",
"provider": "S3",
"version": "1"
},
"configuration": {
"S3Bucket": "awscodepipeline-demo-bucket2",
"S3ObjectKey": "aws-codepipeline-s3-aws-codedeploy_linux.zip"
},
"inputArtifacts": [],
"name": "Source",
"outputArtifacts": [
{
"name": "MyApp"
}
],
"runOrder": 1
}
],
"name": "Source"
},
{
"actions": [
{
"actionTypeId": {
"__type": "ActionTypeId",
"category": "Deploy",
"owner": "AWS",
"provider": "CodeDeploy",
"version": "1"
},
"configuration": {

Examples API Version 2015-07-09 188

CodePipeline API Reference

"ApplicationName": "CodePipelineDemoApplication",
"DeploymentGroupName": "CodePipelineDemoFleet"
},
"inputArtifacts": [
{
"name": "MyApp"
}
],
"name": "CodePipelineDemoFleet",
"outputArtifacts": [],
"runOrder": 1
}
],
"name": "Staging"
}
],
"version": 3
}
}

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS Command Line Interface

• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript V3
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3

The following data types are supported:

• ActionConfiguration
• ActionConfigurationProperty
• ActionContext
• ActionDeclaration
• ActionExecution
• ActionExecutionDetail
• ActionExecutionFilter
• ActionExecutionInput
• ActionExecutionOutput
• ActionExecutionResult
• ActionRevision
• ActionState
• ActionType
• ActionTypeArtifactDetails
• ActionTypeDeclaration
• ActionTypeExecutor
• ActionTypeId
• ActionTypeIdentifier
• ActionTypePermissions
• ActionTypeProperty

API Version 2015-07-09 190

CodePipeline API Reference

• ActionTypeSettings
• ActionTypeUrls
• ApprovalResult
• Artifact
• ArtifactDetail
• ArtifactDetails
• ArtifactLocation
• ArtifactRevision
• ArtifactStore
• AWSSessionCredentials
• BlockerDeclaration
• CurrentRevision
• EncryptionKey
• ErrorDetails
• ExecutionDetails
• ExecutionTrigger
• ExecutorConfiguration
• FailureDetails
• GitConfiguration
• GitPushFilter
• GitTagFilterCriteria
• InputArtifact
• Job
• JobData
• JobDetails
• JobWorkerExecutorConfiguration
• LambdaExecutorConfiguration
• ListWebhookItem
• OutputArtifact
• PipelineContext

API Version 2015-07-09 191

CodePipeline API Reference

• PipelineDeclaration
• PipelineExecution
• PipelineExecutionSummary
• PipelineMetadata
• PipelineSummary
• PipelineTriggerDeclaration
• PipelineVariable
• PipelineVariableDeclaration
• ResolvedPipelineVariable
• S3ArtifactLocation
• S3Location
• SourceRevision
• SourceRevisionOverride
• StageContext
• StageDeclaration
• StageExecution
• StageState
• StopExecutionTrigger
• Tag
• ThirdPartyJob
• ThirdPartyJobData
• ThirdPartyJobDetails
• TransitionState
• WebhookAuthConﬁguration
• WebhookDeﬁnition
• WebhookFilterRule

API Version 2015-07-09 192

CodePipeline API Reference

ActionConﬁguration
Represents information about an action conﬁguration.

Contents
conﬁguration

The conﬁguration data for the action.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 50.

Value Length Constraints: Minimum length of 1. Maximum length of 1000.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

ActionConﬁguration API Version 2015-07-09 193

CodePipeline API Reference

ActionConﬁgurationProperty
Represents information about an action conﬁguration property.

Contents
key

Whether the conﬁguration property is a key.

Type: Boolean

Required: Yes
name

The name of the action conﬁguration property.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Required: Yes
required

Whether the conﬁguration property is a required value.

Type: Boolean

Required: Yes
secret

Whether the conﬁguration property is secret. Secrets are hidden from all calls
except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and
PollForThirdPartyJobs.

When updating a pipeline, passing * * * * * without changing any other values of the action
preserves the previous value of the secret.

Type: Boolean

Required: Yes

ActionConﬁgurationProperty API Version 2015-07-09 194

CodePipeline API Reference

description

The description of the action conﬁguration property that is displayed to users.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 160.

Required: No
queryable

Indicates that the property is used with PollForJobs. When creating a custom action, an
action can have up to one queryable property. If it has one, that property must be both required
and not secret.

If you create a pipeline with a custom action type, and that custom action contains a queryable
property, the value for that conﬁguration property is subject to other restrictions. The value
must be less than or equal to twenty (20) characters. The value can contain only alphanumeric
characters, underscores, and hyphens.

Type: Boolean

Required: No
type

The type of the conﬁguration property.

Type: String

Valid Values: String | Number | Boolean

Required: No

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for Ruby V3

The system-generated unique ID that corresponds to an action's execution.

Type: String

Required: No
name

The name of the action in the context of a job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

ActionContext API Version 2015-07-09 197

CodePipeline API Reference

ActionDeclaration
Represents information about an action declaration.

Contents
actionTypeId

Speciﬁes the action type and the provider of the action.

Type: ActionTypeId object

Required: Yes
name

The action declaration's name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: Yes
conﬁguration

The action's configuration. These are key-value pairs that specify input values for an action.
For more information, see Action Structure Requirements in CodePipeline. For the list of
configuration properties for the AWS CloudFormation action type in CodePipeline, see
Configuration Properties Reference in the AWS CloudFormation User Guide. For template
snippets with examples, see Using Parameter Override Functions with CodePipeline Pipelines in
the AWS CloudFormation User Guide.

The values can be represented in either JSON or YAML format. For example, the JSON
conﬁguration item format is as follows:

JSON:

"Configuration" : { Key : Value },

Type: String to string map

ActionDeclaration API Version 2015-07-09 198

CodePipeline API Reference

Key Length Constraints: Minimum length of 1. Maximum length of 50.

Value Length Constraints: Minimum length of 1. Maximum length of 1000.

Required: No
inputArtifacts

The name or ID of the artifact consumed by the action, such as a test or build artifact.

Type: Array of InputArtifact objects

Required: No
namespace

The variable namespace associated with the action. All variables produced as output by this
action fall under this namespace.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9@\-_]+

Required: No
outputArtifacts

The name or ID of the result of the action declaration, such as a test or build artifact.

Type: Array of OutputArtifact objects

Required: No
region

The action declaration's AWS Region, such as us-east-1.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 30.

Required: No

Contents API Version 2015-07-09 199

CodePipeline API Reference

roleArn

The ARN of the IAM service role that performs the declared action. This is assumed through the
roleArn for the pipeline.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: arn:aws(-[\w]+)*:iam::[0-9]{12}:role/.*

Required: No
runOrder

The order in which actions are run.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 999.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

The details of an error returned by a URL external to AWS.

Type: ErrorDetails object

Required: No
externalExecutionId

The external ID of the run of the action.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1500.

Required: No
externalExecutionUrl

The URL of a resource external to AWS that is used when running the action (for example, an
external repository URL).

ActionExecution API Version 2015-07-09 201

CodePipeline API Reference

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No
lastStatusChange

The last status change of the action.

Type: Timestamp

Required: No
lastUpdatedBy

The ARN of the user who last changed the pipeline.

Type: String

Required: No
percentComplete

A percentage of completeness of the action as it runs.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 100.

Required: No
status

The status of the action, or for a completed action, the last status of the action.

Type: String

Valid Values: InProgress | Abandoned | Succeeded | Failed

Required: No
summary

A summary of the run of the action.

Type: String

Contents API Version 2015-07-09 202

CodePipeline API Reference

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No
token

The system-generated token used to identify a unique approval request. The token for each
open approval request can be obtained using the GetPipelineState command. It is used to
validate that the approval request corresponding to this token is still valid.

Type: String

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

The action execution ID.

Type: String

Required: No
actionName

The name of the action.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: No
input

Input details for the action execution, such as role ARN, Region, and input artifacts.

Type: ActionExecutionInput object

Required: No
lastUpdateTime

The last update time of the action execution.

Type: Timestamp

Required: No
output

Output details for the action execution, such as the action execution result.

ActionExecutionDetail API Version 2015-07-09 204

CodePipeline API Reference

Type: ActionExecutionOutput object

Required: No
pipelineExecutionId

The pipeline execution ID for the action execution.

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: No
pipelineVersion

The version of the pipeline where the action was run.

Type: Integer

Valid Range: Minimum value of 1.

Required: No
stageName

The name of the stage that contains the action.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: No
startTime

The start time of the action execution.

Type: Timestamp

Required: No
status

The status of the action execution. Status categories are InProgress, Succeeded, and
Failed.

Contents API Version 2015-07-09 205

CodePipeline API Reference

Type: String

Valid Values: InProgress | Abandoned | Succeeded | Failed

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

The pipeline execution ID used to ﬁlter action execution history.

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

ActionExecutionFilter API Version 2015-07-09 207

CodePipeline API Reference

ActionExecutionInput
Input information used for an action execution.

Contents
actionTypeId

Represents information about an action type.

Type: ActionTypeId object

Required: No
conﬁguration

Conﬁguration data for an action execution.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 50.

Value Length Constraints: Minimum length of 1. Maximum length of 1000.

Required: No
inputArtifacts

Details of input artifacts of the action that correspond to the action execution.

Type: Array of ArtifactDetail objects

Required: No
namespace

The variable namespace associated with the action. All variables produced as output by this
action fall under this namespace.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9@\-_]+

ActionExecutionInput API Version 2015-07-09 208

CodePipeline API Reference

Required: No
region

The AWS Region for the action, such as us-east-1.

Type: String

Length Constraints: Minimum length of 4. Maximum length of 30.

Required: No
resolvedConﬁguration

Conﬁguration data for an action execution with all variable references replaced with their real
values for the execution.

Type: String to string map

Required: No
roleArn

The ARN of the IAM service role that performs the declared action. This is assumed through the
roleArn for the pipeline.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: arn:aws(-[\w]+)*:iam::[0-9]{12}:role/.*

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

Type: ActionExecutionResult object

Required: No
outputArtifacts

Details of output artifacts of the action that correspond to the action execution.

Type: Array of ArtifactDetail objects

Required: No
outputVariables

The outputVariables ﬁeld shows the key-value pairs that were output as part of that execution.

Type: String to string map

Key Pattern: [A-Za-z0-9@\-_]+

Required: No

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

ActionExecutionOutput API Version 2015-07-09 211

CodePipeline API Reference

The action provider's external ID for the action execution.

Type: String

Required: No
externalExecutionSummary

The action provider's summary for the action execution.

Type: String

Required: No
externalExecutionUrl

The deepest external link to the external resource (for example, a repository URL or deployment
endpoint) that is used when running the action.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2

ActionExecutionResult API Version 2015-07-09 213

CodePipeline API Reference

• AWS SDK for Ruby V3

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes
revisionId

The system-generated unique ID that identiﬁes the revision number of the action.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1500.

Required: Yes

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

ActionRevision API Version 2015-07-09 215

CodePipeline API Reference

• AWS SDK for Go

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The name of the action.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: No
currentRevision

Represents information about the version (or revision) of an action.

Type: ActionRevision object

Required: No
entityUrl

A URL link for more information about the state of the action, such as a deployment group
details page.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No
latestExecution

Represents information about the run of an action.

Type: ActionExecution object

Required: No

ActionState API Version 2015-07-09 217

CodePipeline API Reference

revisionUrl

A URL link for more information about the revision, such as a commit details page.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

Represents information about an action type.

Type: ActionTypeId object

Required: Yes
inputArtifactDetails

The details of the input artifact for the action, such as its commit ID.

Type: ArtifactDetails object

Required: Yes
outputArtifactDetails

The details of the output artifact of the action, such as its commit ID.

Type: ArtifactDetails object

Required: Yes
actionConﬁgurationProperties

The conﬁguration properties for the action type.

Type: Array of ActionConﬁgurationProperty objects

Array Members: Maximum number of 10 items.

Required: No
settings

The settings for the action type.

Type: ActionTypeSettings object

ActionType API Version 2015-07-09 219

CodePipeline API Reference

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

Valid Range: Minimum value of 0. Maximum value of 10.

Required: Yes
minimumCount

The minimum number of artifacts that can be used with the action type. For example, you
should specify a minimum and maximum of zero input artifacts for an action type with a
category of source.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 10.

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

ActionTypeArtifactDetails API Version 2015-07-09 221

CodePipeline API Reference

Type: ActionTypeExecutor object

Required: Yes
id

The action category, owner, provider, and version of the action type to be updated.

Type: ActionTypeIdentiﬁer object

Required: Yes
inputArtifactDetails

Details for the artifacts, such as application ﬁles, to be worked on by the action. For example,
the minimum and maximum number of input artifacts allowed.

Type: ActionTypeArtifactDetails object

Required: Yes
outputArtifactDetails

Details for the output artifacts, such as a built application, that are the result of the action. For
example, the minimum and maximum number of output artifacts allowed.

Type: ActionTypeArtifactDetails object

Required: Yes
description

The description for the action type to be updated.

ActionTypeDeclaration API Version 2015-07-09 223

CodePipeline API Reference

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No
permissions

Details identifying the accounts with permissions to use the action type.

Type: ActionTypePermissions object

Required: No
properties

The properties of the action type to be updated.

Type: Array of ActionTypeProperty objects

Array Members: Maximum number of 10 items.

Required: No
urls

The links associated with the action type to be updated.

Type: ActionTypeUrls object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

Type: ExecutorConﬁguration object

Required: Yes
type

The integration model used to create and update the action type, Lambda or JobWorker.

Type: String

Valid Values: JobWorker | Lambda

Required: Yes
jobTimeout

The timeout in seconds for the job. An action execution can have multiple jobs. This is the
timeout for a single job, not the entire action execution.

Type: Integer

Valid Range: Minimum value of 60. Maximum value of 43200.

Required: No
policyStatementsTemplate

The policy statement that speciﬁes the permissions in the CodePipeline customer account that
are needed to successfully run an action.

To grant permission to another account, specify the account ID as the Principal, a domain-style
identiﬁer deﬁned by the service, for example codepipeline.amazonaws.com.

ActionTypeExecutor API Version 2015-07-09 225

CodePipeline API Reference

Note
The size of the passed JSON policy document cannot exceed 2048 characters.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

Valid Values: Source | Build | Deploy | Test | Invoke | Approval

Required: Yes
owner

The creator of the action being called. There are three valid values for the Owner ﬁeld in the
action category section within your pipeline structure: AWS, ThirdParty, and Custom. For
more information, see Valid Action Types and Providers in CodePipeline.

Type: String

Valid Values: AWS | ThirdParty | Custom

Required: Yes
provider

The provider of the service being called by the action. Valid providers are determined by the
action category. For example, an action in the Deploy category type might have a provider of
CodeDeploy, which would be speciﬁed as CodeDeploy. For more information, see Valid Action
Types and Providers in CodePipeline.

ActionTypeId API Version 2015-07-09 227

CodePipeline API Reference

Type: String

Length Constraints: Minimum length of 1. Maximum length of 35.

Pattern: [0-9A-Za-z_-]+

Required: Yes
version

A string that describes the action version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 9.

Pattern: [0-9A-Za-z_-]+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

Valid Values: Source | Build | Deploy | Test | Invoke | Approval

Required: Yes
owner

The creator of the action type being called: AWS or ThirdParty.

Type: String

Pattern: AWS|ThirdParty

Required: Yes
provider

The provider of the action type being called. The provider name is supplied when the action
type is created.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 35.

Pattern: [0-9A-Za-z_-]+

ActionTypeIdentiﬁer API Version 2015-07-09 229

CodePipeline API Reference

Required: Yes
version

A string that describes the action type version.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 9.

Pattern: [0-9A-Za-z_-]+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 1000 items.

Pattern: [0-9]{12}|\*

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

ActionTypePermissions API Version 2015-07-09 231

CodePipeline API Reference

ActionTypeProperty
Represents information about each property speciﬁed in the action conﬁguration, such as the
description and key name that display for the customer using the action type.

Contents
key

Whether the conﬁguration property is a key.

Type: Boolean

Required: Yes
name

The property name that is displayed to users.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Required: Yes
noEcho

Whether to omit the ﬁeld value entered by the customer in the log. If true, the value is not
saved in CloudTrail logs for the action execution.

Type: Boolean

Required: Yes
optional

Whether the conﬁguration property is an optional value.

Type: Boolean

Required: Yes
description

The description of the property that is displayed to users.

ActionTypeProperty API Version 2015-07-09 232

CodePipeline API Reference

Type: String

Length Constraints: Minimum length of 1. Maximum length of 250.

Required: No
queryable

Indicates that the property is used with polling. An action type can have up to one queryable
property. If it has one, that property must be both required and not secret.

Type: Boolean

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No
executionUrlTemplate

The URL returned to the CodePipeline console that contains a link to the top-level landing page
for the external system, such as the console page for CodeDeploy. This link is shown on the
pipeline view page in the CodePipeline console and provides a link to the execution entity of
the external action.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No
revisionUrlTemplate

The URL returned to the CodePipeline console that contains a link to the page where customers
can update or change the conﬁguration of the external action.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

ActionTypeSettings API Version 2015-07-09 234

CodePipeline API Reference

thirdPartyConﬁgurationUrl

The URL of a sign-up page where users can sign up for an external service and perform initial
conﬁguration of the action provided by that service.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No
entityUrlTemplate

The URL returned to the CodePipeline console that provides a deep link to the resources of the
external system, such as a status page. This link is provided as part of the action display in the
pipeline.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No
executionUrlTemplate

The link to an execution page for the action type in progress. For example, for a CodeDeploy
action, this link is shown on the pipeline view page in the CodePipeline console, and it links to a
CodeDeploy status page.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

ActionTypeUrls API Version 2015-07-09 236

CodePipeline API Reference

revisionUrlTemplate

The URL returned to the CodePipeline console that contains a link to the page where customers
can update or change the conﬁguration of the external action.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

The response submitted by a reviewer assigned to an approval action request.

Type: String

Valid Values: Approved | Rejected

Required: Yes
summary

The summary of the current status of the approval request.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 512.

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

ApprovalResult API Version 2015-07-09 238

CodePipeline API Reference

Artifact
Artifacts are the files that are worked on by actions in the pipeline. See the action configuration
for each action for details about artifact parameters. For example, the S3 source action artifact is
a file name (or file path), and the files are generally provided as a ZIP file. Example artifact name:
SampleApp_Windows.zip

Contents
location

The location of an artifact.

Type: ArtifactLocation object

Required: No
name

The artifact's name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [a-zA-Z0-9_\-]+

Required: No
revision

The artifact's revision ID. Depending on the type of object, this could be a commit ID (GitHub) or
a revision ID (Amazon S3).

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1500.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

Artifact API Version 2015-07-09 239

CodePipeline API Reference

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

The artifact object name for the action execution.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [a-zA-Z0-9_\-]+

Required: No
s3location

The Amazon S3 artifact location for the action execution.

Type: S3Location object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

ArtifactDetail API Version 2015-07-09 241

CodePipeline API Reference

ArtifactDetails
Returns information about the details of an artifact.

Contents
maximumCount

The maximum number of artifacts allowed for the action type.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 5.

Required: Yes
minimumCount

The minimum number of artifacts allowed for the action type.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 5.

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

ArtifactDetails API Version 2015-07-09 242

CodePipeline API Reference

ArtifactLocation
Represents information about the location of an artifact.

Contents
s3Location

The S3 bucket that contains the artifact.

Type: S3ArtifactLocation object

Required: No
type

The type of artifact in the location.

Type: String

Valid Values: S3

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

ArtifactLocation API Version 2015-07-09 243

CodePipeline API Reference

ArtifactRevision
Represents revision details of an artifact.

Contents
created

The date and time when the most recent revision of the artifact was created, in timestamp
format.

Type: Timestamp

Required: No
name

The name of an artifact. This name might be system-generated, such as "MyApp", or deﬁned by
the user when an action is created.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [a-zA-Z0-9_\-]+

Required: No
revisionChangeIdentiﬁer

An additional identiﬁer for a revision, such as a commit date or, for artifacts stored in Amazon
S3 buckets, the ETag value.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: No
revisionId

The revision ID of the artifact.

Type: String

ArtifactRevision API Version 2015-07-09 244

CodePipeline API Reference

Length Constraints: Minimum length of 1. Maximum length of 1500.

Required: No
revisionSummary

Summary information about the most recent revision of the artifact. For GitHub and
CodeCommit repositories, the commit message. For Amazon S3 buckets or actions, the user-
provided content of a codepipeline-artifact-revision-summary key speciﬁed in the
object metadata.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No
revisionUrl

The commit ID for the artifact revision. For artifacts stored in GitHub or CodeCommit
repositories, the commit ID is linked to a commit details page.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: [a-zA-Z0-9\-\.]+

Required: Yes
type

The type of the artifact store, such as S3.

Type: String

Valid Values: S3

Required: Yes
encryptionKey

The encryption key used to encrypt the data in the artifact store, such as an AWS Key
Management Service key. If this is undeﬁned, the default key for Amazon S3 is used.

ArtifactStore API Version 2015-07-09 246

CodePipeline API Reference

Type: EncryptionKey object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

The access key for the session.

Type: String

Required: Yes
secretAccessKey

The secret access key for the session.

Type: String

Required: Yes
sessionToken

The token for the session.

Type: String

Required: Yes

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

AWSSessionCredentials API Version 2015-07-09 248

CodePipeline API Reference

Reserved for future use.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes
type

Reserved for future use.

Type: String

Valid Values: Schedule

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

BlockerDeclaration API Version 2015-07-09 250

CodePipeline API Reference

CurrentRevision
Represents information about a current revision.

Contents
changeIdentiﬁer

The change identiﬁer for the current revision.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes
revision

The revision ID of the current version of an artifact.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1500.

Required: Yes
created

The date and time when the most recent revision of the artifact was created, in timestamp
format.

Type: Timestamp

Required: No
revisionSummary

The summary of the most recent revision of the artifact.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

CurrentRevision API Version 2015-07-09 251

CodePipeline API Reference

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

Length Constraints: Minimum length of 1. Maximum length of 400.

Required: Yes
type

The type of encryption key, such as an AWS KMS key. When creating or updating a pipeline, the
value must be set to 'KMS'.

Type: String

Valid Values: KMS

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

EncryptionKey API Version 2015-07-09 253

CodePipeline API Reference

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

The system ID or number code of the error.

Type: String

Required: No
message

The text of the error message.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 5000.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

ErrorDetails API Version 2015-07-09 255

CodePipeline API Reference

ExecutionDetails
The details of the actions taken and results produced on an artifact as it passes through stages in
the pipeline.

Contents
externalExecutionId

The system-generated unique ID of this action used to identify this job worker in any external
systems, such as CodeDeploy.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1500.

Required: No
percentComplete

The percentage of work completed on the action, represented on a scale of 0 to 100 percent.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 100.

Required: No
summary

The summary of the current status of the actions.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

ExecutionDetails API Version 2015-07-09 256

CodePipeline API Reference

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

Length Constraints: Minimum length of 0. Maximum length of 1024.

Required: No
triggerType

The type of change-detection method, command, or user interaction that started a pipeline
execution.

Type: String

Valid Values: CreatePipeline | StartPipelineExecution | PollForSourceChanges

| Webhook | CloudWatchEvent | PutActionRevision | WebhookV2

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

ExecutionTrigger API Version 2015-07-09 258

CodePipeline API Reference

ExecutorConﬁguration
The action engine, or executor, related to the supported integration model used to create and
update the action type. The available executor types are Lambda and JobWorker.

Contents
jobWorkerExecutorConﬁguration

Details about the JobWorker executor of the action type.

Type: JobWorkerExecutorConﬁguration object

Required: No
lambdaExecutorConﬁguration

Details about the Lambda executor of the action type.

Type: LambdaExecutorConﬁguration object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

ExecutorConﬁguration API Version 2015-07-09 259

CodePipeline API Reference

FailureDetails
Represents information about failure details.

Contents
message

The message about the failure.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 5000.

Required: Yes
type

The type of the failure.

Type: String

Valid Values: JobFailed | ConfigurationError | PermissionError |

RevisionOutOfSync | RevisionUnavailable | SystemUnavailable

Required: Yes
externalExecutionId

The external ID of the run of the action that failed.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1500.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

FailureDetails API Version 2015-07-09 260

CodePipeline API Reference

• AWS SDK for Go

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: Yes
push

The ﬁeld where the repository event that will start the pipeline, such as pushing Git tags, is
speciﬁed with details.

Note
Git tags is the only supported event type.

Type: Array of GitPushFilter objects

GitConﬁguration API Version 2015-07-09 262

CodePipeline API Reference

Array Members: Fixed number of 1 item.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

Type: GitTagFilterCriteria object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

GitPushFilter API Version 2015-07-09 264

CodePipeline API Reference

GitTagFilterCriteria
The Git tags speciﬁed as ﬁlter criteria for whether a Git tag repository event will start the pipeline.

Contents
excludes

The list of patterns of Git tags that, when pushed, are to be excluded from starting the pipeline.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 8 items.

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No
includes

The list of patterns of Git tags that, when pushed, are to be included as criteria that starts the
pipeline.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 8 items.

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: No

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

GitTagFilterCriteria API Version 2015-07-09 265

CodePipeline API Reference

The name of the artifact to be worked on (for example, "My App").

Artifacts are the files that are worked on by actions in the pipeline. See the action configuration
for each action for details about artifact parameters. For example, the S3 source action input
artifact is a file name (or file path), and the files are generally provided as a ZIP file. Example
artifact name: SampleApp_Windows.zip

The input artifact of an action must exactly match the output artifact declared in a preceding
action, but the input artifact does not have to be the next action in strict sequence from
the action that provided the output artifact. Actions in parallel can declare diﬀerent output
artifacts, which are in turn consumed by diﬀerent following actions.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [a-zA-Z0-9_\-]+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

InputArtifact API Version 2015-07-09 267

CodePipeline API Reference

Job
Represents information about a job.

Contents
accountId

The ID of the AWS account to use when performing the job.

Type: String

Pattern: [0-9]{12}

Required: No
data

Other data about a job.

Type: JobData object

Required: No
id

The unique system-generated ID of the job.

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: No
nonce

A system-generated random number that CodePipeline uses to ensure that the job is being
worked on by only one job worker. Use this number in an AcknowledgeJob request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Required: No

Job API Version 2015-07-09 268

CodePipeline API Reference

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

Represents information about an action conﬁguration.

Type: ActionConﬁguration object

Required: No
actionTypeId

Represents information about an action type.

Type: ActionTypeId object

Required: No
artifactCredentials

Represents an AWS session credentials object. These credentials are temporary credentials that
are issued by AWS Secure Token Service (STS). They can be used to access input and output
artifacts in the S3 bucket used to store artifacts for the pipeline in CodePipeline.

Type: AWSSessionCredentials object

Required: No
continuationToken

A system-generated token, such as a deployment ID, required by a job to continue the job
asynchronously.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

JobData API Version 2015-07-09 270

CodePipeline API Reference

encryptionKey

Represents information about the key used to encrypt data in the artifact store, such as an AWS
KMS key.

Type: EncryptionKey object

Required: No
inputArtifacts

The artifact supplied to the job.

Type: Array of Artifact objects

Required: No
outputArtifacts

The output of the job.

Type: Array of Artifact objects

Required: No
pipelineContext

Represents information about a pipeline to a job worker.

Note
Includes pipelineArn and pipelineExecutionId for custom jobs.

Type: PipelineContext object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The AWS account ID associated with the job.

Type: String

Pattern: [0-9]{12}

Required: No
data

Represents other information about a job required for a job worker to complete the job.

Type: JobData object

Required: No
id

The unique system-generated ID of the job.

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2

JobDetails API Version 2015-07-09 273

CodePipeline API Reference

• AWS SDK for Ruby V3

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 1000 items.

Pattern: [0-9]{12}

Required: No
pollingServicePrincipals

The service Principals in which the job worker is conﬁgured and might poll for jobs as part of
the action execution.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

JobWorkerExecutorConﬁguration API Version 2015-07-09 275

CodePipeline API Reference

The ARN of the Lambda function used by the action engine.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 140.

Pattern: arn:aws(-[\w]+)*:lambda:.+:[0-9]{12}:function:.+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

LambdaExecutorConﬁguration API Version 2015-07-09 277

CodePipeline API Reference

ListWebhookItem
The detail returned for each webhook after listing webhooks, such as the webhook URL, the
webhook name, and the webhook ARN.

Contents
deﬁnition

The detail returned for each webhook, such as the webhook authentication type and ﬁlter rules.

Type: WebhookDeﬁnition object

Required: Yes
url

A unique URL generated by CodePipeline. When a POST request is made to this URL, the
defined pipeline is started as long as the body of the post request satisfies the defined
authentication and filtering conditions. Deleting and re-creating a webhook makes the old URL
invalid and generates a new one.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Required: Yes
arn

The Amazon Resource Name (ARN) of the webhook.

Type: String

Required: No
errorCode

The number code of the error.

Type: String

Required: No

ListWebhookItem API Version 2015-07-09 278

CodePipeline API Reference

errorMessage

The text of the error message about the webhook.

Type: String

Required: No
lastTriggered

The date and time a webhook was last successfully triggered, in timestamp format.

Type: Timestamp

Required: No
tags

Speciﬁes the tags applied to the webhook.

Type: Array of Tag objects

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

The name of the output of an artifact, such as "My App".

Output artifact names must be unique within a pipeline.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [a-zA-Z0-9_\-]+

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

OutputArtifact API Version 2015-07-09 280

CodePipeline API Reference

PipelineContext
Represents information about a pipeline to a job worker.

Note
PipelineContext contains pipelineArn and pipelineExecutionId for custom action
jobs. The pipelineArn and pipelineExecutionId ﬁelds are not populated for
ThirdParty action jobs.

Contents
action

The context of an action to a job worker in the stage of a pipeline.

Type: ActionContext object

Required: No
pipelineArn

The Amazon Resource Name (ARN) of the pipeline.

Type: String

Pattern: arn:aws(-[\w]+)*:codepipeline:.+:[0-9]{12}:.+

Required: No
pipelineExecutionId

The execution ID of the pipeline.

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: No
pipelineName

The name of the pipeline. This is a user-speciﬁed value. Pipeline names must be unique across
all pipeline names under an AWS account.

PipelineContext API Version 2015-07-09 281

CodePipeline API Reference

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: No
stage

The stage of the pipeline.

Type: StageContext object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

The name of the pipeline.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: Yes
roleArn

The Amazon Resource Name (ARN) for CodePipeline to use to either perform actions with no
actionRoleArn, or to use to assume roles for actions with an actionRoleArn.

Type: String

Length Constraints: Maximum length of 1024.

Pattern: arn:aws(-[\w]+)*:iam::[0-9]{12}:role/.*

Required: Yes
stages

The stage in which to perform the action.

Type: Array of StageDeclaration objects

Required: Yes
artifactStore

Represents information about the S3 bucket where artifacts are stored for the pipeline.

PipelineDeclaration API Version 2015-07-09 283

CodePipeline API Reference

Note
You must include either artifactStore or artifactStores in your pipeline, but
you cannot use both. If you create a cross-region action in your pipeline, you must use
artifactStores.

Type: ArtifactStore object

Required: No

artifactStores

A mapping of artifactStore objects and their corresponding AWS Regions. There must be an
artifact store for the pipeline Region and for each cross-region action in the pipeline.

Note
You must include either artifactStore or artifactStores in your pipeline, but
you cannot use both. If you create a cross-region action in your pipeline, you must use
artifactStores.

Type: String to ArtifactStore object map

Key Length Constraints: Minimum length of 4. Maximum length of 30.

Required: No

pipelineType

CodePipeline provides the following pipeline types, which diﬀer in characteristics and price, so
that you can tailor your pipeline features and cost to the needs of your applications.

• V1 type pipelines have a JSON structure that contains standard pipeline, stage, and action-
level parameters.

• V2 type pipelines have the same structure as a V1 type, along with additional parameters for
release safety and trigger conﬁguration.

Contents API Version 2015-07-09 284

CodePipeline API Reference

Important
Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when
creating or updating a pipeline will result in the pipeline having the V2 type of pipeline
and the associated costs.

For information about pricing for CodePipeline, see Pricing.

For information about which type of pipeline to choose, see What type of pipeline is right for
me?.

Type: String

Valid Values: V1 | V2

Required: No
triggers

The trigger conﬁguration specifying a type of event, such as Git tags, that starts the pipeline.

Note
When a trigger conﬁguration is speciﬁed, default change detection for repository and
branch commits is disabled.

Type: Array of PipelineTriggerDeclaration objects

Array Members: Maximum number of 20 items.

Required: No
variables

A list that deﬁnes the pipeline variables for a pipeline resource. Variable names can have
alphanumeric and underscore characters, and the values must match [A-Za-z0-9@\-_]+.

Type: Array of PipelineVariableDeclaration objects

Array Members: Maximum number of 50 items.

Contents API Version 2015-07-09 285

CodePipeline API Reference

Required: No
version

The version number of the pipeline. A new pipeline always has a version number of 1. This
number is incremented when a pipeline is updated.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

A list of ArtifactRevision objects included in a pipeline execution.

Type: Array of ArtifactRevision objects

Required: No
pipelineExecutionId

The ID of the pipeline execution.

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: No
pipelineName

The name of the pipeline with the speciﬁed pipeline execution.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: No
pipelineVersion

The version number of the pipeline with the speciﬁed pipeline execution.

Type: Integer

Valid Range: Minimum value of 1.

PipelineExecution API Version 2015-07-09 287

CodePipeline API Reference

Required: No
status

The status of the pipeline execution.

• Cancelled: The pipeline’s deﬁnition was updated before the pipeline execution could be
completed.
• InProgress: The pipeline execution is currently running.
• Stopped: The pipeline execution was manually stopped. For more information, see Stopped
Executions.
• Stopping: The pipeline execution received a request to be manually stopped. Depending
on the selected stop mode, the execution is either completing or abandoning in-progress
actions. For more information, see Stopped Executions.
• Succeeded: The pipeline execution was completed successfully.
• Superseded: While this pipeline execution was waiting for the next stage to be completed,
a newer pipeline execution advanced and continued through the pipeline instead. For more
information, see Superseded Executions.
• Failed: The pipeline execution was not completed successfully.

Type: String

Valid Values: Cancelled | InProgress | Stopped | Stopping | Succeeded |

Superseded | Failed

Required: No
statusSummary

A summary that contains a description of the pipeline execution status.

Type: String

Required: No
trigger

The interaction or event that started a pipeline execution.

Type: ExecutionTrigger object

Required: No

Contents API Version 2015-07-09 288

CodePipeline API Reference

variables

A list of pipeline variables used for the pipeline execution.

Type: Array of ResolvedPipelineVariable objects

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

The ID of the pipeline execution.

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: No
sourceRevisions

A list of the source artifact revisions that initiated a pipeline execution.

Type: Array of SourceRevision objects

Required: No
startTime

The date and time when the pipeline execution began, in timestamp format.

Type: Timestamp

Required: No
status

The status of the pipeline execution.

• InProgress: The pipeline execution is currently running.

PipelineExecutionSummary API Version 2015-07-09 290

CodePipeline API Reference

• Stopped: The pipeline execution was manually stopped. For more information, see Stopped
Executions.
• Stopping: The pipeline execution received a request to be manually stopped. Depending
on the selected stop mode, the execution is either completing or abandoning in-progress
actions. For more information, see Stopped Executions.
• Succeeded: The pipeline execution was completed successfully.
• Superseded: While this pipeline execution was waiting for the next stage to be completed,
a newer pipeline execution advanced and continued through the pipeline instead. For more
information, see Superseded Executions.
• Failed: The pipeline execution was not completed successfully.

Type: String

Valid Values: Cancelled | InProgress | Stopped | Stopping | Succeeded |

Superseded | Failed

Required: No
stopTrigger

The interaction that stopped a pipeline execution.

Type: StopExecutionTrigger object

Required: No
trigger

The interaction or event that started a pipeline execution, such as automated change detection
or a StartPipelineExecution API call.

Type: ExecutionTrigger object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The Amazon Resource Name (ARN) of the pipeline.

Type: String

Pattern: arn:aws(-[\w]+)*:codepipeline:.+:[0-9]{12}:.+

Required: No
pollingDisabledAt

The date and time that polling for source changes (periodic checks) was stopped for the
pipeline, in timestamp format. You can migrate (update) a polling pipeline to use event-based
change detection. For example, for a pipeline with a CodeCommit source, we recommend you
migrate (update) your pipeline to use CloudWatch Events. To learn more, see Migrate polling
pipelines to use event-based change detection in the AWS CodePipeline User Guide.

Type: Timestamp

Required: No
updated

The date and time the pipeline was last updated, in timestamp format.

Type: Timestamp

Required: No

PipelineMetadata API Version 2015-07-09 293

CodePipeline API Reference

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

The name of the pipeline.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: No
pipelineType

CodePipeline provides the following pipeline types, which diﬀer in characteristics and price, so
that you can tailor your pipeline features and cost to the needs of your applications.
• V1 type pipelines have a JSON structure that contains standard pipeline, stage, and action-
level parameters.
• V2 type pipelines have the same structure as a V1 type, along with additional parameters for
release safety and trigger conﬁguration.

PipelineSummary API Version 2015-07-09 295

CodePipeline API Reference

For information about pricing for CodePipeline, see Pricing.

For information about which type of pipeline to choose, see What type of pipeline is right for
me?.

Type: String

Valid Values: V1 | V2

Required: No
updated

The date and time of the last update to the pipeline, in timestamp format.

Type: Timestamp

Required: No
version

The version number of the pipeline.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

Type: GitConﬁguration object

Required: Yes

providerType

The source provider for the event, such as connections configured for a repository with Git tags,
for the specified trigger configuration.

Type: String

Valid Values: CodeStarSourceConnection

Required: Yes

PipelineTriggerDeclaration API Version 2015-07-09 297

CodePipeline API Reference

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

The name of a pipeline-level variable.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [A-Za-z0-9@\-_]+

Required: Yes
value

The value of a pipeline-level variable.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Pattern: .*

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

PipelineVariable API Version 2015-07-09 299

CodePipeline API Reference

PipelineVariableDeclaration
A variable declared at the pipeline level.

Contents
name

The name of a pipeline-level variable.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [A-Za-z0-9@\-_]+

Required: Yes
defaultValue

The value of a pipeline-level variable.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1000.

Pattern: .*

Required: No
description

The description of a pipeline-level variable. It's used to add additional context about the
variable, and not being used at time when pipeline executes.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 200.

Pattern: .*

Required: No

PipelineVariableDeclaration API Version 2015-07-09 300

CodePipeline API Reference

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

The name of a pipeline-level variable.

Type: String

Required: No
resolvedValue

The resolved value of a pipeline-level variable.

Type: String

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

ResolvedPipelineVariable API Version 2015-07-09 302

CodePipeline API Reference

S3ArtifactLocation
The location of the S3 bucket that contains a revision.

Contents
bucketName

The name of the S3 bucket.

Type: String

Required: Yes
objectKey

The key of the object in the S3 bucket, which uniquely identiﬁes the object in the bucket.

Type: String

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

S3ArtifactLocation API Version 2015-07-09 303

CodePipeline API Reference

S3Location
The Amazon S3 artifact location for an action's artifacts.

Contents
bucket

The Amazon S3 artifact bucket for an action's artifacts.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Required: No
key

The artifact name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

S3Location API Version 2015-07-09 304

CodePipeline API Reference

SourceRevision
Information about the version (or revision) of a source artifact that initiated a pipeline execution.

Contents
actionName

The name of the action that processed the revision to the source artifact.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: Yes
revisionId

The system-generated unique ID that identiﬁes the revision number of the artifact.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1500.

Required: No
revisionSummary

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No
revisionUrl

The commit ID for the artifact revision. For artifacts stored in GitHub or CodeCommit
repositories, the commit ID is linked to a commit details page.

SourceRevision API Version 2015-07-09 305

CodePipeline API Reference

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

The name of the action where the override will be applied.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: Yes
revisionType

The type of source revision, based on the source provider. For example, the revision type for the
CodeCommit action provider is the commit ID.

Type: String

Valid Values: COMMIT_ID | IMAGE_DIGEST | S3_OBJECT_VERSION_ID

Required: Yes
revisionValue

The source revision, or version of your source artifact, with the changes that you want to run in
the pipeline execution.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1500.

Required: Yes

SourceRevisionOverride API Version 2015-07-09 307

CodePipeline API Reference

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

The name of the stage.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

StageContext API Version 2015-07-09 309

CodePipeline API Reference

StageDeclaration
Represents information about a stage and its deﬁnition.

Contents
actions

The actions included in a stage.

Type: Array of ActionDeclaration objects

Required: Yes
name

The name of the stage.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: Yes
blockers

Reserved for future use.

Type: Array of BlockerDeclaration objects

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2

StageDeclaration API Version 2015-07-09 310

CodePipeline API Reference

• AWS SDK for Ruby V3

The ID of the pipeline execution associated with the stage.

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes
status

The status of the stage, or for a completed stage, the last status of the stage.

Note
A status of cancelled means that the pipeline’s deﬁnition was updated before the stage
execution could be completed.

Type: String

Valid Values: Cancelled | InProgress | Failed | Stopped | Stopping |

Succeeded

Required: Yes

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go

StageExecution API Version 2015-07-09 312

CodePipeline API Reference

• AWS SDK for Java V2

• AWS SDK for Ruby V3

The state of the stage.

Type: Array of ActionState objects

Required: No
inboundExecution

Represents information about the run of a stage.

Type: StageExecution object

Required: No
inboundTransitionState

The state of the inbound transition, which is either enabled or disabled.

Type: TransitionState object

Required: No
latestExecution

Information about the latest execution in the stage, including its ID and status.

Type: StageExecution object

Required: No
stageName

The name of the stage.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

StageState API Version 2015-07-09 314

CodePipeline API Reference

Pattern: [A-Za-z0-9.@\-_]+

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

The user-speciﬁed reason the pipeline was stopped.

Type: String

Length Constraints: Maximum length of 200.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

StopExecutionTrigger API Version 2015-07-09 316

CodePipeline API Reference

Tag
A tag is a key-value pair that is used to manage the resource.

Contents
key

The tag's key.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes
value

The tag's value.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Required: Yes

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

Tag API Version 2015-07-09 317

CodePipeline API Reference

ThirdPartyJob
A response to a PollForThirdPartyJobs request returned by CodePipeline when there is a job
to be worked on by a partner action.

Contents
clientId

The clientToken portion of the clientId and clientToken pair used to verify that the
calling entity is allowed access to the job and its details.

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: No
jobId

The identiﬁer used to identify the job in CodePipeline.

Type: String

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

ThirdPartyJob API Version 2015-07-09 318

CodePipeline API Reference

ThirdPartyJobData
Represents information about the job data for a partner action.

Contents
actionConﬁguration

Represents information about an action conﬁguration.

Type: ActionConﬁguration object

Required: No
actionTypeId

Represents information about an action type.

Type: ActionTypeId object

Required: No
artifactCredentials

Type: AWSSessionCredentials object

Required: No
continuationToken

A system-generated token, such as a CodeDeploy deployment ID, that a job requires to continue
the job asynchronously.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2048.

Required: No
encryptionKey

The encryption key used to encrypt and decrypt data in the artifact store for the pipeline, such
as an AWS Key Management Service (AWS KMS) key. This is optional and might not be present.

ThirdPartyJobData API Version 2015-07-09 319

CodePipeline API Reference

Type: EncryptionKey object

Required: No
inputArtifacts

The name of the artifact that is worked on by the action, if any. This name might be system-
generated, such as "MyApp", or it might be deﬁned by the user when the action is created. The
input artifact name must match the name of an output artifact generated by an action in an
earlier action or stage of the pipeline.

Type: Array of Artifact objects

Required: No
outputArtifacts

The name of the artifact that is the result of the action, if any. This name might be system-
generated, such as "MyBuiltApp", or it might be deﬁned by the user when the action is created.

Type: Array of Artifact objects

Required: No
pipelineContext

Represents information about a pipeline to a job worker.

Note
Does not include pipelineArn and pipelineExecutionId for ThirdParty jobs.

Type: PipelineContext object

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2
• AWS SDK for Ruby V3

The data to be returned by the third party job worker.

Type: ThirdPartyJobData object

Required: No
id

The identiﬁer used to identify the job details in CodePipeline.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Required: No
nonce

A system-generated random number that CodePipeline uses to ensure that the job is being
worked on by only one job worker. Use this number in an AcknowledgeThirdPartyJob request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 50.

Required: No

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go

ThirdPartyJobDetails API Version 2015-07-09 322

CodePipeline API Reference

• AWS SDK for Java V2

• AWS SDK for Ruby V3

Length Constraints: Minimum length of 1. Maximum length of 300.

Pattern: [a-zA-Z0-9!@ \.\*\?\-]+

Required: No
enabled

Whether the transition between stages is enabled (true) or disabled (false).

Type: Boolean

Required: No
lastChangedAt

The timestamp when the transition state was last changed.

Type: Timestamp

Required: No
lastChangedBy

The ID of the user who last changed the transition state.

Type: String

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

TransitionState API Version 2015-07-09 324

CodePipeline API Reference

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: No
SecretToken

The property used to conﬁgure GitHub authentication. For GITHUB_HMAC, only the
SecretToken property must be set.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: No

See Also
For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

WebhookAuthConﬁguration API Version 2015-07-09 326

CodePipeline API Reference

WebhookDeﬁnition
Represents information about a webhook and its deﬁnition.

Contents
authentication

Supported options are GITHUB_HMAC, IP, and UNAUTHENTICATED.

• For information about the authentication scheme implemented by GITHUB_HMAC, see
Securing your webhooks on the GitHub Developer website.
• IP rejects webhooks trigger requests unless they originate from an IP address in the IP range
whitelisted in the authentication conﬁguration.
• UNAUTHENTICATED accepts all webhook trigger requests regardless of origin.

Type: String

Valid Values: GITHUB_HMAC | IP | UNAUTHENTICATED

Required: Yes
authenticationConﬁguration

Properties that conﬁgure the authentication applied to incoming webhook trigger requests.
The required properties depend on the authentication type. For GITHUB_HMAC, only the
SecretToken property must be set. For IP, only the AllowedIPRange property must be set
to a valid CIDR range. For UNAUTHENTICATED, no properties can be set.

Type: WebhookAuthConﬁguration object

Required: Yes
ﬁlters

A list of rules applied to the body/payload sent in the POST request to a webhook URL. All
deﬁned rules must pass for the request to be accepted and the pipeline started.

Type: Array of WebhookFilterRule objects

Array Members: Maximum number of 5 items.

Required: Yes

WebhookDeﬁnition API Version 2015-07-09 327

CodePipeline API Reference

name

The name of the webhook.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: Yes
targetAction

The name of the action in a pipeline you want to connect to the webhook. The action must be
from the source (ﬁrst) stage of the pipeline.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: Yes
targetPipeline

The name of the pipeline you want to connect to the webhook.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9.@\-_]+

Required: Yes

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2
• AWS SDK for Ruby V3

Length Constraints: Minimum length of 1. Maximum length of 150.

Required: Yes
matchEquals

The value selected by the JsonPath expression must match what is supplied in the
MatchEquals field. Otherwise, the request is ignored. Properties from the target action
configuration can be included as placeholders in this value by surrounding the action
configuration key with curly brackets. For example, if the value supplied here is "refs/heads/
{Branch}" and the target action has an action configuration property called "Branch" with a
value of "main", the MatchEquals value is evaluated as "refs/heads/main". For a list of action
configuration properties for built-in action types, see Pipeline Structure Reference Action
Requirements.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 150.

Required: No

See Also

For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
following:

WebhookFilterRule API Version 2015-07-09 330

CodePipeline API Reference

• AWS SDK for C++

• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3

The action to be performed.

Type: string

Required: Yes
Version

The API version that the request is written for, expressed in the format YYYY-MM-DD.

Type: string

Required: Yes
X-Amz-Algorithm

The hash algorithm that you used to create the request signature.

Condition: Specify this parameter when you include authentication information in a query
string instead of in the HTTP authorization header.

Type: string

Valid Values: AWS4-HMAC-SHA256

Required: Conditional
X-Amz-Credential

The credential scope value, which is a string that includes your access key, the date, the region
you are targeting, the service you are requesting, and a termination string ("aws4_request").
The value is expressed in the following format: access_key/YYYYMMDD/region/service/
aws4_request.

API Version 2015-07-09 332

CodePipeline API Reference

For more information, see Create a signed AWS API request in the IAM User Guide.

Condition: Specify this parameter when you include authentication information in a query
string instead of in the HTTP authorization header.

Type: string

Required: Conditional
X-Amz-Date

The date that is used to create the signature. The format must be ISO 8601 basic format
(YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value:
20120325T120000Z.

Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for
signing requests. If the Date header is speciﬁed in the ISO 8601 basic format, X-Amz-Date is not
required. When X-Amz-Date is used, it always overrides the value of the Date header. For more
information, see Elements of an AWS API request signature in the IAM User Guide.

Type: string

Required: Conditional
X-Amz-Security-Token

The temporary security token that was obtained through a call to AWS Security Token Service
(AWS STS). For a list of services that support temporary security credentials from AWS STS, see
AWS services that work with IAM in the IAM User Guide.

Condition: If you're using temporary security credentials from AWS STS, you must include the
security token.

Type: string

Required: Conditional
X-Amz-Signature

Speciﬁes the hex-encoded signature that was calculated from the string to sign and the derived
signing key.

Condition: Specify this parameter when you include authentication information in a query
string instead of in the HTTP authorization header.

API Version 2015-07-09 333

CodePipeline API Reference

Type: string

Required: Conditional
X-Amz-SignedHeaders

Speciﬁes all the HTTP headers that were included as part of the canonical request. For more
information about specifying signed headers, see Create a signed AWS API request in the IAM
User Guide.

Condition: Specify this parameter when you include authentication information in a query
string instead of in the HTTP authorization header.

Type: string

Required: Conditional

API Version 2015-07-09 334

CodePipeline API Reference

Common Errors
This section lists the errors common to the API actions of all AWS services. For errors speciﬁc to an
API action for this service, see the topic for that API action.

AccessDeniedException

You do not have suﬃcient access to perform this action.

HTTP Status Code: 400

IncompleteSignature

The request signature does not conform to AWS standards.

HTTP Status Code: 400

InternalFailure

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

InvalidAction

The action or operation requested is invalid. Verify that the action is typed correctly.

HTTP Status Code: 400

InvalidClientTokenId

The X.509 certiﬁcate or AWS access key ID provided does not exist in our records.

HTTP Status Code: 403

NotAuthorized

You do not have permission to perform this action.

HTTP Status Code: 400

OptInRequired

The AWS access key ID needs a subscription for the service.

HTTP Status Code: 403

API Version 2015-07-09 335

CodePipeline API Reference

RequestExpired

The request reached the service more than 15 minutes after the date stamp on the request or
more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the
date stamp on the request is more than 15 minutes in the future.