BatchDeleteFeaturedResultsSetCommand

Suggest an Edit

Removes one or more sets of featured results. 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, BatchDeleteFeaturedResultsSetCommand } from "@aws-sdk/client-kendra"; // ES Modules import
// const { KendraClient, BatchDeleteFeaturedResultsSetCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
const client = new KendraClient(config);
const input = { // BatchDeleteFeaturedResultsSetRequest
  IndexId: "STRING_VALUE", // required
  FeaturedResultsSetIds: [ // FeaturedResultsSetIdList // required
    "STRING_VALUE",
  ],
};
const command = new BatchDeleteFeaturedResultsSetCommand(input);
const response = await client.send(command);
// { // BatchDeleteFeaturedResultsSetResponse
//   Errors: [ // BatchDeleteFeaturedResultsSetErrors // required
//     { // BatchDeleteFeaturedResultsSetError
//       Id: "STRING_VALUE", // required
//       ErrorCode: "InternalError" || "InvalidRequest", // required
//       ErrorMessage: "STRING_VALUE", // required
//     },
//   ],
// };

BatchDeleteFeaturedResultsSetCommand Input

See BatchDeleteFeaturedResultsSetCommandInput for more details

Parameter
Type
Description
FeaturedResultsSetIds
Required
string[] | undefined

The identifiers of the featured results sets that you want to delete.

IndexId
Required
string | undefined

The identifier of the index used for featuring results.

BatchDeleteFeaturedResultsSetCommand Output

See BatchDeleteFeaturedResultsSetCommandOutput for details

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

The list of errors for the featured results set IDs, explaining why they couldn't be removed from the index.

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.