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

AcknowledgeJob

Returns information about a specified job and whether that job has been received by the job worker. Only used for custom actions.

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 confirm 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 AWS 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

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 specified 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 specified nonce was specified in an invalid format.

HTTP Status Code: 400

JobNotFoundException

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

Example

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