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

PutJobSuccessResult

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

Request Syntax

{
   "continuationToken": "string",
   "currentRevision": { 
      "changeIdentifier": "string",
      "created": number,
      "revision": "string",
      "revisionSummary": "string"
   },
   "executionDetails": { 
      "externalExecutionId": "string",
      "percentComplete": number,
      "summary": "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.

continuationToken

A token generated by a job worker, such as an AWS CodeDeploy deployment ID, that a successful job provides to identify a custom action in progress. Future jobs will use this token in order to identify the running instance of the action. It can be reused to return additional information about the progress of the custom action. When the action is complete, no continuation token should be supplied.

Type: String

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

Required: No

currentRevision

The ID of the current revision of the artifact successfully worked upon by the job.

Type: CurrentRevision object

Required: No

executionDetails

The execution details of the successful job, such as the actions taken by the job worker.

Type: ExecutionDetails object

Required: No

jobId

The unique system-generated ID of the job that succeeded. 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: