Menu
AWS IoT
Developer Guide

GetIndexingConfiguration

GetIndexingConfiguration

Gets the search configuration.

https

Request syntax:

GET /indexing/config

Response syntax:

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

Response 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 get-indexing-configuration \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ }

Output:

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

cli output fields:

Name

Type

Description

thingIndexingConfiguration

ThingIndexingConfiguration

Thing indexing configuration.

thingIndexingMode

string

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.

enum: OFF | REGISTRY | REGISTRY_AND_SHADOW

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.

ThrottlingException

The rate exceeds the limit.

UnauthorizedException

You are not authorized to perform this operation.

ServiceUnavailableException

The service is temporarily unavailable.

InternalFailureException

An unexpected error has occurred.