Copyright	(c) 2013-2021 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

Amazonka.CloudSearchDomains.Suggest

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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.

Synopsis

data Suggest = Suggest' {
- size :: Maybe Integer
- query :: Text
- suggester :: Text
}
newSuggest :: Text -> Text -> Suggest
suggest_size :: Lens' Suggest (Maybe Integer)
suggest_query :: Lens' Suggest Text
suggest_suggester :: Lens' Suggest Text
data SuggestResponse = SuggestResponse' {
- suggest :: Maybe SuggestModel
- status :: Maybe SuggestStatus
- httpStatus :: Int
}
newSuggestResponse :: Int -> SuggestResponse
suggestResponse_suggest :: Lens' SuggestResponse (Maybe SuggestModel)
suggestResponse_status :: Lens' SuggestResponse (Maybe SuggestStatus)
suggestResponse_httpStatus :: Lens' SuggestResponse Int

Creating a Request

data Suggest Source #

Container for the parameters to the Suggest request.

See: newSuggest smart constructor.

Constructors

Suggest'
Fields size :: Maybe Integer Specifies the maximum number of suggestions to return. query :: Text Specifies the string for which you want to get suggestions. suggester :: Text Specifies the name of the suggester to use to find suggested matches.

Instances

Instances details

Eq Suggest Source #
Instance details Defined in Amazonka.CloudSearchDomains.Suggest Methods (==) :: Suggest -> Suggest -> Bool # (/=) :: Suggest -> Suggest -> Bool #
Read Suggest Source #
Instance details Defined in Amazonka.CloudSearchDomains.Suggest Methods readsPrec :: Int -> ReadS Suggest # readList :: ReadS [Suggest] # readPrec :: ReadPrec Suggest # readListPrec :: ReadPrec [Suggest] #
Show Suggest Source #
Instance details Defined in Amazonka.CloudSearchDomains.Suggest Methods showsPrec :: Int -> Suggest -> ShowS # show :: Suggest -> String # showList :: [Suggest] -> ShowS #
Generic Suggest Source #
Instance details Defined in Amazonka.CloudSearchDomains.Suggest Associated Types type Rep Suggest :: Type -> Type # Methods from :: Suggest -> Rep Suggest x # to :: Rep Suggest x -> Suggest #
NFData Suggest Source #
Instance details Defined in Amazonka.CloudSearchDomains.Suggest Methods rnf :: Suggest -> () #
Hashable Suggest Source #
Instance details Defined in Amazonka.CloudSearchDomains.Suggest Methods hashWithSalt :: Int -> Suggest -> Int # hash :: Suggest -> Int #
AWSRequest Suggest Source #
Instance details Defined in Amazonka.CloudSearchDomains.Suggest Associated Types type AWSResponse Suggest # Methods request :: Suggest -> Request Suggest # response :: MonadResource m => Logger -> Service -> Proxy Suggest -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse Suggest))) #
ToHeaders Suggest Source #
Instance details Defined in Amazonka.CloudSearchDomains.Suggest Methods toHeaders :: Suggest -> [Header] #
ToPath Suggest Source #
Instance details Defined in Amazonka.CloudSearchDomains.Suggest Methods toPath :: Suggest -> ByteString #
ToQuery Suggest Source #
Instance details Defined in Amazonka.CloudSearchDomains.Suggest Methods toQuery :: Suggest -> QueryString #
type Rep Suggest Source #
Instance details Defined in Amazonka.CloudSearchDomains.Suggest type Rep Suggest = D1 ('MetaData "Suggest" "Amazonka.CloudSearchDomains.Suggest" "libZSservicesZSamazonka-cloudsearch-domainsZSamazonka-cloudsearch-domains" 'False) (C1 ('MetaCons "Suggest'" 'PrefixI 'True) (S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: (S1 ('MetaSel ('Just "query") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "suggester") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse Suggest Source #
Instance details Defined in Amazonka.CloudSearchDomains.Suggest type AWSResponse Suggest = SuggestResponse

newSuggest Source #

Arguments

:: Text	`$sel:query:Suggest'`
-> Text	`$sel:suggester:Suggest'`
-> Suggest

Create a value of Suggest with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:size:Suggest', suggest_size - Specifies the maximum number of suggestions to return.

$sel:query:Suggest', suggest_query - Specifies the string for which you want to get suggestions.

$sel:suggester:Suggest', suggest_suggester - Specifies the name of the suggester to use to find suggested matches.

Request Lenses

suggest_size :: Lens' Suggest (Maybe Integer) Source #

Specifies the maximum number of suggestions to return.

suggest_query :: Lens' Suggest Text Source #

Specifies the string for which you want to get suggestions.

suggest_suggester :: Lens' Suggest Text Source #

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

Destructuring the Response

data SuggestResponse Source #

Contains the response to a Suggest request.

See: newSuggestResponse smart constructor.

Constructors

SuggestResponse'
Fields suggest :: Maybe SuggestModel Container for the matching search suggestion information. status :: Maybe SuggestStatus The status of a `SuggestRequest`. Contains the resource ID (`rid`) and how long it took to process the request (`timems`). httpStatus :: Int The response's http status code.

Instances

Instances details

Eq SuggestResponse Source #
Instance details Defined in Amazonka.CloudSearchDomains.Suggest Methods (==) :: SuggestResponse -> SuggestResponse -> Bool # (/=) :: SuggestResponse -> SuggestResponse -> Bool #
Read SuggestResponse Source #
Instance details Defined in Amazonka.CloudSearchDomains.Suggest Methods readsPrec :: Int -> ReadS SuggestResponse # readList :: ReadS [SuggestResponse] # readPrec :: ReadPrec SuggestResponse # readListPrec :: ReadPrec [SuggestResponse] #
Show SuggestResponse Source #
Instance details Defined in Amazonka.CloudSearchDomains.Suggest Methods showsPrec :: Int -> SuggestResponse -> ShowS # show :: SuggestResponse -> String # showList :: [SuggestResponse] -> ShowS #
Generic SuggestResponse Source #
Instance details Defined in Amazonka.CloudSearchDomains.Suggest Associated Types type Rep SuggestResponse :: Type -> Type # Methods from :: SuggestResponse -> Rep SuggestResponse x # to :: Rep SuggestResponse x -> SuggestResponse #
NFData SuggestResponse Source #
Instance details Defined in Amazonka.CloudSearchDomains.Suggest Methods rnf :: SuggestResponse -> () #
type Rep SuggestResponse Source #
Instance details Defined in Amazonka.CloudSearchDomains.Suggest type Rep SuggestResponse = D1 ('MetaData "SuggestResponse" "Amazonka.CloudSearchDomains.Suggest" "libZSservicesZSamazonka-cloudsearch-domainsZSamazonka-cloudsearch-domains" 'False) (C1 ('MetaCons "SuggestResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "suggest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SuggestModel)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SuggestStatus)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSuggestResponse Source #

Arguments

:: Int	`$sel:httpStatus:SuggestResponse'`
-> SuggestResponse

Create a value of SuggestResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:suggest:SuggestResponse', suggestResponse_suggest - Container for the matching search suggestion information.

$sel:status:SuggestResponse', suggestResponse_status - The status of a SuggestRequest. Contains the resource ID (rid) and how long it took to process the request (timems).

$sel:httpStatus:SuggestResponse', suggestResponse_httpStatus - The response's http status code.

Response Lenses

suggestResponse_suggest :: Lens' SuggestResponse (Maybe SuggestModel) Source #

Container for the matching search suggestion information.

suggestResponse_status :: 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).

suggestResponse_httpStatus :: Lens' SuggestResponse Int Source #

The response's http status code.