CreateJobRequest

Gets and sets the property AbortConfig.

Allows you to create the criteria to abort a job.

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.

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

Gets and sets the property Document.

The job document. Required if you don't specify a value for documentSource.

Gets and sets the property DocumentParameters.

Parameters of an Amazon Web Services managed template that you can specify to create the job document.

Gets and sets the property DocumentSource.

An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document.

For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0

For more information, see Methods for accessing a bucket.

Gets and sets the property JobExecutionsRetryConfig.

Allows you to create the criteria to retry a job.

Gets and sets the property JobExecutionsRolloutConfig.

Allows you to create a staged rollout of the job.

Gets and sets the property JobId.

A job identifier which must be unique for your Amazon Web Services account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.

Gets and sets the property JobTemplateArn.

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

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 information for pre-signed S3 URLs.

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

Metadata which can be used to manage the job.

Gets and sets the property Targets.

A list of 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 thing when the thing 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. The 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 time expires, it will be automatically set to TIMED_OUT.