Skip to content

ThingGroupIndexingConfiguration

Used by
Source code in docs_src/capo_iot/types/thing_group_indexing_configuration.py 
14
15
16
17
18
19
20
21
22
class ThingGroupIndexingConfiguration(TypedDict, closed=True):
    thing_group_indexing_mode: (
        "capo_iot.types.thing_group_indexing_mode.ThingGroupIndexingMode"
    )
    """<p>Thing group indexing mode.</p>"""
    managed_fields: NotRequired["capo_iot.types.fields.Fields"]
    """<p>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 <a href="https://docs.aws.amazon.com/iot/latest/developerguide/managing-fleet-index.html#managed-field">Managed fields</a> in the <i>Amazon Web Services IoT Core Developer Guide</i>.</p> <note> <p>You can't modify managed fields by updating fleet indexing configuration.</p> </note>"""
    custom_fields: NotRequired["capo_iot.types.fields.Fields"]
    """<p>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.</p> <p>Contains custom field names and their data type.</p>"""

custom_fields instance-attribute 

custom_fields: NotRequired[Fields]

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.

managed_fields instance-attribute 

managed_fields: NotRequired[Fields]

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.

thing_group_indexing_mode instance-attribute 

thing_group_indexing_mode: ThingGroupIndexingMode

Thing group indexing mode.