AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IoT::Types::ThingGroupIndexingConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ThingGroupIndexingConfiguration as input to an Aws::Client method, you can use a vanilla Hash:

{
  thing_group_indexing_mode: "OFF", # required, accepts OFF, ON
  managed_fields: [
    {
      name: "FieldName",
      type: "Number", # accepts Number, String, Boolean
    },
  ],
  custom_fields: [
    {
      name: "FieldName",
      type: "Number", # accepts Number, String, Boolean
    },
  ],
}

Thing group indexing configuration.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#custom_fieldsArray<Types::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.

Returns:

  • (Array<Types::Field>)

    A list of thing group fields to index.

#managed_fieldsArray<Types::Field>

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

Returns:

  • (Array<Types::Field>)

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

#thing_group_indexing_modeString

Thing group indexing mode.

Possible values:

  • OFF
  • ON

Returns:

  • (String)

    Thing group indexing mode.