ListEntities - AWS IoT TwinMaker

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

ListEntities

列出工作区中的所有实体。

请求语法

POST /workspaces/workspaceId/entities-list HTTP/1.1 Content-type: application/json { "filters": [ { ... } ], "maxResults": number, "nextToken": "string" }

URI 请求参数

请求使用以下 URI 参数。

workspaceId

工作区的 ID。

长度限制:最小长度为 1。长度上限为 128。

模式:[a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+

必需:是

请求体

请求接受采用 JSON 格式的以下数据。

filters

筛选请求的对象列表。

注意

有效输入仅接受一个对象。

类型:ListEntitiesFilter 对象数组

必需:否

maxResults

一次性返回的最大结果数。默认值为 25。

有效范围:最小值为 1。最大值为 250。

类型:整数

有效范围:最小值为 0。最大值为 200。

必需:否

nextToken

指定下一页结果的字符串。

类型:字符串

长度约束:最小长度为 0。最大长度为 17880。

模式:.*

必需:否

响应语法

HTTP/1.1 200 Content-type: application/json { "entitySummaries": [ { "arn": "string", "creationDateTime": number, "description": "string", "entityId": "string", "entityName": "string", "hasChildEntities": boolean, "parentEntityId": "string", "status": { "error": { "code": "string", "message": "string" }, "state": "string" }, "updateDateTime": number } ], "nextToken": "string" }

响应元素

如果此操作成功,则该服务将会发送回 HTTP 200 响应。

服务以 JSON 格式返回以下数据。

entitySummaries

包含有关实体信息的对象列表。

类型:EntitySummary 对象数组

nextToken

指定下一页结果的字符串。

类型:字符串

长度约束:最小长度为 0。最大长度为 17880。

模式:.*

错误

有关所有操作的常见错误信息,请参阅常见错误

InternalServerException

出现意外错误。

HTTP 状态代码:500

ServiceQuotaExceededException

已超出服务限额。

HTTP 状态代码:402

ThrottlingException

速率超过限制。

HTTP 状态代码:429

ValidationException

失败

HTTP 状态代码:400

另请参阅

有关在特定语言的 AWS SDK 中使用此 API 的更多信息,请参阅以下内容: