AWS IoT
开发人员指南
AWS 服务或AWS文档中描述的功能,可能因地区/位置而异。请点击 Amazon AWS 入门,可查看中国地区的具体差异

UpdateThing

更新事物的数据。

请求语法:

PATCH /things/thingName Content-type: application/json { "thingTypeName": "string", "attributePayload": { "attributes": { "string": "string" }, "merge": "boolean" }, "expectedVersion": "long", "removeThingType": "boolean" }

URI 请求参数:

名称

类型

请求?

描述

thingName

ThingName

要更新的事物的名称。

请求正文参数:

名称

类型

请求?

描述

thingTypeName

ThingTypeName

事务类型的名称。

attributePayload

AttributePayload

事物属性的列表,采用包含名称/值对的 JSON 字符串形式。例如:

\"attributes\":{\"name1\":\"value2\"}

此数据用于添加新属性或更新现有属性。

expectedVersion

OptionalVersion

注册表中预期的事物记录的版本。如果注册表中记录的版本与请求中指定的预期版本不匹配,则使用 VersionConflictException 拒绝 UpdateThing 请求。

removeThingType

RemoveThingType

删除事物类型关联。如果为 true,则删除关联。

错误:

InvalidRequestException

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

HTTP 响应代码:400

VersionConflictException

传递到命令的事物的版本不同于使用 --version 参数指定的版本时,将引发异常错误。

HTTP 响应代码:409

ThrottlingException

速率超过限制。

HTTP 响应代码:429

UnauthorizedException

您没有权限执行此操作。

HTTP 响应代码:401

ServiceUnavailableException

服务暂时不可用。

HTTP 响应代码:503

InternalFailureException

出现意外错误。

HTTP 响应代码:500

ResourceNotFoundException

指定的资源不存在。

HTTP 响应代码:404

CLI

摘要:

aws iot update-thing \ --thing-name <value> \ [--thing-type-name <value>] \ [--attribute-payload <value>] \ [--expected-version <value>] \ [--remove-thing-type | --no-remove-thing-type] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "thingName": "string", "thingTypeName": "string", "attributePayload": { "attributes": { "string": "string" }, "merge": "boolean" }, "expectedVersion": "long", "removeThingType": "boolean" }

cli-input-json 字段:

名称

类型

描述

thingName

字符串

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

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

要更新的事物的名称。

thingTypeName

字符串

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

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

事务类型的名称。

attributePayload

AttributePayload

事物属性的列表,采用包含名称/值对的 JSON 字符串形式。例如:

\"attributes\":{\"name1\":\"value2\"}

此数据用于添加新属性或更新现有属性。

个属性

map

键:AttributeName

值:AttributeValue

一个 JSON 字符串,其中最多包含三个 JSON 格式的键/值对。例如:

\"attributes\":{\"string1\":\"string2\"}

AttributeName

字符串

最大长度:128

模式:[a-zA-Z0-9_.,@/:#-]+

AttributeValue

字符串

最大长度:800

模式:[a-zA-Z0-9_.,@/:#-]*

merge

布尔值

指定在 AttributePayload 中提供的属性列表是否与存储在注册表中的属性合并,而不是覆盖。

要删除属性,请使用空属性值调用 UpdateThing

注意

merge 属性仅在调用 UpdateThing 时有效。

expectedVersion

long

java 类:java.lang.Long

注册表中预期的事物记录的版本。如果注册表中记录的版本与请求中指定的预期版本不匹配,则使用 VersionConflictException 拒绝 UpdateThing 请求。

removeThingType

布尔值

删除事物类型关联。如果为 true,则删除关联。

输出:

本页内容: