Class: Aws::IoT::Types::SearchIndexRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::SearchIndexRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Overview

Note:

When making an API call, you may pass SearchIndexRequest data as a hash:

{
  index_name: "IndexName",
  query_string: "QueryString", # required
  next_token: "NextToken",
  max_results: 1,
  query_version: "QueryVersion",
}

Instance Attribute Summary

• #index_name ⇒ String

  The search index name.

• #max_results ⇒ Integer

  The maximum number of results to return at one time.

• #next_token ⇒ String

  The token used to get the next set of results, or null if there are no additional results.

• #query_string ⇒ String

  The search query string.

• #query_version ⇒ String

  The query version.

Instance Attribute Details

#index_name ⇒ String

The search index name.

Returns:

• (String)

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

class SearchIndexRequest < Struct.new(
  :index_name,
  :query_string,
  :next_token,
  :max_results,
  :query_version)
  include Aws::Structure
end

#max_results ⇒ Integer

The maximum number of results to return at one time.

Returns:

• (Integer)

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

class SearchIndexRequest < Struct.new(
  :index_name,
  :query_string,
  :next_token,
  :max_results,
  :query_version)
  include Aws::Structure
end

#next_token ⇒ String

The token used to get the next set of results, or null if there are no additional results.

Returns:

• (String)

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

class SearchIndexRequest < Struct.new(
  :index_name,
  :query_string,
  :next_token,
  :max_results,
  :query_version)
  include Aws::Structure
end

#query_string ⇒ String

The search query string.

Returns:

• (String)

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

class SearchIndexRequest < Struct.new(
  :index_name,
  :query_string,
  :next_token,
  :max_results,
  :query_version)
  include Aws::Structure
end

#query_version ⇒ String

The query version.

Returns:

• (String)

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

class SearchIndexRequest < Struct.new(
  :index_name,
  :query_string,
  :next_token,
  :max_results,
  :query_version)
  include Aws::Structure
end