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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iot/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 collapse

Instance Attribute Details

#index_nameString

The search index name.

Returns:

  • (String)


6626
6627
6628
6629
6630
6631
6632
6633
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6626

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

#max_resultsInteger

The maximum number of results to return at one time.

Returns:

  • (Integer)


6626
6627
6628
6629
6630
6631
6632
6633
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6626

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

#next_tokenString

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

Returns:

  • (String)


6626
6627
6628
6629
6630
6631
6632
6633
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6626

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

#query_stringString

The search query string.

Returns:

  • (String)


6626
6627
6628
6629
6630
6631
6632
6633
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6626

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

#query_versionString

The query version.

Returns:

  • (String)


6626
6627
6628
6629
6630
6631
6632
6633
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 6626

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