@aws-sdk/client-kendra 3.50.0 → 3.53.0

package/dist-types/Kendra.d.ts

@@ -81,7 +81,7 @@ export declare class Kendra extends KendraClient {
     associatePersonasToEntities(args: AssociatePersonasToEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociatePersonasToEntitiesCommandOutput) => void): void;
     /**
      * <p>Removes one or more documents from an index. The documents must have
-     *       been added with the <code>BatchPutDocument</code> operation.</p>
+     *       been added with the <code>BatchPutDocument</code> API.</p>
      *          <p>The documents are deleted asynchronously. You can see the progress of
      *       the deletion by using Amazon Web Services CloudWatch. Any error messages related to the
      *       processing of the batch are sent to you CloudWatch log.</p>
@@ -92,15 +92,15 @@ export declare class Kendra extends KendraClient {
     /**
      * <p>Returns the indexing status for one or more documents submitted
      *             with the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">
-     *                 BatchPutDocument</a> operation.</p>
-     *         <p>When you use the <code>BatchPutDocument</code> operation,
+     *                 BatchPutDocument</a> API.</p>
+     *         <p>When you use the <code>BatchPutDocument</code> API,
      *             documents are indexed asynchronously. You can use the
-     *                 <code>BatchGetDocumentStatus</code> operation to get the current
+     *                 <code>BatchGetDocumentStatus</code> API to get the current
      *             status of a list of documents so that you can determine if they have
      *             been successfully indexed.</p>
-     *         <p>You can also use the <code>BatchGetDocumentStatus</code> operation
+     *         <p>You can also use the <code>BatchGetDocumentStatus</code> API
      *             to check the status of the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchDeleteDocument.html">
-     *                 BatchDeleteDocument</a> operation. When a document is
+     *                 BatchDeleteDocument</a> API. When a document is
      *             deleted from the index, Amazon Kendra returns <code>NOT_FOUND</code> as the
      *             status.</p>
      */
@@ -109,9 +109,9 @@ export declare class Kendra extends KendraClient {
     batchGetDocumentStatus(args: BatchGetDocumentStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetDocumentStatusCommandOutput) => void): void;
     /**
      * <p>Adds one or more documents to an index.</p>
-     *          <p>The <code>BatchPutDocument</code> operation enables you to ingest
+     *          <p>The <code>BatchPutDocument</code> API enables you to ingest
      *       inline documents or a set of documents stored in an Amazon S3 bucket. Use
-     *       this operation to ingest your text and unstructured text into an index,
+     *       this API to ingest your text and unstructured text into an index,
      *       add custom attributes to the documents, and to attach an access control
      *       list to the documents added to the index.</p>
      *          <p>The documents are indexed asynchronously. You can see the progress of
@@ -168,12 +168,12 @@ export declare class Kendra extends KendraClient {
     createFaq(args: CreateFaqCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFaqCommandOutput) => void): void;
     /**
      * <p>Creates a new Amazon Kendra index. Index creation is an asynchronous
-     *       operation. To determine if index creation has completed, check the
+     *       API. To determine if index creation has completed, check the
      *         <code>Status</code> field returned from a call to
      *         <code>DescribeIndex</code>. The <code>Status</code> field is set to
      *         <code>ACTIVE</code> when the index is ready to use.</p>
      *          <p>Once the index is active you can index your documents using the
-     *         <code>BatchPutDocument</code> operation or using one of the supported
+     *         <code>BatchPutDocument</code> API or using one of the supported
      *       data sources. </p>
      */
     createIndex(args: CreateIndexCommandInput, options?: __HttpHandlerOptions): Promise<CreateIndexCommandOutput>;
@@ -207,7 +207,7 @@ export declare class Kendra extends KendraClient {
      * <p>Deletes an Amazon Kendra data source. An exception is not thrown if the
      *       data source is already being deleted. While the data source is being
      *       deleted, the <code>Status</code> field returned by a call to the
-     *         <code>DescribeDataSource</code> operation is set to
+     *         <code>DescribeDataSource</code> API is set to
      *         <code>DELETING</code>. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/delete-data-source.html">Deleting Data Sources</a>.</p>
      */
     deleteDataSource(args: DeleteDataSourceCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDataSourceCommandOutput>;
@@ -231,7 +231,7 @@ export declare class Kendra extends KendraClient {
      * <p>Deletes an existing Amazon Kendra index. An exception is not thrown if
      *       the index is already being deleted. While the index is being deleted, the
      *         <code>Status</code> field returned by a call to the
-     *         <code>DescribeIndex</code> operation is set to
+     *         <code>DescribeIndex</code> API is set to
      *       <code>DELETING</code>.</p>
      */
     deleteIndex(args: DeleteIndexCommandInput, options?: __HttpHandlerOptions): Promise<DeleteIndexCommandOutput>;
@@ -277,7 +277,7 @@ export declare class Kendra extends KendraClient {
     deleteThesaurus(args: DeleteThesaurusCommandInput, cb: (err: any, data?: DeleteThesaurusCommandOutput) => void): void;
     deleteThesaurus(args: DeleteThesaurusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteThesaurusCommandOutput) => void): void;
     /**
-     * <p>Gets information about a Amazon Kendra data source.</p>
+     * <p>Gets information about an Amazon Kendra data source.</p>
      */
     describeDataSource(args: DescribeDataSourceCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDataSourceCommandOutput>;
     describeDataSource(args: DescribeDataSourceCommandInput, cb: (err: any, data?: DescribeDataSourceCommandOutput) => void): void;
@@ -494,10 +494,10 @@ export declare class Kendra extends KendraClient {
     putPrincipalMapping(args: PutPrincipalMappingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPrincipalMappingCommandOutput) => void): void;
     /**
      * <p>Searches an active index. Use this API to search your documents
-     *          using query. The <code>Query</code> operation enables to do faceted
+     *          using query. The <code>Query</code> API enables to do faceted
      *          search and to filter results based on document attributes.</p>
      *          <p>It also enables you to provide user context that Amazon Kendra uses
-     *          to enforce document access control in the search results. </p>
+     *          to enforce document access control in the search results.</p>
      *          <p>Amazon Kendra searches your index for text content and question and
      *          answer (FAQ) content. By default the response contains three types of
      *          results.</p>
@@ -528,8 +528,8 @@ export declare class Kendra extends KendraClient {
     startDataSourceSyncJob(args: StartDataSourceSyncJobCommandInput, cb: (err: any, data?: StartDataSourceSyncJobCommandOutput) => void): void;
     startDataSourceSyncJob(args: StartDataSourceSyncJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDataSourceSyncJobCommandOutput) => void): void;
     /**
-     * <p>Stops a running synchronization job. You can't stop a scheduled
-     *       synchronization job.</p>
+     * <p>Stops a synchronization job that is currently running.
+     *       You can't stop a scheduled synchronization job.</p>
      */
     stopDataSourceSyncJob(args: StopDataSourceSyncJobCommandInput, options?: __HttpHandlerOptions): Promise<StopDataSourceSyncJobCommandOutput>;
     stopDataSourceSyncJob(args: StopDataSourceSyncJobCommandInput, cb: (err: any, data?: StopDataSourceSyncJobCommandOutput) => void): void;

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

@@ -8,7 +8,7 @@ export interface BatchDeleteDocumentCommandOutput extends BatchDeleteDocumentRes
 }
 /**
  * <p>Removes one or more documents from an index. The documents must have
- *       been added with the <code>BatchPutDocument</code> operation.</p>
+ *       been added with the <code>BatchPutDocument</code> API.</p>
  *          <p>The documents are deleted asynchronously. You can see the progress of
  *       the deletion by using Amazon Web Services CloudWatch. Any error messages related to the
  *       processing of the batch are sent to you CloudWatch log.</p>

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

@@ -9,15 +9,15 @@ export interface BatchGetDocumentStatusCommandOutput extends BatchGetDocumentSta
 /**
  * <p>Returns the indexing status for one or more documents submitted
  *             with the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">
- *                 BatchPutDocument</a> operation.</p>
- *         <p>When you use the <code>BatchPutDocument</code> operation,
+ *                 BatchPutDocument</a> API.</p>
+ *         <p>When you use the <code>BatchPutDocument</code> API,
  *             documents are indexed asynchronously. You can use the
- *                 <code>BatchGetDocumentStatus</code> operation to get the current
+ *                 <code>BatchGetDocumentStatus</code> API to get the current
  *             status of a list of documents so that you can determine if they have
  *             been successfully indexed.</p>
- *         <p>You can also use the <code>BatchGetDocumentStatus</code> operation
+ *         <p>You can also use the <code>BatchGetDocumentStatus</code> API
  *             to check the status of the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchDeleteDocument.html">
- *                 BatchDeleteDocument</a> operation. When a document is
+ *                 BatchDeleteDocument</a> API. When a document is
  *             deleted from the index, Amazon Kendra returns <code>NOT_FOUND</code> as the
  *             status.</p>
  * @example

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

@@ -8,9 +8,9 @@ export interface BatchPutDocumentCommandOutput extends BatchPutDocumentResponse,
 }
 /**
  * <p>Adds one or more documents to an index.</p>
- *          <p>The <code>BatchPutDocument</code> operation enables you to ingest
+ *          <p>The <code>BatchPutDocument</code> API enables you to ingest
  *       inline documents or a set of documents stored in an Amazon S3 bucket. Use
- *       this operation to ingest your text and unstructured text into an index,
+ *       this API to ingest your text and unstructured text into an index,
  *       add custom attributes to the documents, and to attach an access control
  *       list to the documents added to the index.</p>
  *          <p>The documents are indexed asynchronously. You can see the progress of

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

@@ -8,12 +8,12 @@ export interface CreateIndexCommandOutput extends CreateIndexResponse, __Metadat
 }
 /**
  * <p>Creates a new Amazon Kendra index. Index creation is an asynchronous
- *       operation. To determine if index creation has completed, check the
+ *       API. To determine if index creation has completed, check the
  *         <code>Status</code> field returned from a call to
  *         <code>DescribeIndex</code>. The <code>Status</code> field is set to
  *         <code>ACTIVE</code> when the index is ready to use.</p>
  *          <p>Once the index is active you can index your documents using the
- *         <code>BatchPutDocument</code> operation or using one of the supported
+ *         <code>BatchPutDocument</code> API or using one of the supported
  *       data sources. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

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

@@ -10,7 +10,7 @@ export interface DeleteDataSourceCommandOutput extends __MetadataBearer {
  * <p>Deletes an Amazon Kendra data source. An exception is not thrown if the
  *       data source is already being deleted. While the data source is being
  *       deleted, the <code>Status</code> field returned by a call to the
- *         <code>DescribeDataSource</code> operation is set to
+ *         <code>DescribeDataSource</code> API is set to
  *         <code>DELETING</code>. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/delete-data-source.html">Deleting Data Sources</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

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

@@ -10,7 +10,7 @@ export interface DeleteIndexCommandOutput extends __MetadataBearer {
  * <p>Deletes an existing Amazon Kendra index. An exception is not thrown if
  *       the index is already being deleted. While the index is being deleted, the
  *         <code>Status</code> field returned by a call to the
- *         <code>DescribeIndex</code> operation is set to
+ *         <code>DescribeIndex</code> API is set to
  *       <code>DELETING</code>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

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

@@ -7,7 +7,7 @@ export interface DescribeDataSourceCommandInput extends DescribeDataSourceReques
 export interface DescribeDataSourceCommandOutput extends DescribeDataSourceResponse, __MetadataBearer {
 }
 /**
- * <p>Gets information about a Amazon Kendra data source.</p>
+ * <p>Gets information about an Amazon Kendra data source.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -8,10 +8,10 @@ export interface QueryCommandOutput extends QueryResult, __MetadataBearer {
 }
 /**
  * <p>Searches an active index. Use this API to search your documents
- *          using query. The <code>Query</code> operation enables to do faceted
+ *          using query. The <code>Query</code> API enables to do faceted
  *          search and to filter results based on document attributes.</p>
  *          <p>It also enables you to provide user context that Amazon Kendra uses
- *          to enforce document access control in the search results. </p>
+ *          to enforce document access control in the search results.</p>
  *          <p>Amazon Kendra searches your index for text content and question and
  *          answer (FAQ) content. By default the response contains three types of
  *          results.</p>

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

@@ -7,8 +7,8 @@ export interface StopDataSourceSyncJobCommandInput extends StopDataSourceSyncJob
 export interface StopDataSourceSyncJobCommandOutput extends __MetadataBearer {
 }
 /**
- * <p>Stops a running synchronization job. You can't stop a scheduled
- *       synchronization job.</p>
+ * <p>Stops a synchronization job that is currently running.
+ *       You can't stop a scheduled synchronization job.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/index.d.ts

@@ -3,3 +3,4 @@ export * from "./KendraClient";
 export * from "./commands";
 export * from "./models";
 export * from "./pagination";
+export { KendraServiceException } from "./models/KendraServiceException";

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

@@ -0,0 +1,10 @@
+import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
+/**
+ * Base exception class for all service exceptions from Kendra service.
+ */
+export declare class KendraServiceException extends __ServiceException {
+    /**
+     * @internal
+     */
+    constructor(options: __ServiceExceptionOptions);
+}