CreateJobRequest

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Allows you to create the criteria to abort a job.

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Allows you to create the criteria to retry a job.

Link copied to clipboard

Allows you to create a staged rollout of the job.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Configuration information for pre-signed S3 URLs.

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
val tags: List<Tag>?

Metadata which can be used to manage the job.

Link copied to clipboard

A list of 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 thing when the thing 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. 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.

Functions

Link copied to clipboard
inline fun copy(block: CreateJobRequest.Builder.() -> Unit = {}): CreateJobRequest
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String