"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-specific 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
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
CreatePipeline
CreatePipeline
Creates a pipeline.
NoteIn the pipeline structure, 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.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 232).
The request accepts the following data in JSON format.
pipeline (p. 17)
Represents the structure of actions and stages to be performed in the pipeline.
Type: PipelineDeclaration (p. 205) object Required: Yes
tags (p. 17)
The tags for the pipeline.
Type: Array of Tag (p. 222) objects Required: No
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 (p. 18)
Represents the structure of actions and stages to be performed in the pipeline.
Errors
Type: PipelineDeclaration (p. 205) object tags (p. 18)
Specifies the tags applied to the pipeline.
Type: Array of Tag (p. 222) objects
Errors
For information about the errors that are common to all actions, see Common Errors (p. 234).
ConcurrentModificationException
Unable to modify the tag due to a simultaneous update request.
HTTP Status Code: 400
InvalidActionDeclarationException
The action declaration was specified in an invalid format.
HTTP Status Code: 400
InvalidBlockerDeclarationException Reserved for future use.
HTTP Status Code: 400 InvalidStageDeclarationException
The stage declaration was specified in an invalid format.
HTTP Status Code: 400 InvalidStructureException
The structure was specified in an invalid format.
HTTP Status Code: 400 InvalidTagsException
The specified 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 specified pipeline name is already in use.
HTTP Status Code: 400 TooManyTagsException
The tags limit for a resource has been exceeded.
HTTP Status Code: 400
Examples
ValidationException
The validation was specified in an invalid format.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of CreatePipeline.
Sample Request
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": [
"S3ObjectKey": "aws-codepipeline-s3-aws-codedeploy_linux.zip"
},
Examples
"ApplicationName": "CodePipelineDemoApplication", "DeploymentGroupName": "CodePipelineDemoFleet"
},
"location": "codepipeline-us-east-1-11EXAMPLE11"
},
"name": "MySecondPipeline", "version": 1
"location": "codepipeline-us-east-1-11EXAMPLE11", "type": "S3"
},
"name": "MySecondPipeline",
"roleArn": "arn:aws:iam::111111111111:role/AWS-CodePipeline-Service", "stages": [
"S3ObjectKey": "aws-codepipeline-s3-aws-codedeploy_linux.zip"
},
See Also
"ApplicationName": "CodePipelineDemoApplication", "DeploymentGroupName": "CodePipelineDemoFleet"
},
For more information about using this API in one of the language-specific 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
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteCustomActionType
DeleteCustomActionType
Marks a custom action as deleted. PollForJobs for the custom action fails after the action is marked for deletion. Used for custom actions only.
Important
To re-create a custom action after it has been deleted you must use a string in the version field that has never been used before. This string can be an incremented version number, for example. To restore a deleted custom action, use a JSON file that is identical to the deleted action, including the original string in the version field.
Request Syntax
{ "category": "string", "provider": "string", "version": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 232).
The request accepts the following data in JSON format.
category (p. 24)
The category of the custom action that you want to delete, such as source or deploy.
Type: String
Valid Values: Source | Build | Deploy | Test | Invoke | Approval Required: Yes
provider (p. 24)
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 version (p. 24)
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
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 (p. 234).
ConcurrentModificationException
Unable to modify the tag due to a simultaneous update request.
HTTP Status Code: 400 ValidationException
The validation was specified in an invalid format.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of DeleteCustomActionType.
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-specific AWS SDKs, see the following:
See Also
• 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
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeletePipeline
DeletePipeline
Deletes the specified pipeline.
Request Syntax
{
"name": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 232).
The request accepts the following data in JSON format.
name (p. 27)
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 (p. 234).
ConcurrentModificationException
Unable to modify the tag due to a simultaneous update request.
HTTP Status Code: 400 ValidationException
The validation was specified in an invalid format.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of DeletePipeline.
See Also
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-specific 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
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteWebhook
DeleteWebhook
Deletes a previously created webhook by name. Deleting the webhook stops CodePipeline from starting a pipeline every time an external event occurs. The API returns successfully when trying to delete a webhook that is already deleted. If a deleted webhook is re-created by calling PutWebhook with the same name, it will have a different URL.
Request Syntax
{
"name": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 232).
The request accepts the following data in JSON format.
name (p. 29)
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 (p. 234).
ConcurrentModificationException
Unable to modify the tag due to a simultaneous update request.
HTTP Status Code: 400 ValidationException
The validation was specified in an invalid format.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
See Also
• 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
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeregisterWebhookWithThirdParty
DeregisterWebhookWithThirdParty
Removes the connection between the webhook that was created by CodePipeline and the external tool with events to be detected. Currently supported only for webhooks that target an action type of GitHub.
Request Syntax
{
"webhookName": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 232).
The request accepts the following data in JSON format.
webhookName (p. 31)
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 (p. 234).
ValidationException
The validation was specified in an invalid format.
HTTP Status Code: 400 WebhookNotFoundException
The specified 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-specific AWS SDKs, see the following:
See Also
• 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
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DisableStageTransition
DisableStageTransition
Prevents artifacts in a pipeline from transitioning to the next stage in the pipeline.
Request Syntax
{ "pipelineName": "string", "reason": "string", "stageName": "string", "transitionType": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 232).
The request accepts the following data in JSON format.
pipelineName (p. 33)
The name of the pipeline in which you want to disable the flow 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 (p. 33)
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!@ \(\)\.\*\?\-]+
Required: Yes stageName (p. 33)
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
Response Elements
transitionType (p. 33)
Specifies 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 (p. 234).
PipelineNotFoundException
The pipeline was specified in an invalid format or cannot be found.
HTTP Status Code: 400 StageNotFoundException
The stage was specified in an invalid format or cannot be found.
HTTP Status Code: 400 ValidationException
The validation was specified 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
See Also
{
"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
See Also
For more information about using this API in one of the language-specific 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
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
EnableStageTransition
EnableStageTransition
Enables artifacts in a pipeline to transition to a stage in a pipeline.
Request Syntax
{
"pipelineName": "string", "stageName": "string", "transitionType": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 232).
The request accepts the following data in JSON format.
pipelineName (p. 36)
The name of the pipeline in which you want to enable the flow 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 (p. 36)
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 transitionType (p. 36)
Specifies 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
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 (p. 234).
PipelineNotFoundException
The pipeline was specified in an invalid format or cannot be found.
HTTP Status Code: 400 StageNotFoundException
The stage was specified in an invalid format or cannot be found.
HTTP Status Code: 400 ValidationException
The validation was specified in an invalid format.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of EnableStageTransition.
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
See Also
For more information about using this API in one of the language-specific 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
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetActionType
GetActionType
Returns information about an action type created for an external provider, where the action is to be used by customers of the external provider. The action can be created with any supported integration model.
Request Syntax
{ "category": "string", "owner": "string", "provider": "string", "version": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 232).
The request accepts the following data in JSON format.
category (p. 39)
Defines what kind of action can be taken in the stage. The following are the valid values:
• Source
• Build
• Test
• Deploy
• Approval
• Invoke Type: String
Valid Values: Source | Build | Deploy | Test | Invoke | Approval Required: Yes
owner (p. 39)
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 (p. 39)
The provider of the action type being called. The provider name is specified when the action type is created.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 35.
Response Syntax
Pattern: [0-9A-Za-z_-]+
Required: Yes version (p. 39)
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": {
"policyStatementsTemplate": "string", "type": "string"
Response Elements
"configurationUrl": "string", "entityUrlTemplate": "string", "executionUrlTemplate": "string", "revisionUrlTemplate": "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.
actionType (p. 40)
The action type information for the requested action type, such as the action type ID.
Type: ActionTypeDeclaration (p. 161) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 234).
ActionTypeNotFoundException
The specified action type cannot be found.
HTTP Status Code: 400 ValidationException
The validation was specified in an invalid format.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific 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
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
GetJobDetails
GetJobDetails
Returns information about a job. Used for custom actions only.
Important
When this API is called, CodePipeline returns temporary credentials for the S3 bucket used to store artifacts for the pipeline, if the action requires access to that S3 bucket for input or output artifacts. This API also returns any secret values defined for the action.
Request Syntax
{ "jobId": "string"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters (p. 232).
The request accepts the following data in JSON format.
jobId (p. 42)
The unique system-generated ID for the job.
Type: 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 (p. 42)
The details of the job.
NoteIf AWSSessionCredentials is used, a long-running job can call GetJobDetails again to obtain new credentials.
Type: JobDetails (p. 197) object
Errors
For information about the errors that are common to all actions, see Common Errors (p. 234).
Examples
JobNotFoundException
The job was specified in an invalid format or cannot be found.
HTTP Status Code: 400 ValidationException
The validation was specified in an invalid format.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of GetJobDetails.
Sample Request
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"
}
"accountId": "111111111111", "data": {
"actionConfiguration": {
"__type": "ActionConfiguration", "configuration": {
"ProjectName": "JenkinsTestProject"
}
"provider": "JenkinsProviderName", "version": "1"
},
See Also
"artifactCredentials": {
"__type": "AWSSessionCredentials", "accessKeyId": "AKIAIOSFODNN7EXAMPLE",
"secretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY", "sessionToken":
"bucketName": "codepipeline-us-east-1-11EXAMPLE11", "objectKey": "MySecondPipeline/MyAppBuild/EXAMPLE"
},
"pipelineName": "MySecondPipeline", "stage": {
"name": "Testing"
} } },
"id": "ef66c259-EXAMPLE"
}}
See Also
For more information about using this API in one of the language-specific 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
• AWS SDK for JavaScript