Skip to content

Commit 104b8be

Browse files
author
awstools
committed
feat(client-kendra): Amazon Kendra now provides a data source connector for alfresco
1 parent 49bcc4f commit 104b8be

11 files changed

+636
-190
lines changed

clients/client-kendra/src/Kendra.ts

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -404,6 +404,9 @@ export class Kendra extends KendraClient {
404404
* <p>The documents are indexed asynchronously. You can see the progress of
405405
* the batch using Amazon Web Services CloudWatch. Any error messages related to processing
406406
* the batch are sent to your Amazon Web Services CloudWatch log.</p>
407+
* <p>For an example of ingesting inline documents using Python and Java SDKs,
408+
* see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-adding-binary-doc.html">Adding
409+
* files directly to an index</a>.</p>
407410
*/
408411
public batchPutDocument(
409412
args: BatchPutDocumentCommandInput,
@@ -486,6 +489,10 @@ export class Kendra extends KendraClient {
486489
* Otherwise, an exception is raised.</p>
487490
* <p>Amazon S3 and <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-custom.html">custom</a> data sources are
488491
* the only supported data sources in the Amazon Web Services GovCloud (US-West) region.</p>
492+
* <p>For an example of creating an index and data source using the Python SDK,
493+
* see <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html">Getting
494+
* started with Python SDK</a>. For an example of creating an index and data
495+
* 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>
489496
*/
490497
public createDataSource(
491498
args: CreateDataSourceCommandInput,
@@ -518,7 +525,8 @@ export class Kendra extends KendraClient {
518525

519526
/**
520527
* <p>Creates an Amazon Kendra experience such as a search application. For more information
521-
* 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
528+
* on creating a search application experience, including using the Python and Java SDKs,
529+
* see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building a
522530
* search experience with no code</a>.</p>
523531
*/
524532
public createExperience(
@@ -553,6 +561,9 @@ export class Kendra extends KendraClient {
553561
/**
554562
* <p>Creates an new set of frequently asked question (FAQ) questions and answers.</p>
555563
* <p>Adding FAQs to an index is an asynchronous operation.</p>
564+
* <p>For an example of adding an FAQ to an index using Python and Java SDKs,
565+
* see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html#using-faq-file">Using you
566+
* FAQ file</a>.</p>
556567
*/
557568
public createFaq(args: CreateFaqCommandInput, options?: __HttpHandlerOptions): Promise<CreateFaqCommandOutput>;
558569
public createFaq(args: CreateFaqCommandInput, cb: (err: any, data?: CreateFaqCommandOutput) => void): void;
@@ -585,7 +596,11 @@ export class Kendra extends KendraClient {
585596
* <code>ACTIVE</code> when the index is ready to use.</p>
586597
* <p>Once the index is active you can index your documents using the
587598
* <code>BatchPutDocument</code> API or using one of the supported
588-
* data sources. </p>
599+
* data sources.</p>
600+
* <p>For an example of creating an index and data source using the Python SDK,
601+
* see <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html">Getting
602+
* started with Python SDK</a>. For an example of creating an index and data
603+
* 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>
589604
*/
590605
public createIndex(args: CreateIndexCommandInput, options?: __HttpHandlerOptions): Promise<CreateIndexCommandOutput>;
591606
public createIndex(args: CreateIndexCommandInput, cb: (err: any, data?: CreateIndexCommandOutput) => void): void;
@@ -623,6 +638,9 @@ export class Kendra extends KendraClient {
623638
* <p>
624639
* <code>CreateQuerySuggestionsBlockList</code> is currently not supported in the
625640
* Amazon Web Services GovCloud (US-West) region.</p>
641+
* <p>For an example of creating a block list for query suggestions using the
642+
* Python SDK, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html#suggestions-block-list">Query
643+
* suggestions block list</a>.</p>
626644
*/
627645
public createQuerySuggestionsBlockList(
628646
args: CreateQuerySuggestionsBlockListCommandInput,
@@ -656,6 +674,9 @@ export class Kendra extends KendraClient {
656674
/**
657675
* <p>Creates a thesaurus for an index. The thesaurus
658676
* contains a list of synonyms in Solr format.</p>
677+
* <p>For an example of adding a thesaurus file to an index, see
678+
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/index-synonyms-adding-thesaurus-file.html">Adding
679+
* custom synonyms to an index</a>.</p>
659680
*/
660681
public createThesaurus(
661682
args: CreateThesaurusCommandInput,

clients/client-kendra/src/commands/BatchPutDocumentCommand.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,9 @@ export interface BatchPutDocumentCommandOutput extends BatchPutDocumentResponse,
3232
* <p>The documents are indexed asynchronously. You can see the progress of
3333
* the batch using Amazon Web Services CloudWatch. Any error messages related to processing
3434
* the batch are sent to your Amazon Web Services CloudWatch log.</p>
35+
* <p>For an example of ingesting inline documents using Python and Java SDKs,
36+
* see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-adding-binary-doc.html">Adding
37+
* files directly to an index</a>.</p>
3538
* @example
3639
* Use a bare-bones client and the command you need to make an API call.
3740
* ```javascript

clients/client-kendra/src/commands/CreateDataSourceCommand.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,10 @@ export interface CreateDataSourceCommandOutput extends CreateDataSourceResponse,
3333
* Otherwise, an exception is raised.</p>
3434
* <p>Amazon S3 and <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-custom.html">custom</a> data sources are
3535
* the only supported data sources in the Amazon Web Services GovCloud (US-West) region.</p>
36+
* <p>For an example of creating an index and data source using the Python SDK,
37+
* see <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html">Getting
38+
* started with Python SDK</a>. For an example of creating an index and data
39+
* 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>
3640
* @example
3741
* Use a bare-bones client and the command you need to make an API call.
3842
* ```javascript

clients/client-kendra/src/commands/CreateExperienceCommand.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ export interface CreateExperienceCommandOutput extends CreateExperienceResponse,
2424

2525
/**
2626
* <p>Creates an Amazon Kendra experience such as a search application. For more information
27-
* 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
27+
* on creating a search application experience, including using the Python and Java SDKs,
28+
* see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building a
2829
* search experience with no code</a>.</p>
2930
* @example
3031
* Use a bare-bones client and the command you need to make an API call.

clients/client-kendra/src/commands/CreateFaqCommand.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ export interface CreateFaqCommandOutput extends CreateFaqResponse, __MetadataBea
2222
/**
2323
* <p>Creates an new set of frequently asked question (FAQ) questions and answers.</p>
2424
* <p>Adding FAQs to an index is an asynchronous operation.</p>
25+
* <p>For an example of adding an FAQ to an index using Python and Java SDKs,
26+
* see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html#using-faq-file">Using you
27+
* FAQ file</a>.</p>
2528
* @example
2629
* Use a bare-bones client and the command you need to make an API call.
2730
* ```javascript

clients/client-kendra/src/commands/CreateIndexCommand.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,11 @@ export interface CreateIndexCommandOutput extends CreateIndexResponse, __Metadat
3030
* <code>ACTIVE</code> when the index is ready to use.</p>
3131
* <p>Once the index is active you can index your documents using the
3232
* <code>BatchPutDocument</code> API or using one of the supported
33-
* data sources. </p>
33+
* data sources.</p>
34+
* <p>For an example of creating an index and data source using the Python SDK,
35+
* see <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html">Getting
36+
* started with Python SDK</a>. For an example of creating an index and data
37+
* 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>
3438
* @example
3539
* Use a bare-bones client and the command you need to make an API call.
3640
* ```javascript

clients/client-kendra/src/commands/CreateQuerySuggestionsBlockListCommand.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,9 @@ export interface CreateQuerySuggestionsBlockListCommandOutput
3737
* <p>
3838
* <code>CreateQuerySuggestionsBlockList</code> is currently not supported in the
3939
* Amazon Web Services GovCloud (US-West) region.</p>
40+
* <p>For an example of creating a block list for query suggestions using the
41+
* Python SDK, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/query-suggestions.html#suggestions-block-list">Query
42+
* suggestions block list</a>.</p>
4043
* @example
4144
* Use a bare-bones client and the command you need to make an API call.
4245
* ```javascript

clients/client-kendra/src/commands/CreateThesaurusCommand.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,9 @@ export interface CreateThesaurusCommandOutput extends CreateThesaurusResponse, _
2525
/**
2626
* <p>Creates a thesaurus for an index. The thesaurus
2727
* contains a list of synonyms in Solr format.</p>
28+
* <p>For an example of adding a thesaurus file to an index, see
29+
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/index-synonyms-adding-thesaurus-file.html">Adding
30+
* custom synonyms to an index</a>.</p>
2831
* @example
2932
* Use a bare-bones client and the command you need to make an API call.
3033
* ```javascript

0 commit comments

Comments
 (0)