AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

Inheritance Hierarchy

System.Object
  Amazon.IoT.Model.ThingIndexingConfiguration

Namespace: Amazon.IoT.Model
Assembly: AWSSDK.IoT.dll
Version: 3.x.y.z

Syntax

C#
public class ThingIndexingConfiguration

The ThingIndexingConfiguration type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property CustomFields System.Collections.Generic.List<Amazon.IoT.Model.Field>

Gets and sets the property CustomFields.

Contains custom field names and their data type.

Public Property DeviceDefenderIndexingMode Amazon.IoT.DeviceDefenderIndexingMode

Gets and sets the property 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.

Public Property Filter Amazon.IoT.Model.IndexingFilter

Gets and sets the property 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 in namedShadowNames filter.

To add geolocation data to your fleet indexing configuration:

  • If you store geolocation data in a class/unnamed shadow, set thingIndexingMode to be REGISTRY_AND_SHADOW and specify your geolocation data in geoLocations filter.

  • If you store geolocation data in a named shadow, set namedShadowIndexingMode to be ON, add the shadow name in namedShadowNames filter, and specify your geolocation data in geoLocations filter. For more information, see Managing fleet indexing.

Public Property ManagedFields System.Collections.Generic.List<Amazon.IoT.Model.Field>

Gets and sets the property 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 Web Services IoT Core Developer Guide.

You can't modify managed fields by updating fleet indexing configuration.

Public Property NamedShadowIndexingMode Amazon.IoT.NamedShadowIndexingMode

Gets and sets the property 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 IoT Device Shadow service.

Public Property ThingConnectivityIndexingMode Amazon.IoT.ThingConnectivityIndexingMode

Gets and sets the property 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.

Public Property ThingIndexingMode Amazon.IoT.ThingIndexingMode

Gets and sets the property 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.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5