@aws-sdk/client-kendra 3.179.0 → 3.180.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -3,6 +3,17 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ # [3.180.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.179.0...v3.180.0) (2022-09-27)
7
+
8
+
9
+ ### Features
10
+
11
+ * **client-kendra:** My AWS Service (placeholder) - Amazon Kendra now provides a data source connector for DropBox. For more information, see https://docs.aws.amazon.com/kendra/latest/dg/data-source-dropbox.html ([192b01b](https://github.com/aws/aws-sdk-js-v3/commit/192b01b885da6cc963f9dfe7d3746e29012a14e3))
12
+
13
+
14
+
15
+
16
+
6
17
  # [3.179.0](https://github.com/aws/aws-sdk-js-v3/compare/v3.178.0...v3.179.0) (2022-09-26)
7
18
 
8
19
  **Note:** Version bump only for package @aws-sdk/client-kendra
@@ -65,7 +65,7 @@ import { KendraClient } from "./KendraClient";
65
65
  */
66
66
  export declare class Kendra extends KendraClient {
67
67
  /**
68
- * <p>Grants users or groups in your Amazon Web Services SSO identity source access
68
+ * <p>Grants users or groups in your IAM Identity Center identity source access
69
69
  * to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a
70
70
  * search application. For more information on creating a search application
71
71
  * experience, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building
@@ -75,7 +75,7 @@ export declare class Kendra extends KendraClient {
75
75
  associateEntitiesToExperience(args: AssociateEntitiesToExperienceCommandInput, cb: (err: any, data?: AssociateEntitiesToExperienceCommandOutput) => void): void;
76
76
  associateEntitiesToExperience(args: AssociateEntitiesToExperienceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateEntitiesToExperienceCommandOutput) => void): void;
77
77
  /**
78
- * <p>Defines the specific permissions of users or groups in your Amazon Web Services SSO
78
+ * <p>Defines the specific permissions of users or groups in your IAM Identity Center
79
79
  * identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra
80
80
  * experience such as a search application. For more information on creating a
81
81
  * search application experience, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building
@@ -173,20 +173,19 @@ export declare class Kendra extends KendraClient {
173
173
  createAccessControlConfiguration(args: CreateAccessControlConfigurationCommandInput, cb: (err: any, data?: CreateAccessControlConfigurationCommandOutput) => void): void;
174
174
  createAccessControlConfiguration(args: CreateAccessControlConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccessControlConfigurationCommandOutput) => void): void;
175
175
  /**
176
- * <p>Creates a data source connector that you want to use with an Amazon Kendra index.</p>
177
- * <p>You specify a name, data source connector type and description for
178
- * your data source. You also specify configuration information for the
179
- * data source connector.</p>
176
+ * <p>Creates a data source connector that you want to use with an Amazon Kendra
177
+ * index.</p>
178
+ * <p>You specify a name, data source connector type and description for your data source. You
179
+ * also specify configuration information for the data source connector.</p>
180
180
  * <p>
181
- * <code>CreateDataSource</code> is a synchronous operation. The
182
- * operation returns 200 if the data source was successfully created.
183
- * Otherwise, an exception is raised.</p>
184
- * <p>Amazon S3 and <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-custom.html">custom</a> data sources are
185
- * the only supported data sources in the Amazon Web Services GovCloud (US-West) region.</p>
186
- * <p>For an example of creating an index and data source using the Python SDK,
187
- * see <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html">Getting
188
- * started with Python SDK</a>. For an example of creating an index and data
189
- * 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>
181
+ * <code>CreateDataSource</code> is a synchronous operation. The operation returns 200 if the
182
+ * data source was successfully created. Otherwise, an exception is raised.</p>
183
+ * <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
184
+ * supported data sources in the Amazon Web Services GovCloud (US-West) region.</p>
185
+ * <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
186
+ * SDK</a>. For an example of creating an index and data source using the Java SDK, see
187
+ * <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html">Getting started with Java
188
+ * SDK</a>.</p>
190
189
  */
191
190
  createDataSource(args: CreateDataSourceCommandInput, options?: __HttpHandlerOptions): Promise<CreateDataSourceCommandOutput>;
192
191
  createDataSource(args: CreateDataSourceCommandInput, cb: (err: any, data?: CreateDataSourceCommandOutput) => void): void;
@@ -268,10 +267,9 @@ export declare class Kendra extends KendraClient {
268
267
  deleteAccessControlConfiguration(args: DeleteAccessControlConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccessControlConfigurationCommandOutput) => void): void;
269
268
  /**
270
269
  * <p>Deletes an Amazon Kendra data source connector. An exception is not thrown if the
271
- * data source is already being deleted. While the data source is being
272
- * deleted, the <code>Status</code> field returned by a call to the
273
- * <code>DescribeDataSource</code> API is set to
274
- * <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>
270
+ * data source is already being deleted. While the data source is being deleted, the
271
+ * <code>Status</code> field returned by a call to the <code>DescribeDataSource</code> API is
272
+ * 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>
275
273
  */
276
274
  deleteDataSource(args: DeleteDataSourceCommandInput, options?: __HttpHandlerOptions): Promise<DeleteDataSourceCommandOutput>;
277
275
  deleteDataSource(args: DeleteDataSourceCommandInput, cb: (err: any, data?: DeleteDataSourceCommandOutput) => void): void;
@@ -419,7 +417,7 @@ export declare class Kendra extends KendraClient {
419
417
  describeThesaurus(args: DescribeThesaurusCommandInput, cb: (err: any, data?: DescribeThesaurusCommandOutput) => void): void;
420
418
  describeThesaurus(args: DescribeThesaurusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeThesaurusCommandOutput) => void): void;
421
419
  /**
422
- * <p>Prevents users or groups in your Amazon Web Services SSO identity source
420
+ * <p>Prevents users or groups in your IAM Identity Center identity source
423
421
  * from accessing your Amazon Kendra experience. You can create an Amazon Kendra experience
424
422
  * such as a search application. For more information on creating a search
425
423
  * application experience, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building
@@ -429,7 +427,7 @@ export declare class Kendra extends KendraClient {
429
427
  disassociateEntitiesFromExperience(args: DisassociateEntitiesFromExperienceCommandInput, cb: (err: any, data?: DisassociateEntitiesFromExperienceCommandOutput) => void): void;
430
428
  disassociateEntitiesFromExperience(args: DisassociateEntitiesFromExperienceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateEntitiesFromExperienceCommandOutput) => void): void;
431
429
  /**
432
- * <p>Removes the specific permissions of users or groups in your Amazon Web Services SSO
430
+ * <p>Removes the specific permissions of users or groups in your IAM Identity Center
433
431
  * identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra
434
432
  * experience such as a search application. For more information on creating a
435
433
  * search application experience, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building a
@@ -471,8 +469,7 @@ export declare class Kendra extends KendraClient {
471
469
  listDataSources(args: ListDataSourcesCommandInput, cb: (err: any, data?: ListDataSourcesCommandOutput) => void): void;
472
470
  listDataSources(args: ListDataSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataSourcesCommandOutput) => void): void;
473
471
  /**
474
- * <p>Gets statistics about synchronizing a data
475
- * source connector.</p>
472
+ * <p>Gets statistics about synchronizing a data source connector.</p>
476
473
  */
477
474
  listDataSourceSyncJobs(args: ListDataSourceSyncJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListDataSourceSyncJobsCommandOutput>;
478
475
  listDataSourceSyncJobs(args: ListDataSourceSyncJobsCommandInput, cb: (err: any, data?: ListDataSourceSyncJobsCommandOutput) => void): void;
@@ -485,7 +482,7 @@ export declare class Kendra extends KendraClient {
485
482
  listEntityPersonas(args: ListEntityPersonasCommandInput, cb: (err: any, data?: ListEntityPersonasCommandOutput) => void): void;
486
483
  listEntityPersonas(args: ListEntityPersonasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEntityPersonasCommandOutput) => void): void;
487
484
  /**
488
- * <p>Lists users or groups in your Amazon Web Services SSO identity source that are
485
+ * <p>Lists users or groups in your IAM Identity Center identity source that are
489
486
  * granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience
490
487
  * such as a search application. For more information on creating a search
491
488
  * application experience, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building
@@ -602,16 +599,16 @@ export declare class Kendra extends KendraClient {
602
599
  query(args: QueryCommandInput, cb: (err: any, data?: QueryCommandOutput) => void): void;
603
600
  query(args: QueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryCommandOutput) => void): void;
604
601
  /**
605
- * <p>Starts a synchronization job for a data source connector. If a synchronization
606
- * job is already in progress, Amazon Kendra returns a
607
- * <code>ResourceInUseException</code> exception.</p>
602
+ * <p>Starts a synchronization job for a data source connector. If a synchronization job is
603
+ * already in progress, Amazon Kendra returns a <code>ResourceInUseException</code>
604
+ * exception.</p>
608
605
  */
609
606
  startDataSourceSyncJob(args: StartDataSourceSyncJobCommandInput, options?: __HttpHandlerOptions): Promise<StartDataSourceSyncJobCommandOutput>;
610
607
  startDataSourceSyncJob(args: StartDataSourceSyncJobCommandInput, cb: (err: any, data?: StartDataSourceSyncJobCommandOutput) => void): void;
611
608
  startDataSourceSyncJob(args: StartDataSourceSyncJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDataSourceSyncJobCommandOutput) => void): void;
612
609
  /**
613
- * <p>Stops a synchronization job that is currently running.
614
- * You can't stop a scheduled synchronization job.</p>
610
+ * <p>Stops a synchronization job that is currently running. You can't stop a scheduled
611
+ * synchronization job.</p>
615
612
  */
616
613
  stopDataSourceSyncJob(args: StopDataSourceSyncJobCommandInput, options?: __HttpHandlerOptions): Promise<StopDataSourceSyncJobCommandOutput>;
617
614
  stopDataSourceSyncJob(args: StopDataSourceSyncJobCommandInput, cb: (err: any, data?: StopDataSourceSyncJobCommandOutput) => void): void;
@@ -7,7 +7,7 @@ export interface AssociateEntitiesToExperienceCommandInput extends AssociateEnti
7
7
  export interface AssociateEntitiesToExperienceCommandOutput extends AssociateEntitiesToExperienceResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Grants users or groups in your Amazon Web Services SSO identity source access
10
+ * <p>Grants users or groups in your IAM Identity Center identity source access
11
11
  * to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a
12
12
  * search application. For more information on creating a search application
13
13
  * experience, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building
@@ -7,7 +7,7 @@ export interface AssociatePersonasToEntitiesCommandInput extends AssociatePerson
7
7
  export interface AssociatePersonasToEntitiesCommandOutput extends AssociatePersonasToEntitiesResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Defines the specific permissions of users or groups in your Amazon Web Services SSO
10
+ * <p>Defines the specific permissions of users or groups in your IAM Identity Center
11
11
  * identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra
12
12
  * experience such as a search application. For more information on creating a
13
13
  * search application experience, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building
@@ -7,20 +7,19 @@ export interface CreateDataSourceCommandInput extends CreateDataSourceRequest {
7
7
  export interface CreateDataSourceCommandOutput extends CreateDataSourceResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Creates a data source connector that you want to use with an Amazon Kendra index.</p>
11
- * <p>You specify a name, data source connector type and description for
12
- * your data source. You also specify configuration information for the
13
- * data source connector.</p>
10
+ * <p>Creates a data source connector that you want to use with an Amazon Kendra
11
+ * index.</p>
12
+ * <p>You specify a name, data source connector type and description for your data source. You
13
+ * also specify configuration information for the data source connector.</p>
14
14
  * <p>
15
- * <code>CreateDataSource</code> is a synchronous operation. The
16
- * operation returns 200 if the data source was successfully created.
17
- * Otherwise, an exception is raised.</p>
18
- * <p>Amazon S3 and <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-custom.html">custom</a> data sources are
19
- * the only supported data sources in the Amazon Web Services GovCloud (US-West) region.</p>
20
- * <p>For an example of creating an index and data source using the Python SDK,
21
- * see <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-python.html">Getting
22
- * started with Python SDK</a>. For an example of creating an index and data
23
- * 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>
15
+ * <code>CreateDataSource</code> is a synchronous operation. The operation returns 200 if the
16
+ * data source was successfully created. Otherwise, an exception is raised.</p>
17
+ * <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
18
+ * supported data sources in the Amazon Web Services GovCloud (US-West) region.</p>
19
+ * <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
20
+ * SDK</a>. For an example of creating an index and data source using the Java SDK, see
21
+ * <a href="https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html">Getting started with Java
22
+ * SDK</a>.</p>
24
23
  * @example
25
24
  * Use a bare-bones client and the command you need to make an API call.
26
25
  * ```javascript
@@ -8,10 +8,9 @@ export interface DeleteDataSourceCommandOutput extends __MetadataBearer {
8
8
  }
9
9
  /**
10
10
  * <p>Deletes an Amazon Kendra data source connector. An exception is not thrown if the
11
- * data source is already being deleted. While the data source is being
12
- * deleted, the <code>Status</code> field returned by a call to the
13
- * <code>DescribeDataSource</code> API is set to
14
- * <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>
11
+ * data source is already being deleted. While the data source is being deleted, the
12
+ * <code>Status</code> field returned by a call to the <code>DescribeDataSource</code> API is
13
+ * 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>
15
14
  * @example
16
15
  * Use a bare-bones client and the command you need to make an API call.
17
16
  * ```javascript
@@ -7,7 +7,7 @@ export interface DisassociateEntitiesFromExperienceCommandInput extends Disassoc
7
7
  export interface DisassociateEntitiesFromExperienceCommandOutput extends DisassociateEntitiesFromExperienceResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Prevents users or groups in your Amazon Web Services SSO identity source
10
+ * <p>Prevents users or groups in your IAM Identity Center identity source
11
11
  * from accessing your Amazon Kendra experience. You can create an Amazon Kendra experience
12
12
  * such as a search application. For more information on creating a search
13
13
  * application experience, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building
@@ -7,7 +7,7 @@ export interface DisassociatePersonasFromEntitiesCommandInput extends Disassocia
7
7
  export interface DisassociatePersonasFromEntitiesCommandOutput extends DisassociatePersonasFromEntitiesResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Removes the specific permissions of users or groups in your Amazon Web Services SSO
10
+ * <p>Removes the specific permissions of users or groups in your IAM Identity Center
11
11
  * identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra
12
12
  * experience such as a search application. For more information on creating a
13
13
  * search application experience, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building a
@@ -7,8 +7,7 @@ export interface ListDataSourceSyncJobsCommandInput extends ListDataSourceSyncJo
7
7
  export interface ListDataSourceSyncJobsCommandOutput extends ListDataSourceSyncJobsResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Gets statistics about synchronizing a data
11
- * source connector.</p>
10
+ * <p>Gets statistics about synchronizing a data source connector.</p>
12
11
  * @example
13
12
  * Use a bare-bones client and the command you need to make an API call.
14
13
  * ```javascript
@@ -7,7 +7,7 @@ export interface ListExperienceEntitiesCommandInput extends ListExperienceEntiti
7
7
  export interface ListExperienceEntitiesCommandOutput extends ListExperienceEntitiesResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Lists users or groups in your Amazon Web Services SSO identity source that are
10
+ * <p>Lists users or groups in your IAM Identity Center identity source that are
11
11
  * granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience
12
12
  * such as a search application. For more information on creating a search
13
13
  * application experience, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building
@@ -7,9 +7,9 @@ export interface StartDataSourceSyncJobCommandInput extends StartDataSourceSyncJ
7
7
  export interface StartDataSourceSyncJobCommandOutput extends StartDataSourceSyncJobResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Starts a synchronization job for a data source connector. If a synchronization
11
- * job is already in progress, Amazon Kendra returns a
12
- * <code>ResourceInUseException</code> exception.</p>
10
+ * <p>Starts a synchronization job for a data source connector. If a synchronization job is
11
+ * already in progress, Amazon Kendra returns a <code>ResourceInUseException</code>
12
+ * exception.</p>
13
13
  * @example
14
14
  * Use a bare-bones client and the command you need to make an API call.
15
15
  * ```javascript
@@ -7,8 +7,8 @@ export interface StopDataSourceSyncJobCommandInput extends StopDataSourceSyncJob
7
7
  export interface StopDataSourceSyncJobCommandOutput extends __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Stops a synchronization job that is currently running.
11
- * You can't stop a scheduled synchronization job.</p>
10
+ * <p>Stops a synchronization job that is currently running. You can't stop a scheduled
11
+ * synchronization job.</p>
12
12
  * @example
13
13
  * Use a bare-bones client and the command you need to make an API call.
14
14
  * ```javascript