Menu
AWS IoT
Developer Guide

UpdateIndexingConfiguration

Updates the search configuration.

Request syntax:

POST /indexing/config Content-type: application/json { "thingIndexingConfiguration": { "thingIndexingMode": "string" } }

Request Body Parameters:

Name

Type

Req?

Description

thingIndexingConfiguration

ThingIndexingConfiguration

no

Thing indexing configuration.

Errors:

InvalidRequestException

The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.

HTTP response code: 400

ThrottlingException

The rate exceeds the limit.

HTTP response code: 429

UnauthorizedException

You are not authorized to perform this operation.

HTTP response code: 401

ServiceUnavailableException

The service is temporarily unavailable.

HTTP response code: 503

InternalFailureException

An unexpected error has occurred.

HTTP response code: 500

CLI

Synopsis:

aws iot update-indexing-configuration \ [--thing-indexing-configuration <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "thingIndexingConfiguration": { "thingIndexingMode": "string" } }

cli-input-json fields:

Name

Type

Description

thingIndexingConfiguration

ThingIndexingConfiguration

Thing indexing configuration.

thingIndexingMode

string

enum: OFF | REGISTRY | REGISTRY_AND_SHADOW

java class: com.amazonaws.iot.indexing.ThingIndexingMode

Thing indexing mode. Valid values are:

  • REGISTRY – Your thing index will contain only registry data.

  • REGISTRY_AND_SHADOW - Your thing index will contain registry and shadow data.

  • OFF - Thing indexing is disabled.

Output:

None

On this page: