Copyright | (c) 2013-2018 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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 .
- describeSuggesters :: Text -> DescribeSuggesters
- data DescribeSuggesters
- dssDeployed :: Lens' DescribeSuggesters (Maybe Bool)
- dssSuggesterNames :: Lens' DescribeSuggesters [Text]
- dssDomainName :: Lens' DescribeSuggesters Text
- describeSuggestersResponse :: Int -> DescribeSuggestersResponse
- data DescribeSuggestersResponse
- dssrsResponseStatus :: Lens' DescribeSuggestersResponse Int
- dssrsSuggesters :: Lens' DescribeSuggestersResponse [SuggesterStatus]
Creating a Request
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:
dssDeployed
- Whether to display the deployed configuration (true
) or include any pending changes (false
). Defaults tofalse
.dssSuggesterNames
- The suggesters you want to describe.dssDomainName
- The name of the domain you want to describe.
data DescribeSuggesters Source #
Container for the parameters to the
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 DescribeSuggester
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:
dssrsResponseStatus
- -- | The response status code.dssrsSuggesters
- The suggesters configured for the domain specified in the request.
data DescribeSuggestersResponse Source #
The result of a DescribeSuggesters
request.
See: describeSuggestersResponse
smart constructor.
Response Lenses
dssrsResponseStatus :: Lens' DescribeSuggestersResponse Int Source #
- - | The response status code.
dssrsSuggesters :: Lens' DescribeSuggestersResponse [SuggesterStatus] Source #
The suggesters configured for the domain specified in the request.