Network.AWS.CloudSearch.DescribeSuggesters

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.

Creating a Request

describeSuggesters

Arguments

:: Text

dssDomainName

-> DescribeSuggesters

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
• dssSuggesterNames
• dssDomainName

data DescribeSuggesters

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.

Instances

Eq DescribeSuggesters

Data DescribeSuggesters

Read DescribeSuggesters

Show DescribeSuggesters

Generic DescribeSuggesters

AWSRequest DescribeSuggesters

ToPath DescribeSuggesters

ToHeaders DescribeSuggesters

ToQuery DescribeSuggesters

Typeable * DescribeSuggesters

type Rep DescribeSuggesters

type Rs DescribeSuggesters = DescribeSuggestersResponse

Request Lenses

dssDeployed :: Lens' DescribeSuggesters (Maybe Bool)

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

dssSuggesterNames :: Lens' DescribeSuggesters [Text]

The suggesters you want to describe.

dssDomainName :: Lens' DescribeSuggesters Text

The name of the domain you want to describe.

Destructuring the Response

describeSuggestersResponse

Arguments

:: Int

dssrsStatus

-> DescribeSuggestersResponse

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:

• dssrsStatus
• dssrsSuggesters

data DescribeSuggestersResponse

The result of a DescribeSuggesters request.

See: describeSuggestersResponse smart constructor.

Instances

Eq DescribeSuggestersResponse

Data DescribeSuggestersResponse

Read DescribeSuggestersResponse

Show DescribeSuggestersResponse

Generic DescribeSuggestersResponse

Typeable * DescribeSuggestersResponse

type Rep DescribeSuggestersResponse

Response Lenses

dssrsStatus :: Lens' DescribeSuggestersResponse Int

The response status code.

dssrsSuggesters :: Lens' DescribeSuggestersResponse [SuggesterStatus]

The suggesters configured for the domain specified in the request.