@aws-sdk/client-kendra 3.112.0 → 3.121.0

package/dist-types/Kendra.d.ts

@@ -117,6 +117,9 @@ export declare class Kendra extends KendraClient {
      *          <p>The documents are indexed asynchronously. You can see the progress of
      *       the batch using Amazon Web Services CloudWatch. Any error messages related to processing
      *       the batch are sent to your Amazon Web Services CloudWatch log.</p>
+     *          <p>For an example of ingesting inline documents using Python and Java SDKs,
+     *       see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-adding-binary-doc.html">Adding
+     *         files directly to an index</a>.</p>
      */
     batchPutDocument(args: BatchPutDocumentCommandInput, options?: __HttpHandlerOptions): Promise<BatchPutDocumentCommandOutput>;
     batchPutDocument(args: BatchPutDocumentCommandInput, cb: (err: any, data?: BatchPutDocumentCommandOutput) => void): void;
@@ -147,13 +150,18 @@ export declare class Kendra extends KendraClient {
      *       Otherwise, an exception is raised.</p>
      *          <p>Amazon S3 and <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-custom.html">custom</a> data sources are
      *       the only supported data sources in the Amazon Web Services GovCloud (US-West) region.</p>
+     *          <p>For an example of creating an index and data source using the Python SDK,
+     *       see <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html">Getting
+     *         started with Python SDK</a>. For an example of creating an index and data
+     *       source using the Java SDK, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html">Getting started with Java SDK</a>.</p>
      */
     createDataSource(args: CreateDataSourceCommandInput, options?: __HttpHandlerOptions): Promise<CreateDataSourceCommandOutput>;
     createDataSource(args: CreateDataSourceCommandInput, cb: (err: any, data?: CreateDataSourceCommandOutput) => void): void;
     createDataSource(args: CreateDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDataSourceCommandOutput) => void): void;
     /**
      * <p>Creates an 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
+     *             on creating a search application experience, including using the Python and Java SDKs,
+     *             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>
      */
     createExperience(args: CreateExperienceCommandInput, options?: __HttpHandlerOptions): Promise<CreateExperienceCommandOutput>;
@@ -162,6 +170,9 @@ export declare class Kendra extends KendraClient {
     /**
      * <p>Creates an new set of frequently asked question (FAQ) questions and answers.</p>
      *         <p>Adding FAQs to an index is an asynchronous operation.</p>
+     *         <p>For an example of adding an FAQ to an index using Python and Java SDKs,
+     *             see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html#using-faq-file">Using you
+     *                 FAQ file</a>.</p>
      */
     createFaq(args: CreateFaqCommandInput, options?: __HttpHandlerOptions): Promise<CreateFaqCommandOutput>;
     createFaq(args: CreateFaqCommandInput, cb: (err: any, data?: CreateFaqCommandOutput) => void): void;
@@ -174,7 +185,11 @@ export declare class Kendra extends KendraClient {
      *         <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> API or using one of the supported
-     *       data sources. </p>
+     *       data sources.</p>
+     *          <p>For an example of creating an index and data source using the Python SDK,
+     *       see <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html">Getting
+     *         started with Python SDK</a>. For an example of creating an index and data
+     *       source using the Java SDK, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html">Getting started with Java SDK</a>.</p>
      */
     createIndex(args: CreateIndexCommandInput, options?: __HttpHandlerOptions): Promise<CreateIndexCommandOutput>;
     createIndex(args: CreateIndexCommandInput, cb: (err: any, data?: CreateIndexCommandOutput) => void): void;
@@ -192,6 +207,9 @@ export declare class Kendra extends KendraClient {
      *         <p>
      *             <code>CreateQuerySuggestionsBlockList</code> is currently not supported in the
      *             Amazon Web Services GovCloud (US-West) region.</p>
+     *         <p>For an example of creating a block list for query suggestions using the
+     *             Python SDK, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html#suggestions-block-list">Query
+     *                 suggestions block list</a>.</p>
      */
     createQuerySuggestionsBlockList(args: CreateQuerySuggestionsBlockListCommandInput, options?: __HttpHandlerOptions): Promise<CreateQuerySuggestionsBlockListCommandOutput>;
     createQuerySuggestionsBlockList(args: CreateQuerySuggestionsBlockListCommandInput, cb: (err: any, data?: CreateQuerySuggestionsBlockListCommandOutput) => void): void;
@@ -199,6 +217,9 @@ export declare class Kendra extends KendraClient {
     /**
      * <p>Creates a thesaurus for an index. The thesaurus
      *       contains a list of synonyms in Solr format.</p>
+     *          <p>For an example of adding a thesaurus file to an index, see
+     *          <a href="https://docs.aws.amazon.com/kendra/latest/dg/index-synonyms-adding-thesaurus-file.html">Adding
+     *             custom synonyms to an index</a>.</p>
      */
     createThesaurus(args: CreateThesaurusCommandInput, options?: __HttpHandlerOptions): Promise<CreateThesaurusCommandOutput>;
     createThesaurus(args: CreateThesaurusCommandInput, cb: (err: any, data?: CreateThesaurusCommandOutput) => void): void;

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

@@ -16,6 +16,9 @@ export interface BatchPutDocumentCommandOutput extends BatchPutDocumentResponse,
  *          <p>The documents are indexed asynchronously. You can see the progress of
  *       the batch using Amazon Web Services CloudWatch. Any error messages related to processing
  *       the batch are sent to your Amazon Web Services CloudWatch log.</p>
+ *          <p>For an example of ingesting inline documents using Python and Java SDKs,
+ *       see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-adding-binary-doc.html">Adding
+ *         files directly to an index</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -17,6 +17,10 @@ export interface CreateDataSourceCommandOutput extends CreateDataSourceResponse,
  *       Otherwise, an exception is raised.</p>
  *          <p>Amazon S3 and <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-custom.html">custom</a> data sources are
  *       the only supported data sources in the Amazon Web Services GovCloud (US-West) region.</p>
+ *          <p>For an example of creating an index and data source using the Python SDK,
+ *       see <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html">Getting
+ *         started with Python SDK</a>. For an example of creating an index and data
+ *       source using the Java SDK, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html">Getting started with Java SDK</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -8,7 +8,8 @@ export interface CreateExperienceCommandOutput extends CreateExperienceResponse,
 }
 /**
  * <p>Creates an 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
+ *             on creating a search application experience, including using the Python and Java SDKs,
+ *             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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

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

@@ -9,6 +9,9 @@ export interface CreateFaqCommandOutput extends CreateFaqResponse, __MetadataBea
 /**
  * <p>Creates an new set of frequently asked question (FAQ) questions and answers.</p>
  *         <p>Adding FAQs to an index is an asynchronous operation.</p>
+ *         <p>For an example of adding an FAQ to an index using Python and Java SDKs,
+ *             see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html#using-faq-file">Using you
+ *                 FAQ file</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -14,7 +14,11 @@ export interface CreateIndexCommandOutput extends CreateIndexResponse, __Metadat
  *         <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> API or using one of the supported
- *       data sources. </p>
+ *       data sources.</p>
+ *          <p>For an example of creating an index and data source using the Python SDK,
+ *       see <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html">Getting
+ *         started with Python SDK</a>. For an example of creating an index and data
+ *       source using the Java SDK, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html">Getting started with Java SDK</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -19,6 +19,9 @@ export interface CreateQuerySuggestionsBlockListCommandOutput extends CreateQuer
  *         <p>
  *             <code>CreateQuerySuggestionsBlockList</code> is currently not supported in the
  *             Amazon Web Services GovCloud (US-West) region.</p>
+ *         <p>For an example of creating a block list for query suggestions using the
+ *             Python SDK, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html#suggestions-block-list">Query
+ *                 suggestions block list</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

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

@@ -9,6 +9,9 @@ export interface CreateThesaurusCommandOutput extends CreateThesaurusResponse, _
 /**
  * <p>Creates a thesaurus for an index. The thesaurus
  *       contains a list of synonyms in Solr format.</p>
+ *          <p>For an example of adding a thesaurus file to an index, see
+ *          <a href="https://docs.aws.amazon.com/kendra/latest/dg/index-synonyms-adding-thesaurus-file.html">Adding
+ *             custom synonyms to an index</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript