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

ListThingGroups

列出您账户中的事物组。

请求语法:

GET /thing-groups?maxResults=maxResults&nextToken=nextToken&parentGroup=parentGroup&namePrefixFilter=namePrefixFilter&recursive=recursive

URI 请求参数:

名称

类型

请求?

描述

nextToken

NextToken

用于获取下一组结果的令牌,没有更多结果时为 null

maxResults

RegistryMaxResults

一次性返回的最大结果数。

parentGroup

ThingGroupName

一个筛选条件,用于将结果限制为指定的父组。

namePrefixFilter

ThingGroupName

一个筛选条件,用于将结果限制为具有指定名称前缀的组。

recursive

RecursiveWithoutDefault

如果为 true,则还会返回子组。

响应语法:

Content-type: application/json { "thingGroups": [ { "groupName": "string", "groupArn": "string" } ], "nextToken": "string" }

响应正文参数:

名称

类型

请求?

描述

thingGroups

ThingGroupNameAndArnList

事物组。

nextToken

NextToken

用于获取下一组结果的令牌,没有更多结果时为 null

错误:

InvalidRequestException

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

HTTP 响应代码:400

InternalFailureException

出现意外错误。

HTTP 响应代码:500

ResourceNotFoundException

指定的资源不存在。

HTTP 响应代码:404

CLI

摘要:

aws iot list-thing-groups \ [--next-token <value>] \ [--max-results <value>] \ [--parent-group <value>] \ [--name-prefix-filter <value>] \ [--recursive | --no-recursive] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "nextToken": "string", "maxResults": "integer", "parentGroup": "string", "namePrefixFilter": "string", "recursive": "boolean" }

cli-input-json 字段:

名称

类型

描述

nextToken

字符串

用于获取下一组结果的令牌,没有更多结果时为 null

maxResults

integer

java 类:java.lang.Integer

范围 - 最大值:250,最小值:1

一次性返回的最大结果数。

parentGroup

字符串

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

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

一个筛选条件,用于将结果限制为指定的父组。

namePrefixFilter

字符串

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

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

一个筛选条件,用于将结果限制为具有指定名称前缀的组。

recursive

布尔值

java 类:java.lang.Boolean

如果为 true,则还会返回子组。

输出:

{ "thingGroups": [ { "groupName": "string", "groupArn": "string" } ], "nextToken": "string" }

cli 输出字段:

名称

类型

描述

thingGroups

列表

成员:GroupNameAndArn

java 类:java.util.List

事物组。

GroupNameAndArn

GroupNameAndArn

groupName

字符串

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

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

组名称。

groupArn

字符串

组 ARN。

nextToken

字符串

用于获取下一组结果的令牌,没有更多结果时为 null

本页内容: