AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing SearchIndexRequest as input to an Aws::Client method, you can use a vanilla 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)

    The search index name.

#max_resultsInteger

The maximum number of results to return at one time.

Returns:

  • (Integer)

    The maximum number of results to return at one time.

#next_tokenString

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

Returns:

  • (String)

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

#query_stringString

The search query string.

Returns:

  • (String)

    The search query string.

#query_versionString

The query version.

Returns:

  • (String)

    The query version.