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

Class: Aws::CloudSearch::Types::DefineSuggesterRequest

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

Overview

Note:

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

{
  domain_name: "DomainName", # required
  suggester: { # required
    suggester_name: "StandardName", # required
    document_suggester_options: { # required
      source_field: "FieldName", # required
      fuzzy_matching: "none", # accepts none, low, high
      sort_expression: "String",
    },
  },
}

Container for the parameters to the DefineSuggester operation. Specifies the name of the domain you want to update and the suggester configuration.

Instance Attribute Summary collapse

Instance Attribute Details

#domain_nameString

A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Returns:

  • (String)


636
637
638
639
640
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 636

class DefineSuggesterRequest < Struct.new(
  :domain_name,
  :suggester)
  include Aws::Structure
end

#suggesterTypes::Suggester

Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester: FuzzyMatching, SortExpression.

Returns:



636
637
638
639
640
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 636

class DefineSuggesterRequest < Struct.new(
  :domain_name,
  :suggester)
  include Aws::Structure
end