/indices/search - AWS IoT Wireless

The query search index.

Requires permission to access the SearchIndex action.

curl --location -g --request POST 'https://api.iotwireless.{region}.amazonaws.com/indices/search' \ --header 'Content-Type: application/json' \ --data-raw '{ "indexName": "string", "queryString": "string", "nextToken": "string", "maxResults": 1, "queryVersion": "string" }'

Request

Body Params application/json

indexName

string

optional

The search index name.

>= 1 characters<= 128 characters

Match pattern:

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

queryString

string

required

The search query string.

>= 1 characters

nextToken

string

optional

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

maxResults

integer

optional

The maximum number of results to return at one time.

>= 1<= 500

queryVersion

string

optional

The query version.

Examples

Responses

🟢200Success

application/json

Body

nextToken

string

optional

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

<= 4096 characters

things

array[object (ThingDocument) {7}]

optional

The things that match the search query.

thingName

string

optional

The thing name.

thingId

string

optional

The thing ID.

thingTypeName

string

optional

The thing type name.

>= 1 characters<= 128 characters

Match pattern:

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

thingGroupNames

array[string]

optional

Thing group names.

attributes

object

optional

The attributes.

shadow

string

optional

The shadow.

connectivity

object

optional

Indicates whether the thing is connected to the Amazon Web Services IoT Core service.

thingGroups

array[object (ThingGroupDocument) {5}]

optional

The thing groups that match the search query.

thingGroupName

string

optional

The thing group name.

>= 1 characters<= 128 characters

Match pattern:

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

thingGroupId

string

optional

The thing group ID.

>= 1 characters<= 128 characters

Match pattern:

[a-zA-Z0-9\-]+

thingGroupDescription

string

optional

The thing group description.

<= 2028 characters

Match pattern:

[\p{Graph}\x20]*

attributes

object

optional

The thing group attributes.

parentGroupNames

array[string]

optional

Parent group names.

🟠480InvalidRequestException

🟠481ThrottlingException

🟠482UnauthorizedException

🟠483ServiceUnavailableException

🟠484InternalFailureException

🟠485ResourceNotFoundException

🟠486InvalidQueryException

🟠487IndexNotReadyException