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

PutApprovalResult

Provides the response to a manual approval request to AWS CodePipeline. Valid responses include Approved and Rejected.

Request Syntax

{
   "actionName": "string",
   "pipelineName": "string",
   "result": { 
      "status": "string",
      "summary": "string"
   },
   "stageName": "string",
   "token": "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 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

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 and 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 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 specified 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 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.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
Content-Length: 24

{
   "approvedAt": 1466137312.204
}

See Also

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