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.UpdateQuerySuggestionsBlockList

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Updates a block list used for query suggestions for an index.

Updates to a block list might not take effect right away. Amazon Kendra needs to refresh the entire suggestions list to apply any updates to the block list. Other changes not related to the block list apply immediately.

If a block list is updating, then you need to wait for the first update to finish before submitting another update.

Amazon Kendra supports partial updates, so you only need to provide the fields you want to update.

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

Synopsis

Creating a Request

data UpdateQuerySuggestionsBlockList Source #

See: newUpdateQuerySuggestionsBlockList smart constructor.

Constructors

UpdateQuerySuggestionsBlockList'

Fields

description :: Maybe Text
A new description for the block list.
name :: Maybe Text
A new name for the block list.
roleArn :: Maybe Text
The IAM (Identity and Access Management) role used to access the block list text file in S3.
sourceS3Path :: Maybe S3Path
The S3 path where your block list text file sits in S3.
If you update your block list and provide the same path to the block list text file in S3, then Amazon Kendra reloads the file to refresh the block list. Amazon Kendra does not automatically refresh your block list. You need to call the UpdateQuerySuggestionsBlockList API to refresh you block list.
If you update your block list, then Amazon Kendra asynchronously refreshes all query suggestions with the latest content in the S3 file. This means changes might not take effect immediately.
indexId :: Text
The identifier of the index for the block list.
id :: Text
The identifier of the block list you want to update.

Instances

Instances details

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

newUpdateQuerySuggestionsBlockList Source #

Arguments

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

Create a value of UpdateQuerySuggestionsBlockList 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:description:UpdateQuerySuggestionsBlockList', updateQuerySuggestionsBlockList_description - A new description for the block list.

UpdateQuerySuggestionsBlockList, updateQuerySuggestionsBlockList_name - A new name for the block list.

UpdateQuerySuggestionsBlockList, updateQuerySuggestionsBlockList_roleArn - The IAM (Identity and Access Management) role used to access the block list text file in S3.

$sel:sourceS3Path:UpdateQuerySuggestionsBlockList', updateQuerySuggestionsBlockList_sourceS3Path - The S3 path where your block list text file sits in S3.

If you update your block list and provide the same path to the block list text file in S3, then Amazon Kendra reloads the file to refresh the block list. Amazon Kendra does not automatically refresh your block list. You need to call the UpdateQuerySuggestionsBlockList API to refresh you block list.

If you update your block list, then Amazon Kendra asynchronously refreshes all query suggestions with the latest content in the S3 file. This means changes might not take effect immediately.

$sel:indexId:UpdateQuerySuggestionsBlockList', updateQuerySuggestionsBlockList_indexId - The identifier of the index for the block list.

UpdateQuerySuggestionsBlockList, updateQuerySuggestionsBlockList_id - The identifier of the block list you want to update.

Request Lenses

updateQuerySuggestionsBlockList_description :: Lens' UpdateQuerySuggestionsBlockList (Maybe Text) Source #

A new description for the block list.

updateQuerySuggestionsBlockList_name :: Lens' UpdateQuerySuggestionsBlockList (Maybe Text) Source #

A new name for the block list.

updateQuerySuggestionsBlockList_roleArn :: Lens' UpdateQuerySuggestionsBlockList (Maybe Text) Source #

The IAM (Identity and Access Management) role used to access the block list text file in S3.

updateQuerySuggestionsBlockList_sourceS3Path :: Lens' UpdateQuerySuggestionsBlockList (Maybe S3Path) Source #

The S3 path where your block list text file sits in S3.

If you update your block list and provide the same path to the block list text file in S3, then Amazon Kendra reloads the file to refresh the block list. Amazon Kendra does not automatically refresh your block list. You need to call the UpdateQuerySuggestionsBlockList API to refresh you block list.

If you update your block list, then Amazon Kendra asynchronously refreshes all query suggestions with the latest content in the S3 file. This means changes might not take effect immediately.

updateQuerySuggestionsBlockList_indexId :: Lens' UpdateQuerySuggestionsBlockList Text Source #

The identifier of the index for the block list.

updateQuerySuggestionsBlockList_id :: Lens' UpdateQuerySuggestionsBlockList Text Source #

The identifier of the block list you want to update.

Destructuring the Response

data UpdateQuerySuggestionsBlockListResponse Source #

See: newUpdateQuerySuggestionsBlockListResponse smart constructor.

Constructors

UpdateQuerySuggestionsBlockListResponse'

Instances

Instances details

Generic UpdateQuerySuggestionsBlockListResponse Source #
Instance details Defined in Amazonka.Kendra.UpdateQuerySuggestionsBlockList Associated Types type Rep UpdateQuerySuggestionsBlockListResponse :: Type -> Type # Methods from :: UpdateQuerySuggestionsBlockListResponse -> Rep UpdateQuerySuggestionsBlockListResponse x # to :: Rep UpdateQuerySuggestionsBlockListResponse x -> UpdateQuerySuggestionsBlockListResponse #
Read UpdateQuerySuggestionsBlockListResponse Source #
Instance details Defined in Amazonka.Kendra.UpdateQuerySuggestionsBlockList Methods readsPrec :: Int -> ReadS UpdateQuerySuggestionsBlockListResponse # readList :: ReadS [UpdateQuerySuggestionsBlockListResponse] # readPrec :: ReadPrec UpdateQuerySuggestionsBlockListResponse # readListPrec :: ReadPrec [UpdateQuerySuggestionsBlockListResponse] #
Show UpdateQuerySuggestionsBlockListResponse Source #
Instance details Defined in Amazonka.Kendra.UpdateQuerySuggestionsBlockList Methods showsPrec :: Int -> UpdateQuerySuggestionsBlockListResponse -> ShowS # show :: UpdateQuerySuggestionsBlockListResponse -> String # showList :: [UpdateQuerySuggestionsBlockListResponse] -> ShowS #
NFData UpdateQuerySuggestionsBlockListResponse Source #
Instance details Defined in Amazonka.Kendra.UpdateQuerySuggestionsBlockList Methods rnf :: UpdateQuerySuggestionsBlockListResponse -> () #
Eq UpdateQuerySuggestionsBlockListResponse Source #
Instance details Defined in Amazonka.Kendra.UpdateQuerySuggestionsBlockList Methods (==) :: UpdateQuerySuggestionsBlockListResponse -> UpdateQuerySuggestionsBlockListResponse -> Bool # (/=) :: UpdateQuerySuggestionsBlockListResponse -> UpdateQuerySuggestionsBlockListResponse -> Bool #
type Rep UpdateQuerySuggestionsBlockListResponse Source #
Instance details Defined in Amazonka.Kendra.UpdateQuerySuggestionsBlockList type Rep UpdateQuerySuggestionsBlockListResponse = D1 ('MetaData "UpdateQuerySuggestionsBlockListResponse" "Amazonka.Kendra.UpdateQuerySuggestionsBlockList" "amazonka-kendra-2.0-IHloXAWlYIS8YTp1gXe6J" 'False) (C1 ('MetaCons "UpdateQuerySuggestionsBlockListResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newUpdateQuerySuggestionsBlockListResponse :: UpdateQuerySuggestionsBlockListResponse Source #

Create a value of UpdateQuerySuggestionsBlockListResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.