Skip to content

Lists the block lists used for query suggestions for an index

Description

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.

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

Usage

kendra_list_query_suggestions_block_lists(IndexId, NextToken,
  MaxResults)

Arguments

  • IndexId

    [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

    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

    The maximum number of block lists to return.

Value

A list with the following syntax:

list(
  BlockListSummaryItems = list(
    list(
      Id = "string",
      Name = "string",
      Status = "ACTIVE"|"CREATING"|"DELETING"|"UPDATING"|"ACTIVE_BUT_UPDATE_FAILED"|"FAILED",
      CreatedAt = as.POSIXct(
        "2015-01-01"
      ),
      UpdatedAt = as.POSIXct(
        "2015-01-01"
      ),
      ItemCount = 123
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_query_suggestions_block_lists(
  IndexId = "string",
  NextToken = "string",
  MaxResults = 123
)