Copyright | (c) 2013-2017 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 |
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.
- suggest :: Text -> Text -> Suggest
- data Suggest
- sSize :: Lens' Suggest (Maybe Integer)
- sQuery :: Lens' Suggest Text
- sSuggester :: Lens' Suggest Text
- suggestResponse :: Int -> SuggestResponse
- data SuggestResponse
- srsSuggest :: Lens' SuggestResponse (Maybe SuggestModel)
- srsStatus :: Lens' SuggestResponse (Maybe SuggestStatus)
- srsResponseStatus :: Lens' SuggestResponse Int
Creating a Request
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
- Specifies the maximum number of suggestions to return.sQuery
- Specifies the string for which you want to get suggestions.sSuggester
- Specifies the name of the suggester to use to find suggested matches.
Container for the parameters to the Suggest
request.
See: suggest
smart constructor.
Request Lenses
sSize :: Lens' Suggest (Maybe Integer) Source #
Specifies the maximum number of suggestions to return.
sSuggester :: Lens' Suggest Text Source #
Specifies the name of the suggester to use to find suggested matches.
Destructuring the Response
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
- Container for the matching search suggestion information.srsStatus
- The status of aSuggestRequest
. Contains the resource ID (rid
) and how long it took to process the request (timems
).srsResponseStatus
- -- | The response status code.
data SuggestResponse Source #
Contains the response to a Suggest
request.
See: suggestResponse
smart constructor.
Response Lenses
srsSuggest :: Lens' SuggestResponse (Maybe SuggestModel) Source #
Container for the matching search suggestion information.
srsStatus :: 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
).
srsResponseStatus :: Lens' SuggestResponse Int Source #
- - | The response status code.