Menu
AWS CodePipeline
API Reference (API Version 2015-07-09)

PutActionRevision

Provides information to AWS CodePipeline about new revisions to a source.

Request Syntax

{
   "actionName": "string",
   "actionRevision": { 
      "created": number,
      "revisionChangeId": "string",
      "revisionId": "string"
   },
   "pipelineName": "string",
   "stageName": "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.

actionName

The name of the action that will process 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

pipelineName

The name of the pipeline that will start 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 will act upon 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 specified pipeline.

Type: Boolean

pipelineExecutionId

The ID of the current workflow 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 specified action cannot be found.

HTTP Status Code: 400

PipelineNotFoundException

The specified pipeline was specified in an invalid format or cannot be found.

HTTP Status Code: 400

StageNotFoundException

The specified 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

Example

Sample Request

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