Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1483477323.4 KB

Get details of the over-the-air (OTA) task by its task id.

get/ota-tasks/{Identifier}

Path parameters

Identifierstring required

The over-the-air (OTA) task id.

Response

Success

TaskIdstring

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

TaskArnstring

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

Descriptionstring

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

S3Urlstring

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.

OtaType'ONE_TIME' | 'CONTINUOUS'

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

OtaTargetQueryStringstring

The query string to add things to the thing group.

OtaMechanism'PUSH'

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

TargetString[]

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

CreatedAtstring date-time

The timestamp value of when the over-the-air (OTA) task was created.

LastUpdatedAtstring date-time

The timestamp value of when the over-the-air (OTA) task was last updated at.

TaskConfigurationIdstring

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

Status'IN_PROGRESS' | 'CANCELED' | 'COMPLETED' | 'DELETION_IN_PROGRESS' | 'SCHEDULED'

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

Tagsobject

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