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

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

Overview

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`.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#deployed ⇒ Boolean

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

Returns:

  • (Boolean) 


962
963
964
965
966
967
968
 
# File 'lib/aws-sdk-cloudsearch/types.rb', line 962

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

#domain_name ⇒ String

The name of the domain you want to describe.

Returns:

  • (String) 


962
963
964
965
966
967
968
 
# File 'lib/aws-sdk-cloudsearch/types.rb', line 962

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

#suggester_names ⇒ Array<String>

The suggesters you want to describe.

Returns:

  • (Array<String>) 


962
963
964
965
966
967
968
 
# File 'lib/aws-sdk-cloudsearch/types.rb', line 962

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