Job

Gets and sets the property AbortConfig.

Configuration for criteria to abort the job.

Gets and sets the property Comment.

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

Gets and sets the property CompletedAt.

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

Gets and sets the property CreatedAt.

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

Gets and sets the property Description.

A short text description of the job.

Gets and sets the property DestinationPackageVersions.

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.

Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.

Gets and sets the property 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.

Gets and sets the property ForceCanceled.

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

Gets and sets the property 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.

Gets and sets the property JobArn.

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

Gets and sets the property JobExecutionsRetryConfig.

The configuration for the criteria to retry the job.

Gets and sets the property JobExecutionsRolloutConfig.

Allows you to create a staged rollout of a job.

Gets and sets the property JobId.

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

Gets and sets the property JobProcessDetails.

Details about the job process.

Gets and sets the property JobTemplateArn.

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

Gets and sets the property LastUpdatedAt.

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

Gets and sets the property 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/

Gets and sets the property PresignedUrlConfig.

Configuration for pre-signed S3 URLs.

Gets and sets the property ReasonCode.

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

Gets and sets the property ScheduledJobRollouts.

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

Gets and sets the property 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.

Gets and sets the property Status.

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

Gets and sets the property Targets.

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

Gets and sets the property 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.

Gets and sets the property 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.