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 |
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
- data UpdateQuerySuggestionsBlockList = UpdateQuerySuggestionsBlockList' {}
- newUpdateQuerySuggestionsBlockList :: Text -> Text -> UpdateQuerySuggestionsBlockList
- updateQuerySuggestionsBlockList_description :: Lens' UpdateQuerySuggestionsBlockList (Maybe Text)
- updateQuerySuggestionsBlockList_name :: Lens' UpdateQuerySuggestionsBlockList (Maybe Text)
- updateQuerySuggestionsBlockList_roleArn :: Lens' UpdateQuerySuggestionsBlockList (Maybe Text)
- updateQuerySuggestionsBlockList_sourceS3Path :: Lens' UpdateQuerySuggestionsBlockList (Maybe S3Path)
- updateQuerySuggestionsBlockList_indexId :: Lens' UpdateQuerySuggestionsBlockList Text
- updateQuerySuggestionsBlockList_id :: Lens' UpdateQuerySuggestionsBlockList Text
- data UpdateQuerySuggestionsBlockListResponse = UpdateQuerySuggestionsBlockListResponse' {
- newUpdateQuerySuggestionsBlockListResponse :: UpdateQuerySuggestionsBlockListResponse
Creating a Request
data UpdateQuerySuggestionsBlockList Source #
See: newUpdateQuerySuggestionsBlockList
smart constructor.
UpdateQuerySuggestionsBlockList' | |
|
Instances
newUpdateQuerySuggestionsBlockList Source #
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.
Instances
Generic UpdateQuerySuggestionsBlockListResponse Source # | |
Defined in Amazonka.Kendra.UpdateQuerySuggestionsBlockList type Rep UpdateQuerySuggestionsBlockListResponse :: Type -> Type # | |
Read UpdateQuerySuggestionsBlockListResponse Source # | |
Show UpdateQuerySuggestionsBlockListResponse Source # | |
NFData UpdateQuerySuggestionsBlockListResponse Source # | |
Defined in Amazonka.Kendra.UpdateQuerySuggestionsBlockList rnf :: UpdateQuerySuggestionsBlockListResponse -> () # | |
Eq UpdateQuerySuggestionsBlockListResponse Source # | |
type Rep UpdateQuerySuggestionsBlockListResponse Source # | |
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.