Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Kendra.DescribeQuerySuggestionsConfig

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information on the settings of query suggestions for an index.

This is used to check the current settings applied to query suggestions.

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

Synopsis

Creating a Request

data DescribeQuerySuggestionsConfig Source #

See: newDescribeQuerySuggestionsConfig smart constructor.

Constructors

DescribeQuerySuggestionsConfig'
Fields indexId :: Text The identifier of the index with query suggestions that you want to get information on.

Instances

Instances details

ToJSON DescribeQuerySuggestionsConfig Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig Methods toJSON :: DescribeQuerySuggestionsConfig -> Value # toEncoding :: DescribeQuerySuggestionsConfig -> Encoding # toJSONList :: [DescribeQuerySuggestionsConfig] -> Value # toEncodingList :: [DescribeQuerySuggestionsConfig] -> Encoding #
ToHeaders DescribeQuerySuggestionsConfig Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig Methods toHeaders :: DescribeQuerySuggestionsConfig -> [Header] #
ToPath DescribeQuerySuggestionsConfig Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig Methods toPath :: DescribeQuerySuggestionsConfig -> ByteString #
ToQuery DescribeQuerySuggestionsConfig Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig Methods toQuery :: DescribeQuerySuggestionsConfig -> QueryString #
AWSRequest DescribeQuerySuggestionsConfig Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig Associated Types type AWSResponse DescribeQuerySuggestionsConfig # Methods request :: (Service -> Service) -> DescribeQuerySuggestionsConfig -> Request DescribeQuerySuggestionsConfig # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeQuerySuggestionsConfig -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeQuerySuggestionsConfig))) #
Generic DescribeQuerySuggestionsConfig Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig Associated Types type Rep DescribeQuerySuggestionsConfig :: Type -> Type # Methods from :: DescribeQuerySuggestionsConfig -> Rep DescribeQuerySuggestionsConfig x # to :: Rep DescribeQuerySuggestionsConfig x -> DescribeQuerySuggestionsConfig #
Read DescribeQuerySuggestionsConfig Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig Methods readsPrec :: Int -> ReadS DescribeQuerySuggestionsConfig # readList :: ReadS [DescribeQuerySuggestionsConfig] # readPrec :: ReadPrec DescribeQuerySuggestionsConfig # readListPrec :: ReadPrec [DescribeQuerySuggestionsConfig] #
Show DescribeQuerySuggestionsConfig Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig Methods showsPrec :: Int -> DescribeQuerySuggestionsConfig -> ShowS # show :: DescribeQuerySuggestionsConfig -> String # showList :: [DescribeQuerySuggestionsConfig] -> ShowS #
NFData DescribeQuerySuggestionsConfig Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig Methods rnf :: DescribeQuerySuggestionsConfig -> () #
Eq DescribeQuerySuggestionsConfig Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig Methods (==) :: DescribeQuerySuggestionsConfig -> DescribeQuerySuggestionsConfig -> Bool # (/=) :: DescribeQuerySuggestionsConfig -> DescribeQuerySuggestionsConfig -> Bool #
Hashable DescribeQuerySuggestionsConfig Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig Methods hashWithSalt :: Int -> DescribeQuerySuggestionsConfig -> Int # hash :: DescribeQuerySuggestionsConfig -> Int #
type AWSResponse DescribeQuerySuggestionsConfig Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig type AWSResponse DescribeQuerySuggestionsConfig = DescribeQuerySuggestionsConfigResponse
type Rep DescribeQuerySuggestionsConfig Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig type Rep DescribeQuerySuggestionsConfig = D1 ('MetaData "DescribeQuerySuggestionsConfig" "Amazonka.Kendra.DescribeQuerySuggestionsConfig" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DescribeQuerySuggestionsConfig'" 'PrefixI 'True) (S1 ('MetaSel ('Just "indexId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeQuerySuggestionsConfig Source #

Arguments

:: Text	`$sel:indexId:DescribeQuerySuggestionsConfig'`
-> DescribeQuerySuggestionsConfig

Create a value of DescribeQuerySuggestionsConfig 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:indexId:DescribeQuerySuggestionsConfig', describeQuerySuggestionsConfig_indexId - The identifier of the index with query suggestions that you want to get information on.

Request Lenses

describeQuerySuggestionsConfig_indexId :: Lens' DescribeQuerySuggestionsConfig Text Source #

The identifier of the index with query suggestions that you want to get information on.

Destructuring the Response

data DescribeQuerySuggestionsConfigResponse Source #

See: newDescribeQuerySuggestionsConfigResponse smart constructor.

Constructors

DescribeQuerySuggestionsConfigResponse'

Fields

includeQueriesWithoutUserInformation :: Maybe Bool
TRUE to use all queries, otherwise use only queries that include user information to generate the query suggestions.
lastClearTime :: Maybe POSIX
The date-time query suggestions for an index was last cleared.
After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. Amazon Kendra only considers re-occurences of a query from the time you cleared suggestions.
lastSuggestionsBuildTime :: Maybe POSIX
The date-time query suggestions for an index was last updated.
minimumNumberOfQueryingUsers :: Maybe Natural
The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.
minimumQueryCount :: Maybe Natural
The minimum number of times a query must be searched in order for the query to be eligible to suggest to your users.
mode :: Maybe Mode
Whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.
By default, Amazon Kendra enables query suggestions.LEARN_ONLY turns off query suggestions for your users. You can change the mode using the UpdateQuerySuggestionsConfig API.
queryLogLookBackWindowInDays :: Maybe Int
How recent your queries are in your query log time window (in days).
status :: Maybe QuerySuggestionsStatus
Whether the status of query suggestions settings is currently ACTIVE or UPDATING.
Active means the current settings apply and Updating means your changed settings are in the process of applying.
totalSuggestionsCount :: Maybe Int
The current total count of query suggestions for an index.
This count can change when you update your query suggestions settings, if you filter out certain queries from suggestions using a block list, and as the query log accumulates more queries for Amazon Kendra to learn from.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeQuerySuggestionsConfigResponse Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig Associated Types type Rep DescribeQuerySuggestionsConfigResponse :: Type -> Type # Methods from :: DescribeQuerySuggestionsConfigResponse -> Rep DescribeQuerySuggestionsConfigResponse x # to :: Rep DescribeQuerySuggestionsConfigResponse x -> DescribeQuerySuggestionsConfigResponse #
Read DescribeQuerySuggestionsConfigResponse Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig Methods readsPrec :: Int -> ReadS DescribeQuerySuggestionsConfigResponse # readList :: ReadS [DescribeQuerySuggestionsConfigResponse] # readPrec :: ReadPrec DescribeQuerySuggestionsConfigResponse # readListPrec :: ReadPrec [DescribeQuerySuggestionsConfigResponse] #
Show DescribeQuerySuggestionsConfigResponse Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig Methods showsPrec :: Int -> DescribeQuerySuggestionsConfigResponse -> ShowS # show :: DescribeQuerySuggestionsConfigResponse -> String # showList :: [DescribeQuerySuggestionsConfigResponse] -> ShowS #
NFData DescribeQuerySuggestionsConfigResponse Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig Methods rnf :: DescribeQuerySuggestionsConfigResponse -> () #
Eq DescribeQuerySuggestionsConfigResponse Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig Methods (==) :: DescribeQuerySuggestionsConfigResponse -> DescribeQuerySuggestionsConfigResponse -> Bool # (/=) :: DescribeQuerySuggestionsConfigResponse -> DescribeQuerySuggestionsConfigResponse -> Bool #
type Rep DescribeQuerySuggestionsConfigResponse Source #
Instance details Defined in Amazonka.Kendra.DescribeQuerySuggestionsConfig type Rep DescribeQuerySuggestionsConfigResponse = D1 ('MetaData "DescribeQuerySuggestionsConfigResponse" "Amazonka.Kendra.DescribeQuerySuggestionsConfig" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "DescribeQuerySuggestionsConfigResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "includeQueriesWithoutUserInformation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "lastClearTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "lastSuggestionsBuildTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "minimumNumberOfQueryingUsers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "minimumQueryCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))) :: ((S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Mode)) :: S1 ('MetaSel ('Just "queryLogLookBackWindowInDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QuerySuggestionsStatus)) :: (S1 ('MetaSel ('Just "totalSuggestionsCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeQuerySuggestionsConfigResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeQuerySuggestionsConfigResponse'`
-> DescribeQuerySuggestionsConfigResponse

Create a value of DescribeQuerySuggestionsConfigResponse 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:includeQueriesWithoutUserInformation:DescribeQuerySuggestionsConfigResponse', describeQuerySuggestionsConfigResponse_includeQueriesWithoutUserInformation - TRUE to use all queries, otherwise use only queries that include user information to generate the query suggestions.

$sel:lastClearTime:DescribeQuerySuggestionsConfigResponse', describeQuerySuggestionsConfigResponse_lastClearTime - The date-time query suggestions for an index was last cleared.

After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. Amazon Kendra only considers re-occurences of a query from the time you cleared suggestions.

$sel:lastSuggestionsBuildTime:DescribeQuerySuggestionsConfigResponse', describeQuerySuggestionsConfigResponse_lastSuggestionsBuildTime - The date-time query suggestions for an index was last updated.

$sel:minimumNumberOfQueryingUsers:DescribeQuerySuggestionsConfigResponse', describeQuerySuggestionsConfigResponse_minimumNumberOfQueryingUsers - The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.

$sel:minimumQueryCount:DescribeQuerySuggestionsConfigResponse', describeQuerySuggestionsConfigResponse_minimumQueryCount - The minimum number of times a query must be searched in order for the query to be eligible to suggest to your users.

$sel:mode:DescribeQuerySuggestionsConfigResponse', describeQuerySuggestionsConfigResponse_mode - Whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.

By default, Amazon Kendra enables query suggestions.LEARN_ONLY turns off query suggestions for your users. You can change the mode using the UpdateQuerySuggestionsConfig API.

$sel:queryLogLookBackWindowInDays:DescribeQuerySuggestionsConfigResponse', describeQuerySuggestionsConfigResponse_queryLogLookBackWindowInDays - How recent your queries are in your query log time window (in days).

DescribeQuerySuggestionsConfigResponse, describeQuerySuggestionsConfigResponse_status - Whether the status of query suggestions settings is currently ACTIVE or UPDATING.

Active means the current settings apply and Updating means your changed settings are in the process of applying.

$sel:totalSuggestionsCount:DescribeQuerySuggestionsConfigResponse', describeQuerySuggestionsConfigResponse_totalSuggestionsCount - The current total count of query suggestions for an index.

This count can change when you update your query suggestions settings, if you filter out certain queries from suggestions using a block list, and as the query log accumulates more queries for Amazon Kendra to learn from.

$sel:httpStatus:DescribeQuerySuggestionsConfigResponse', describeQuerySuggestionsConfigResponse_httpStatus - The response's http status code.

Response Lenses

describeQuerySuggestionsConfigResponse_includeQueriesWithoutUserInformation :: Lens' DescribeQuerySuggestionsConfigResponse (Maybe Bool) Source #

TRUE to use all queries, otherwise use only queries that include user information to generate the query suggestions.

describeQuerySuggestionsConfigResponse_lastClearTime :: Lens' DescribeQuerySuggestionsConfigResponse (Maybe UTCTime) Source #

The date-time query suggestions for an index was last cleared.

After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. Amazon Kendra only considers re-occurences of a query from the time you cleared suggestions.

describeQuerySuggestionsConfigResponse_lastSuggestionsBuildTime :: Lens' DescribeQuerySuggestionsConfigResponse (Maybe UTCTime) Source #

The date-time query suggestions for an index was last updated.

describeQuerySuggestionsConfigResponse_minimumNumberOfQueryingUsers :: Lens' DescribeQuerySuggestionsConfigResponse (Maybe Natural) Source #

The minimum number of unique users who must search a query in order for the query to be eligible to suggest to your users.

describeQuerySuggestionsConfigResponse_minimumQueryCount :: Lens' DescribeQuerySuggestionsConfigResponse (Maybe Natural) Source #

The minimum number of times a query must be searched in order for the query to be eligible to suggest to your users.

describeQuerySuggestionsConfigResponse_mode :: Lens' DescribeQuerySuggestionsConfigResponse (Maybe Mode) Source #

Whether query suggestions are currently in ENABLED mode or LEARN_ONLY mode.

By default, Amazon Kendra enables query suggestions.LEARN_ONLY turns off query suggestions for your users. You can change the mode using the UpdateQuerySuggestionsConfig API.

describeQuerySuggestionsConfigResponse_queryLogLookBackWindowInDays :: Lens' DescribeQuerySuggestionsConfigResponse (Maybe Int) Source #

How recent your queries are in your query log time window (in days).

describeQuerySuggestionsConfigResponse_status :: Lens' DescribeQuerySuggestionsConfigResponse (Maybe QuerySuggestionsStatus) Source #

Whether the status of query suggestions settings is currently ACTIVE or UPDATING.

Active means the current settings apply and Updating means your changed settings are in the process of applying.

describeQuerySuggestionsConfigResponse_totalSuggestionsCount :: Lens' DescribeQuerySuggestionsConfigResponse (Maybe Int) Source #

The current total count of query suggestions for an index.

This count can change when you update your query suggestions settings, if you filter out certain queries from suggestions using a block list, and as the query log accumulates more queries for Amazon Kendra to learn from.

describeQuerySuggestionsConfigResponse_httpStatus :: Lens' DescribeQuerySuggestionsConfigResponse Int Source #

The response's http status code.