AWSIoTThingIndexingConfiguration

Objective-C

@interface AWSIoTThingIndexingConfiguration

Swift

class AWSIoTThingIndexingConfiguration

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

Required parameters: [thingIndexingMode]

  • Contains custom field names and their data type.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSIoTField *> *_Nullable customFields;

    Swift

    var customFields: [AWSIoTField]? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic) AWSIoTDeviceDefenderIndexingMode deviceDefenderIndexingMode;

    Swift

    var deviceDefenderIndexingMode: AWSIoTDeviceDefenderIndexingMode { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) AWSIoTIndexingFilter *_Nullable filter;

    Swift

    var filter: AWSIoTIndexingFilter? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic, strong) NSArray<AWSIoTField *> *_Nullable managedFields;

    Swift

    var managedFields: [AWSIoTField]? { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic) AWSIoTNamedShadowIndexingMode namedShadowIndexingMode;

    Swift

    var namedShadowIndexingMode: AWSIoTNamedShadowIndexingMode { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic) AWSIoTThingConnectivityIndexingMode thingConnectivityIndexingMode;

    Swift

    var thingConnectivityIndexingMode: AWSIoTThingConnectivityIndexingMode { get set }

  • 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.

    Declaration

    Objective-C

    @property (nonatomic) AWSIoTThingIndexingMode thingIndexingMode;

    Swift

    var thingIndexingMode: AWSIoTThingIndexingMode { get set }