Table Of Contents


User Guide

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

[ aws . iot ]



Updates the search configuration.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.


[--thing-indexing-configuration <value>]
[--thing-group-indexing-configuration <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--thing-indexing-configuration (structure)

Thing indexing configuration.

Shorthand Syntax:


JSON Syntax:

  "thingIndexingMode": "OFF"|"REGISTRY"|"REGISTRY_AND_SHADOW",
  "thingConnectivityIndexingMode": "OFF"|"STATUS"

--thing-group-indexing-configuration (structure)

Thing group indexing configuration.

Shorthand Syntax:


JSON Syntax:

  "thingGroupIndexingMode": "OFF"|"ON"

--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.


To enable thing indexing

The following update-indexing-configuration example enables thing indexing to support searching registry data, shadow data, and thing connectivity status using the AWS_Things index.

aws iot update-indexing-configuration
    --thing-indexing-configuration thingIndexingMode=REGISTRY_AND_SHADOW,thingConnectivityIndexingMode=STATUS

This command produces no output.

For more information, see Managing Thing Indexing in the AWS IoT Developers Guide.