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

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::DescribeIndexResponse

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #index_name ⇒ String

  The index name.

• #index_status ⇒ String

  The index status.

• #schema ⇒ String

  Contains a value that specifies the type of indexing performed.

Instance Attribute Details

#index_name ⇒ String

The index name.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 5658

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

#index_status ⇒ String

The index status.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 5658

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

#schema ⇒ String

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].

[1]: docs.aws.amazon.com/iot/latest/apireference/API_GetIndexingConfiguration.html

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 5658

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