Amazonka.IoT.Types.ThingIndexingConfiguration

Documentation

data ThingIndexingConfiguration

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

See: newThingIndexingConfiguration smart constructor.

Constructors

ThingIndexingConfiguration'

Fields

• customFields :: Maybe [Field]

  Contains custom field names and their data type.

• deviceDefenderIndexingMode :: Maybe 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.

• filter' :: Maybe IndexingFilter

  Provides additional filters for specific data sources. Named shadow is the only data source that currently supports and requires a filter. To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode to be ON and specify your shadow names in filter.

• managedFields :: Maybe [Field]

  Contains fields that are indexed and whose types are already known by the Fleet Indexing service.

• namedShadowIndexingMode :: Maybe 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.

• thingConnectivityIndexingMode :: Maybe 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.
• thingIndexingMode :: 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.

Instances

FromJSON ThingIndexingConfiguration

Defined in Amazonka.IoT.Types.ThingIndexingConfiguration

Methods

parseJSON :: Value -> Parser ThingIndexingConfiguration

parseJSONList :: Value -> Parser [ThingIndexingConfiguration]

ToJSON ThingIndexingConfiguration

Defined in Amazonka.IoT.Types.ThingIndexingConfiguration

Methods

toJSON :: ThingIndexingConfiguration -> Value

toEncoding :: ThingIndexingConfiguration -> Encoding

toJSONList :: [ThingIndexingConfiguration] -> Value

toEncodingList :: [ThingIndexingConfiguration] -> Encoding

Generic ThingIndexingConfiguration

Defined in Amazonka.IoT.Types.ThingIndexingConfiguration

Associated Types

type Rep ThingIndexingConfiguration :: Type -> Type

Methods

from :: ThingIndexingConfiguration -> Rep ThingIndexingConfiguration x

to :: Rep ThingIndexingConfiguration x -> ThingIndexingConfiguration

Read ThingIndexingConfiguration

Defined in Amazonka.IoT.Types.ThingIndexingConfiguration

Methods

readsPrec :: Int -> ReadS ThingIndexingConfiguration

readList :: ReadS [ThingIndexingConfiguration]

readPrec :: ReadPrec ThingIndexingConfiguration

readListPrec :: ReadPrec [ThingIndexingConfiguration]

Show ThingIndexingConfiguration

Defined in Amazonka.IoT.Types.ThingIndexingConfiguration

Methods

showsPrec :: Int -> ThingIndexingConfiguration -> ShowS

show :: ThingIndexingConfiguration -> String

showList :: [ThingIndexingConfiguration] -> ShowS

NFData ThingIndexingConfiguration

Defined in Amazonka.IoT.Types.ThingIndexingConfiguration

Methods

rnf :: ThingIndexingConfiguration -> ()

Eq ThingIndexingConfiguration

Defined in Amazonka.IoT.Types.ThingIndexingConfiguration

Methods

(==) :: ThingIndexingConfiguration -> ThingIndexingConfiguration -> Bool

(/=) :: ThingIndexingConfiguration -> ThingIndexingConfiguration -> Bool

Hashable ThingIndexingConfiguration

Defined in Amazonka.IoT.Types.ThingIndexingConfiguration

Methods

hashWithSalt :: Int -> ThingIndexingConfiguration -> Int

hash :: ThingIndexingConfiguration -> Int

type Rep ThingIndexingConfiguration

Defined in Amazonka.IoT.Types.ThingIndexingConfiguration

type Rep ThingIndexingConfiguration = D1 ('MetaData "ThingIndexingConfiguration" "Amazonka.IoT.Types.ThingIndexingConfiguration" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "ThingIndexingConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "customFields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Field])) :*: (S1 ('MetaSel ('Just "deviceDefenderIndexingMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DeviceDefenderIndexingMode)) :*: S1 ('MetaSel ('Just "filter'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IndexingFilter)))) :*: ((S1 ('MetaSel ('Just "managedFields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Field])) :*: S1 ('MetaSel ('Just "namedShadowIndexingMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NamedShadowIndexingMode))) :*: (S1 ('MetaSel ('Just "thingConnectivityIndexingMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ThingConnectivityIndexingMode)) :*: S1 ('MetaSel ('Just "thingIndexingMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ThingIndexingMode)))))

newThingIndexingConfiguration

Arguments

:: ThingIndexingMode

$sel:thingIndexingMode:ThingIndexingConfiguration'

-> ThingIndexingConfiguration

Create a value of ThingIndexingConfiguration with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:customFields:ThingIndexingConfiguration', thingIndexingConfiguration_customFields - Contains custom field names and their data type.

$sel:deviceDefenderIndexingMode:ThingIndexingConfiguration', thingIndexingConfiguration_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.

$sel:filter':ThingIndexingConfiguration', thingIndexingConfiguration_filter - Provides additional filters for specific data sources. Named shadow is the only data source that currently supports and requires a filter. To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode to be ON and specify your shadow names in filter.

$sel:managedFields:ThingIndexingConfiguration', thingIndexingConfiguration_managedFields - Contains fields that are indexed and whose types are already known by the Fleet Indexing service.

$sel:namedShadowIndexingMode:ThingIndexingConfiguration', thingIndexingConfiguration_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.

$sel:thingConnectivityIndexingMode:ThingIndexingConfiguration', thingIndexingConfiguration_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.

$sel:thingIndexingMode:ThingIndexingConfiguration', thingIndexingConfiguration_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.

thingIndexingConfiguration_customFields :: Lens' ThingIndexingConfiguration (Maybe [Field])

Contains custom field names and their data type.

thingIndexingConfiguration_deviceDefenderIndexingMode :: Lens' ThingIndexingConfiguration (Maybe 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.

thingIndexingConfiguration_filter :: Lens' ThingIndexingConfiguration (Maybe IndexingFilter)

Provides additional filters for specific data sources. Named shadow is the only data source that currently supports and requires a filter. To add named shadows to your fleet indexing configuration, set namedShadowIndexingMode to be ON and specify your shadow names in filter.

thingIndexingConfiguration_managedFields :: Lens' ThingIndexingConfiguration (Maybe [Field])

Contains fields that are indexed and whose types are already known by the Fleet Indexing service.

thingIndexingConfiguration_namedShadowIndexingMode :: Lens' ThingIndexingConfiguration (Maybe 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.

thingIndexingConfiguration_thingConnectivityIndexingMode :: Lens' ThingIndexingConfiguration (Maybe 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.

thingIndexingConfiguration_thingIndexingMode :: Lens' ThingIndexingConfiguration 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.