選取您的 Cookie 偏好設定

我們使用提供自身網站和服務所需的基本 Cookie 和類似工具。我們使用效能 Cookie 收集匿名統計資料,以便了解客戶如何使用我們的網站並進行改進。基本 Cookie 無法停用,但可以按一下「自訂」或「拒絕」以拒絕效能 Cookie。

如果您同意,AWS 與經核准的第三方也會使用 Cookie 提供實用的網站功能、記住您的偏好設定,並顯示相關內容,包括相關廣告。若要接受或拒絕所有非必要 Cookie,請按一下「接受」或「拒絕」。若要進行更詳細的選擇,請按一下「自訂」。

SearchIndex - AWS IoT
此頁面尚未翻譯為您的語言。 請求翻譯

SearchIndex

The query search index.

Requires permission to access the SearchIndex action.

Request Syntax

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

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

indexName

The search index name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z0-9:_-]+

Required: No

maxResults

The maximum number of results to return per page at one time. This maximum number cannot exceed 100. The response might contain fewer results but will never contain more. You can use nextToken to retrieve the next set of results until nextToken returns NULL.

Type: Integer

Valid Range: Minimum value of 1.

Required: No

nextToken

The token used to get the next set of results, or null if there are no additional results.

Type: String

Required: No

queryString

The search query string. For more information about the search query syntax, see Query syntax.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

queryVersion

The query version.

Type: String

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "thingGroups": [ { "attributes": { "string" : "string" }, "parentGroupNames": [ "string" ], "thingGroupDescription": "string", "thingGroupId": "string", "thingGroupName": "string" } ], "things": [ { "attributes": { "string" : "string" }, "connectivity": { "connected": boolean, "disconnectReason": "string", "timestamp": number }, "deviceDefender": "string", "shadow": "string", "thingGroupNames": [ "string" ], "thingId": "string", "thingName": "string", "thingTypeName": "string" } ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

The token used to get the next set of results, or null if there are no additional results.

Type: String

thingGroups

The thing groups that match the search query.

Type: Array of ThingGroupDocument objects

things

The things that match the search query.

Type: Array of ThingDocument objects

Errors

IndexNotReadyException

The index is not ready.

HTTP Status Code: 400

InternalFailureException

An unexpected error has occurred.

HTTP Status Code: 500

InvalidQueryException

The query is invalid.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 400

UnauthorizedException

You are not authorized to perform this operation.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

隱私權網站條款Cookie 偏好設定
© 2025, Amazon Web Services, Inc.或其附屬公司。保留所有權利。