DescribeJobExecution - Amazon IoT
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Gets details of a job execution.

Requires permission to access the DescribeJobExecution action.

Request Syntax

GET /things/thingName/jobs/jobId?executionNumber=executionNumber&includeJobDocument=includeJobDocument&namespaceId=namespaceId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


Optional. A number that identifies a particular job execution on a particular device. If not specified, the latest job execution is returned.


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


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

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

Pattern: [a-zA-Z0-9_-]+|^\$next

Required: Yes


The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.



The namespaceId feature is in public preview.

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


The thing name associated with the device the job execution is running on.

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

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

Required: Yes

Request Body

The request does not have a request body.

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.


Contains data about a job execution.

Type: JobExecution object



The certificate is invalid.

HTTP Status Code: 400


The contents of the request were invalid.

HTTP Status Code: 400


The specified resource does not exist.

HTTP Status Code: 404


The service is temporarily unavailable.

HTTP Status Code: 503


The job is in a terminal state.

HTTP Status Code: 410


The rate exceeds the limit.

HTTP Status Code: 400

See Also

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