AWS IoT
API Reference

Job

The Job object contains details about a job.

Contents

abortConfig

Configuration for criteria to abort the job.

Type: AbortConfig object

Required: No

comment

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

Type: String

Length Constraints: Maximum length of 2028.

Pattern: [^\p{C}]+

Required: No

completedAt

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

Type: Timestamp

Required: No

createdAt

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

Type: Timestamp

Required: No

description

A short text description of the job.

Type: String

Length Constraints: Maximum length of 2028.

Pattern: [^\p{C}]+

Required: No

forceCanceled

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

Type: Boolean

Required: No

jobArn

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

Type: String

Required: No

jobExecutionsRolloutConfig

Allows you to create a staged rollout of a job.

Type: JobExecutionsRolloutConfig object

Required: No

jobId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

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

Required: No

jobProcessDetails

Details about the job process.

Type: JobProcessDetails object

Required: No

lastUpdatedAt

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

Type: Timestamp

Required: No

presignedUrlConfig

Configuration for pre-signed S3 URLs.

Type: PresignedUrlConfig object

Required: No

reasonCode

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

Type: String

Length Constraints: Maximum length of 128.

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

Required: No

status

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

Type: String

Valid Values: IN_PROGRESS | CANCELED | COMPLETED | DELETION_IN_PROGRESS

Required: No

targets

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

Type: Array of strings

Array Members: Minimum number of 1 item.

Required: No

targetSelection

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.

Type: String

Valid Values: CONTINUOUS | SNAPSHOT

Required: No

timeoutConfig

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.

Type: TimeoutConfig object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: