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

PutThirdPartyJobFailureResult

Represents the failure of a third party job as returned to the pipeline by a job worker. Only used for partner actions.

Request Syntax

{
   "clientToken": "string",
   "failureDetails": { 
      "externalExecutionId": "string",
      "message": "string",
      "type": "string"
   },
   "jobId": "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

failureDetails

Represents information about failure details.

Type: FailureDetails object

Required: Yes

jobId

The ID of the job that failed. This is the same ID returned from PollForThirdPartyJobs.

Type: String

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

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

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

InvalidJobStateException

The specified job state 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: