CreateJobRequest

import type { CreateJobRequest } from "https://aws-api.deno.dev/v0.3/services/iot.ts?docs=full";

interface CreateJobRequest {

abortConfig?: AbortConfig | null;

description?: string | null;

document?: string | null;

documentParameters?: {

[key: string]: string | null | undefined;

} | null;

documentSource?: string | null;

jobExecutionsRetryConfig?: JobExecutionsRetryConfig | null;

jobExecutionsRolloutConfig?: JobExecutionsRolloutConfig | null;

jobId: string;

jobTemplateArn?: string | null;

namespaceId?: string | null;

presignedUrlConfig?: PresignedUrlConfig | null;

tags?: Tag[] | null;

targets: string[];

targetSelection?: TargetSelection | null;

timeoutConfig?: TimeoutConfig | null;

}

§Properties

abortConfig?: AbortConfig | null

[src]

Allows you to create the criteria to abort a job.

description?: string | null

[src]

A short text description of the job.

document?: string | null

[src]

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

documentParameters?: {

[key: string]: string | null | undefined;

} | null

[src]

Parameters of a managed template that you can specify to create the job document.

documentSource?: string | null

[src]

An S3 link to the job document. Required if you don't specify a value for document.

Note: If the job document resides in an S3 bucket, you must use a placeholder link when specifying the document. The placeholder link is of the following form: ${aws:iot:s3-presigned-url:https://s3.amazonaws.com/bucket/key} where bucket is your bucket name and key is the object in the bucket to which you are linking.

jobExecutionsRetryConfig?: JobExecutionsRetryConfig | null

[src]

Allows you to create the criteria to retry a job.

jobExecutionsRolloutConfig?: JobExecutionsRolloutConfig | null

[src]

Allows you to create a staged rollout of the job.

jobId: string

[src]

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.

jobTemplateArn?: string | null

[src]

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

namespaceId?: string | null

[src]

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_/

Note: The namespaceId feature is in public preview.

presignedUrlConfig?: PresignedUrlConfig | null

[src]

Configuration information for pre-signed S3 URLs.

tags?: Tag[] | null

[src]

Metadata which can be used to manage the job.

targets: string[]

[src]

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

targetSelection?: TargetSelection | null

[src]

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.

timeoutConfig?: TimeoutConfig | null

[src]

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.