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

UpdateThingGroup

UpdateThingGroup

更新事物组。

https

请求语法:

PATCH /thing-groups/thingGroupName Content-type: application/json { "thingGroupProperties": { "thingGroupDescription": "string", "attributePayload": { "attributes": { "string": "string" }, "merge": "boolean" } }, "expectedVersion": "long" }

URI 请求参数:

名称

类型

请求?

描述

thingGroupName

ThingGroupName

要更新的事物组。

请求正文参数:

名称

类型

请求?

描述

thingGroupProperties

ThingGroupProperties

事物组属性。

expectedVersion

OptionalVersion

事物组的预期版本。如果这与所更新的事物组的版本不匹配,更新将失败。

响应语法:

Content-type: application/json { "version": "long" }

响应正文参数:

名称

类型

请求?

说明

版本

版本

已更新事物组的版本。

错误:

InvalidRequestException

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

HTTP 响应代码:400

VersionConflictException

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

HTTP 响应代码:409

ThrottlingException

速率超过限制。

HTTP 响应代码:429

InternalFailureException

出现意外错误。

HTTP 响应代码:500

ResourceNotFoundException

指定的资源不存在。

HTTP 响应代码:404

cli

摘要:

aws iot update-thing-group \ --thing-group-name <value> \ --thing-group-properties <value> \ [--expected-version <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "thingGroupName": "string", "thingGroupProperties": { "thingGroupDescription": "string", "attributePayload": { "attributes": { "string": "string" }, "merge": "boolean" } }, "expectedVersion": "long" }

cli-input-json 字段:

名称

类型

描述

thingGroupName

字符串

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

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

要更新的事物组。

thingGroupProperties

ThingGroupProperties

事物组属性。

thingGroupDescription

字符串

最大长度:2028

模式:[\\p {Graph}]*

事物组的描述。

attributePayload

AttributePayload

JSON 格式的事物组属性。

个属性

map

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

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

merge

布尔值

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

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

注意

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

expectedVersion

long

事物组的预期版本。如果这与所更新的事物组的版本不匹配,更新将失败。

输出:

{ "version": "long" }

cli 输出字段:

名称

类型

描述

版本

long

已更新事物组的版本。

错误:

InvalidRequestException

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

VersionConflictException

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

ThrottlingException

速率超过限制。

InternalFailureException

出现意外错误。

ResourceNotFoundException

指定的资源不存在。