ThingIndexingConfiguration
The thing indexing configuration. For more information, see Managing
Thing Indexing
Contents
- 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
-
- 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 selections for named shadows and geolocation data.
To add named shadows to your fleet indexing configuration, set
namedShadowIndexingMode
to be ON and specify your shadow names innamedShadowNames
filter.To add geolocation data to your fleet indexing configuration:
-
If you store geolocation data in a class/unnamed shadow, set
thingIndexingMode
to beREGISTRY_AND_SHADOW
and specify your geolocation data ingeoLocations
filter. -
If you store geolocation data in a named shadow, set
namedShadowIndexingMode
to beON
, add the shadow name innamedShadowNames
filter, and specify your geolocation data ingeoLocations
filter. For more information, see Managing fleet indexing.
Type: IndexingFilter object
Required: No
-
- managedFields
-
Contains fields that are indexed and whose types are already known by the Fleet Indexing service. This is an optional field. For more information, see Managed fields
in the Amazon IoT Core Developer Guide. Note
You can't modify managed fields by updating fleet indexing configuration.
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 Amazon 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
-
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: