amazonka-iot-2.0: Amazon IoT SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IoT.Types.ThingGroupIndexingConfiguration

Description

 
Synopsis

Documentation

data ThingGroupIndexingConfiguration Source #

Thing group indexing configuration.

See: newThingGroupIndexingConfiguration smart constructor.

Constructors

ThingGroupIndexingConfiguration' 

Fields

  • customFields :: Maybe [Field]

    A list of thing group fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration API to get a list of managed fields.

    Contains custom field names and their data type.

  • managedFields :: Maybe [Field]

    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.

  • thingGroupIndexingMode :: ThingGroupIndexingMode

    Thing group indexing mode.

Instances

Instances details
FromJSON ThingGroupIndexingConfiguration Source # 
Instance details

Defined in Amazonka.IoT.Types.ThingGroupIndexingConfiguration

ToJSON ThingGroupIndexingConfiguration Source # 
Instance details

Defined in Amazonka.IoT.Types.ThingGroupIndexingConfiguration

Generic ThingGroupIndexingConfiguration Source # 
Instance details

Defined in Amazonka.IoT.Types.ThingGroupIndexingConfiguration

Associated Types

type Rep ThingGroupIndexingConfiguration :: Type -> Type #

Read ThingGroupIndexingConfiguration Source # 
Instance details

Defined in Amazonka.IoT.Types.ThingGroupIndexingConfiguration

Show ThingGroupIndexingConfiguration Source # 
Instance details

Defined in Amazonka.IoT.Types.ThingGroupIndexingConfiguration

NFData ThingGroupIndexingConfiguration Source # 
Instance details

Defined in Amazonka.IoT.Types.ThingGroupIndexingConfiguration

Eq ThingGroupIndexingConfiguration Source # 
Instance details

Defined in Amazonka.IoT.Types.ThingGroupIndexingConfiguration

Hashable ThingGroupIndexingConfiguration Source # 
Instance details

Defined in Amazonka.IoT.Types.ThingGroupIndexingConfiguration

type Rep ThingGroupIndexingConfiguration Source # 
Instance details

Defined in Amazonka.IoT.Types.ThingGroupIndexingConfiguration

type Rep ThingGroupIndexingConfiguration = D1 ('MetaData "ThingGroupIndexingConfiguration" "Amazonka.IoT.Types.ThingGroupIndexingConfiguration" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "ThingGroupIndexingConfiguration'" 'PrefixI 'True) (S1 ('MetaSel ('Just "customFields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Field])) :*: (S1 ('MetaSel ('Just "managedFields") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Field])) :*: S1 ('MetaSel ('Just "thingGroupIndexingMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ThingGroupIndexingMode))))

newThingGroupIndexingConfiguration Source #

Create a value of ThingGroupIndexingConfiguration 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:ThingGroupIndexingConfiguration', thingGroupIndexingConfiguration_customFields - A list of thing group fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration API to get a list of managed fields.

Contains custom field names and their data type.

$sel:managedFields:ThingGroupIndexingConfiguration', thingGroupIndexingConfiguration_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.

$sel:thingGroupIndexingMode:ThingGroupIndexingConfiguration', thingGroupIndexingConfiguration_thingGroupIndexingMode - Thing group indexing mode.

thingGroupIndexingConfiguration_customFields :: Lens' ThingGroupIndexingConfiguration (Maybe [Field]) Source #

A list of thing group fields to index. This list cannot contain any managed fields. Use the GetIndexingConfiguration API to get a list of managed fields.

Contains custom field names and their data type.

thingGroupIndexingConfiguration_managedFields :: Lens' ThingGroupIndexingConfiguration (Maybe [Field]) Source #

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.