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

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

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

Instance Attribute Summary collapse

Instance Attribute Details

#index_nameString

The index name.

Returns:

  • (String)


2687
2688
2689
2690
2691
2692
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2687

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

#index_statusString

The index status.

Returns:

  • (String)


2687
2688
2689
2690
2691
2692
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2687

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:

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

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

Returns:

  • (String)


2687
2688
2689
2690
2691
2692
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 2687

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