@aws-sdk/client-kendra 3.296.0 → 3.298.0

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
 import { TagResourceRequest, TagResourceResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link TagResourceCommand}.
  */
 export interface TagResourceCommandInput extends TagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link TagResourceCommand}.
  */
 export interface TagResourceCommandOutput extends TagResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Adds the specified tag to the specified index, FAQ, or data source
  *       resource. If the tag already exists, the existing value is replaced with
  *       the new value.</p>
@@ -27,6 +32,8 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
  * const response = await client.send(command);
  * ```
  *
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
+ * @returns {@link TagResourceCommandOutput}
  * @see {@link TagResourceCommandInput} for command's `input` shape.
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
  * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
@@ -56,11 +63,20 @@ export interface TagResourceCommandOutput extends TagResourceResponse, __Metadat
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, KendraClientResolvedConfig> {
     readonly input: TagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
 import { UntagResourceRequest, UntagResourceResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandInput extends UntagResourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandOutput extends UntagResourceResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Removes a tag from an index, FAQ, or a data source.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
+ * @returns {@link UntagResourceCommandOutput}
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
  * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
@@ -54,11 +61,20 @@ export interface UntagResourceCommandOutput extends UntagResourceResponse, __Met
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, KendraClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UntagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
 import { UpdateAccessControlConfigurationRequest, UpdateAccessControlConfigurationResponse } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateAccessControlConfigurationCommand}.
  */
 export interface UpdateAccessControlConfigurationCommandInput extends UpdateAccessControlConfigurationRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateAccessControlConfigurationCommand}.
  */
 export interface UpdateAccessControlConfigurationCommandOutput extends UpdateAccessControlConfigurationResponse, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates an access control configuration for your documents in an index. This
  *             includes user and group access information for your documents. This is useful
  *             for user context filtering, where search results are filtered based on the user
@@ -44,6 +49,8 @@ export interface UpdateAccessControlConfigurationCommandOutput extends UpdateAcc
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateAccessControlConfigurationCommandInput - {@link UpdateAccessControlConfigurationCommandInput}
+ * @returns {@link UpdateAccessControlConfigurationCommandOutput}
  * @see {@link UpdateAccessControlConfigurationCommandInput} for command's `input` shape.
  * @see {@link UpdateAccessControlConfigurationCommandOutput} for command's `response` shape.
  * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
@@ -82,11 +89,20 @@ export interface UpdateAccessControlConfigurationCommandOutput extends UpdateAcc
 export declare class UpdateAccessControlConfigurationCommand extends $Command<UpdateAccessControlConfigurationCommandInput, UpdateAccessControlConfigurationCommandOutput, KendraClientResolvedConfig> {
     readonly input: UpdateAccessControlConfigurationCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateAccessControlConfigurationCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateAccessControlConfigurationCommandInput, UpdateAccessControlConfigurationCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
 import { UpdateDataSourceRequest } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateDataSourceCommand}.
  */
 export interface UpdateDataSourceCommandInput extends UpdateDataSourceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateDataSourceCommand}.
  */
 export interface UpdateDataSourceCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates an existing Amazon Kendra data source connector.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateDataSourceCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateDataSourceCommandInput - {@link UpdateDataSourceCommandInput}
+ * @returns {@link UpdateDataSourceCommandOutput}
  * @see {@link UpdateDataSourceCommandInput} for command's `input` shape.
  * @see {@link UpdateDataSourceCommandOutput} for command's `response` shape.
  * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
@@ -58,11 +65,20 @@ export interface UpdateDataSourceCommandOutput extends __MetadataBearer {
 export declare class UpdateDataSourceCommand extends $Command<UpdateDataSourceCommandInput, UpdateDataSourceCommandOutput, KendraClientResolvedConfig> {
     readonly input: UpdateDataSourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateDataSourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateDataSourceCommandInput, UpdateDataSourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
 import { UpdateExperienceRequest } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateExperienceCommand}.
  */
 export interface UpdateExperienceCommandInput extends UpdateExperienceRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateExperienceCommand}.
  */
 export interface UpdateExperienceCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates your Amazon Kendra experience such as a search application. For more information on
  *             creating a search application experience, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building a
  *                 search experience with no code</a>.</p>
@@ -27,6 +32,8 @@ export interface UpdateExperienceCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateExperienceCommandInput - {@link UpdateExperienceCommandInput}
+ * @returns {@link UpdateExperienceCommandOutput}
  * @see {@link UpdateExperienceCommandInput} for command's `input` shape.
  * @see {@link UpdateExperienceCommandOutput} for command's `response` shape.
  * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
@@ -60,11 +67,20 @@ export interface UpdateExperienceCommandOutput extends __MetadataBearer {
 export declare class UpdateExperienceCommand extends $Command<UpdateExperienceCommandInput, UpdateExperienceCommandOutput, KendraClientResolvedConfig> {
     readonly input: UpdateExperienceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateExperienceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateExperienceCommandInput, UpdateExperienceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
 import { UpdateIndexRequest } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateIndexCommand}.
  */
 export interface UpdateIndexCommandInput extends UpdateIndexRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateIndexCommand}.
  */
 export interface UpdateIndexCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates an existing Amazon Kendra index.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateIndexCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateIndexCommandInput - {@link UpdateIndexCommandInput}
+ * @returns {@link UpdateIndexCommandOutput}
  * @see {@link UpdateIndexCommandInput} for command's `input` shape.
  * @see {@link UpdateIndexCommandOutput} for command's `response` shape.
  * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
@@ -63,11 +70,20 @@ export interface UpdateIndexCommandOutput extends __MetadataBearer {
 export declare class UpdateIndexCommand extends $Command<UpdateIndexCommandInput, UpdateIndexCommandOutput, KendraClientResolvedConfig> {
     readonly input: UpdateIndexCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateIndexCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateIndexCommandInput, UpdateIndexCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
 import { UpdateQuerySuggestionsBlockListRequest } from "../models/models_0";
 /**
+ * @public
+ *
  * The input for {@link UpdateQuerySuggestionsBlockListCommand}.
  */
 export interface UpdateQuerySuggestionsBlockListCommandInput extends UpdateQuerySuggestionsBlockListRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateQuerySuggestionsBlockListCommand}.
  */
 export interface UpdateQuerySuggestionsBlockListCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates a block list used for query suggestions for an index.</p>
  *          <p>Updates to a block list might not take effect right away. Amazon Kendra
  *             needs to refresh the entire suggestions list to apply any updates to the
@@ -35,6 +40,8 @@ export interface UpdateQuerySuggestionsBlockListCommandOutput extends __Metadata
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateQuerySuggestionsBlockListCommandInput - {@link UpdateQuerySuggestionsBlockListCommandInput}
+ * @returns {@link UpdateQuerySuggestionsBlockListCommandOutput}
  * @see {@link UpdateQuerySuggestionsBlockListCommandInput} for command's `input` shape.
  * @see {@link UpdateQuerySuggestionsBlockListCommandOutput} for command's `response` shape.
  * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
@@ -68,11 +75,20 @@ export interface UpdateQuerySuggestionsBlockListCommandOutput extends __Metadata
 export declare class UpdateQuerySuggestionsBlockListCommand extends $Command<UpdateQuerySuggestionsBlockListCommandInput, UpdateQuerySuggestionsBlockListCommandOutput, KendraClientResolvedConfig> {
     readonly input: UpdateQuerySuggestionsBlockListCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateQuerySuggestionsBlockListCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateQuerySuggestionsBlockListCommandInput, UpdateQuerySuggestionsBlockListCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
 import { UpdateQuerySuggestionsConfigRequest } from "../models/models_1";
 /**
+ * @public
+ *
  * The input for {@link UpdateQuerySuggestionsConfigCommand}.
  */
 export interface UpdateQuerySuggestionsConfigCommandInput extends UpdateQuerySuggestionsConfigRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateQuerySuggestionsConfigCommand}.
  */
 export interface UpdateQuerySuggestionsConfigCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates the settings of query suggestions for an index.</p>
  *          <p>Amazon Kendra supports partial updates, so you only need to provide
  *             the fields you want to update.</p>
@@ -36,6 +41,8 @@ export interface UpdateQuerySuggestionsConfigCommandOutput extends __MetadataBea
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateQuerySuggestionsConfigCommandInput - {@link UpdateQuerySuggestionsConfigCommandInput}
+ * @returns {@link UpdateQuerySuggestionsConfigCommandOutput}
  * @see {@link UpdateQuerySuggestionsConfigCommandInput} for command's `input` shape.
  * @see {@link UpdateQuerySuggestionsConfigCommandOutput} for command's `response` shape.
  * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
@@ -69,11 +76,20 @@ export interface UpdateQuerySuggestionsConfigCommandOutput extends __MetadataBea
 export declare class UpdateQuerySuggestionsConfigCommand extends $Command<UpdateQuerySuggestionsConfigCommandInput, UpdateQuerySuggestionsConfigCommandOutput, KendraClientResolvedConfig> {
     readonly input: UpdateQuerySuggestionsConfigCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateQuerySuggestionsConfigCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateQuerySuggestionsConfigCommandInput, UpdateQuerySuggestionsConfigCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
 import { UpdateThesaurusRequest } from "../models/models_1";
 /**
+ * @public
+ *
  * The input for {@link UpdateThesaurusCommand}.
  */
 export interface UpdateThesaurusCommandInput extends UpdateThesaurusRequest {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateThesaurusCommand}.
  */
 export interface UpdateThesaurusCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates a thesaurus for an index.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateThesaurusCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateThesaurusCommandInput - {@link UpdateThesaurusCommandInput}
+ * @returns {@link UpdateThesaurusCommandOutput}
  * @see {@link UpdateThesaurusCommandInput} for command's `input` shape.
  * @see {@link UpdateThesaurusCommandOutput} for command's `response` shape.
  * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
@@ -58,11 +65,20 @@ export interface UpdateThesaurusCommandOutput extends __MetadataBearer {
 export declare class UpdateThesaurusCommand extends $Command<UpdateThesaurusCommandInput, UpdateThesaurusCommandOutput, KendraClientResolvedConfig> {
     readonly input: UpdateThesaurusCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateThesaurusCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateThesaurusCommandInput, UpdateThesaurusCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/KendraServiceException.d.ts

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from Kendra service.
  */
 export declare class KendraServiceException extends __ServiceException {