ClearQuerySuggestionsCommand

Suggest an Edit

Clears existing query suggestions from an index.

This deletes existing suggestions only, not the queries in the query log. After you clear suggestions, Amazon Kendra learns new suggestions based on new queries added to the query log from the time you cleared suggestions. If you do not see any new suggestions, then please allow Amazon Kendra to collect enough queries to learn new suggestions.

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

Example Syntax

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

import { KendraClient, ClearQuerySuggestionsCommand } from "@aws-sdk/client-kendra"; // ES Modules import
// const { KendraClient, ClearQuerySuggestionsCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
const client = new KendraClient(config);
const input = { // ClearQuerySuggestionsRequest
  IndexId: "STRING_VALUE", // required
};
const command = new ClearQuerySuggestionsCommand(input);
const response = await client.send(command);
// {};

ClearQuerySuggestionsCommand Input

See ClearQuerySuggestionsCommandInput for more details

Parameter
Type
Description
IndexId
Required
string | undefined

The identifier of the index you want to clear query suggestions from.

ClearQuerySuggestionsCommand Output

See ClearQuerySuggestionsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

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.

ConflictException
client

A conflict occurred with the request. Please fix any inconsistences with your resources 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.