Network.AWS.CloudSearchDomains.Suggest

Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display likely matches before users finish typing. In Amazon CloudSearch, suggestions are based on the contents of a particular text field. When you request suggestions, Amazon CloudSearch finds all of the documents whose values in the suggester field start with the specified query string. The beginning of the field must match the query string to be considered a match.

For more information about configuring suggesters and retrieving suggestions, see Getting Suggestions in the Amazon CloudSearch Developer Guide.

The endpoint for submitting Suggest requests is domain-specific. You submit suggest requests to a domain's search endpoint. To get the search endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console.

See: AWS API Reference for Suggest.

Creating a Request

suggest

Arguments

:: Text

sQuery

-> Text

sSuggester

-> Suggest

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

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

• sSize
• sQuery
• sSuggester

data Suggest

Container for the parameters to the Suggest request.

See: suggest smart constructor.

Instances

Eq Suggest

Data Suggest

Read Suggest

Show Suggest

Generic Suggest

AWSRequest Suggest

ToPath Suggest

ToHeaders Suggest

ToQuery Suggest

Typeable * Suggest

type Rep Suggest

type Rs Suggest = SuggestResponse

Request Lenses

sSize :: Lens' Suggest (Maybe Integer)

Specifies the maximum number of suggestions to return.

sQuery :: Lens' Suggest Text

Specifies the string for which you want to get suggestions.

sSuggester :: Lens' Suggest Text

Specifies the name of the suggester to use to find suggested matches.

Destructuring the Response

suggestResponse

Arguments

:: Int

srsResponseStatus

-> SuggestResponse

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

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

• srsSuggest
• srsStatus
• srsResponseStatus

data SuggestResponse

Contains the response to a Suggest request.

See: suggestResponse smart constructor.

Instances

Eq SuggestResponse

Data SuggestResponse

Read SuggestResponse

Show SuggestResponse

Generic SuggestResponse

Typeable * SuggestResponse

type Rep SuggestResponse

Response Lenses

srsSuggest :: Lens' SuggestResponse (Maybe SuggestModel)

Container for the matching search suggestion information.

srsStatus :: Lens' SuggestResponse (Maybe SuggestStatus)

The status of a SuggestRequest. Contains the resource ID (rid) and how long it took to process the request (timems).

srsResponseStatus :: Lens' SuggestResponse Int

The response status code.