AWS IoT
API Reference

StartNextPendingJobExecution

Gets and starts the next pending (status IN_PROGRESS or QUEUED) job execution for a thing.

Request Syntax

PUT /things/thingName/jobs/$next HTTP/1.1 Content-type: application/json { "statusDetails": { "string" : "string" }, "stepTimeoutInMinutes": number }

URI Request Parameters

The request requires the following URI parameters.

thingName

The name of the thing associated with the device.

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

Pattern: [a-zA-Z0-9:_-]+

Request Body

The request accepts the following data in JSON format.

statusDetails

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

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: [a-zA-Z0-9:_-]+

Value Length Constraints: Minimum length of 1. Maximum length of 1024.

Value Pattern: [^\p{C}]*+

Required: No

stepTimeoutInMinutes

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 calling UpdateJobExecution, setting the status to IN_PROGRESS, and specifying a new timeout value in field stepTimeoutInMinutes) the job execution status will be automatically set to TIMED_OUT. Note that setting the step timeout has no effect on the in progress timeout that may have been specified when the job was created (CreateJob using field timeoutConfig).

Valid values for this parameter range from 1 to 10080 (1 minute to 7 days).

Type: Long

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "execution": { "approximateSecondsBeforeTimedOut": number, "executionNumber": number, "jobDocument": "string", "jobId": "string", "lastUpdatedAt": number, "queuedAt": number, "startedAt": number, "status": "string", "statusDetails": { "string" : "string" }, "thingName": "string", "versionNumber": number } }

Response Elements

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

The following data is returned in JSON format by the service.

execution

A JobExecution object.

Type: JobExecution object

Errors

CertificateValidationException

The certificate is invalid.

HTTP Status Code: 400

InvalidRequestException

The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: