ListFeaturedResultsSetsCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { KendraClient, ListFeaturedResultsSetsCommand } from "@aws-sdk/client-kendra"; // ES Modules import
// const { KendraClient, ListFeaturedResultsSetsCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
const client = new KendraClient(config);
const input = { // ListFeaturedResultsSetsRequest
  IndexId: "STRING_VALUE", // required
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
};
const command = new ListFeaturedResultsSetsCommand(input);
const response = await client.send(command);
// { // ListFeaturedResultsSetsResponse
//   FeaturedResultsSetSummaryItems: [ // FeaturedResultsSetSummaryItems
//     { // FeaturedResultsSetSummary
//       FeaturedResultsSetId: "STRING_VALUE",
//       FeaturedResultsSetName: "STRING_VALUE",
//       Status: "ACTIVE" || "INACTIVE",
//       LastUpdatedTimestamp: Number("long"),
//       CreationTimestamp: Number("long"),
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

ListFeaturedResultsSetsCommand Input

See ListFeaturedResultsSetsCommandInput for more details

Parameter
Type
Description
IndexId
Required
string | undefined

The identifier of the index used for featuring results.

MaxResults
number | undefined

The maximum number of featured results sets to return.

NextToken
string | undefined

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.

ListFeaturedResultsSetsCommand Output

See ListFeaturedResultsSetsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
FeaturedResultsSetSummaryItems
FeaturedResultsSetSummary[] | undefined

An array of summary information for one or more featured results sets.

NextToken
string | undefined

If the response is truncated, Amazon Kendra returns a pagination token in the response.

Throws

Name
Fault
Details
AccessDeniedException
client

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

InternalServerException
server

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support  for help.

ResourceNotFoundException
client

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

ThrottlingException
client

The request was denied due to request throttling. Please reduce the number of requests and try again.

ValidationException
client

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

KendraServiceException
Base exception class for all service exceptions from Kendra service.