Builder

class Builder

Properties

Link copied to clipboard

Configuration for criteria to abort the job.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

A short text description of the job.

Link copied to clipboard

The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

The configuration for the criteria to retry the job.

Link copied to clipboard

Allows you to create a staged rollout of a job.

Link copied to clipboard

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

Link copied to clipboard

Details about the job process.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Configuration for pre-signed S3 URLs.

Link copied to clipboard

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

Link copied to clipboard

Displays the next seven maintenance window occurrences and their start times.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Functions