Menu
AWS IoT
Developer Guide

ListOTAUpdates

Lists OTA updates.

Request syntax:

GET /otaUpdates?maxResults=maxResults&nextToken=nextToken&otaUpdateStatus=otaUpdateStatus

URI Request Parameters:

Name

Type

Req?

Description

maxResults

MaxResults

no

The maximum number of results to return at one time.

nextToken

NextToken

no

A token used to retrieve the next set of results.

otaUpdateStatus

OTAUpdateStatus

no

The OTA update job status.

Response syntax:

Content-type: application/json { "otaUpdates": [ { "otaUpdateId": "string", "otaUpdateArn": "string", "creationDate": "timestamp" } ], "nextToken": "string" }

Response Body Parameters:

Name

Type

Req?

Description

otaUpdates

OTAUpdatesSummary

no

A list of OTA update jobs.

nextToken

NextToken

no

A token to use to get the next set of results.

Errors:

InvalidRequestException

The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.

HTTP response code: 400

ThrottlingException

The rate exceeds the limit.

HTTP response code: 429

UnauthorizedException

You are not authorized to perform this operation.

HTTP response code: 401

InternalFailureException

An unexpected error has occurred.

HTTP response code: 500

ServiceUnavailableException

The service is temporarily unavailable.

HTTP response code: 503

CLI

Synopsis:

aws iot list-ota-updates \ [--max-results <value>] \ [--next-token <value>] \ [--ota-update-status <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "maxResults": "integer", "nextToken": "string", "otaUpdateStatus": "string" }

cli-input-json fields:

Name

Type

Description

maxResults

integer

java class: java.lang.Integer

range- max:250 min:1

The maximum number of results to return at one time.

nextToken

string

A token used to retrieve the next set of results.

otaUpdateStatus

string

enum: CREATE_PENDING | CREATE_IN_PROGRESS | CREATE_COMPLETE | CREATE_FAILED

The OTA update job status.

Output:

{ "otaUpdates": [ { "otaUpdateId": "string", "otaUpdateArn": "string", "creationDate": "timestamp" } ], "nextToken": "string" }

cli output fields:

Name

Type

Description

otaUpdates

list

member: OTAUpdateSummary

A list of OTA update jobs.

OTAUpdateSummary

OTAUpdateSummary

otaUpdateId

string

length max:128 min:1

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

The OTA update ID.

otaUpdateArn

string

The OTA update ARN.

creationDate

timestamp

The date when the OTA update was created.

nextToken

string

A token to use to get the next set of results.

On this page: