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

Class: Aws::CloudSearch::Types::DescribeSuggestersRequest

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 DescribeSuggestersRequest data as a hash:

{
  domain_name: "DomainName", # required
  suggester_names: ["StandardName"],
  deployed: false,
}

Container for the parameters to the DescribeSuggester operation. Specifies the name of the domain you want to describe. To restrict the response to particular suggesters, specify the names of the suggesters you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to true.

Instance Attribute Summary collapse

Instance Attribute Details

#deployedBoolean

Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

Returns:

  • (Boolean)


1171
1172
1173
1174
1175
1176
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1171

class DescribeSuggestersRequest < Struct.new(
  :domain_name,
  :suggester_names,
  :deployed)
  include Aws::Structure
end

#domain_nameString

The name of the domain you want to describe.

Returns:

  • (String)


1171
1172
1173
1174
1175
1176
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1171

class DescribeSuggestersRequest < Struct.new(
  :domain_name,
  :suggester_names,
  :deployed)
  include Aws::Structure
end

#suggester_namesArray<String>

The suggesters you want to describe.

Returns:

  • (Array<String>)


1171
1172
1173
1174
1175
1176
# File 'gems/aws-sdk-cloudsearch/lib/aws-sdk-cloudsearch/types.rb', line 1171

class DescribeSuggestersRequest < Struct.new(
  :domain_name,
  :suggester_names,
  :deployed)
  include Aws::Structure
end