Menu
AWS IoT
Developer Guide

ListJobExecutionsForJob

Lists the job executions for a job.

Request syntax:

GET /jobs/jobId/things?status=status&maxResults=maxResults&nextToken=nextToken

URI Request Parameters:

Name

Type

Req?

Description

jobId

JobId

yes

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

status

JobExecutionStatus

no

The status of the job.

maxResults

LaserMaxResults

no

The maximum number of results to be returned per request.

nextToken

NextToken

no

The token to retrieve the next set of results.

Response syntax:

Content-type: application/json { "executionSummaries": [ { "thingArn": "string", "jobExecutionSummary": { "status": "string", "queuedAt": "timestamp", "startedAt": "timestamp", "lastUpdatedAt": "timestamp", "executionNumber": "long" } } ], "nextToken": "string" }

Response Body Parameters:

Name

Type

Req?

Description

executionSummaries

JobExecutionSummaryForJobList

no

A list of job execution summaries.

nextToken

NextToken

no

The token for the next set of results, or null if there are no additional results.

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 list-job-executions-for-job \ --job-id <value> \ [--status <value>] \ [--max-results <value>] \ [--next-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "jobId": "string", "status": "string", "maxResults": "integer", "nextToken": "string" }

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.

status

string

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

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

The status of the job.

maxResults

integer

java class: java.lang.Integer

range- max:250 min:1

The maximum number of results to be returned per request.

nextToken

string

The token to retrieve the next set of results.

Output:

{ "executionSummaries": [ { "thingArn": "string", "jobExecutionSummary": { "status": "string", "queuedAt": "timestamp", "startedAt": "timestamp", "lastUpdatedAt": "timestamp", "executionNumber": "long" } } ], "nextToken": "string" }

cli output fields:

Name

Type

Description

executionSummaries

list

member: JobExecutionSummaryForJob

java class: java.util.List

A list of job execution summaries.

JobExecutionSummaryForJob

JobExecutionSummaryForJob

thingArn

string

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

jobExecutionSummary

JobExecutionSummary

Contains a subset of information about a job execution.

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.

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 later in commands which return or update job execution information.

nextToken

string

The token for the next set of results, or null if there are no additional results.

On this page: