List Featured Results Sets

kendra_list_featured_results_sets

R Documentation

Lists all your sets of featured results for a given index¶

Description¶

Lists all your sets of featured results for a given index. Features results are placed above all other results for certain queries. If there's an exact match of a query, then one or more specific documents are featured in the search results.

Usage¶

kendra_list_featured_results_sets(IndexId, NextToken, MaxResults)

Arguments¶

IndexId

[required] The identifier of the index used for featuring results.

NextToken

If the response is truncated, Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of featured results sets.

MaxResults

The maximum number of featured results sets to return.

Value¶

A list with the following syntax:

list(
  FeaturedResultsSetSummaryItems = list(
    list(
      FeaturedResultsSetId = "string",
      FeaturedResultsSetName = "string",
      Status = "ACTIVE"|"INACTIVE",
      LastUpdatedTimestamp = 123,
      CreationTimestamp = 123
    )
  ),
  NextToken = "string"
)

Request syntax¶

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