Menu
AWS IoT
Developer Guide

GetOTAUpdate

GetOTAUpdate

Gets an OTA update.

https

Request syntax:

GET /otaUpdates/otaUpdateId

URI Request Parameters:

Name

Type

Req?

Description

otaUpdateId

OTAUpdateId

yes

The OTA update ID.

Response syntax:

Content-type: application/json { "otaUpdateInfo": { "otaUpdateId": "string", "otaUpdateArn": "string", "creationDate": "timestamp", "lastModifiedDate": "timestamp", "description": "string", "targets": [ "string" ], "targetSelection": "string", "otaUpdateFiles": [ { "fileName": "string", "fileVersion": "string", "fileSource": { "streamId": "string", "fileId": "integer" }, "codeSigning": { "awsSignerJobId": "string", "customCodeSigning": { "signature": { "stream": { "streamId": "string", "fileId": "integer" }, "inlineDocument": "blob" }, "certificateChain": { "stream": { "streamId": "string", "fileId": "integer" }, "certificateName": "string", "inlineDocument": "string" }, "hashAlgorithm": "string", "signatureAlgorithm": "string" } }, "attributes": { "string": "string" } } ], "otaUpdateStatus": "string", "awsIotJobId": "string", "awsIotJobArn": "string", "errorInfo": { "code": "string", "message": "string" }, "additionalParameters": { "string": "string" } } }

Response Body Parameters:

Name

Type

Req?

Description

otaUpdateInfo

OTAUpdateInfo

no

The OTA update info.

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

ResourceNotFoundException

The specified resource does not exist.

HTTP response code: 404

cli

Synopsis:

aws iot get-ota-update \ --ota-update-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "otaUpdateId": "string" }

cli-input-json fields:

Name

Type

Description

otaUpdateId

string

length- max:128 min:1

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

The OTA update ID.

Output:

{ "otaUpdateInfo": { "otaUpdateId": "string", "otaUpdateArn": "string", "creationDate": "timestamp", "lastModifiedDate": "timestamp", "description": "string", "targets": [ "string" ], "targetSelection": "string", "otaUpdateFiles": [ { "fileName": "string", "fileVersion": "string", "fileSource": { "streamId": "string", "fileId": "integer" }, "codeSigning": { "awsSignerJobId": "string", "customCodeSigning": { "signature": { "stream": { "streamId": "string", "fileId": "integer" }, "inlineDocument": "blob" }, "certificateChain": { "stream": { "streamId": "string", "fileId": "integer" }, "certificateName": "string", "inlineDocument": "string" }, "hashAlgorithm": "string", "signatureAlgorithm": "string" } }, "attributes": { "string": "string" } } ], "otaUpdateStatus": "string", "awsIotJobId": "string", "awsIotJobArn": "string", "errorInfo": { "code": "string", "message": "string" }, "additionalParameters": { "string": "string" } } }

cli output fields:

Name

Type

Description

otaUpdateInfo

OTAUpdateInfo

The OTA update info.

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.

lastModifiedDate

timestamp

The date when the OTA update was last updated.

description

string

length- max:2028

pattern: [^\\p{C}]+

A description of the OTA update.

targets

list

member: Target

The targets of the OTA update.

targetSelection

string

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.

enum: CONTINUOUS | SNAPSHOT

otaUpdateFiles

list

member: OTAUpdateFile

A list of files associated with the OTA update.

fileName

string

The name of the file.

fileVersion

string

The file version.

fileSource

Stream

The source of the file.

streamId

string

length- max:128 min:1

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

The stream ID.

fileId

integer

range- max:255 min:0

The ID of a file associated with a stream.

codeSigning

CodeSigning

The code signing method of the file.

awsSignerJobId

string

The ID of the AWSSignerJob which was created to sign the file.

customCodeSigning

CustomCodeSigning

A custom method for code signing a file.

signature

CodeSigningSignature

The signature for the file.

stream

Stream

A stream of the code signing signature.

streamId

string

length- max:128 min:1

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

The stream ID.

fileId

integer

range- max:255 min:0

The ID of a file associated with a stream.

inlineDocument

blob

A base64 encoded binary representation of the code signing signature.

certificateChain

CodeSigningCertificateChain

The certificate chain.

stream

Stream

A stream of the certificate chain files.

streamId

string

length- max:128 min:1

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

The stream ID.

fileId

integer

range- max:255 min:0

The ID of a file associated with a stream.

certificateName

string

The name of the certificate.

inlineDocument

string

A base64 encoded binary representation of the code signing certificate chain.

hashAlgorithm

string

The hash algorithm used to code sign the file.

signatureAlgorithm

string

The signature algorithm used to code sign the file.

attributes

map

A list of name/attribute pairs.

otaUpdateStatus

string

The status of the OTA update.

enum: CREATE_PENDING | CREATE_IN_PROGRESS | CREATE_COMPLETE | CREATE_FAILED

awsIotJobId

string

The AWS IoT job ID associated with the OTA update.

awsIotJobArn

string

The AWS IoT job ARN associated with the OTA update.

errorInfo

ErrorInfo

Error information associated with the OTA update.

code

string

The error code.

message

string

The error message.

additionalParameters

map

A collection of name/value pairs

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.

ThrottlingException

The rate exceeds the limit.

UnauthorizedException

You are not authorized to perform this operation.

InternalFailureException

An unexpected error has occurred.

ServiceUnavailableException

The service is temporarily unavailable.

ResourceNotFoundException

The specified resource does not exist.