Describe Query Suggestions Block List

kendra_describe_query_suggestions_block_list

R Documentation

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

Description¶

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.

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

Usage¶

kendra_describe_query_suggestions_block_list(IndexId, Id)

Arguments¶

IndexId: [required] The identifier of the index for the block list.
Id: [required] The identifier of the block list you want to get information on.

Value¶

A list with the following syntax:

list(
  IndexId = "string",
  Id = "string",
  Name = "string",
  Description = "string",
  Status = "ACTIVE"|"CREATING"|"DELETING"|"UPDATING"|"ACTIVE_BUT_UPDATE_FAILED"|"FAILED",
  ErrorMessage = "string",
  CreatedAt = as.POSIXct(
    "2015-01-01"
  ),
  UpdatedAt = as.POSIXct(
    "2015-01-01"
  ),
  SourceS3Path = list(
    Bucket = "string",
    Key = "string"
  ),
  ItemCount = 123,
  FileSizeBytes = 123,
  RoleArn = "string"
)

Request syntax¶

svc$describe_query_suggestions_block_list(
  IndexId = "string",
  Id = "string"
)