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:abortConfig:Job', job_abortConfig - Configuration for criteria to abort the job.

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

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

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

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

$sel:documentParameters:Job', job_documentParameters - A key-value map that pairs the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.

documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them.

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

$sel:isConcurrent:Job', job_isConcurrent - Indicates whether a job is concurrent. Will be true when a job is rolling out new job executions or canceling previously created executions, otherwise false.

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

$sel:jobExecutionsRetryConfig:Job', job_jobExecutionsRetryConfig - The configuration for the criteria to retry the job.

$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:jobProcessDetails:Job', job_jobProcessDetails - Details about the job process.

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

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

$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:presignedUrlConfig:Job', job_presignedUrlConfig - Configuration for pre-signed S3 URLs.

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

$sel:schedulingConfig:Job', job_schedulingConfig - The configuration that allows you to schedule a job for a future date and time in addition to specifying the end behavior for each job execution.

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

$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.

We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.

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

$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.

Configuration for criteria to abort the job.

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

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

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

A short text description of the job.

A key-value map that pairs the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.

documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them.

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

Indicates whether a job is concurrent. Will be true when a job is rolling out new job executions or canceling previously created executions, otherwise false.

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

The configuration for the criteria to retry the job.

Allows you to create a staged rollout of a job.

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

Details about the job process.

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

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

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.

Configuration for pre-signed S3 URLs.

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

The configuration that allows you to schedule a job for a future date and time in addition to specifying the end behavior for each job execution.

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

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.

We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.

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

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.