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

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

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

Overview

Note:

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

#deployed ⇒ Boolean

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

Returns:

  • (Boolean) —

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

#domain_name ⇒ String

The name of the domain you want to describe.

Returns:

  • (String) —

    The name of the domain you want to describe.

#suggester_names ⇒ Array<String>

The suggesters you want to describe.

Returns:

  • (Array<String>) —

    The suggesters you want to describe.