amazonka-cloudsearch-2.0: Amazon CloudSearch SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CloudSearch.DefineSuggester

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.

Synopsis

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' 

Instances

Instances details
ToHeaders DefineSuggester Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineSuggester

ToPath DefineSuggester Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineSuggester

ToQuery DefineSuggester Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineSuggester

AWSRequest DefineSuggester Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineSuggester

Associated Types

type AWSResponse DefineSuggester #

Generic DefineSuggester Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineSuggester

Associated Types

type Rep DefineSuggester :: Type -> Type #

Read DefineSuggester Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineSuggester

Show DefineSuggester Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineSuggester

NFData DefineSuggester Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineSuggester

Methods

rnf :: DefineSuggester -> () #

Eq DefineSuggester Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineSuggester

Hashable DefineSuggester Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineSuggester

type AWSResponse DefineSuggester Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineSuggester

type Rep DefineSuggester Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineSuggester

type Rep DefineSuggester = D1 ('MetaData "DefineSuggester" "Amazonka.CloudSearch.DefineSuggester" "amazonka-cloudsearch-2.0-A2SXRDW2ivUDvdOgQgoVJQ" 'False) (C1 ('MetaCons "DefineSuggester'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "suggester") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Suggester)))

newDefineSuggester Source #

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:

DefineSuggester, defineSuggester_domainName - Undocumented member.

DefineSuggester, defineSuggester_suggester - Undocumented member.

Request Lenses

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

Instances

Instances details
Generic DefineSuggesterResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineSuggester

Associated Types

type Rep DefineSuggesterResponse :: Type -> Type #

Read DefineSuggesterResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineSuggester

Show DefineSuggesterResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineSuggester

NFData DefineSuggesterResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineSuggester

Methods

rnf :: DefineSuggesterResponse -> () #

Eq DefineSuggesterResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineSuggester

type Rep DefineSuggesterResponse Source # 
Instance details

Defined in Amazonka.CloudSearch.DefineSuggester

type Rep DefineSuggesterResponse = D1 ('MetaData "DefineSuggesterResponse" "Amazonka.CloudSearch.DefineSuggester" "amazonka-cloudsearch-2.0-A2SXRDW2ivUDvdOgQgoVJQ" '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 #

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.

DefineSuggester, defineSuggesterResponse_suggester - Undocumented member.

Response Lenses