kendra / Client / update_query_suggestions_block_list

update_query_suggestions_block_list#

kendra.Client.update_query_suggestions_block_list(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.update_query_suggestions_block_list(
    IndexId='string',
    Id='string',
    Name='string',
    Description='string',
    SourceS3Path={
        'Bucket': 'string',
        'Key': 'string'
    },
    RoleArn='string'
)
Parameters:

  • IndexId (string) –

    [REQUIRED]

    The identifier of the index for the block list.

  • Id (string) –

    [REQUIRED]

    The identifier of the block list you want to update.

  • Name (string) – A new name for the block list.

  • Description (string) – A new description for the block list.

  • SourceS3Path (dict) –

    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.

    • Bucket (string) – [REQUIRED]

      The name of the S3 bucket that contains the file.

    • Key (string) – [REQUIRED]

      The name of the file.

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

Returns:

None

Exceptions

  • kendra.Client.exceptions.ValidationException

  • kendra.Client.exceptions.ResourceNotFoundException

  • kendra.Client.exceptions.ThrottlingException

  • kendra.Client.exceptions.AccessDeniedException

  • kendra.Client.exceptions.ConflictException

  • kendra.Client.exceptions.InternalServerException