v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1483477323.4 KB

Create an over-the-air (OTA) task to target a device.

post/ota-tasks

Request body

Descriptionstring

The description of the over-the-air (OTA) task.

S3Urlstring required

The URL to the Amazon S3 bucket where the over-the-air (OTA) task is stored.

Protocol'HTTP'

The connection protocol the over-the-air (OTA) task uses to update the device.

TargetString[]

The device targeted for the over-the-air (OTA) task.

TaskConfigurationIdstring

The identifier for the over-the-air (OTA) task configuration.

OtaMechanism'PUSH'

The deployment mechanism for the over-the-air (OTA) task.

OtaType'ONE_TIME' | 'CONTINUOUS' required

The frequency type for the over-the-air (OTA) task.

OtaTargetQueryStringstring

The query string to add things to the thing group.

ClientTokenstring

An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.

Tagsobject

A set of key/value pairs that are used to manage the over-the-air (OTA) task.

Response

Success

TaskIdstring

The identifier of the over-the-air (OTA) task.

TaskArnstring

The Amazon Resource Name (ARN) of the over-the-air (OTA) task.

Descriptionstring

A description of the over-the-air (OTA) task.