Class: Aws::IoT::Types::IndexingFilter

Inherits:

Struct

Object
Struct
Aws::IoT::Types::IndexingFilter

show all

Defined in:: gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb

Overview

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.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#geo_locations ⇒ Array<Types::GeoLocationTarget>
The list of geolocation targets that you select to index.
#named_shadow_names ⇒ Array<String>
The shadow names that you select to index.

Instance Attribute Details

#geo_locations ⇒ `Array<Types::GeoLocationTarget>`

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 Amazon Web Services IoT Device Management Quotas in the Amazon Web Services General Reference.

Returns:

(Array<Types::GeoLocationTarget>)

# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 8081

class IndexingFilter < Struct.new(
  :named_shadow_names,
  :geo_locations)
  SENSITIVE = []
  include Aws::Structure
end

#named_shadow_names ⇒ `Array<String>`

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