Documentation

The Job object contains details about a job.

See: newJob smart constructor.

Create a value of Job with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:status:Job', job_status - The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.

$sel:jobExecutionsRolloutConfig:Job', job_jobExecutionsRolloutConfig - Allows you to create a staged rollout of a job.

$sel:jobId:Job', job_jobId - The unique identifier you assigned to this job when it was created.

$sel:lastUpdatedAt:Job', job_lastUpdatedAt - The time, in seconds since the epoch, when the job was last updated.

$sel:jobArn:Job', job_jobArn - An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".

$sel:createdAt:Job', job_createdAt - The time, in seconds since the epoch, when the job was created.

$sel:abortConfig:Job', job_abortConfig - Configuration for criteria to abort the job.

$sel:jobProcessDetails:Job', job_jobProcessDetails - Details about the job process.

$sel:namespaceId:Job', job_namespaceId - 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/

The namespaceId feature is in public preview.

$sel:reasonCode:Job', job_reasonCode - If the job was updated, provides the reason code for the update.

$sel:presignedUrlConfig:Job', job_presignedUrlConfig - Configuration for pre-signed S3 URLs.

$sel:forceCanceled:Job', job_forceCanceled - Will be true if the job was canceled with the optional force parameter set to true.

$sel:jobTemplateArn:Job', job_jobTemplateArn - The ARN of the job template used to create the job.

$sel:targets:Job', job_targets - A list of IoT things and thing groups to which the job should be sent.

$sel:completedAt:Job', job_completedAt - The time, in seconds since the epoch, when the job was completed.

$sel:comment:Job', job_comment - If the job was updated, describes the reason for the update.

$sel:description:Job', job_description - A short text description of the job.

$sel:targetSelection:Job', job_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.

$sel:timeoutConfig:Job', job_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.

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

Allows you to create a staged rollout of a job.

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

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

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

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

Configuration for criteria to abort the job.

Details about the job process.

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/

The namespaceId feature is in public preview.

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

Configuration for pre-signed S3 URLs.

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

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

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

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

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

A short text description of the job.

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.

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.