Menu
AWS IoT
API Reference

SearchIndex

The query search index.

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 at one time.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 500.

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.

Type: String

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

Required: Yes

queryVersion

The query version.

Type: String

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "things": [ 
      { 
         "attributes": { 
            "string" : "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

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: 429

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: