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

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

Instance Attribute Summary collapse

Instance Attribute Details

#index_nameString

The index name.

Returns:

  • (String)


3973
3974
3975
3976
3977
3978
# File 'lib/aws-sdk-iot/types.rb', line 3973

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

#index_statusString

The index status.

Returns:

  • (String)


3973
3974
3975
3976
3977
3978
# File 'lib/aws-sdk-iot/types.rb', line 3973

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

#schemaString

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

  • REGISTRY – Your thing index will contain only registry data.

  • REGISTRY_AND_SHADOW - Your thing index will contain registry data and shadow data.

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

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

Returns:

  • (String)


3973
3974
3975
3976
3977
3978
# File 'lib/aws-sdk-iot/types.rb', line 3973

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