Safe Haskell | None |
---|---|
Language | Haskell2010 |
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
- data Suggest
- suggest :: Text -> Text -> Suggest
- sQuery :: Lens' Suggest Text
- sSize :: Lens' Suggest (Maybe Integer)
- sSuggester :: Lens' Suggest Text
- data SuggestResponse
- suggestResponse :: SuggestResponse
- srStatus :: Lens' SuggestResponse (Maybe SuggestStatus)
- srSuggest :: Lens' SuggestResponse (Maybe SuggestModel)
Request
Request constructor
:: Text | |
-> Text | |
-> Suggest |
Request lenses
sSuggester :: Lens' Suggest Text Source
Specifies the name of the suggester to use to find suggested matches.
Response
data SuggestResponse Source
Response constructor
suggestResponse :: SuggestResponse Source
SuggestResponse
constructor.
The fields accessible through corresponding lenses are:
Response lenses
srStatus :: Lens' SuggestResponse (Maybe SuggestStatus) Source
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) Source
Container for the matching search suggestion information.