CreateOTAUpdateRequest

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

interface CreateOTAUpdateRequest {

additionalParameters?: {

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

} | null;

awsJobAbortConfig?: AwsJobAbortConfig | null;

awsJobExecutionsRolloutConfig?: AwsJobExecutionsRolloutConfig | null;

awsJobPresignedUrlConfig?: AwsJobPresignedUrlConfig | null;

awsJobTimeoutConfig?: AwsJobTimeoutConfig | null;

description?: string | null;

files: OTAUpdateFile[];

otaUpdateId: string;

protocols?: Protocol[] | null;

roleArn: string;

tags?: Tag[] | null;

targets: string[];

targetSelection?: TargetSelection | null;

}

§Properties

additionalParameters?: {

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

} | null

[src]

A list of additional OTA update parameters which are name-value pairs.

awsJobAbortConfig?: AwsJobAbortConfig | null

[src]

The criteria that determine when and how a job abort takes place.

awsJobExecutionsRolloutConfig?: AwsJobExecutionsRolloutConfig | null

[src]

Configuration for the rollout of OTA updates.

awsJobPresignedUrlConfig?: AwsJobPresignedUrlConfig | null

[src]

Configuration information for pre-signed URLs.

awsJobTimeoutConfig?: AwsJobTimeoutConfig | null

[src]

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.

description?: string | null

[src]

The description of the OTA update.

files: OTAUpdateFile[]

[src]

The files to be streamed by the OTA update.

otaUpdateId: string

[src]

The ID of the OTA update to be created.

protocols?: Protocol[] | null

[src]

The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.

roleArn: string

[src]

The IAM role that grants Amazon Web Services IoT Core access to the Amazon S3, IoT jobs and Amazon Web Services Code Signing resources to create an OTA update job.

tags?: Tag[] | null

[src]

Metadata which can be used to manage updates.

targets: string[]

[src]

The devices targeted to receive OTA updates.

targetSelection?: TargetSelection | null

[src]

Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.