Menu
AWS IoT
Developer Guide

DescribeJobExecution

Describes a job execution.

Request syntax:

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

URI Request Parameters:

Name

Type

Req?

Description

jobId

JobId

yes

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

thingName

ThingName

yes

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

executionNumber

ExecutionNumber

no

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

Response syntax:

Content-type: application/json { "execution": { "jobId": "string", "status": "string", "statusDetails": { "detailsMap": { "string": "string" } }, "thingArn": "string", "queuedAt": "timestamp", "startedAt": "timestamp", "lastUpdatedAt": "timestamp", "executionNumber": "long" } }

Response Body Parameters:

Name

Type

Req?

Description

execution

JobExecution

no

Information about the job execution.

Errors:

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

ResourceNotFoundException

The specified resource does not exist.

HTTP response code: 404

ThrottlingException

The rate exceeds the limit.

HTTP response code: 429

ServiceUnavailableException

The service is temporarily unavailable.

HTTP response code: 503

CLI

Synopsis:

aws iot describe-job-execution \ --job-id <value> \ --thing-name <value> \ [--execution-number <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "jobId": "string", "thingName": "string", "executionNumber": "long" }

cli-input-json fields:

Name

Type

Description

jobId

string

length max:64 min:1

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

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

thingName

string

length max:128 min:1

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

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

executionNumber

long

java class: java.lang.Long

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

Output:

{ "execution": { "jobId": "string", "status": "string", "statusDetails": { "detailsMap": { "string": "string" } }, "thingArn": "string", "queuedAt": "timestamp", "startedAt": "timestamp", "lastUpdatedAt": "timestamp", "executionNumber": "long" } }

cli output fields:

Name

Type

Description

execution

JobExecution

Information about the job execution.

jobId

string

length max:64 min:1

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

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

status

string

enum: QUEUED | IN_PROGRESS | SUCCEEDED | FAILED | REJECTED | REMOVED | CANCELED

java class: com.amazonaws.iot.laser.common.JobExecutionStatus

The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCESS, CANCELED, or REJECTED).

statusDetails

JobExecutionStatusDetails

A collection of name/value pairs that describe the status of the job execution.

detailsMap

map

key: DetailsKey

value: DetailsValue

The job execution status.

DetailsKey

string

length max:128 min:1

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

DetailsValue

string

length max:1024 min:1

pattern: [^\\p{C}]*+

thingArn

string

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

queuedAt

timestamp

The time, in milliseconds since the epoch, when the job execution was queued.

startedAt

timestamp

The time, in milliseconds since the epoch, when the job execution started.

lastUpdatedAt

timestamp

The time, in milliseconds since the epoch, when the job execution was last updated.

executionNumber

long

java class: java.lang.Long

A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information.

On this page: