list_query_suggestions_block_lists

kendra.Client.list_query_suggestions_block_lists(**kwargs)

Lists the block lists used for query suggestions for an index.

For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

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

See also: AWS API Documentation

Request Syntax

response = client.list_query_suggestions_block_lists(
    IndexId='string',
    NextToken='string',
    MaxResults=123
)

Parameters

• IndexId (string) --

  [REQUIRED]

  The identifier of the index for a list of all block lists that exist for that index.

  For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

• NextToken (string) -- If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of block lists ( BlockListSummaryItems ).
• MaxResults (integer) -- The maximum number of block lists to return.

Return type

dict

Returns

Response Syntax

{
    'BlockListSummaryItems': [
        {
            'Id': 'string',
            'Name': 'string',
            'Status': 'ACTIVE'|'CREATING'|'DELETING'|'UPDATING'|'ACTIVE_BUT_UPDATE_FAILED'|'FAILED',
            'CreatedAt': datetime(2015, 1, 1),
            'UpdatedAt': datetime(2015, 1, 1),
            'ItemCount': 123
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • BlockListSummaryItems (list) --

    Summary items for a block list.

    This includes summary items on the block list ID, block list name, when the block list was created, when the block list was last updated, and the count of block words/phrases in the block list.

    For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

    • (dict) --

      Summary information on a query suggestions block list.

      This includes information on the block list ID, block list name, when the block list was created, when the block list was last updated, and the count of block words/phrases in the block list.

      For information on the current quota limits for block lists, see Quotas for Amazon Kendra.

      • Id (string) --

        The identifier of a block list.

      • Name (string) --

        The name of the block list.

      • Status (string) --

        The status of the block list.

      • CreatedAt (datetime) --

        The date-time summary information for a query suggestions block list was last created.

      • UpdatedAt (datetime) --

        The date-time the block list was last updated.

      • ItemCount (integer) --

        The number of items in the block list file.

  • NextToken (string) --

    If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of block lists.

Exceptions

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