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.CloudSearch.DefineSuggester

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide.

Creating a Request

data DefineSuggester Source #

Container for the parameters to the DefineSuggester operation. Specifies the name of the domain you want to update and the suggester configuration.

See: newDefineSuggester smart constructor.

Constructors

DefineSuggester'
Fields domainName :: Text suggester :: Suggester

Instances

Instances details

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

newDefineSuggester Source #

Arguments

:: Text	`$sel:domainName:DefineSuggester'`
-> Suggester	`$sel:suggester:DefineSuggester'`
-> DefineSuggester

Create a value of DefineSuggester 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:domainName:DefineSuggester', defineSuggester_domainName - Undocumented member.

$sel:suggester:DefineSuggester', defineSuggester_suggester - Undocumented member.

Request Lenses

defineSuggester_domainName :: Lens' DefineSuggester Text Source #

Undocumented member.

defineSuggester_suggester :: Lens' DefineSuggester Suggester Source #

Undocumented member.

Destructuring the Response

data DefineSuggesterResponse Source #

The result of a DefineSuggester request. Contains the status of the newly-configured suggester.

See: newDefineSuggesterResponse smart constructor.

Constructors

DefineSuggesterResponse'
Fields httpStatus :: Int The response's http status code. suggester :: SuggesterStatus

Instances

Instances details

Eq DefineSuggesterResponse Source #
Instance details Defined in Amazonka.CloudSearch.DefineSuggester Methods (==) :: DefineSuggesterResponse -> DefineSuggesterResponse -> Bool # (/=) :: DefineSuggesterResponse -> DefineSuggesterResponse -> Bool #
Read DefineSuggesterResponse Source #
Instance details Defined in Amazonka.CloudSearch.DefineSuggester Methods readsPrec :: Int -> ReadS DefineSuggesterResponse # readList :: ReadS [DefineSuggesterResponse] # readPrec :: ReadPrec DefineSuggesterResponse # readListPrec :: ReadPrec [DefineSuggesterResponse] #
Show DefineSuggesterResponse Source #
Instance details Defined in Amazonka.CloudSearch.DefineSuggester Methods showsPrec :: Int -> DefineSuggesterResponse -> ShowS # show :: DefineSuggesterResponse -> String # showList :: [DefineSuggesterResponse] -> ShowS #
Generic DefineSuggesterResponse Source #
Instance details Defined in Amazonka.CloudSearch.DefineSuggester Associated Types type Rep DefineSuggesterResponse :: Type -> Type # Methods from :: DefineSuggesterResponse -> Rep DefineSuggesterResponse x # to :: Rep DefineSuggesterResponse x -> DefineSuggesterResponse #
NFData DefineSuggesterResponse Source #
Instance details Defined in Amazonka.CloudSearch.DefineSuggester Methods rnf :: DefineSuggesterResponse -> () #
type Rep DefineSuggesterResponse Source #
Instance details Defined in Amazonka.CloudSearch.DefineSuggester type Rep DefineSuggesterResponse = D1 ('MetaData "DefineSuggesterResponse" "Amazonka.CloudSearch.DefineSuggester" "libZSservicesZSamazonka-cloudsearchZSamazonka-cloudsearch" 'False) (C1 ('MetaCons "DefineSuggesterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "suggester") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SuggesterStatus)))

newDefineSuggesterResponse Source #

Arguments

:: Int	`$sel:httpStatus:DefineSuggesterResponse'`
-> SuggesterStatus	`$sel:suggester:DefineSuggester'`
-> DefineSuggesterResponse

Create a value of DefineSuggesterResponse 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:httpStatus:DefineSuggesterResponse', defineSuggesterResponse_httpStatus - The response's http status code.

$sel:suggester:DefineSuggester', defineSuggesterResponse_suggester - Undocumented member.

Response Lenses

defineSuggesterResponse_httpStatus :: Lens' DefineSuggesterResponse Int Source #

The response's http status code.

defineSuggesterResponse_suggester :: Lens' DefineSuggesterResponse SuggesterStatus Source #

Undocumented member.