kendra / Client / describe_query_suggestions_block_list

describe_query_suggestions_block_list#

kendra.Client.describe_query_suggestions_block_list(**kwargs)#

Gets information about a block list used for query suggestions for an index.

This is used to check the current settings that are applied to a block list.

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

Request Syntax

response = client.describe_query_suggestions_block_list(
    IndexId='string',
    Id='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 get information on.

Return type:

dict

Returns:

Response Syntax

{
    'IndexId': 'string',
    'Id': 'string',
    'Name': 'string',
    'Description': 'string',
    'Status': 'ACTIVE'|'CREATING'|'DELETING'|'UPDATING'|'ACTIVE_BUT_UPDATE_FAILED'|'FAILED',
    'ErrorMessage': 'string',
    'CreatedAt': datetime(2015, 1, 1),
    'UpdatedAt': datetime(2015, 1, 1),
    'SourceS3Path': {
        'Bucket': 'string',
        'Key': 'string'
    },
    'ItemCount': 123,
    'FileSizeBytes': 123,
    'RoleArn': 'string'
}

Response Structure

(dict) –
- IndexId (string) –
  
  The identifier of the index for the block list.
- Id (string) –
  
  The identifier of the block list.
- Name (string) –
  
  The name of the block list.
- Description (string) –
  
  The description for the block list.
- Status (string) –
  
  The current status of the block list. When the value is ACTIVE, the block list is ready for use.
- ErrorMessage (string) –
  
  The error message containing details if there are issues processing the block list.
- CreatedAt (datetime) –
  
  The Unix timestamp when a block list for query suggestions was created.
- UpdatedAt (datetime) –
  
  The Unix timestamp when a block list for query suggestions was last updated.
- SourceS3Path (dict) –
  
  Shows the current S3 path to your block list text file in your S3 bucket.
  
  Each block word or phrase should be on a separate line in a text file.
  
  For information on the current quota limits for block lists, see Quotas for Amazon Kendra.
  - Bucket (string) –
    
    The name of the S3 bucket that contains the file.
  - Key (string) –
    
    The name of the file.
- ItemCount (integer) –
  
  The current number of valid, non-empty words or phrases in the block list text file.
- FileSizeBytes (integer) –
  
  The current size of the block list text file in S3.
- RoleArn (string) –
  
  The IAM (Identity and Access Management) role used by Amazon Kendra to access the block list text file in S3.
  
  The role needs S3 read permissions to your file in S3 and needs to give STS (Security Token Service) assume role permissions to Amazon Kendra.

Exceptions

kendra.Client.exceptions.ValidationException
kendra.Client.exceptions.ResourceNotFoundException
kendra.Client.exceptions.ThrottlingException
kendra.Client.exceptions.AccessDeniedException
kendra.Client.exceptions.InternalServerException