/jobs/{jobId} - AWS IoT Wireless

Describes a job.

Requires permission to access the DescribeJob action.

{ "documentSource": "string", "job": { "jobArn": "string", "jobId": "string", "targetSelection": "CONTINUOUS", "status": "IN_PROGRESS", "forceCanceled": true, "reasonCode": "string", "comment": "string", "targets": [], "description": "string", "presignedUrlConfig": { "roleArn": "string", "expiresInSec": 0 }, "jobExecutionsRolloutConfig": { "maximumPerMinute": 0, "exponentialRate": { "baseRatePerMinute": 0, "incrementFactor": 0, "rateIncreaseCriteria": { "numberOfNotifiedThings": 0, "numberOfSucceededThings": 0 } } }, "abortConfig": { "criteriaList": [] }, "createdAt": "string", "lastUpdatedAt": "string", "completedAt": "string", "jobProcessDetails": { "processingTargets": [], "numberOfCanceledThings": 0, "numberOfSucceededThings": 0, "numberOfFailedThings": 0, "numberOfRejectedThings": 0, "numberOfQueuedThings": 0, "numberOfInProgressThings": 0, "numberOfRemovedThings": 0, "numberOfTimedOutThings": 0 }, "timeoutConfig": { "inProgressTimeoutInMinutes": 0 }, "namespaceId": "string", "jobTemplateArn": "string" } }

Responses

🟢200Success

application/json

Body

documentSource

string

optional

An S3 link to the job document.

>= 1 characters<= 1350 characters

job

object

optional

Information about the job.

jobArn

string

optional

An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".

jobId

string

optional

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

>= 1 characters<= 64 characters

Match pattern:

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

targetSelection

enum<string>

optional

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.

Allowed values:

CONTINUOUSSNAPSHOT

status

enum<string>

optional

The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.

Allowed values:

IN_PROGRESSCANCELEDCOMPLETEDDELETION_IN_PROGRESS

forceCanceled

boolean

optional

Will be true if the job was canceled with the optional force parameter set to true.

reasonCode

string

optional

If the job was updated, provides the reason code for the update.

<= 128 characters

Match pattern:

[\p{Upper}\p{Digit}_]+

comment

string

optional

If the job was updated, describes the reason for the update.

<= 2028 characters

Match pattern:

[^\p{C}]+

targets

array[string]

optional

A list of IoT things and thing groups to which the job should be sent.

>= 1 items

description

string

optional

A short text description of the job.

<= 2028 characters

Match pattern:

[^\p{C}]+

presignedUrlConfig

object

optional

Configuration for pre-signed S3 URLs.

jobExecutionsRolloutConfig

object

optional

Allows you to create a staged rollout of a job.

abortConfig

object

optional

Configuration for criteria to abort the job.

createdAt

string <date-time>

optional

The time, in seconds since the epoch, when the job was created.

lastUpdatedAt

string <date-time>

optional

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

completedAt

string <date-time>

optional

The time, in seconds since the epoch, when the job was completed.

jobProcessDetails

object

optional

Details about the job process.

timeoutConfig

object

optional

Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to IN_PROGRESS. If the job execution status is not set to another terminal state before the timer expires, it will be automatically set to TIMED_OUT.

namespaceId

string

optional

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

When you specify a value for this parameter, Amazon Web Services 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/

>= 1 characters<= 64 characters

Match pattern:

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

jobTemplateArn

string

optional

The ARN of the job template used to create the job.

>= 1 characters<= 1600 characters

Match pattern:

^arn:[!-~]+$

🟠480InvalidRequestException

🟠481ResourceNotFoundException

🟠482ThrottlingException

🟠483ServiceUnavailableException