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

SearchIndex

查询搜索索引。

请求语法:

POST /indices/search Content-type: application/json { "indexName": "string", "queryString": "string", "nextToken": "string", "maxResults": "integer", "queryVersion": "string" }

请求正文参数:

名称

类型

请求?

描述

indexName

IndexName

搜索索引名称。

queryString

QueryString

搜索查询字符串。

nextToken

NextToken

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

maxResults

QueryMaxResults

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

queryVersion

QueryVersion

查询版本。

响应语法:

Content-type: application/json { "nextToken": "string", "things": [ { "thingName": "string", "thingId": "string", "thingTypeName": "string", "thingGroupNames": [ "string" ], "attributes": { "string": "string" }, "shadow": "string" } ] }

响应正文参数:

名称

类型

请求?

描述

nextToken

NextToken

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

things

ThingDocumentList

与查询搜索匹配的事物。

错误:

InvalidRequestException

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

HTTP 响应代码:400

ThrottlingException

速率超过限制。

HTTP 响应代码:429

UnauthorizedException

您没有权限执行此操作。

HTTP 响应代码:401

ServiceUnavailableException

服务暂时不可用。

HTTP 响应代码:503

InternalFailureException

出现意外错误。

HTTP 响应代码:500

ResourceNotFoundException

指定的资源不存在。

HTTP 响应代码:404

InvalidQueryException

查询无效。

HTTP 响应代码:400

IndexNotReadyException

索引未准备就绪。

HTTP 响应代码:400

CLI

摘要:

aws iot search-index \ [--index-name <value>] \ --query-string <value> \ [--next-token <value>] \ [--max-results <value>] \ [--query-version <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "indexName": "string", "queryString": "string", "nextToken": "string", "maxResults": "integer", "queryVersion": "string" }

cli-input-json 字段:

名称

类型

描述

indexName

字符串

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

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

搜索索引名称。

queryString

字符串

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

搜索查询字符串。

nextToken

字符串

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

maxResults

integer

java 类:java.lang.Integer

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

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

queryVersion

字符串

查询版本。

输出:

{ "nextToken": "string", "things": [ { "thingName": "string", "thingId": "string", "thingTypeName": "string", "thingGroupNames": [ "string" ], "attributes": { "string": "string" }, "shadow": "string" } ] }

cli 输出字段:

名称

类型

描述

nextToken

字符串

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

things

列表

成员:ThingDocument

java 类:java.util.List

与查询搜索匹配的事物。

ThingDocument

ThingDocument

thingName

字符串

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

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

事物名称。

thingId

字符串

事物 ID。

thingTypeName

字符串

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

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

事物类型名称。

thingGroupNames

列表

成员:ThingGroupName

java 类:java.util.List

事物组名称。

ThingGroupName

字符串

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

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

属性

map

键:AttributeName

值:AttributeValue

属性。

AttributeName

字符串

最大长度:128

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

AttributeValue

字符串

最大长度:800

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

shadow

字符串

事物影子。

本页内容: