Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . iot ]

search-index

Description

The query search index.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

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

Options

--index-name (string)

The search index name.

--query-string (string)

The search query string.

--next-token (string)

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

--max-results (integer)

The maximum number of results to return at one time.

--query-version (string)

The query version.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

nextToken -> (string)

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

things -> (list)

The things that match the search query.

(structure)

The thing search index document.

thingName -> (string)

The thing name.

thingId -> (string)

The thing ID.

thingTypeName -> (string)

The thing type name.

thingGroupNames -> (list)

Thing group names.

(string)

attributes -> (map)

The attributes.

key -> (string)

value -> (string)

shadow -> (string)

The shadow.