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

AcknowledgeThirdPartyJob

Confirms a job worker has received the specified job. Only used for partner actions.

Request Syntax

{
   "clientToken": "string",
   "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.

clientToken

The clientToken portion of the clientId and clientToken pair used to verify that the calling entity is allowed access to the job and its details.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

jobId

The unique system-generated ID of the job.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

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 to a GetThirdPartyJobDetails request.

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

The status information for the third party job, if any.

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.

InvalidClientTokenException

The client token was specified in an invalid format

HTTP Status Code: 400

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

See Also

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