/otaUpdates/{otaUpdateId} - AWS IoT Wireless

Gets an OTA update.

Requires permission to access the GetOTAUpdate action.

{ "otaUpdateInfo": { "otaUpdateId": "string", "otaUpdateArn": "string", "creationDate": "string", "lastModifiedDate": "string", "description": "string", "targets": [], "protocols": [], "awsJobExecutionsRolloutConfig": { "maximumPerMinute": 0, "exponentialRate": { "baseRatePerMinute": 0, "incrementFactor": 0, "rateIncreaseCriteria": { "numberOfNotifiedThings": 0, "numberOfSucceededThings": 0 } } }, "awsJobPresignedUrlConfig": { "expiresInSec": 0 }, "targetSelection": "CONTINUOUS", "otaUpdateFiles": [], "otaUpdateStatus": "CREATE_PENDING", "awsIotJobId": "string", "awsIotJobArn": "string", "errorInfo": { "code": "string", "message": "string" }, "additionalParameters": { "property1": "string", "property2": "string" } } }

Responses

🟢200Success

application/json

Body

otaUpdateInfo

object

optional

The OTA update info.

otaUpdateId

string

optional

The OTA update ID.

>= 1 characters<= 128 characters

Match pattern:

[a-zA-Z0-9_-]+

otaUpdateArn

string

optional

The OTA update ARN.

creationDate

string <date-time>

optional

The date when the OTA update was created.

lastModifiedDate

string <date-time>

optional

The date when the OTA update was last updated.

description

string

optional

A description of the OTA update.

<= 2028 characters

Match pattern:

[^\p{C}]+

targets

array[string]

optional

The targets of the OTA update.

>= 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

awsJobExecutionsRolloutConfig

object

optional

Configuration for the rollout of OTA updates.

awsJobPresignedUrlConfig

object

optional

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

targetSelection

enum<string>

optional

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

Allowed values:

CONTINUOUSSNAPSHOT

otaUpdateFiles

array[object (OTAUpdateFile) {6}]

optional

A list of files associated with the OTA update.

>= 1 items<= 50 items

otaUpdateStatus

enum<string>

optional

The status of the OTA update.

Allowed values:

CREATE_PENDINGCREATE_IN_PROGRESSCREATE_COMPLETECREATE_FAILED

awsIotJobId

string

optional

The IoT job ID associated with the OTA update.

awsIotJobArn

string

optional

The IoT job ARN associated with the OTA update.

errorInfo

object

optional

Error information associated with the OTA update.

additionalParameters

object

optional

A collection of name/value pairs

🟠480InvalidRequestException

🟠481ThrottlingException

🟠482UnauthorizedException

🟠483InternalFailureException

🟠484ServiceUnavailableException

🟠485ResourceNotFoundException