Menu
AWS IoT
Developer Guide

GetPendingJobExecutions

Gets the list of all jobs for a thing that are not in a terminal status.

Request syntax:

GET /things/thingName/jobs

URI Request Parameters:

Name

Type

Req?

Description

thingName

ThingName

yes

The name of the thing that is executing the job.

Response syntax:

Content-type: application/json { "inProgressJobs": [ { "jobId": "string", "queuedAt": "long", "startedAt": "long", "lastUpdatedAt": "long", "versionNumber": "long", "executionNumber": "long" } ], "queuedJobs": [ { "jobId": "string", "queuedAt": "long", "startedAt": "long", "lastUpdatedAt": "long", "versionNumber": "long", "executionNumber": "long" } ] }

Response Body Parameters:

Name

Type

Req?

Description

inProgressJobs

JobExecutionSummaryList

no

A list of JobExecutionSummary objects with status IN_PROGRESS.

queuedJobs

JobExecutionSummaryList

no

A list of JobExecutionSummary objects with status QUEUED.

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

CertificateValidationException

The certificate is invalid.

HTTP response code: 400

CLI

Synopsis:

aws iot-jobs-data get-pending-job-executions \ --thing-name <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "thingName": "string" }

cli-input-json fields:

Name

Type

Description

thingName

string

length max:128 min:1

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

The name of the thing that is executing the job.

Output:

{ "inProgressJobs": [ { "jobId": "string", "queuedAt": "long", "startedAt": "long", "lastUpdatedAt": "long", "versionNumber": "long", "executionNumber": "long" } ], "queuedJobs": [ { "jobId": "string", "queuedAt": "long", "startedAt": "long", "lastUpdatedAt": "long", "versionNumber": "long", "executionNumber": "long" } ] }

cli output fields:

Name

Type

Description

inProgressJobs

list

member: JobExecutionSummary

java class: java.util.List

A list of JobExecutionSummary objects with status IN_PROGRESS.

JobExecutionSummary

JobExecutionSummary

jobId

string

length max:64 min:1

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

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

queuedAt

long

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

startedAt

long

java class: java.lang.Long

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

lastUpdatedAt

long

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

versionNumber

long

The version of the job execution. Job execution versions are incremented each time AWS IoT Jobs receives an update from a device.

executionNumber

long

java class: java.lang.Long

A number that identifies a particular job execution on a particular device.

queuedJobs

list

member: JobExecutionSummary

java class: java.util.List

A list of JobExecutionSummary objects with status QUEUED.

JobExecutionSummary

JobExecutionSummary

jobId

string

length max:64 min:1

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

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

queuedAt

long

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

startedAt

long

java class: java.lang.Long

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

lastUpdatedAt

long

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

versionNumber

long

The version of the job execution. Job execution versions are incremented each time AWS IoT Jobs receives an update from a device.

executionNumber

long

java class: java.lang.Long

A number that identifies a particular job execution on a particular device.

On this page: