Amazonka.Kendra.GetQuerySuggestions

Fetches the queries that are suggested to your users.

GetQuerySuggestions is currently not supported in the Amazon Web Services GovCloud (US-West) region.

Creating a Request

data GetQuerySuggestions

See: newGetQuerySuggestions smart constructor.

Constructors

GetQuerySuggestions'

Fields

• maxSuggestionsCount :: Maybe Int

  The maximum number of query suggestions you want to show to your users.

• indexId :: Text

  The identifier of the index you want to get query suggestions from.

• queryText :: Text

  The text of a user's query to generate query suggestions.

  A query is suggested if the query prefix matches what a user starts to type as their query.

  Amazon Kendra does not show any suggestions if a user types fewer than two characters or more than 60 characters. A query must also have at least one search result and contain at least one word of more than four characters.

Instances

ToJSON GetQuerySuggestions

Defined in Amazonka.Kendra.GetQuerySuggestions

Methods

toJSON :: GetQuerySuggestions -> Value

toEncoding :: GetQuerySuggestions -> Encoding

toJSONList :: [GetQuerySuggestions] -> Value

toEncodingList :: [GetQuerySuggestions] -> Encoding

ToHeaders GetQuerySuggestions

Defined in Amazonka.Kendra.GetQuerySuggestions

Methods

toHeaders :: GetQuerySuggestions -> [Header]

ToPath GetQuerySuggestions

Defined in Amazonka.Kendra.GetQuerySuggestions

Methods

toPath :: GetQuerySuggestions -> ByteString

ToQuery GetQuerySuggestions

Defined in Amazonka.Kendra.GetQuerySuggestions

Methods

toQuery :: GetQuerySuggestions -> QueryString

AWSRequest GetQuerySuggestions

Defined in Amazonka.Kendra.GetQuerySuggestions

Associated Types

type AWSResponse GetQuerySuggestions

Methods

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

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

Generic GetQuerySuggestions

Defined in Amazonka.Kendra.GetQuerySuggestions

Associated Types

type Rep GetQuerySuggestions :: Type -> Type

Methods

from :: GetQuerySuggestions -> Rep GetQuerySuggestions x

to :: Rep GetQuerySuggestions x -> GetQuerySuggestions

Read GetQuerySuggestions

Defined in Amazonka.Kendra.GetQuerySuggestions

Methods

readsPrec :: Int -> ReadS GetQuerySuggestions

readList :: ReadS [GetQuerySuggestions]

readPrec :: ReadPrec GetQuerySuggestions

readListPrec :: ReadPrec [GetQuerySuggestions]

Show GetQuerySuggestions

Defined in Amazonka.Kendra.GetQuerySuggestions

Methods

showsPrec :: Int -> GetQuerySuggestions -> ShowS

show :: GetQuerySuggestions -> String

showList :: [GetQuerySuggestions] -> ShowS

NFData GetQuerySuggestions

Defined in Amazonka.Kendra.GetQuerySuggestions

Methods

rnf :: GetQuerySuggestions -> ()

Eq GetQuerySuggestions

Defined in Amazonka.Kendra.GetQuerySuggestions

Methods

(==) :: GetQuerySuggestions -> GetQuerySuggestions -> Bool

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

Hashable GetQuerySuggestions

Defined in Amazonka.Kendra.GetQuerySuggestions

Methods

hashWithSalt :: Int -> GetQuerySuggestions -> Int

hash :: GetQuerySuggestions -> Int

type AWSResponse GetQuerySuggestions

Defined in Amazonka.Kendra.GetQuerySuggestions

type AWSResponse GetQuerySuggestions = GetQuerySuggestionsResponse

type Rep GetQuerySuggestions

Defined in Amazonka.Kendra.GetQuerySuggestions

type Rep GetQuerySuggestions = D1 ('MetaData "GetQuerySuggestions" "Amazonka.Kendra.GetQuerySuggestions" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "GetQuerySuggestions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxSuggestionsCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "queryText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newGetQuerySuggestions

Arguments

:: Text

$sel:indexId:GetQuerySuggestions'

-> Text

$sel:queryText:GetQuerySuggestions'

-> GetQuerySuggestions

Create a value of GetQuerySuggestions 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:maxSuggestionsCount:GetQuerySuggestions', getQuerySuggestions_maxSuggestionsCount - The maximum number of query suggestions you want to show to your users.

$sel:indexId:GetQuerySuggestions', getQuerySuggestions_indexId - The identifier of the index you want to get query suggestions from.

$sel:queryText:GetQuerySuggestions', getQuerySuggestions_queryText - The text of a user's query to generate query suggestions.

A query is suggested if the query prefix matches what a user starts to type as their query.

Amazon Kendra does not show any suggestions if a user types fewer than two characters or more than 60 characters. A query must also have at least one search result and contain at least one word of more than four characters.

Request Lenses

getQuerySuggestions_maxSuggestionsCount :: Lens' GetQuerySuggestions (Maybe Int)

The maximum number of query suggestions you want to show to your users.

getQuerySuggestions_indexId :: Lens' GetQuerySuggestions Text

The identifier of the index you want to get query suggestions from.

getQuerySuggestions_queryText :: Lens' GetQuerySuggestions Text

The text of a user's query to generate query suggestions.

A query is suggested if the query prefix matches what a user starts to type as their query.

Amazon Kendra does not show any suggestions if a user types fewer than two characters or more than 60 characters. A query must also have at least one search result and contain at least one word of more than four characters.

Destructuring the Response

data GetQuerySuggestionsResponse

See: newGetQuerySuggestionsResponse smart constructor.

Constructors

GetQuerySuggestionsResponse'

Fields

• querySuggestionsId :: Maybe Text

  The identifier for a list of query suggestions for an index.

• suggestions :: Maybe [Suggestion]

  A list of query suggestions for an index.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetQuerySuggestionsResponse

Defined in Amazonka.Kendra.GetQuerySuggestions

Associated Types

type Rep GetQuerySuggestionsResponse :: Type -> Type

Methods

from :: GetQuerySuggestionsResponse -> Rep GetQuerySuggestionsResponse x

to :: Rep GetQuerySuggestionsResponse x -> GetQuerySuggestionsResponse

Read GetQuerySuggestionsResponse

Defined in Amazonka.Kendra.GetQuerySuggestions

Methods

readsPrec :: Int -> ReadS GetQuerySuggestionsResponse

readList :: ReadS [GetQuerySuggestionsResponse]

readPrec :: ReadPrec GetQuerySuggestionsResponse

readListPrec :: ReadPrec [GetQuerySuggestionsResponse]

Show GetQuerySuggestionsResponse

Defined in Amazonka.Kendra.GetQuerySuggestions

Methods

showsPrec :: Int -> GetQuerySuggestionsResponse -> ShowS

show :: GetQuerySuggestionsResponse -> String

showList :: [GetQuerySuggestionsResponse] -> ShowS

NFData GetQuerySuggestionsResponse

Defined in Amazonka.Kendra.GetQuerySuggestions

Methods

rnf :: GetQuerySuggestionsResponse -> ()

Eq GetQuerySuggestionsResponse

Defined in Amazonka.Kendra.GetQuerySuggestions

Methods

(==) :: GetQuerySuggestionsResponse -> GetQuerySuggestionsResponse -> Bool

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

type Rep GetQuerySuggestionsResponse

Defined in Amazonka.Kendra.GetQuerySuggestions

type Rep GetQuerySuggestionsResponse = D1 ('MetaData "GetQuerySuggestionsResponse" "Amazonka.Kendra.GetQuerySuggestions" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "GetQuerySuggestionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "querySuggestionsId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "suggestions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Suggestion])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newGetQuerySuggestionsResponse

Arguments

:: Int

$sel:httpStatus:GetQuerySuggestionsResponse'

-> GetQuerySuggestionsResponse

Create a value of GetQuerySuggestionsResponse 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:querySuggestionsId:GetQuerySuggestionsResponse', getQuerySuggestionsResponse_querySuggestionsId - The identifier for a list of query suggestions for an index.

$sel:suggestions:GetQuerySuggestionsResponse', getQuerySuggestionsResponse_suggestions - A list of query suggestions for an index.

$sel:httpStatus:GetQuerySuggestionsResponse', getQuerySuggestionsResponse_httpStatus - The response's http status code.

Response Lenses

getQuerySuggestionsResponse_querySuggestionsId :: Lens' GetQuerySuggestionsResponse (Maybe Text)

The identifier for a list of query suggestions for an index.

getQuerySuggestionsResponse_suggestions :: Lens' GetQuerySuggestionsResponse (Maybe [Suggestion])

A list of query suggestions for an index.

getQuerySuggestionsResponse_httpStatus :: Lens' GetQuerySuggestionsResponse Int

The response's http status code.