Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1443725.1 KB

Updates the status of a job execution.

post/things/{thingName}/jobs/{jobId}

Path parameters

jobIdstring required

The unique identifier assigned to this job when it was created.

thingNamestring required

The name of the thing associated with the device.

Request body

status'QUEUED' | 'IN_PROGRESS' | 'SUCCEEDED' | 'FAILED' | 'TIMED_OUT' | 'REJECTED' | 'REMOVED' | 'CANCELED' required

The new status for the job execution (IN_PROGRESS, FAILED, SUCCESS, or REJECTED). This must be specified on every update.

statusDetailsobject

Optional. A collection of name/value pairs that describe the status of the job execution. If not specified, the statusDetails are unchanged.

stepTimeoutInMinutesinteger

Specifies the amount of time this device has to finish execution of this job. If the job execution status is not set to a terminal state before this timer expires, or before the timer is reset (by again calling <code>UpdateJobExecution</code>, setting the status to <code>IN_PROGRESS</code> and specifying a new timeout value in this field) the job execution status will be automatically set to <code>TIMED_OUT</code>. Note that setting or resetting this timeout has no effect on that job execution timeout which may have been specified when the job was created (<code>CreateJob</code> using field <code>timeoutConfig</code>).

expectedVersioninteger

Optional. The expected current version of the job execution. Each time you update the job execution, its version is incremented. If the version of the job execution stored in Jobs does not match, the update is rejected with a VersionMismatch error, and an ErrorResponse that contains the current job execution status data is returned. (This makes it unnecessary to perform a separate DescribeJobExecution request in order to obtain the job execution status data.)

includeJobExecutionStateboolean

Optional. When included and set to true, the response contains the JobExecutionState data. The default is false.

includeJobDocumentboolean

Optional. When set to true, the response contains the job document. The default is false.

executionNumberinteger

Optional. A number that identifies a particular job execution on a particular device.

Response

Success

jobDocumentstring

The contents of the Job Documents.