Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-142381,278956.3 KB

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

Requires permission to access the CreateOTAUpdate action.

post/otaUpdates/{otaUpdateId}

Path parameters

otaUpdateIdstring required

The ID of the OTA update to be created.

Request body

descriptionstring

The description of the OTA update.

targetsTarget[] required

The devices targeted to receive OTA updates.

protocolsProtocol[]

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.

targetSelection'CONTINUOUS' | 'SNAPSHOT'

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.

roleArnstring 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.

additionalParametersobject

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

Response

Success

otaUpdateIdstring

The OTA update ID.

awsIotJobIdstring

The IoT job ID associated with the OTA update.

otaUpdateArnstring

The OTA update ARN.

awsIotJobArnstring

The IoT job ARN associated with the OTA update.

otaUpdateStatus'CREATE_PENDING' | 'CREATE_IN_PROGRESS' | 'CREATE_COMPLETE' | 'CREATE_FAILED' | 'DELETE_IN_PROGRESS' | 'DELETE_FAILED'

The OTA update status.