@aws-sdk/client-kendra 3.300.0 → 3.303.0

package/dist-types/commands/UpdateExperienceCommand.d.ts

@@ -2,7 +2,7 @@ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
 import { Command as $Command } from "@aws-sdk/smithy-client";
 import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
 import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
-import { UpdateExperienceRequest } from "../models/models_0";
+import { UpdateExperienceRequest } from "../models/models_1";
 /**
  * @public
  *
@@ -28,22 +28,22 @@ export interface UpdateExperienceCommandOutput extends __MetadataBearer {
  * import { KendraClient, UpdateExperienceCommand } from "@aws-sdk/client-kendra"; // ES Modules import
  * // const { KendraClient, UpdateExperienceCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
  * const client = new KendraClient(config);
- * const input = {
+ * const input = { // UpdateExperienceRequest
  *   Id: "STRING_VALUE", // required
  *   Name: "STRING_VALUE",
  *   IndexId: "STRING_VALUE", // required
  *   RoleArn: "STRING_VALUE",
- *   Configuration: {
- *     ContentSourceConfiguration: {
- *       DataSourceIds: [
+ *   Configuration: { // ExperienceConfiguration
+ *     ContentSourceConfiguration: { // ContentSourceConfiguration
+ *       DataSourceIds: [ // DataSourceIdList
  *         "STRING_VALUE",
  *       ],
- *       FaqIds: [
+ *       FaqIds: [ // FaqIdsList
  *         "STRING_VALUE",
  *       ],
  *       DirectPutContent: true || false,
  *     },
- *     UserIdentityConfiguration: {
+ *     UserIdentityConfiguration: { // UserIdentityConfiguration
  *       IdentityAttributeName: "STRING_VALUE",
  *     },
  *   },
@@ -69,7 +69,7 @@ export interface UpdateExperienceCommandOutput extends __MetadataBearer {
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>An issue occurred with the internal server used for your Amazon Kendra service.
- *             Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/aws.amazon.com/contact-us"> Support</a> for help.</p>
+ *             Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>The resource you want to use doesn’t exist. Please check you have provided the correct

package/dist-types/commands/UpdateFeaturedResultsSetCommand.d.ts

@@ -0,0 +1,105 @@
+import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
+import { UpdateFeaturedResultsSetRequest, UpdateFeaturedResultsSetResponse } from "../models/models_1";
+/**
+ * @public
+ *
+ * The input for {@link UpdateFeaturedResultsSetCommand}.
+ */
+export interface UpdateFeaturedResultsSetCommandInput extends UpdateFeaturedResultsSetRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateFeaturedResultsSetCommand}.
+ */
+export interface UpdateFeaturedResultsSetCommandOutput extends UpdateFeaturedResultsSetResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Updates a set of featured results. Features 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 of a query, then one
+ *             or more specific documents are featured in the search results.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { KendraClient, UpdateFeaturedResultsSetCommand } from "@aws-sdk/client-kendra"; // ES Modules import
+ * // const { KendraClient, UpdateFeaturedResultsSetCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
+ * const client = new KendraClient(config);
+ * const input = { // UpdateFeaturedResultsSetRequest
+ *   IndexId: "STRING_VALUE", // required
+ *   FeaturedResultsSetId: "STRING_VALUE", // required
+ *   FeaturedResultsSetName: "STRING_VALUE",
+ *   Description: "STRING_VALUE",
+ *   Status: "ACTIVE" || "INACTIVE",
+ *   QueryTexts: [ // QueryTextList
+ *     "STRING_VALUE",
+ *   ],
+ *   FeaturedDocuments: [ // FeaturedDocumentList
+ *     { // FeaturedDocument
+ *       Id: "STRING_VALUE",
+ *     },
+ *   ],
+ * };
+ * const command = new UpdateFeaturedResultsSetCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @param UpdateFeaturedResultsSetCommandInput - {@link UpdateFeaturedResultsSetCommandInput}
+ * @returns {@link UpdateFeaturedResultsSetCommandOutput}
+ * @see {@link UpdateFeaturedResultsSetCommandInput} for command's `input` shape.
+ * @see {@link UpdateFeaturedResultsSetCommandOutput} for command's `response` shape.
+ * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You don't have sufficient access to perform this action. Please ensure you have the
+ *             required permission policies and user accounts and try again.</p>
+ *
+ * @throws {@link FeaturedResultsConflictException} (client fault)
+ *  <p>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.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An issue occurred with the internal server used for your Amazon Kendra service.
+ *             Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The resource you want to use doesn’t exist. Please check you have provided the correct
+ *             resource and try again.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling. Please reduce the number of requests
+ *             and try again.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints set by the Amazon Kendra service.
+ *             Please provide the correct input and try again.</p>
+ *
+ *
+ */
+export declare class UpdateFeaturedResultsSetCommand extends $Command<UpdateFeaturedResultsSetCommandInput, UpdateFeaturedResultsSetCommandOutput, KendraClientResolvedConfig> {
+    readonly input: UpdateFeaturedResultsSetCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UpdateFeaturedResultsSetCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateFeaturedResultsSetCommandInput, UpdateFeaturedResultsSetCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/UpdateIndexCommand.d.ts

@@ -2,7 +2,7 @@ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
 import { Command as $Command } from "@aws-sdk/smithy-client";
 import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
 import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
-import { UpdateIndexRequest } from "../models/models_0";
+import { UpdateIndexRequest } from "../models/models_1";
 /**
  * @public
  *
@@ -26,25 +26,25 @@ export interface UpdateIndexCommandOutput extends __MetadataBearer {
  * import { KendraClient, UpdateIndexCommand } from "@aws-sdk/client-kendra"; // ES Modules import
  * // const { KendraClient, UpdateIndexCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
  * const client = new KendraClient(config);
- * const input = {
+ * const input = { // UpdateIndexRequest
  *   Id: "STRING_VALUE", // required
  *   Name: "STRING_VALUE",
  *   RoleArn: "STRING_VALUE",
  *   Description: "STRING_VALUE",
- *   DocumentMetadataConfigurationUpdates: [
- *     {
+ *   DocumentMetadataConfigurationUpdates: [ // DocumentMetadataConfigurationList
+ *     { // DocumentMetadataConfiguration
  *       Name: "STRING_VALUE", // required
  *       Type: "STRING_VALUE" || "STRING_LIST_VALUE" || "LONG_VALUE" || "DATE_VALUE", // required
- *       Relevance: {
+ *       Relevance: { // Relevance
  *         Freshness: true || false,
  *         Importance: Number("int"),
  *         Duration: "STRING_VALUE",
  *         RankOrder: "ASCENDING" || "DESCENDING",
- *         ValueImportanceMap: {
+ *         ValueImportanceMap: { // ValueImportanceMap
  *           "<keys>": Number("int"),
  *         },
  *       },
- *       Search: {
+ *       Search: { // Search
  *         Facetable: true || false,
  *         Searchable: true || false,
  *         Displayable: true || false,
@@ -52,13 +52,13 @@ export interface UpdateIndexCommandOutput extends __MetadataBearer {
  *       },
  *     },
  *   ],
- *   CapacityUnits: {
+ *   CapacityUnits: { // CapacityUnitsConfiguration
  *     StorageCapacityUnits: Number("int"), // required
  *     QueryCapacityUnits: Number("int"), // required
  *   },
- *   UserTokenConfigurations: [
- *     {
- *       JwtTokenTypeConfiguration: {
+ *   UserTokenConfigurations: [ // UserTokenConfigurationList
+ *     { // UserTokenConfiguration
+ *       JwtTokenTypeConfiguration: { // JwtTokenTypeConfiguration
  *         KeyLocation: "URL" || "SECRET_MANAGER", // required
  *         URL: "STRING_VALUE",
  *         SecretManagerArn: "STRING_VALUE",
@@ -67,14 +67,14 @@ export interface UpdateIndexCommandOutput extends __MetadataBearer {
  *         Issuer: "STRING_VALUE",
  *         ClaimRegex: "STRING_VALUE",
  *       },
- *       JsonTokenTypeConfiguration: {
+ *       JsonTokenTypeConfiguration: { // JsonTokenTypeConfiguration
  *         UserNameAttributeField: "STRING_VALUE", // required
  *         GroupAttributeField: "STRING_VALUE", // required
  *       },
  *     },
  *   ],
  *   UserContextPolicy: "ATTRIBUTE_FILTER" || "USER_TOKEN",
- *   UserGroupResolutionConfiguration: {
+ *   UserGroupResolutionConfiguration: { // UserGroupResolutionConfiguration
  *     UserGroupResolutionMode: "AWS_SSO" || "NONE", // required
  *   },
  * };
@@ -98,7 +98,7 @@ export interface UpdateIndexCommandOutput extends __MetadataBearer {
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>An issue occurred with the internal server used for your Amazon Kendra service.
- *             Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/aws.amazon.com/contact-us"> Support</a> for help.</p>
+ *             Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>The resource you want to use doesn’t exist. Please check you have provided the correct
@@ -106,7 +106,8 @@ export interface UpdateIndexCommandOutput extends __MetadataBearer {
  *
  * @throws {@link ServiceQuotaExceededException} (client fault)
  *  <p>You have exceeded the set limits for your Amazon Kendra service. Please see
- *             Quotas[hyperlink Kendra Quotas pg] for more information, or contact <a href="http://aws.amazon.com/aws.amazon.com/contact-us"> Support</a> to inquire about
+ *             <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas</a> for
+ *             more information, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> to inquire about
  *             an increase of limits.</p>
  *
  * @throws {@link ThrottlingException} (client fault)

package/dist-types/commands/UpdateQuerySuggestionsBlockListCommand.d.ts

@@ -2,7 +2,7 @@ import { EndpointParameterInstructions } from "@aws-sdk/middleware-endpoint";
 import { Command as $Command } from "@aws-sdk/smithy-client";
 import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
 import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
-import { UpdateQuerySuggestionsBlockListRequest } from "../models/models_0";
+import { UpdateQuerySuggestionsBlockListRequest } from "../models/models_1";
 /**
  * @public
  *
@@ -36,12 +36,12 @@ export interface UpdateQuerySuggestionsBlockListCommandOutput extends __Metadata
  * import { KendraClient, UpdateQuerySuggestionsBlockListCommand } from "@aws-sdk/client-kendra"; // ES Modules import
  * // const { KendraClient, UpdateQuerySuggestionsBlockListCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
  * const client = new KendraClient(config);
- * const input = {
+ * const input = { // UpdateQuerySuggestionsBlockListRequest
  *   IndexId: "STRING_VALUE", // required
  *   Id: "STRING_VALUE", // required
  *   Name: "STRING_VALUE",
  *   Description: "STRING_VALUE",
- *   SourceS3Path: {
+ *   SourceS3Path: { // S3Path
  *     Bucket: "STRING_VALUE", // required
  *     Key: "STRING_VALUE", // required
  *   },
@@ -67,7 +67,7 @@ export interface UpdateQuerySuggestionsBlockListCommandOutput extends __Metadata
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>An issue occurred with the internal server used for your Amazon Kendra service.
- *             Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/aws.amazon.com/contact-us"> Support</a> for help.</p>
+ *             Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>The resource you want to use doesn’t exist. Please check you have provided the correct

package/dist-types/commands/UpdateQuerySuggestionsConfigCommand.d.ts

@@ -37,7 +37,7 @@ export interface UpdateQuerySuggestionsConfigCommandOutput extends __MetadataBea
  * import { KendraClient, UpdateQuerySuggestionsConfigCommand } from "@aws-sdk/client-kendra"; // ES Modules import
  * // const { KendraClient, UpdateQuerySuggestionsConfigCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
  * const client = new KendraClient(config);
- * const input = {
+ * const input = { // UpdateQuerySuggestionsConfigRequest
  *   IndexId: "STRING_VALUE", // required
  *   Mode: "ENABLED" || "LEARN_ONLY",
  *   QueryLogLookBackWindowInDays: Number("int"),
@@ -65,7 +65,7 @@ export interface UpdateQuerySuggestionsConfigCommandOutput extends __MetadataBea
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>An issue occurred with the internal server used for your Amazon Kendra service.
- *             Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/aws.amazon.com/contact-us"> Support</a> for help.</p>
+ *             Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>The resource you want to use doesn’t exist. Please check you have provided the correct

package/dist-types/commands/UpdateThesaurusCommand.d.ts

@@ -26,13 +26,13 @@ export interface UpdateThesaurusCommandOutput extends __MetadataBearer {
  * import { KendraClient, UpdateThesaurusCommand } from "@aws-sdk/client-kendra"; // ES Modules import
  * // const { KendraClient, UpdateThesaurusCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
  * const client = new KendraClient(config);
- * const input = {
+ * const input = { // UpdateThesaurusRequest
  *   Id: "STRING_VALUE", // required
  *   Name: "STRING_VALUE",
  *   IndexId: "STRING_VALUE", // required
  *   Description: "STRING_VALUE",
  *   RoleArn: "STRING_VALUE",
- *   SourceS3Path: {
+ *   SourceS3Path: { // S3Path
  *     Bucket: "STRING_VALUE", // required
  *     Key: "STRING_VALUE", // required
  *   },
@@ -57,7 +57,7 @@ export interface UpdateThesaurusCommandOutput extends __MetadataBearer {
  *
  * @throws {@link InternalServerException} (server fault)
  *  <p>An issue occurred with the internal server used for your Amazon Kendra service.
- *             Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/aws.amazon.com/contact-us"> Support</a> for help.</p>
+ *             Please wait a few minutes and try again, or contact <a href="http://aws.amazon.com/contact-us/">Support</a> for help.</p>
  *
  * @throws {@link ResourceNotFoundException} (client fault)
  *  <p>The resource you want to use doesn’t exist. Please check you have provided the correct

package/dist-types/commands/index.d.ts

@@ -1,6 +1,7 @@
 export * from "./AssociateEntitiesToExperienceCommand";
 export * from "./AssociatePersonasToEntitiesCommand";
 export * from "./BatchDeleteDocumentCommand";
+export * from "./BatchDeleteFeaturedResultsSetCommand";
 export * from "./BatchGetDocumentStatusCommand";
 export * from "./BatchPutDocumentCommand";
 export * from "./ClearQuerySuggestionsCommand";
@@ -8,6 +9,7 @@ export * from "./CreateAccessControlConfigurationCommand";
 export * from "./CreateDataSourceCommand";
 export * from "./CreateExperienceCommand";
 export * from "./CreateFaqCommand";
+export * from "./CreateFeaturedResultsSetCommand";
 export * from "./CreateIndexCommand";
 export * from "./CreateQuerySuggestionsBlockListCommand";
 export * from "./CreateThesaurusCommand";
@@ -23,6 +25,7 @@ export * from "./DescribeAccessControlConfigurationCommand";
 export * from "./DescribeDataSourceCommand";
 export * from "./DescribeExperienceCommand";
 export * from "./DescribeFaqCommand";
+export * from "./DescribeFeaturedResultsSetCommand";
 export * from "./DescribeIndexCommand";
 export * from "./DescribePrincipalMappingCommand";
 export * from "./DescribeQuerySuggestionsBlockListCommand";
@@ -39,6 +42,7 @@ export * from "./ListEntityPersonasCommand";
 export * from "./ListExperienceEntitiesCommand";
 export * from "./ListExperiencesCommand";
 export * from "./ListFaqsCommand";
+export * from "./ListFeaturedResultsSetsCommand";
 export * from "./ListGroupsOlderThanOrderingIdCommand";
 export * from "./ListIndicesCommand";
 export * from "./ListQuerySuggestionsBlockListsCommand";
@@ -54,6 +58,7 @@ export * from "./UntagResourceCommand";
 export * from "./UpdateAccessControlConfigurationCommand";
 export * from "./UpdateDataSourceCommand";
 export * from "./UpdateExperienceCommand";
+export * from "./UpdateFeaturedResultsSetCommand";
 export * from "./UpdateIndexCommand";
 export * from "./UpdateQuerySuggestionsBlockListCommand";
 export * from "./UpdateQuerySuggestionsConfigCommand";

package/dist-types/endpoint/EndpointParameters.d.ts

@@ -12,7 +12,7 @@ export declare const resolveClientEndpointParameters: <T>(options: T & ClientInp
     defaultSigningName: string;
 };
 export interface EndpointParameters extends __EndpointParameters {
-    Region: string;
+    Region?: string;
     UseDualStack?: boolean;
     UseFIPS?: boolean;
     Endpoint?: string;