/indexing/config

Updates the search configuration.

Requires permission to access the UpdateIndexingConfiguration action.

curl --location -g --request POST 'https://api.iotwireless.{region}.amazonaws.com/indexing/config' \ --header 'Content-Type: application/json' \ --data-raw '{ "thingIndexingConfiguration": { "thingIndexingMode": "OFF", "thingConnectivityIndexingMode": "OFF", "managedFields": [], "customFields": [] }, "thingGroupIndexingConfiguration": { "thingGroupIndexingMode": "OFF", "managedFields": [], "customFields": [] } }'

Request

Body Params application/json

thingIndexingConfiguration

object

optional

The thing indexing configuration. For more information, see Managing Thing Indexing.

thingIndexingMode

enum<string>

optional

Thing indexing mode. Valid values are:

REGISTRY – Your thing index contains registry data only.
REGISTRY_AND_SHADOW - Your thing index contains registry and shadow data.
OFF - Thing indexing is disabled.

Allowed values:

OFFREGISTRYREGISTRY_AND_SHADOW

thingConnectivityIndexingMode

enum<string>

optional

Thing connectivity indexing mode. Valid values are:

STATUS – Your thing index contains connectivity status. To enable thing connectivity indexing, thingIndexMode must not be set to OFF.
OFF - Thing connectivity status indexing is disabled.

Allowed values:

OFFSTATUS

managedFields

array[object (Field) {2}]

optional

Contains fields that are indexed and whose types are already known by the Fleet Indexing service.

customFields

array[object (Field) {2}]

optional

Contains custom field names and their data type.

thingGroupIndexingConfiguration

object

optional

Thing group indexing configuration.

thingGroupIndexingMode

enum<string>

optional

Thing group indexing mode.

Allowed values:

OFFON

managedFields

array[object (Field) {2}]

optional

Contains fields that are indexed and whose types are already known by the Fleet Indexing service.

customFields

array[object (Field) {2}]

optional

A list of thing group fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration API to get a list of managed fields.

Contains custom field names and their data type.

Examples

Request

Responses