amazonka-cloudsearch-1.2.0: Amazon CloudSearch SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CloudSearch.DescribeSuggesters

Contents

Description

Gets the suggesters configured for a domain. A suggester enables you to display possible matches before users finish typing their queries. Can be limited to specific suggesters by name. By default, shows all suggesters and includes any pending changes to the configuration. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

See: AWS API Reference for DescribeSuggesters.

Synopsis

Creating a Request

describeSuggesters Source

Creates a value of DescribeSuggesters with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data DescribeSuggesters Source

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.

See: describeSuggesters smart constructor.

Request Lenses

dssDeployed :: Lens' DescribeSuggesters (Maybe Bool) Source

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

dssSuggesterNames :: Lens' DescribeSuggesters [Text] Source

The suggesters you want to describe.

dssDomainName :: Lens' DescribeSuggesters Text Source

The name of the domain you want to describe.

Destructuring the Response

describeSuggestersResponse Source

Creates a value of DescribeSuggestersResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

Response Lenses

dssrsSuggesters :: Lens' DescribeSuggestersResponse [SuggesterStatus] Source

The suggesters configured for the domain specified in the request.