Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeJobExecution

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.

executionNumber

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

includeJobDocument

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

jobId

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

namespaceId

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

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

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

Note

The namespaceId feature is in public preview.

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

thingName

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.

execution

Contains data about a job execution.

Type: JobExecution object

Errors

CertificateValidationException

The certificate is invalid.

HTTP Status Code: 400

InvalidRequestException

The contents of the request were invalid.

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

TerminalStateException

The job is in a terminal state.

HTTP Status Code: 410

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 400