AWS IoT
开发人员指南
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 Amazon AWS 入门

GetOTAUpdate

GetOTAUpdate

获取 OTA 更新。

https

请求语法:

GET /otaUpdates/otaUpdateId

URI 请求参数:

名称

类型

请求?

描述

otaUpdateId

OTAUpdateId

OTA 更新 ID。

响应语法:

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" } } }

响应正文参数:

名称

类型

请求?

描述

otaUpdateInfo

OTAUpdateInfo

OTA 更新信息。

错误:

InvalidRequestException

请求的内容无效。例如,UpdateJobExecution 请求包含无效状态详细信息时,将返回此代码。消息包含有关错误的详细信息。

HTTP 响应代码:400

ThrottlingException

速率超过限制。

HTTP 响应代码:429

UnauthorizedException

您没有权限执行此操作。

HTTP 响应代码:401

InternalFailureException

出现意外错误。

HTTP 响应代码:500

ServiceUnavailableException

服务暂时不可用。

HTTP 响应代码:503

ResourceNotFoundException

指定的资源不存在。

HTTP 响应代码:404

cli

摘要:

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 字段:

名称

类型

描述

otaUpdateId

字符串

最大长度:128,最小长度:1

模式:[a-zA-Z0-9_-]+

OTA 更新 ID。

输出:

{ "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 输出字段:

名称

类型

描述

otaUpdateInfo

OTAUpdateInfo

OTA 更新信息。

otaUpdateId

字符串

最大长度:128,最小长度:1

模式:[a-zA-Z0-9_-]+

OTA 更新 ID。

otaUpdateArn

字符串

OTA 更新 ARN。

creationDate

timestamp

创建 OTA 更新的日期。

lastModifiedDate

timestamp

上次更新 OTA 更新的日期。

description

字符串

最大长度:2028

模式:[^\\p{C}]+

OTA 更新的描述。

目标

列表

成员:Target

OTA 更新的目标。

targetSelection

字符串

指定 OTA 更新将继续运行 (CONTINUOUS),还是在指定作为目标的所有事物完成 OTA 更新之后完成 (SNAPSHOT)。如果继续运行,则在检测到目标中出现更改时,OTA 更新也会在事物上运行。例如,当某个事物添加到目标组时会在该事物上运行 OTA 更新,即使是组中原有的全部事物已经完成了 OTA 更新。

枚举:CONTINUOUS | SNAPSHOT

otaUpdateFiles

列表

成员:OTAUpdateFile

与 OTA 更新关联的文件列表。

fileName

字符串

文件的名称。

fileVersion

字符串

文件版本。

fileSource

文件的源。

streamId

字符串

最大长度:128,最小长度:1

模式:[a-zA-Z0-9_-]+

流 ID。

fileId

integer

范围 – 最大值:255,最小值:0

与流关联的文件的 ID。

codeSigning

CodeSigning

文件的代码签名方法。

awsSignerJobId

字符串

已创建用于对文件签名的 AWSSignerJob 的 ID。

customCodeSigning

CustomCodeSigning

用于对文件执行代码签名的自定义方法。

签名

CodeSigningSignature

文件的签名。

stream

代码签署签名的流。

streamId

字符串

最大长度:128,最小长度:1

模式:[a-zA-Z0-9_-]+

流 ID。

fileId

integer

范围 – 最大值:255,最小值:0

与流关联的文件的 ID。

inlineDocument

blob

代码签署签名的 base64 编码二进制表示形式。

certificateChain

CodeSigningCertificateChain

证书链。

stream

证书链文件的流。

streamId

字符串

最大长度:128,最小长度:1

模式:[a-zA-Z0-9_-]+

流 ID。

fileId

integer

范围 – 最大值:255,最小值:0

与流关联的文件的 ID。

certificateName

字符串

证书的名称。

inlineDocument

字符串

代码签名证书链的 base64 编码二进制表示形式。

hashAlgorithm

字符串

用于对文件进行代码签名的哈希算法。

signatureAlgorithm

字符串

用于对文件进行代码签名的签名算法。

个属性

map

名称/属性对的列表。

otaUpdateStatus

字符串

OTA 更新的状态。

枚举:CREATE_PENDING | CREATE_IN_PROGRESS | CREATE_COMPLETE | CREATE_FAILED

awsIotJobId

字符串

与 OTA 更新关联的 AWS IoT 任务 ID。

awsIotJobArn

字符串

与 OTA 更新关联的 AWS IoT 任务 ARN。

errorInfo

ErrorInfo

与 OTA 更新关联的错误信息。

code

字符串

错误代码。

message

字符串

错误消息。

additionalParameters

map

名称/值对的集合

错误:

InvalidRequestException

请求的内容无效。例如,UpdateJobExecution 请求包含无效状态详细信息时,将返回此代码。消息包含有关错误的详细信息。

ThrottlingException

速率超过限制。

UnauthorizedException

您没有权限执行此操作。

InternalFailureException

出现意外错误。

ServiceUnavailableException

服务暂时不可用。

ResourceNotFoundException

指定的资源不存在。