Skip to content

Commit

Permalink
feat(client-kendra): Amazon Kendra now provides a data source connect…
Browse files Browse the repository at this point in the history
…or for alfresco
  • Loading branch information
awstools committed Jun 30, 2022
1 parent 49bcc4f commit 104b8be
Show file tree
Hide file tree
Showing 11 changed files with 636 additions and 190 deletions.
25 changes: 23 additions & 2 deletions clients/client-kendra/src/Kendra.ts
Original file line number Diff line number Diff line change
Expand Up @@ -404,6 +404,9 @@ export 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>
*/
public batchPutDocument(
args: BatchPutDocumentCommandInput,
Expand Down Expand Up @@ -486,6 +489,10 @@ export 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>
*/
public createDataSource(
args: CreateDataSourceCommandInput,
Expand Down Expand Up @@ -518,7 +525,8 @@ export class Kendra extends KendraClient {

/**
* <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>
*/
public createExperience(
Expand Down Expand Up @@ -553,6 +561,9 @@ export 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>
*/
public createFaq(args: CreateFaqCommandInput, options?: __HttpHandlerOptions): Promise<CreateFaqCommandOutput>;
public createFaq(args: CreateFaqCommandInput, cb: (err: any, data?: CreateFaqCommandOutput) => void): void;
Expand Down Expand Up @@ -585,7 +596,11 @@ export 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>
*/
public createIndex(args: CreateIndexCommandInput, options?: __HttpHandlerOptions): Promise<CreateIndexCommandOutput>;
public createIndex(args: CreateIndexCommandInput, cb: (err: any, data?: CreateIndexCommandOutput) => void): void;
Expand Down Expand Up @@ -623,6 +638,9 @@ export 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>
*/
public createQuerySuggestionsBlockList(
args: CreateQuerySuggestionsBlockListCommandInput,
Expand Down Expand Up @@ -656,6 +674,9 @@ export 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>
*/
public createThesaurus(
args: CreateThesaurusCommandInput,
Expand Down
3 changes: 3 additions & 0 deletions clients/client-kendra/src/commands/BatchPutDocumentCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,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
Expand Down
4 changes: 4 additions & 0 deletions clients/client-kendra/src/commands/CreateDataSourceCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,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.
Expand Down
3 changes: 3 additions & 0 deletions clients/client-kendra/src/commands/CreateFaqCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,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
Expand Down
6 changes: 5 additions & 1 deletion clients/client-kendra/src/commands/CreateIndexCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ export interface CreateQuerySuggestionsBlockListCommandOutput
* <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
Expand Down
3 changes: 3 additions & 0 deletions clients/client-kendra/src/commands/CreateThesaurusCommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,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
Expand Down
Loading

0 comments on commit 104b8be

Please sign in to comment.