Amazonka.CloudSearch.DefineSuggester

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

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

ToHeaders DefineSuggester

Defined in Amazonka.CloudSearch.DefineSuggester

Methods

toHeaders :: DefineSuggester -> [Header]

ToPath DefineSuggester

Defined in Amazonka.CloudSearch.DefineSuggester

Methods

toPath :: DefineSuggester -> ByteString

ToQuery DefineSuggester

Defined in Amazonka.CloudSearch.DefineSuggester

Methods

toQuery :: DefineSuggester -> QueryString

AWSRequest DefineSuggester

Defined in Amazonka.CloudSearch.DefineSuggester

Associated Types

type AWSResponse DefineSuggester

Methods

request :: (Service -> Service) -> DefineSuggester -> Request DefineSuggester

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DefineSuggester -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DefineSuggester)))

Generic DefineSuggester

Defined in Amazonka.CloudSearch.DefineSuggester

Associated Types

type Rep DefineSuggester :: Type -> Type

Methods

from :: DefineSuggester -> Rep DefineSuggester x

to :: Rep DefineSuggester x -> DefineSuggester

Read DefineSuggester

Defined in Amazonka.CloudSearch.DefineSuggester

Methods

readsPrec :: Int -> ReadS DefineSuggester

readList :: ReadS [DefineSuggester]

readPrec :: ReadPrec DefineSuggester

readListPrec :: ReadPrec [DefineSuggester]

Show DefineSuggester

Defined in Amazonka.CloudSearch.DefineSuggester

Methods

showsPrec :: Int -> DefineSuggester -> ShowS

show :: DefineSuggester -> String

showList :: [DefineSuggester] -> ShowS

NFData DefineSuggester

Defined in Amazonka.CloudSearch.DefineSuggester

Methods

rnf :: DefineSuggester -> ()

Eq DefineSuggester

Defined in Amazonka.CloudSearch.DefineSuggester

Methods

(==) :: DefineSuggester -> DefineSuggester -> Bool

(/=) :: DefineSuggester -> DefineSuggester -> Bool

Hashable DefineSuggester

Defined in Amazonka.CloudSearch.DefineSuggester

Methods

hashWithSalt :: Int -> DefineSuggester -> Int

hash :: DefineSuggester -> Int

type AWSResponse DefineSuggester

Defined in Amazonka.CloudSearch.DefineSuggester

type AWSResponse DefineSuggester = DefineSuggesterResponse

type Rep DefineSuggester

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

Arguments

:: Text

DefineSuggester

-> 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:

DefineSuggester, defineSuggester_domainName - Undocumented member.

DefineSuggester, defineSuggester_suggester - Undocumented member.

Request Lenses

defineSuggester_domainName :: Lens' DefineSuggester Text

Undocumented member.

defineSuggester_suggester :: Lens' DefineSuggester Suggester

Undocumented member.

Destructuring the Response

data DefineSuggesterResponse

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

Generic DefineSuggesterResponse

Defined in Amazonka.CloudSearch.DefineSuggester

Associated Types

type Rep DefineSuggesterResponse :: Type -> Type

Methods

from :: DefineSuggesterResponse -> Rep DefineSuggesterResponse x

to :: Rep DefineSuggesterResponse x -> DefineSuggesterResponse

Read DefineSuggesterResponse

Defined in Amazonka.CloudSearch.DefineSuggester

Methods

readsPrec :: Int -> ReadS DefineSuggesterResponse

readList :: ReadS [DefineSuggesterResponse]

readPrec :: ReadPrec DefineSuggesterResponse

readListPrec :: ReadPrec [DefineSuggesterResponse]

Show DefineSuggesterResponse

Defined in Amazonka.CloudSearch.DefineSuggester

Methods

showsPrec :: Int -> DefineSuggesterResponse -> ShowS

show :: DefineSuggesterResponse -> String

showList :: [DefineSuggesterResponse] -> ShowS

NFData DefineSuggesterResponse

Defined in Amazonka.CloudSearch.DefineSuggester

Methods

rnf :: DefineSuggesterResponse -> ()

Eq DefineSuggesterResponse

Defined in Amazonka.CloudSearch.DefineSuggester

Methods

(==) :: DefineSuggesterResponse -> DefineSuggesterResponse -> Bool

(/=) :: DefineSuggesterResponse -> DefineSuggesterResponse -> Bool

type Rep DefineSuggesterResponse

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

Arguments

:: Int

$sel:httpStatus:DefineSuggesterResponse'

-> SuggesterStatus

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.

DefineSuggester, defineSuggesterResponse_suggester - Undocumented member.

Response Lenses

defineSuggesterResponse_httpStatus :: Lens' DefineSuggesterResponse Int

The response's http status code.

defineSuggesterResponse_suggester :: Lens' DefineSuggesterResponse SuggesterStatus

Undocumented member.