Class: Aws::IoT::Types::DescribeIndexResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#index_nameString

The index name.

Returns:

  • (String)


5216
5217
5218
5219
5220
5221
5222
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5216

class DescribeIndexResponse < Struct.new(
  :index_name,
  :index_status,
  :schema)
  SENSITIVE = []
  include Aws::Structure
end

#index_statusString

The index status.

Returns:

  • (String)


5216
5217
5218
5219
5220
5221
5222
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5216

class DescribeIndexResponse < Struct.new(
  :index_name,
  :index_status,
  :schema)
  SENSITIVE = []
  include Aws::Structure
end

#schemaString

Contains a value that specifies the type of indexing performed. Valid values are:

  • REGISTRY – Your thing index contains only registry data.

  • REGISTRY_AND_SHADOW - Your thing index contains registry data and shadow data.

  • REGISTRY_AND_CONNECTIVITY_STATUS - Your thing index contains registry data and thing connectivity status data.

  • REGISTRY_AND_SHADOW_AND_CONNECTIVITY_STATUS - Your thing index contains registry data, shadow data, and thing connectivity status data.

  • MULTI_INDEXING_MODE - Your thing index contains multiple data sources. For more information, see GetIndexingConfiguration.

Returns:

  • (String)


5216
5217
5218
5219
5220
5221
5222
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5216

class DescribeIndexResponse < Struct.new(
  :index_name,
  :index_status,
  :schema)
  SENSITIVE = []
  include Aws::Structure
end