ThingIndexingConfiguration
The thing indexing configuration. For more information, see Managing Thing Indexing.
Contents
- customFields
-
Contains custom field names and their data type.
Type: Array of Field objects
Required: No
- deviceDefenderIndexingMode
-
Device Defender indexing mode. Valid values are:
-
VIOLATIONS – Your thing index contains Device Defender violations. To enable Device Defender indexing, deviceDefenderIndexingMode must not be set to OFF.
-
OFF - Device Defender indexing is disabled.
For more information about Device Defender violations, see Device Defender Detect.
Type: String
Valid Values:
OFF | VIOLATIONS
Required: No
-
- filter
-
Provides additional filters for specific data sources. Named shadow is the only data source that currently supports and requires a filter. To add named shadows to your fleet indexing configuration, set
namedShadowIndexingMode
to beON
and specify your shadow names infilter
.Type: IndexingFilter object
Required: No
- managedFields
-
Contains fields that are indexed and whose types are already known by the Fleet Indexing service.
Type: Array of Field objects
Required: No
- namedShadowIndexingMode
-
Named shadow indexing mode. Valid values are:
-
ON – Your thing index contains named shadow. To enable thing named shadow indexing, namedShadowIndexingMode must not be set to OFF.
-
OFF - Named shadow indexing is disabled.
For more information about Shadows, see AWS IoT Device Shadow service.
Type: String
Valid Values:
OFF | ON
Required: No
-
- thingConnectivityIndexingMode
-
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.
Type: String
Valid Values:
OFF | STATUS
Required: No
-
- thingIndexingMode
-
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.
Type: String
Valid Values:
OFF | REGISTRY | REGISTRY_AND_SHADOW
Required: Yes
-
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: