/otaUpdates/{otaUpdateId}

Creates an IoT OTA update on a target group of things or groups.

Requires permission to access the CreateOTAUpdate action.

curl --location -g --request POST 'https://api.iotwireless.{region}.amazonaws.com/otaUpdates/' \ --header 'Content-Type: application/json' \ --data-raw '{ "description": "string", "targets": [ "string" ], "protocols": [ "MQTT" ], "targetSelection": "CONTINUOUS", "awsJobExecutionsRolloutConfig": { "maximumPerMinute": 0, "exponentialRate": { "baseRatePerMinute": 0, "incrementFactor": 0, "rateIncreaseCriteria": { "numberOfNotifiedThings": 0, "numberOfSucceededThings": 0 } } }, "awsJobPresignedUrlConfig": { "expiresInSec": 0 }, "awsJobAbortConfig": { "abortCriteriaList": [] }, "awsJobTimeoutConfig": { "inProgressTimeoutInMinutes": 0 }, "files": [ { "fileName": "string", "fileType": 0, "fileVersion": "string", "fileLocation": { "stream": { "streamId": "string", "fileId": 0 }, "s3Location": { "bucket": "string", "key": "string", "version": "string" } }, "codeSigning": { "awsSignerJobId": "string", "startSigningJobParameter": { "signingProfileParameter": { "certificateArn": "string", "platform": "string", "certificatePathOnDevice": "string" }, "signingProfileName": "string", "destination": { "s3Destination": { "bucket": "string", "prefix": "string" } } }, "customCodeSigning": { "signature": { "inlineDocument": "string" }, "certificateChain": { "certificateName": "string", "inlineDocument": "string" }, "hashAlgorithm": "string", "signatureAlgorithm": "string" } }, "attributes": { "property1": "string", "property2": "string" } } ], "roleArn": "stringstringstringst", "additionalParameters": { "property1": "string", "property2": "string" }, "tags": [ { "Key": "string", "Value": "string" } ] }'

Request

Path Params

otaUpdateId

string

required

The ID of the OTA update to be created.

Body Params application/json

description

string

optional

The description of the OTA update.

<= 2028 characters

Match pattern:

[^\p{C}]+

targets

array[string]

required

The devices targeted to receive OTA updates.

>= 1 items

protocols

array[string]

optional

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.

>= 1 items<= 2 items

Allowed values:

MQTTHTTP

targetSelection

enum<string>

optional

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.

Allowed values:

CONTINUOUSSNAPSHOT

awsJobExecutionsRolloutConfig

object

optional

Configuration for the rollout of OTA updates.

maximumPerMinute

integer

optional

The maximum number of OTA update job executions started per minute.

>= 1<= 1000

exponentialRate

object

optional

The rate of increase for a job rollout. This parameter allows you to define an exponential rate increase for a job rollout.

awsJobPresignedUrlConfig

object

optional

Configuration information for pre-signed URLs. Valid when protocols contains HTTP.

expiresInSec

integer

optional

How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 1800 seconds. Pre-signed URLs are generated when a request for the job document is received.

awsJobAbortConfig

object

optional

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

abortCriteriaList

array[object (AwsJobAbortCriteria) {4}]

optional

The list of criteria that determine when and how to abort the job.

>= 1 items

awsJobTimeoutConfig

object

optional

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.

inProgressTimeoutInMinutes

integer

optional

Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal TIMED_OUT status.

files

array[object (OTAUpdateFile) {6}]

required

The files to be streamed by the OTA update.

>= 1 items<= 50 items

fileName

string

optional

The name of the file.

fileType

integer

optional

An integer value you can include in the job document to allow your devices to identify the type of file received from the cloud.

>= 0<= 255

fileVersion

string

optional

The file version.

fileLocation

object

optional

The location of the updated firmware.

codeSigning

object

optional

The code signing method of the file.

attributes

object

optional

A list of name/attribute pairs.

roleArn

string

required

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.

>= 20 characters<= 2048 characters

additionalParameters

object

optional

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

Additional properties

string

optional

Request

Responses