PutThirdPartyJobSuccessResult
Represents the success of a third party job as returned to the pipeline by a job worker. Used for partner actions only.
Request Syntax
{
"clientToken": "string
",
"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.
- 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
- continuationToken
-
A token generated by a job worker, such as a CodeDeploy deployment ID, that a successful job provides to identify a partner action in progress. Future jobs use this token to identify the running instance of the action. It can be reused to return more information about the progress of the partner 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
-
Represents information about a current revision.
Type: CurrentRevision object
Required: No
- executionDetails
-
The details of the actions taken and results produced on an artifact as it passes through stages in the pipeline.
Type: ExecutionDetails object
Required: No
- jobId
-
The ID of the job that successfully completed. 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 job state was specified in an invalid format.
HTTP Status Code: 400
- JobNotFoundException
-
The 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 Amazon SDKs, see the following: