Amazonka.CloudSearchDomains.Suggest

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.

Creating a Request

data Suggest

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

ToHeaders Suggest

Defined in Amazonka.CloudSearchDomains.Suggest

Methods

toHeaders :: Suggest -> [Header]

ToPath Suggest

Defined in Amazonka.CloudSearchDomains.Suggest

Methods

toPath :: Suggest -> ByteString

ToQuery Suggest

Defined in Amazonka.CloudSearchDomains.Suggest

Methods

toQuery :: Suggest -> QueryString

AWSRequest Suggest

Defined in Amazonka.CloudSearchDomains.Suggest

Associated Types

type AWSResponse Suggest

Methods

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

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

Generic Suggest

Defined in Amazonka.CloudSearchDomains.Suggest

Associated Types

type Rep Suggest :: Type -> Type

Methods

from :: Suggest -> Rep Suggest x

to :: Rep Suggest x -> Suggest

Read Suggest

Defined in Amazonka.CloudSearchDomains.Suggest

Methods

readsPrec :: Int -> ReadS Suggest

readList :: ReadS [Suggest]

readPrec :: ReadPrec Suggest

readListPrec :: ReadPrec [Suggest]

Show Suggest

Defined in Amazonka.CloudSearchDomains.Suggest

Methods

showsPrec :: Int -> Suggest -> ShowS

show :: Suggest -> String

showList :: [Suggest] -> ShowS

NFData Suggest

Defined in Amazonka.CloudSearchDomains.Suggest

Methods

rnf :: Suggest -> ()

Eq Suggest

Defined in Amazonka.CloudSearchDomains.Suggest

Methods

(==) :: Suggest -> Suggest -> Bool

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

Hashable Suggest

Defined in Amazonka.CloudSearchDomains.Suggest

Methods

hashWithSalt :: Int -> Suggest -> Int

hash :: Suggest -> Int

type AWSResponse Suggest

Defined in Amazonka.CloudSearchDomains.Suggest

type AWSResponse Suggest = SuggestResponse

type Rep Suggest

Defined in Amazonka.CloudSearchDomains.Suggest

type Rep Suggest = D1 ('MetaData "Suggest" "Amazonka.CloudSearchDomains.Suggest" "amazonka-cloudsearch-domains-2.0-IDp90WQyZTIipPfNcVjL2" '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))))

newSuggest

Arguments

:: Text

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.

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)

Specifies the maximum number of suggestions to return.

suggest_query :: Lens' Suggest Text

Specifies the string for which you want to get suggestions.

suggest_suggester :: Lens' Suggest Text

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

Destructuring the Response

data SuggestResponse

Contains the response to a Suggest request.

See: newSuggestResponse smart constructor.

Constructors

SuggestResponse'

Fields

• status :: Maybe SuggestStatus

  The status of a SuggestRequest. Contains the resource ID (rid) and how long it took to process the request (timems).

• suggest :: Maybe SuggestModel

  Container for the matching search suggestion information.

• httpStatus :: Int

  The response's http status code.

Instances

Generic SuggestResponse

Defined in Amazonka.CloudSearchDomains.Suggest

Associated Types

type Rep SuggestResponse :: Type -> Type

Methods

from :: SuggestResponse -> Rep SuggestResponse x

to :: Rep SuggestResponse x -> SuggestResponse

Read SuggestResponse

Defined in Amazonka.CloudSearchDomains.Suggest

Methods

readsPrec :: Int -> ReadS SuggestResponse

readList :: ReadS [SuggestResponse]

readPrec :: ReadPrec SuggestResponse

readListPrec :: ReadPrec [SuggestResponse]

Show SuggestResponse

Defined in Amazonka.CloudSearchDomains.Suggest

Methods

showsPrec :: Int -> SuggestResponse -> ShowS

show :: SuggestResponse -> String

showList :: [SuggestResponse] -> ShowS

NFData SuggestResponse

Defined in Amazonka.CloudSearchDomains.Suggest

Methods

rnf :: SuggestResponse -> ()

Eq SuggestResponse

Defined in Amazonka.CloudSearchDomains.Suggest

Methods

(==) :: SuggestResponse -> SuggestResponse -> Bool

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

type Rep SuggestResponse

Defined in Amazonka.CloudSearchDomains.Suggest

type Rep SuggestResponse = D1 ('MetaData "SuggestResponse" "Amazonka.CloudSearchDomains.Suggest" "amazonka-cloudsearch-domains-2.0-IDp90WQyZTIipPfNcVjL2" 'False) (C1 ('MetaCons "SuggestResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SuggestStatus)) :*: (S1 ('MetaSel ('Just "suggest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SuggestModel)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newSuggestResponse

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: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:suggest:SuggestResponse', suggestResponse_suggest - Container for the matching search suggestion information.

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

Response Lenses

suggestResponse_status :: Lens' SuggestResponse (Maybe SuggestStatus)

The status of a SuggestRequest. Contains the resource ID (rid) and how long it took to process the request (timems).

suggestResponse_suggest :: Lens' SuggestResponse (Maybe SuggestModel)

Container for the matching search suggestion information.

suggestResponse_httpStatus :: Lens' SuggestResponse Int

The response's http status code.