IndexingFilter - AWS IoT

IndexingFilter

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.

Contents

geoLocations

The list of geolocation targets that you select to index. The default maximum number of geolocation targets for indexing is 1. To increase the limit, see AWS IoT Device Management Quotas in the AWS General Reference.

Type: Array of GeoLocationTarget objects

Required: No

namedShadowNames

The shadow names that you select to index. The default maximum number of shadow names for indexing is 10. To increase the limit, see AWS IoT Device Management Quotas in the AWS General Reference.

Type: Array of strings

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [$a-zA-Z0-9:_-]+

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: