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

PutJobFailureResult

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

Request Syntax

{
   "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.

failureDetails

The details about the failure of a job.

Type: FailureDetails object

Required: Yes

jobId

The unique system-generated ID of the job that failed. This is the same ID returned from PollForJobs.

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 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.

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: