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.

http://docs.aws.amazon.com/cloudsearch/latest/developerguide/API_Suggest.html

Request

data Suggest

Instances

Eq Suggest

Ord Suggest

Read Suggest

Show Suggest

ToJSON Suggest

AWSRequest Suggest

ToQuery Suggest

ToHeaders Suggest

ToPath Suggest

type Rs Suggest = SuggestResponse

type Sv Suggest = CloudSearchDomains

Request constructor

suggest

Arguments

:: Text

sQuery

-> Text

sSuggester

-> Suggest

Suggest constructor.

The fields accessible through corresponding lenses are:

• sQuery :: Text
• sSize :: Maybe Integer
• sSuggester :: Text

Request lenses

sQuery :: Lens' Suggest Text

Specifies the string for which you want to get suggestions.

sSize :: Lens' Suggest (Maybe Integer)

Specifies the maximum number of suggestions to return.

sSuggester :: Lens' Suggest Text

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

Response

data SuggestResponse

Instances

Eq SuggestResponse

Read SuggestResponse

Show SuggestResponse

FromJSON SuggestResponse

Response constructor

suggestResponse :: SuggestResponse

SuggestResponse constructor.

The fields accessible through corresponding lenses are:

• srStatus :: Maybe SuggestStatus
• srSuggest :: Maybe SuggestModel

Response lenses

srStatus :: Lens' SuggestResponse (Maybe SuggestStatus)

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

srSuggest :: Lens' SuggestResponse (Maybe SuggestModel)

Container for the matching search suggestion information.