import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient"; import type { CreateFeaturedResultsSetRequest, CreateFeaturedResultsSetResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link CreateFeaturedResultsSetCommand}. */ export interface CreateFeaturedResultsSetCommandInput extends CreateFeaturedResultsSetRequest { } /** * @public * * The output of {@link CreateFeaturedResultsSetCommand}. */ export interface CreateFeaturedResultsSetCommandOutput extends CreateFeaturedResultsSetResponse, __MetadataBearer { } declare const CreateFeaturedResultsSetCommand_base: { new (input: CreateFeaturedResultsSetCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: CreateFeaturedResultsSetCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Creates a set of featured results to display at the top of the search results page. * Featured results are placed above all other results for certain queries. You map * specific queries to specific documents for featuring in the results. If a query * contains an exact match, then one or more specific documents are featured in the * search results.

*

You can create up to 50 sets of featured results per index. You can request to * increase this limit by contacting Support.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { KendraClient, CreateFeaturedResultsSetCommand } from "@aws-sdk/client-kendra"; // ES Modules import * // const { KendraClient, CreateFeaturedResultsSetCommand } = require("@aws-sdk/client-kendra"); // CommonJS import * // import type { KendraClientConfig } from "@aws-sdk/client-kendra"; * const config = {}; // type is KendraClientConfig * const client = new KendraClient(config); * const input = { // CreateFeaturedResultsSetRequest * IndexId: "STRING_VALUE", // required * FeaturedResultsSetName: "STRING_VALUE", // required * Description: "STRING_VALUE", * ClientToken: "STRING_VALUE", * Status: "ACTIVE" || "INACTIVE", * QueryTexts: [ // QueryTextList * "STRING_VALUE", * ], * FeaturedDocuments: [ // FeaturedDocumentList * { // FeaturedDocument * Id: "STRING_VALUE", * }, * ], * Tags: [ // TagList * { // Tag * Key: "STRING_VALUE", // required * Value: "STRING_VALUE", // required * }, * ], * }; * const command = new CreateFeaturedResultsSetCommand(input); * const response = await client.send(command); * // { // CreateFeaturedResultsSetResponse * // FeaturedResultsSet: { // FeaturedResultsSet * // FeaturedResultsSetId: "STRING_VALUE", * // FeaturedResultsSetName: "STRING_VALUE", * // Description: "STRING_VALUE", * // Status: "ACTIVE" || "INACTIVE", * // QueryTexts: [ // QueryTextList * // "STRING_VALUE", * // ], * // FeaturedDocuments: [ // FeaturedDocumentList * // { // FeaturedDocument * // Id: "STRING_VALUE", * // }, * // ], * // LastUpdatedTimestamp: Number("long"), * // CreationTimestamp: Number("long"), * // }, * // }; * * ``` * * @param CreateFeaturedResultsSetCommandInput - {@link CreateFeaturedResultsSetCommandInput} * @returns {@link CreateFeaturedResultsSetCommandOutput} * @see {@link CreateFeaturedResultsSetCommandInput} for command's `input` shape. * @see {@link CreateFeaturedResultsSetCommandOutput} for command's `response` shape. * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

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

* * @throws {@link ConflictException} (client fault) *

A conflict occurred with the request. Please fix any inconsistences with your * resources and try again.

* * @throws {@link FeaturedResultsConflictException} (client fault) *

An error message with a list of conflicting queries used across different sets * of featured results. This occurred with the request for a new featured results set. * Check that the queries you specified for featured results are unique per featured * results set for each index.

* * @throws {@link InternalServerException} (server fault) *

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.

* * @throws {@link ResourceNotFoundException} (client fault) *

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

* * @throws {@link ThrottlingException} (client fault) *

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

* * @throws {@link ValidationException} (client fault) *

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

* * @throws {@link KendraServiceException} *

Base exception class for all service exceptions from Kendra service.

* * * @public */ export declare class CreateFeaturedResultsSetCommand extends CreateFeaturedResultsSetCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: CreateFeaturedResultsSetRequest; output: CreateFeaturedResultsSetResponse; }; sdk: { input: CreateFeaturedResultsSetCommandInput; output: CreateFeaturedResultsSetCommandOutput; }; }; }