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).

DescribeJobExecution

Describes a job execution.

Requires permission to access the DescribeJobExecution action.

Request Syntax

GET /things/thingName/jobs/jobId?executionNumber=executionNumber HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

executionNumber

A string (consisting of the digits "0" through "9" which is used to specify a particular job execution on a particular device.

jobId

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

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

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

Required: Yes

thingName

The name of the thing on which the job execution is running.

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, "forceCanceled": boolean, "jobId": "string", "lastUpdatedAt": number, "queuedAt": number, "startedAt": number, "status": "string", "statusDetails": { "detailsMap": { "string" : "string" } }, "thingArn": "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

Information about the job execution.

Type: JobExecution object

Errors

InvalidRequestException

The request is not valid.

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: 400

See Also

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