StartPipelineExecution - CodePipeline

StartPipelineExecution

Starts the specified pipeline. Specifically, it begins processing the latest commit to the source location specified as part of the pipeline.

Request Syntax

{ "clientRequestToken": "string", "name": "string", "sourceRevisions": [ { "actionName": "string", "revisionType": "string", "revisionValue": "string" } ], "variables": [ { "name": "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.

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

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 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.

ConcurrentPipelineExecutionsLimitExceededException

The pipeline has reached the limit for concurrent pipeline executions.

HTTP Status Code: 400

ConflictException

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

HTTP Status Code: 400

PipelineNotFoundException

The pipeline 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 StartPipelineExecution.

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-specific AWS SDKs, see the following: