@aws-sdk/client-kendra 3.128.0 → 3.135.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.
Files changed (69) hide show
  1. package/CHANGELOG.md +35 -0
  2. package/dist-cjs/Kendra.js +75 -0
  3. package/dist-cjs/commands/CreateAccessControlConfigurationCommand.js +36 -0
  4. package/dist-cjs/commands/DeleteAccessControlConfigurationCommand.js +36 -0
  5. package/dist-cjs/commands/DescribeAccessControlConfigurationCommand.js +36 -0
  6. package/dist-cjs/commands/ListAccessControlConfigurationsCommand.js +36 -0
  7. package/dist-cjs/commands/QueryCommand.js +3 -3
  8. package/dist-cjs/commands/UpdateAccessControlConfigurationCommand.js +36 -0
  9. package/dist-cjs/commands/index.js +5 -0
  10. package/dist-cjs/models/index.js +1 -0
  11. package/dist-cjs/models/models_0.js +77 -18
  12. package/dist-cjs/models/models_1.js +15 -0
  13. package/dist-cjs/pagination/ListAccessControlConfigurationsPaginator.js +36 -0
  14. package/dist-cjs/pagination/index.js +1 -0
  15. package/dist-cjs/protocols/Aws_json1_1.js +452 -3
  16. package/dist-es/Kendra.js +75 -0
  17. package/dist-es/commands/CreateAccessControlConfigurationCommand.js +39 -0
  18. package/dist-es/commands/DeleteAccessControlConfigurationCommand.js +39 -0
  19. package/dist-es/commands/DescribeAccessControlConfigurationCommand.js +39 -0
  20. package/dist-es/commands/ListAccessControlConfigurationsCommand.js +39 -0
  21. package/dist-es/commands/QueryCommand.js +1 -1
  22. package/dist-es/commands/UpdateAccessControlConfigurationCommand.js +39 -0
  23. package/dist-es/commands/index.js +5 -0
  24. package/dist-es/models/index.js +1 -0
  25. package/dist-es/models/models_0.js +49 -8
  26. package/dist-es/models/models_1.js +9 -0
  27. package/dist-es/pagination/ListAccessControlConfigurationsPaginator.js +75 -0
  28. package/dist-es/pagination/index.js +1 -0
  29. package/dist-es/protocols/Aws_json1_1.js +525 -2
  30. package/dist-types/Kendra.d.ts +97 -11
  31. package/dist-types/KendraClient.d.ts +7 -2
  32. package/dist-types/commands/CreateAccessControlConfigurationCommand.d.ts +57 -0
  33. package/dist-types/commands/CreateFaqCommand.d.ts +1 -1
  34. package/dist-types/commands/CreateIndexCommand.d.ts +1 -1
  35. package/dist-types/commands/DeleteAccessControlConfigurationCommand.d.ts +38 -0
  36. package/dist-types/commands/DescribeAccessControlConfigurationCommand.d.ts +38 -0
  37. package/dist-types/commands/DescribeIndexCommand.d.ts +1 -1
  38. package/dist-types/commands/DescribeQuerySuggestionsBlockListCommand.d.ts +2 -1
  39. package/dist-types/commands/DescribeQuerySuggestionsConfigCommand.d.ts +1 -1
  40. package/dist-types/commands/DescribeThesaurusCommand.d.ts +1 -1
  41. package/dist-types/commands/ListAccessControlConfigurationsCommand.d.ts +38 -0
  42. package/dist-types/commands/ListThesauriCommand.d.ts +1 -1
  43. package/dist-types/commands/PutPrincipalMappingCommand.d.ts +3 -3
  44. package/dist-types/commands/QueryCommand.d.ts +1 -1
  45. package/dist-types/commands/UpdateAccessControlConfigurationCommand.d.ts +54 -0
  46. package/dist-types/commands/UpdateThesaurusCommand.d.ts +1 -1
  47. package/dist-types/commands/index.d.ts +5 -0
  48. package/dist-types/models/index.d.ts +1 -0
  49. package/dist-types/models/models_0.d.ts +427 -312
  50. package/dist-types/models/models_1.d.ts +136 -0
  51. package/dist-types/pagination/ListAccessControlConfigurationsPaginator.d.ts +4 -0
  52. package/dist-types/pagination/index.d.ts +1 -0
  53. package/dist-types/protocols/Aws_json1_1.d.ts +15 -0
  54. package/dist-types/ts3.4/Kendra.d.ts +25 -0
  55. package/dist-types/ts3.4/KendraClient.d.ts +7 -2
  56. package/dist-types/ts3.4/commands/CreateAccessControlConfigurationCommand.d.ts +17 -0
  57. package/dist-types/ts3.4/commands/DeleteAccessControlConfigurationCommand.d.ts +17 -0
  58. package/dist-types/ts3.4/commands/DescribeAccessControlConfigurationCommand.d.ts +17 -0
  59. package/dist-types/ts3.4/commands/ListAccessControlConfigurationsCommand.d.ts +17 -0
  60. package/dist-types/ts3.4/commands/QueryCommand.d.ts +1 -1
  61. package/dist-types/ts3.4/commands/UpdateAccessControlConfigurationCommand.d.ts +17 -0
  62. package/dist-types/ts3.4/commands/index.d.ts +5 -0
  63. package/dist-types/ts3.4/models/index.d.ts +1 -0
  64. package/dist-types/ts3.4/models/models_0.d.ts +131 -50
  65. package/dist-types/ts3.4/models/models_1.d.ts +51 -0
  66. package/dist-types/ts3.4/pagination/ListAccessControlConfigurationsPaginator.d.ts +4 -0
  67. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  68. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +15 -0
  69. package/package.json +7 -7
@@ -5,12 +5,14 @@ import { BatchDeleteDocumentCommandInput, BatchDeleteDocumentCommandOutput } fro
5
5
  import { BatchGetDocumentStatusCommandInput, BatchGetDocumentStatusCommandOutput } from "./commands/BatchGetDocumentStatusCommand";
6
6
  import { BatchPutDocumentCommandInput, BatchPutDocumentCommandOutput } from "./commands/BatchPutDocumentCommand";
7
7
  import { ClearQuerySuggestionsCommandInput, ClearQuerySuggestionsCommandOutput } from "./commands/ClearQuerySuggestionsCommand";
8
+ import { CreateAccessControlConfigurationCommandInput, CreateAccessControlConfigurationCommandOutput } from "./commands/CreateAccessControlConfigurationCommand";
8
9
  import { CreateDataSourceCommandInput, CreateDataSourceCommandOutput } from "./commands/CreateDataSourceCommand";
9
10
  import { CreateExperienceCommandInput, CreateExperienceCommandOutput } from "./commands/CreateExperienceCommand";
10
11
  import { CreateFaqCommandInput, CreateFaqCommandOutput } from "./commands/CreateFaqCommand";
11
12
  import { CreateIndexCommandInput, CreateIndexCommandOutput } from "./commands/CreateIndexCommand";
12
13
  import { CreateQuerySuggestionsBlockListCommandInput, CreateQuerySuggestionsBlockListCommandOutput } from "./commands/CreateQuerySuggestionsBlockListCommand";
13
14
  import { CreateThesaurusCommandInput, CreateThesaurusCommandOutput } from "./commands/CreateThesaurusCommand";
15
+ import { DeleteAccessControlConfigurationCommandInput, DeleteAccessControlConfigurationCommandOutput } from "./commands/DeleteAccessControlConfigurationCommand";
14
16
  import { DeleteDataSourceCommandInput, DeleteDataSourceCommandOutput } from "./commands/DeleteDataSourceCommand";
15
17
  import { DeleteExperienceCommandInput, DeleteExperienceCommandOutput } from "./commands/DeleteExperienceCommand";
16
18
  import { DeleteFaqCommandInput, DeleteFaqCommandOutput } from "./commands/DeleteFaqCommand";
@@ -18,6 +20,7 @@ import { DeleteIndexCommandInput, DeleteIndexCommandOutput } from "./commands/De
18
20
  import { DeletePrincipalMappingCommandInput, DeletePrincipalMappingCommandOutput } from "./commands/DeletePrincipalMappingCommand";
19
21
  import { DeleteQuerySuggestionsBlockListCommandInput, DeleteQuerySuggestionsBlockListCommandOutput } from "./commands/DeleteQuerySuggestionsBlockListCommand";
20
22
  import { DeleteThesaurusCommandInput, DeleteThesaurusCommandOutput } from "./commands/DeleteThesaurusCommand";
23
+ import { DescribeAccessControlConfigurationCommandInput, DescribeAccessControlConfigurationCommandOutput } from "./commands/DescribeAccessControlConfigurationCommand";
21
24
  import { DescribeDataSourceCommandInput, DescribeDataSourceCommandOutput } from "./commands/DescribeDataSourceCommand";
22
25
  import { DescribeExperienceCommandInput, DescribeExperienceCommandOutput } from "./commands/DescribeExperienceCommand";
23
26
  import { DescribeFaqCommandInput, DescribeFaqCommandOutput } from "./commands/DescribeFaqCommand";
@@ -30,6 +33,7 @@ import { DisassociateEntitiesFromExperienceCommandInput, DisassociateEntitiesFro
30
33
  import { DisassociatePersonasFromEntitiesCommandInput, DisassociatePersonasFromEntitiesCommandOutput } from "./commands/DisassociatePersonasFromEntitiesCommand";
31
34
  import { GetQuerySuggestionsCommandInput, GetQuerySuggestionsCommandOutput } from "./commands/GetQuerySuggestionsCommand";
32
35
  import { GetSnapshotsCommandInput, GetSnapshotsCommandOutput } from "./commands/GetSnapshotsCommand";
36
+ import { ListAccessControlConfigurationsCommandInput, ListAccessControlConfigurationsCommandOutput } from "./commands/ListAccessControlConfigurationsCommand";
33
37
  import { ListDataSourcesCommandInput, ListDataSourcesCommandOutput } from "./commands/ListDataSourcesCommand";
34
38
  import { ListDataSourceSyncJobsCommandInput, ListDataSourceSyncJobsCommandOutput } from "./commands/ListDataSourceSyncJobsCommand";
35
39
  import { ListEntityPersonasCommandInput, ListEntityPersonasCommandOutput } from "./commands/ListEntityPersonasCommand";
@@ -48,6 +52,7 @@ import { StopDataSourceSyncJobCommandInput, StopDataSourceSyncJobCommandOutput }
48
52
  import { SubmitFeedbackCommandInput, SubmitFeedbackCommandOutput } from "./commands/SubmitFeedbackCommand";
49
53
  import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
50
54
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
55
+ import { UpdateAccessControlConfigurationCommandInput, UpdateAccessControlConfigurationCommandOutput } from "./commands/UpdateAccessControlConfigurationCommand";
51
56
  import { UpdateDataSourceCommandInput, UpdateDataSourceCommandOutput } from "./commands/UpdateDataSourceCommand";
52
57
  import { UpdateExperienceCommandInput, UpdateExperienceCommandOutput } from "./commands/UpdateExperienceCommand";
53
58
  import { UpdateIndexCommandInput, UpdateIndexCommandOutput } from "./commands/UpdateIndexCommand";
@@ -139,6 +144,34 @@ export declare class Kendra extends KendraClient {
139
144
  clearQuerySuggestions(args: ClearQuerySuggestionsCommandInput, options?: __HttpHandlerOptions): Promise<ClearQuerySuggestionsCommandOutput>;
140
145
  clearQuerySuggestions(args: ClearQuerySuggestionsCommandInput, cb: (err: any, data?: ClearQuerySuggestionsCommandOutput) => void): void;
141
146
  clearQuerySuggestions(args: ClearQuerySuggestionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ClearQuerySuggestionsCommandOutput) => void): void;
147
+ /**
148
+ * <p>Creates an access configuration for your documents. This includes
149
+ * user and group access information for your documents. This is useful
150
+ * for user context filtering, where search results are filtered based
151
+ * on the user or their group access to documents.</p>
152
+ * <p>You can use this to re-configure your existing document level access control without
153
+ * indexing all of your documents again. For example, your index contains top-secret
154
+ * company documents that only certain employees or users should access. One of these users
155
+ * leaves the company or switches to a team that should be blocked from accessing
156
+ * top-secret documents. The user still has access to top-secret documents because the user
157
+ * had access when your documents were previously indexed. You
158
+ * can create a specific access control configuration for the user with deny
159
+ * access. You can later update the access control configuration to allow access if the
160
+ * user returns to the company and re-joins the 'top-secret' team. You can re-configure
161
+ * access control for your documents as circumstances change.</p>
162
+ * <p>To apply your access control configuration to certain documents, you call
163
+ * the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">BatchPutDocument</a>
164
+ * API with the <code>AccessControlConfigurationId</code> included in the
165
+ * <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html">Document</a>
166
+ * object. If you use an S3 bucket as a data source, you update the
167
+ * <code>.metadata.json</code> with the <code>AccessControlConfigurationId</code>
168
+ * and synchronize your data source. Amazon Kendra currently only supports
169
+ * access control configuration for S3 data sources and documents indexed using the
170
+ * <code>BatchPutDocument</code> API.</p>
171
+ */
172
+ createAccessControlConfiguration(args: CreateAccessControlConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<CreateAccessControlConfigurationCommandOutput>;
173
+ createAccessControlConfiguration(args: CreateAccessControlConfigurationCommandInput, cb: (err: any, data?: CreateAccessControlConfigurationCommandOutput) => void): void;
174
+ createAccessControlConfiguration(args: CreateAccessControlConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccessControlConfigurationCommandOutput) => void): void;
142
175
  /**
143
176
  * <p>Creates a data source that you want to use with an Amazon Kendra index. </p>
144
177
  * <p>You specify a name, data source connector type and description for
@@ -171,14 +204,14 @@ export declare class Kendra extends KendraClient {
171
204
  * <p>Creates an new set of frequently asked question (FAQ) questions and answers.</p>
172
205
  * <p>Adding FAQs to an index is an asynchronous operation.</p>
173
206
  * <p>For an example of adding an FAQ to an index using Python and Java SDKs,
174
- * see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html#using-faq-file">Using you
207
+ * see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html#using-faq-file">Using your
175
208
  * FAQ file</a>.</p>
176
209
  */
177
210
  createFaq(args: CreateFaqCommandInput, options?: __HttpHandlerOptions): Promise<CreateFaqCommandOutput>;
178
211
  createFaq(args: CreateFaqCommandInput, cb: (err: any, data?: CreateFaqCommandOutput) => void): void;
179
212
  createFaq(args: CreateFaqCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFaqCommandOutput) => void): void;
180
213
  /**
181
- * <p>Creates a new Amazon Kendra index. Index creation is an asynchronous
214
+ * <p>Creates an Amazon Kendra index. Index creation is an asynchronous
182
215
  * API. To determine if index creation has completed, check the
183
216
  * <code>Status</code> field returned from a call to
184
217
  * <code>DescribeIndex</code>. The <code>Status</code> field is set to
@@ -224,6 +257,15 @@ export declare class Kendra extends KendraClient {
224
257
  createThesaurus(args: CreateThesaurusCommandInput, options?: __HttpHandlerOptions): Promise<CreateThesaurusCommandOutput>;
225
258
  createThesaurus(args: CreateThesaurusCommandInput, cb: (err: any, data?: CreateThesaurusCommandOutput) => void): void;
226
259
  createThesaurus(args: CreateThesaurusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateThesaurusCommandOutput) => void): void;
260
+ /**
261
+ * <p>Deletes an access control configuration that you created for your
262
+ * documents in an index. This includes user and group access information
263
+ * for your documents. This is useful for user context filtering, where search
264
+ * results are filtered based on the user or their group access to documents.</p>
265
+ */
266
+ deleteAccessControlConfiguration(args: DeleteAccessControlConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAccessControlConfigurationCommandOutput>;
267
+ deleteAccessControlConfiguration(args: DeleteAccessControlConfigurationCommandInput, cb: (err: any, data?: DeleteAccessControlConfigurationCommandOutput) => void): void;
268
+ deleteAccessControlConfiguration(args: DeleteAccessControlConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccessControlConfigurationCommandOutput) => void): void;
227
269
  /**
228
270
  * <p>Deletes an Amazon Kendra data source. An exception is not thrown if the
229
271
  * data source is already being deleted. While the data source is being
@@ -297,6 +339,15 @@ export declare class Kendra extends KendraClient {
297
339
  deleteThesaurus(args: DeleteThesaurusCommandInput, options?: __HttpHandlerOptions): Promise<DeleteThesaurusCommandOutput>;
298
340
  deleteThesaurus(args: DeleteThesaurusCommandInput, cb: (err: any, data?: DeleteThesaurusCommandOutput) => void): void;
299
341
  deleteThesaurus(args: DeleteThesaurusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteThesaurusCommandOutput) => void): void;
342
+ /**
343
+ * <p>Gets information about an access control configuration that you created for your
344
+ * documents in an index. This includes user and group access information for your
345
+ * documents. This is useful for user context filtering, where search results are
346
+ * filtered based on the user or their group access to documents.</p>
347
+ */
348
+ describeAccessControlConfiguration(args: DescribeAccessControlConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAccessControlConfigurationCommandOutput>;
349
+ describeAccessControlConfiguration(args: DescribeAccessControlConfigurationCommandInput, cb: (err: any, data?: DescribeAccessControlConfigurationCommandOutput) => void): void;
350
+ describeAccessControlConfiguration(args: DescribeAccessControlConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccessControlConfigurationCommandOutput) => void): void;
300
351
  /**
301
352
  * <p>Gets information about an Amazon Kendra data source.</p>
302
353
  */
@@ -319,7 +370,7 @@ export declare class Kendra extends KendraClient {
319
370
  describeFaq(args: DescribeFaqCommandInput, cb: (err: any, data?: DescribeFaqCommandOutput) => void): void;
320
371
  describeFaq(args: DescribeFaqCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFaqCommandOutput) => void): void;
321
372
  /**
322
- * <p>Describes an existing Amazon Kendra index.</p>
373
+ * <p>Gets information about an existing Amazon Kendra index.</p>
323
374
  */
324
375
  describeIndex(args: DescribeIndexCommandInput, options?: __HttpHandlerOptions): Promise<DescribeIndexCommandOutput>;
325
376
  describeIndex(args: DescribeIndexCommandInput, cb: (err: any, data?: DescribeIndexCommandOutput) => void): void;
@@ -339,7 +390,8 @@ export declare class Kendra extends KendraClient {
339
390
  describePrincipalMapping(args: DescribePrincipalMappingCommandInput, cb: (err: any, data?: DescribePrincipalMappingCommandOutput) => void): void;
340
391
  describePrincipalMapping(args: DescribePrincipalMappingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePrincipalMappingCommandOutput) => void): void;
341
392
  /**
342
- * <p>Describes a block list used for query suggestions for an index.</p>
393
+ * <p>Gets information about a block list used for query suggestions for
394
+ * an index.</p>
343
395
  * <p>This is used to check the current settings that are applied to a
344
396
  * block list.</p>
345
397
  * <p>
@@ -350,7 +402,7 @@ export declare class Kendra extends KendraClient {
350
402
  describeQuerySuggestionsBlockList(args: DescribeQuerySuggestionsBlockListCommandInput, cb: (err: any, data?: DescribeQuerySuggestionsBlockListCommandOutput) => void): void;
351
403
  describeQuerySuggestionsBlockList(args: DescribeQuerySuggestionsBlockListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeQuerySuggestionsBlockListCommandOutput) => void): void;
352
404
  /**
353
- * <p>Describes the settings of query suggestions for an index.</p>
405
+ * <p>Gets information on the settings of query suggestions for an index.</p>
354
406
  * <p>This is used to check the current settings applied
355
407
  * to query suggestions.</p>
356
408
  * <p>
@@ -361,7 +413,7 @@ export declare class Kendra extends KendraClient {
361
413
  describeQuerySuggestionsConfig(args: DescribeQuerySuggestionsConfigCommandInput, cb: (err: any, data?: DescribeQuerySuggestionsConfigCommandOutput) => void): void;
362
414
  describeQuerySuggestionsConfig(args: DescribeQuerySuggestionsConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeQuerySuggestionsConfigCommandOutput) => void): void;
363
415
  /**
364
- * <p>Describes an existing Amazon Kendra thesaurus.</p>
416
+ * <p>Gets information about an existing Amazon Kendra thesaurus.</p>
365
417
  */
366
418
  describeThesaurus(args: DescribeThesaurusCommandInput, options?: __HttpHandlerOptions): Promise<DescribeThesaurusCommandOutput>;
367
419
  describeThesaurus(args: DescribeThesaurusCommandInput, cb: (err: any, data?: DescribeThesaurusCommandOutput) => void): void;
@@ -403,6 +455,15 @@ export declare class Kendra extends KendraClient {
403
455
  getSnapshots(args: GetSnapshotsCommandInput, options?: __HttpHandlerOptions): Promise<GetSnapshotsCommandOutput>;
404
456
  getSnapshots(args: GetSnapshotsCommandInput, cb: (err: any, data?: GetSnapshotsCommandOutput) => void): void;
405
457
  getSnapshots(args: GetSnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSnapshotsCommandOutput) => void): void;
458
+ /**
459
+ * <p>Lists one or more access control configurations for an index. This
460
+ * includes user and group access information for your documents. This
461
+ * is useful for user context filtering, where search results are filtered
462
+ * based on the user or their group access to documents.</p>
463
+ */
464
+ listAccessControlConfigurations(args: ListAccessControlConfigurationsCommandInput, options?: __HttpHandlerOptions): Promise<ListAccessControlConfigurationsCommandOutput>;
465
+ listAccessControlConfigurations(args: ListAccessControlConfigurationsCommandInput, cb: (err: any, data?: ListAccessControlConfigurationsCommandOutput) => void): void;
466
+ listAccessControlConfigurations(args: ListAccessControlConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccessControlConfigurationsCommandOutput) => void): void;
406
467
  /**
407
468
  * <p>Lists the data sources that you have created.</p>
408
469
  */
@@ -484,7 +545,7 @@ export declare class Kendra extends KendraClient {
484
545
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
485
546
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
486
547
  /**
487
- * <p>Lists the Amazon Kendra thesauri associated with an index.</p>
548
+ * <p>Lists the thesauri for an index.</p>
488
549
  */
489
550
  listThesauri(args: ListThesauriCommandInput, options?: __HttpHandlerOptions): Promise<ListThesauriCommandOutput>;
490
551
  listThesauri(args: ListThesauriCommandInput, cb: (err: any, data?: ListThesauriCommandOutput) => void): void;
@@ -499,9 +560,9 @@ export declare class Kendra extends KendraClient {
499
560
  * in research and engineering, and therefore belong in the intellectual
500
561
  * property group, can see top-secret company documents in their search
501
562
  * results.</p>
502
- * <p>You map users to their groups when you want to filter search results
503
- * for different users based on their group’s access to documents. For more
504
- * information on filtering search results for different users, see
563
+ * <p>This is useful for user context filtering, where search results are
564
+ * filtered based on the user or their group access to documents. For more
565
+ * information, see
505
566
  * <a href="https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html">Filtering
506
567
  * on user context</a>.</p>
507
568
  * <p>If more than five <code>PUT</code> actions for a group are currently
@@ -579,6 +640,31 @@ export declare class Kendra extends KendraClient {
579
640
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
580
641
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
581
642
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
643
+ /**
644
+ * <p>Updates an access control configuration for your documents in an index. This
645
+ * includes user and group access information for your documents. This is useful
646
+ * for user context filtering, where search results are filtered based on the user
647
+ * or their group access to documents.</p>
648
+ * <p>You can update an access control configuration you created without indexing all
649
+ * of your documents again. For example, your index contains top-secret company
650
+ * documents that only certain employees or users should access. You created an 'allow'
651
+ * access control configuration for one user who recently joined the 'top-secret' team,
652
+ * switching from a team with 'deny' access to top-secret documents. However, the user
653
+ * suddenly returns to their previous team and should no longer have access to top secret
654
+ * documents. You can update the access control configuration to re-configure access
655
+ * control for your documents as circumstances change.</p>
656
+ * <p>You call the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">BatchPutDocument</a> API to
657
+ * apply the updated access control configuration, with the
658
+ * <code>AccessControlConfigurationId</code> included in the
659
+ * <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html">Document</a>
660
+ * object. If you use an S3 bucket as a data source, you synchronize your data source to
661
+ * apply the <code>AccessControlConfigurationId</code> in the <code>.metadata.json</code> file.
662
+ * Amazon Kendra currently only supports access control configuration for S3 data
663
+ * sources and documents indexed using the <code>BatchPutDocument</code> API.</p>
664
+ */
665
+ updateAccessControlConfiguration(args: UpdateAccessControlConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<UpdateAccessControlConfigurationCommandOutput>;
666
+ updateAccessControlConfiguration(args: UpdateAccessControlConfigurationCommandInput, cb: (err: any, data?: UpdateAccessControlConfigurationCommandOutput) => void): void;
667
+ updateAccessControlConfiguration(args: UpdateAccessControlConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAccessControlConfigurationCommandOutput) => void): void;
582
668
  /**
583
669
  * <p>Updates an existing Amazon Kendra data source.</p>
584
670
  */
@@ -633,7 +719,7 @@ export declare class Kendra extends KendraClient {
633
719
  updateQuerySuggestionsConfig(args: UpdateQuerySuggestionsConfigCommandInput, cb: (err: any, data?: UpdateQuerySuggestionsConfigCommandOutput) => void): void;
634
720
  updateQuerySuggestionsConfig(args: UpdateQuerySuggestionsConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateQuerySuggestionsConfigCommandOutput) => void): void;
635
721
  /**
636
- * <p>Updates a thesaurus file associated with an index.</p>
722
+ * <p>Updates a thesaurus for an index.</p>
637
723
  */
638
724
  updateThesaurus(args: UpdateThesaurusCommandInput, options?: __HttpHandlerOptions): Promise<UpdateThesaurusCommandOutput>;
639
725
  updateThesaurus(args: UpdateThesaurusCommandInput, cb: (err: any, data?: UpdateThesaurusCommandOutput) => void): void;
@@ -12,12 +12,14 @@ import { BatchDeleteDocumentCommandInput, BatchDeleteDocumentCommandOutput } fro
12
12
  import { BatchGetDocumentStatusCommandInput, BatchGetDocumentStatusCommandOutput } from "./commands/BatchGetDocumentStatusCommand";
13
13
  import { BatchPutDocumentCommandInput, BatchPutDocumentCommandOutput } from "./commands/BatchPutDocumentCommand";
14
14
  import { ClearQuerySuggestionsCommandInput, ClearQuerySuggestionsCommandOutput } from "./commands/ClearQuerySuggestionsCommand";
15
+ import { CreateAccessControlConfigurationCommandInput, CreateAccessControlConfigurationCommandOutput } from "./commands/CreateAccessControlConfigurationCommand";
15
16
  import { CreateDataSourceCommandInput, CreateDataSourceCommandOutput } from "./commands/CreateDataSourceCommand";
16
17
  import { CreateExperienceCommandInput, CreateExperienceCommandOutput } from "./commands/CreateExperienceCommand";
17
18
  import { CreateFaqCommandInput, CreateFaqCommandOutput } from "./commands/CreateFaqCommand";
18
19
  import { CreateIndexCommandInput, CreateIndexCommandOutput } from "./commands/CreateIndexCommand";
19
20
  import { CreateQuerySuggestionsBlockListCommandInput, CreateQuerySuggestionsBlockListCommandOutput } from "./commands/CreateQuerySuggestionsBlockListCommand";
20
21
  import { CreateThesaurusCommandInput, CreateThesaurusCommandOutput } from "./commands/CreateThesaurusCommand";
22
+ import { DeleteAccessControlConfigurationCommandInput, DeleteAccessControlConfigurationCommandOutput } from "./commands/DeleteAccessControlConfigurationCommand";
21
23
  import { DeleteDataSourceCommandInput, DeleteDataSourceCommandOutput } from "./commands/DeleteDataSourceCommand";
22
24
  import { DeleteExperienceCommandInput, DeleteExperienceCommandOutput } from "./commands/DeleteExperienceCommand";
23
25
  import { DeleteFaqCommandInput, DeleteFaqCommandOutput } from "./commands/DeleteFaqCommand";
@@ -25,6 +27,7 @@ import { DeleteIndexCommandInput, DeleteIndexCommandOutput } from "./commands/De
25
27
  import { DeletePrincipalMappingCommandInput, DeletePrincipalMappingCommandOutput } from "./commands/DeletePrincipalMappingCommand";
26
28
  import { DeleteQuerySuggestionsBlockListCommandInput, DeleteQuerySuggestionsBlockListCommandOutput } from "./commands/DeleteQuerySuggestionsBlockListCommand";
27
29
  import { DeleteThesaurusCommandInput, DeleteThesaurusCommandOutput } from "./commands/DeleteThesaurusCommand";
30
+ import { DescribeAccessControlConfigurationCommandInput, DescribeAccessControlConfigurationCommandOutput } from "./commands/DescribeAccessControlConfigurationCommand";
28
31
  import { DescribeDataSourceCommandInput, DescribeDataSourceCommandOutput } from "./commands/DescribeDataSourceCommand";
29
32
  import { DescribeExperienceCommandInput, DescribeExperienceCommandOutput } from "./commands/DescribeExperienceCommand";
30
33
  import { DescribeFaqCommandInput, DescribeFaqCommandOutput } from "./commands/DescribeFaqCommand";
@@ -37,6 +40,7 @@ import { DisassociateEntitiesFromExperienceCommandInput, DisassociateEntitiesFro
37
40
  import { DisassociatePersonasFromEntitiesCommandInput, DisassociatePersonasFromEntitiesCommandOutput } from "./commands/DisassociatePersonasFromEntitiesCommand";
38
41
  import { GetQuerySuggestionsCommandInput, GetQuerySuggestionsCommandOutput } from "./commands/GetQuerySuggestionsCommand";
39
42
  import { GetSnapshotsCommandInput, GetSnapshotsCommandOutput } from "./commands/GetSnapshotsCommand";
43
+ import { ListAccessControlConfigurationsCommandInput, ListAccessControlConfigurationsCommandOutput } from "./commands/ListAccessControlConfigurationsCommand";
40
44
  import { ListDataSourcesCommandInput, ListDataSourcesCommandOutput } from "./commands/ListDataSourcesCommand";
41
45
  import { ListDataSourceSyncJobsCommandInput, ListDataSourceSyncJobsCommandOutput } from "./commands/ListDataSourceSyncJobsCommand";
42
46
  import { ListEntityPersonasCommandInput, ListEntityPersonasCommandOutput } from "./commands/ListEntityPersonasCommand";
@@ -55,14 +59,15 @@ import { StopDataSourceSyncJobCommandInput, StopDataSourceSyncJobCommandOutput }
55
59
  import { SubmitFeedbackCommandInput, SubmitFeedbackCommandOutput } from "./commands/SubmitFeedbackCommand";
56
60
  import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
57
61
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
62
+ import { UpdateAccessControlConfigurationCommandInput, UpdateAccessControlConfigurationCommandOutput } from "./commands/UpdateAccessControlConfigurationCommand";
58
63
  import { UpdateDataSourceCommandInput, UpdateDataSourceCommandOutput } from "./commands/UpdateDataSourceCommand";
59
64
  import { UpdateExperienceCommandInput, UpdateExperienceCommandOutput } from "./commands/UpdateExperienceCommand";
60
65
  import { UpdateIndexCommandInput, UpdateIndexCommandOutput } from "./commands/UpdateIndexCommand";
61
66
  import { UpdateQuerySuggestionsBlockListCommandInput, UpdateQuerySuggestionsBlockListCommandOutput } from "./commands/UpdateQuerySuggestionsBlockListCommand";
62
67
  import { UpdateQuerySuggestionsConfigCommandInput, UpdateQuerySuggestionsConfigCommandOutput } from "./commands/UpdateQuerySuggestionsConfigCommand";
63
68
  import { UpdateThesaurusCommandInput, UpdateThesaurusCommandOutput } from "./commands/UpdateThesaurusCommand";
64
- export declare type ServiceInputTypes = AssociateEntitiesToExperienceCommandInput | AssociatePersonasToEntitiesCommandInput | BatchDeleteDocumentCommandInput | BatchGetDocumentStatusCommandInput | BatchPutDocumentCommandInput | ClearQuerySuggestionsCommandInput | CreateDataSourceCommandInput | CreateExperienceCommandInput | CreateFaqCommandInput | CreateIndexCommandInput | CreateQuerySuggestionsBlockListCommandInput | CreateThesaurusCommandInput | DeleteDataSourceCommandInput | DeleteExperienceCommandInput | DeleteFaqCommandInput | DeleteIndexCommandInput | DeletePrincipalMappingCommandInput | DeleteQuerySuggestionsBlockListCommandInput | DeleteThesaurusCommandInput | DescribeDataSourceCommandInput | DescribeExperienceCommandInput | DescribeFaqCommandInput | DescribeIndexCommandInput | DescribePrincipalMappingCommandInput | DescribeQuerySuggestionsBlockListCommandInput | DescribeQuerySuggestionsConfigCommandInput | DescribeThesaurusCommandInput | DisassociateEntitiesFromExperienceCommandInput | DisassociatePersonasFromEntitiesCommandInput | GetQuerySuggestionsCommandInput | GetSnapshotsCommandInput | ListDataSourceSyncJobsCommandInput | ListDataSourcesCommandInput | ListEntityPersonasCommandInput | ListExperienceEntitiesCommandInput | ListExperiencesCommandInput | ListFaqsCommandInput | ListGroupsOlderThanOrderingIdCommandInput | ListIndicesCommandInput | ListQuerySuggestionsBlockListsCommandInput | ListTagsForResourceCommandInput | ListThesauriCommandInput | PutPrincipalMappingCommandInput | QueryCommandInput | StartDataSourceSyncJobCommandInput | StopDataSourceSyncJobCommandInput | SubmitFeedbackCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateDataSourceCommandInput | UpdateExperienceCommandInput | UpdateIndexCommandInput | UpdateQuerySuggestionsBlockListCommandInput | UpdateQuerySuggestionsConfigCommandInput | UpdateThesaurusCommandInput;
65
- export declare type ServiceOutputTypes = AssociateEntitiesToExperienceCommandOutput | AssociatePersonasToEntitiesCommandOutput | BatchDeleteDocumentCommandOutput | BatchGetDocumentStatusCommandOutput | BatchPutDocumentCommandOutput | ClearQuerySuggestionsCommandOutput | CreateDataSourceCommandOutput | CreateExperienceCommandOutput | CreateFaqCommandOutput | CreateIndexCommandOutput | CreateQuerySuggestionsBlockListCommandOutput | CreateThesaurusCommandOutput | DeleteDataSourceCommandOutput | DeleteExperienceCommandOutput | DeleteFaqCommandOutput | DeleteIndexCommandOutput | DeletePrincipalMappingCommandOutput | DeleteQuerySuggestionsBlockListCommandOutput | DeleteThesaurusCommandOutput | DescribeDataSourceCommandOutput | DescribeExperienceCommandOutput | DescribeFaqCommandOutput | DescribeIndexCommandOutput | DescribePrincipalMappingCommandOutput | DescribeQuerySuggestionsBlockListCommandOutput | DescribeQuerySuggestionsConfigCommandOutput | DescribeThesaurusCommandOutput | DisassociateEntitiesFromExperienceCommandOutput | DisassociatePersonasFromEntitiesCommandOutput | GetQuerySuggestionsCommandOutput | GetSnapshotsCommandOutput | ListDataSourceSyncJobsCommandOutput | ListDataSourcesCommandOutput | ListEntityPersonasCommandOutput | ListExperienceEntitiesCommandOutput | ListExperiencesCommandOutput | ListFaqsCommandOutput | ListGroupsOlderThanOrderingIdCommandOutput | ListIndicesCommandOutput | ListQuerySuggestionsBlockListsCommandOutput | ListTagsForResourceCommandOutput | ListThesauriCommandOutput | PutPrincipalMappingCommandOutput | QueryCommandOutput | StartDataSourceSyncJobCommandOutput | StopDataSourceSyncJobCommandOutput | SubmitFeedbackCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateDataSourceCommandOutput | UpdateExperienceCommandOutput | UpdateIndexCommandOutput | UpdateQuerySuggestionsBlockListCommandOutput | UpdateQuerySuggestionsConfigCommandOutput | UpdateThesaurusCommandOutput;
69
+ export declare type ServiceInputTypes = AssociateEntitiesToExperienceCommandInput | AssociatePersonasToEntitiesCommandInput | BatchDeleteDocumentCommandInput | BatchGetDocumentStatusCommandInput | BatchPutDocumentCommandInput | ClearQuerySuggestionsCommandInput | CreateAccessControlConfigurationCommandInput | CreateDataSourceCommandInput | CreateExperienceCommandInput | CreateFaqCommandInput | CreateIndexCommandInput | CreateQuerySuggestionsBlockListCommandInput | CreateThesaurusCommandInput | DeleteAccessControlConfigurationCommandInput | DeleteDataSourceCommandInput | DeleteExperienceCommandInput | DeleteFaqCommandInput | DeleteIndexCommandInput | DeletePrincipalMappingCommandInput | DeleteQuerySuggestionsBlockListCommandInput | DeleteThesaurusCommandInput | DescribeAccessControlConfigurationCommandInput | DescribeDataSourceCommandInput | DescribeExperienceCommandInput | DescribeFaqCommandInput | DescribeIndexCommandInput | DescribePrincipalMappingCommandInput | DescribeQuerySuggestionsBlockListCommandInput | DescribeQuerySuggestionsConfigCommandInput | DescribeThesaurusCommandInput | DisassociateEntitiesFromExperienceCommandInput | DisassociatePersonasFromEntitiesCommandInput | GetQuerySuggestionsCommandInput | GetSnapshotsCommandInput | ListAccessControlConfigurationsCommandInput | ListDataSourceSyncJobsCommandInput | ListDataSourcesCommandInput | ListEntityPersonasCommandInput | ListExperienceEntitiesCommandInput | ListExperiencesCommandInput | ListFaqsCommandInput | ListGroupsOlderThanOrderingIdCommandInput | ListIndicesCommandInput | ListQuerySuggestionsBlockListsCommandInput | ListTagsForResourceCommandInput | ListThesauriCommandInput | PutPrincipalMappingCommandInput | QueryCommandInput | StartDataSourceSyncJobCommandInput | StopDataSourceSyncJobCommandInput | SubmitFeedbackCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateAccessControlConfigurationCommandInput | UpdateDataSourceCommandInput | UpdateExperienceCommandInput | UpdateIndexCommandInput | UpdateQuerySuggestionsBlockListCommandInput | UpdateQuerySuggestionsConfigCommandInput | UpdateThesaurusCommandInput;
70
+ export declare type ServiceOutputTypes = AssociateEntitiesToExperienceCommandOutput | AssociatePersonasToEntitiesCommandOutput | BatchDeleteDocumentCommandOutput | BatchGetDocumentStatusCommandOutput | BatchPutDocumentCommandOutput | ClearQuerySuggestionsCommandOutput | CreateAccessControlConfigurationCommandOutput | CreateDataSourceCommandOutput | CreateExperienceCommandOutput | CreateFaqCommandOutput | CreateIndexCommandOutput | CreateQuerySuggestionsBlockListCommandOutput | CreateThesaurusCommandOutput | DeleteAccessControlConfigurationCommandOutput | DeleteDataSourceCommandOutput | DeleteExperienceCommandOutput | DeleteFaqCommandOutput | DeleteIndexCommandOutput | DeletePrincipalMappingCommandOutput | DeleteQuerySuggestionsBlockListCommandOutput | DeleteThesaurusCommandOutput | DescribeAccessControlConfigurationCommandOutput | DescribeDataSourceCommandOutput | DescribeExperienceCommandOutput | DescribeFaqCommandOutput | DescribeIndexCommandOutput | DescribePrincipalMappingCommandOutput | DescribeQuerySuggestionsBlockListCommandOutput | DescribeQuerySuggestionsConfigCommandOutput | DescribeThesaurusCommandOutput | DisassociateEntitiesFromExperienceCommandOutput | DisassociatePersonasFromEntitiesCommandOutput | GetQuerySuggestionsCommandOutput | GetSnapshotsCommandOutput | ListAccessControlConfigurationsCommandOutput | ListDataSourceSyncJobsCommandOutput | ListDataSourcesCommandOutput | ListEntityPersonasCommandOutput | ListExperienceEntitiesCommandOutput | ListExperiencesCommandOutput | ListFaqsCommandOutput | ListGroupsOlderThanOrderingIdCommandOutput | ListIndicesCommandOutput | ListQuerySuggestionsBlockListsCommandOutput | ListTagsForResourceCommandOutput | ListThesauriCommandOutput | PutPrincipalMappingCommandOutput | QueryCommandOutput | StartDataSourceSyncJobCommandOutput | StopDataSourceSyncJobCommandOutput | SubmitFeedbackCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateAccessControlConfigurationCommandOutput | UpdateDataSourceCommandOutput | UpdateExperienceCommandOutput | UpdateIndexCommandOutput | UpdateQuerySuggestionsBlockListCommandOutput | UpdateQuerySuggestionsConfigCommandOutput | UpdateThesaurusCommandOutput;
66
71
  export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
67
72
  /**
68
73
  * The HTTP handler to use. Fetch in browser and Https in Nodejs.
@@ -0,0 +1,57 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
4
+ import { CreateAccessControlConfigurationRequest, CreateAccessControlConfigurationResponse } from "../models/models_0";
5
+ export interface CreateAccessControlConfigurationCommandInput extends CreateAccessControlConfigurationRequest {
6
+ }
7
+ export interface CreateAccessControlConfigurationCommandOutput extends CreateAccessControlConfigurationResponse, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Creates an access configuration for your documents. This includes
11
+ * user and group access information for your documents. This is useful
12
+ * for user context filtering, where search results are filtered based
13
+ * on the user or their group access to documents.</p>
14
+ * <p>You can use this to re-configure your existing document level access control without
15
+ * indexing all of your documents again. For example, your index contains top-secret
16
+ * company documents that only certain employees or users should access. One of these users
17
+ * leaves the company or switches to a team that should be blocked from accessing
18
+ * top-secret documents. The user still has access to top-secret documents because the user
19
+ * had access when your documents were previously indexed. You
20
+ * can create a specific access control configuration for the user with deny
21
+ * access. You can later update the access control configuration to allow access if the
22
+ * user returns to the company and re-joins the 'top-secret' team. You can re-configure
23
+ * access control for your documents as circumstances change.</p>
24
+ * <p>To apply your access control configuration to certain documents, you call
25
+ * the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">BatchPutDocument</a>
26
+ * API with the <code>AccessControlConfigurationId</code> included in the
27
+ * <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html">Document</a>
28
+ * object. If you use an S3 bucket as a data source, you update the
29
+ * <code>.metadata.json</code> with the <code>AccessControlConfigurationId</code>
30
+ * and synchronize your data source. Amazon Kendra currently only supports
31
+ * access control configuration for S3 data sources and documents indexed using the
32
+ * <code>BatchPutDocument</code> API.</p>
33
+ * @example
34
+ * Use a bare-bones client and the command you need to make an API call.
35
+ * ```javascript
36
+ * import { KendraClient, CreateAccessControlConfigurationCommand } from "@aws-sdk/client-kendra"; // ES Modules import
37
+ * // const { KendraClient, CreateAccessControlConfigurationCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
38
+ * const client = new KendraClient(config);
39
+ * const command = new CreateAccessControlConfigurationCommand(input);
40
+ * const response = await client.send(command);
41
+ * ```
42
+ *
43
+ * @see {@link CreateAccessControlConfigurationCommandInput} for command's `input` shape.
44
+ * @see {@link CreateAccessControlConfigurationCommandOutput} for command's `response` shape.
45
+ * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
46
+ *
47
+ */
48
+ export declare class CreateAccessControlConfigurationCommand extends $Command<CreateAccessControlConfigurationCommandInput, CreateAccessControlConfigurationCommandOutput, KendraClientResolvedConfig> {
49
+ readonly input: CreateAccessControlConfigurationCommandInput;
50
+ constructor(input: CreateAccessControlConfigurationCommandInput);
51
+ /**
52
+ * @internal
53
+ */
54
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateAccessControlConfigurationCommandInput, CreateAccessControlConfigurationCommandOutput>;
55
+ private serialize;
56
+ private deserialize;
57
+ }
@@ -10,7 +10,7 @@ export interface CreateFaqCommandOutput extends CreateFaqResponse, __MetadataBea
10
10
  * <p>Creates an new set of frequently asked question (FAQ) questions and answers.</p>
11
11
  * <p>Adding FAQs to an index is an asynchronous operation.</p>
12
12
  * <p>For an example of adding an FAQ to an index using Python and Java SDKs,
13
- * see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html#using-faq-file">Using you
13
+ * see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html#using-faq-file">Using your
14
14
  * FAQ file</a>.</p>
15
15
  * @example
16
16
  * Use a bare-bones client and the command you need to make an API call.
@@ -7,7 +7,7 @@ export interface CreateIndexCommandInput extends CreateIndexRequest {
7
7
  export interface CreateIndexCommandOutput extends CreateIndexResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Creates a new Amazon Kendra index. Index creation is an asynchronous
10
+ * <p>Creates an Amazon Kendra index. Index creation is an asynchronous
11
11
  * API. To determine if index creation has completed, check the
12
12
  * <code>Status</code> field returned from a call to
13
13
  * <code>DescribeIndex</code>. The <code>Status</code> field is set to
@@ -0,0 +1,38 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
4
+ import { DeleteAccessControlConfigurationRequest, DeleteAccessControlConfigurationResponse } from "../models/models_0";
5
+ export interface DeleteAccessControlConfigurationCommandInput extends DeleteAccessControlConfigurationRequest {
6
+ }
7
+ export interface DeleteAccessControlConfigurationCommandOutput extends DeleteAccessControlConfigurationResponse, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Deletes an access control configuration that you created for your
11
+ * documents in an index. This includes user and group access information
12
+ * for your documents. This is useful for user context filtering, where search
13
+ * results are filtered based on the user or their group access to documents.</p>
14
+ * @example
15
+ * Use a bare-bones client and the command you need to make an API call.
16
+ * ```javascript
17
+ * import { KendraClient, DeleteAccessControlConfigurationCommand } from "@aws-sdk/client-kendra"; // ES Modules import
18
+ * // const { KendraClient, DeleteAccessControlConfigurationCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
19
+ * const client = new KendraClient(config);
20
+ * const command = new DeleteAccessControlConfigurationCommand(input);
21
+ * const response = await client.send(command);
22
+ * ```
23
+ *
24
+ * @see {@link DeleteAccessControlConfigurationCommandInput} for command's `input` shape.
25
+ * @see {@link DeleteAccessControlConfigurationCommandOutput} for command's `response` shape.
26
+ * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
27
+ *
28
+ */
29
+ export declare class DeleteAccessControlConfigurationCommand extends $Command<DeleteAccessControlConfigurationCommandInput, DeleteAccessControlConfigurationCommandOutput, KendraClientResolvedConfig> {
30
+ readonly input: DeleteAccessControlConfigurationCommandInput;
31
+ constructor(input: DeleteAccessControlConfigurationCommandInput);
32
+ /**
33
+ * @internal
34
+ */
35
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteAccessControlConfigurationCommandInput, DeleteAccessControlConfigurationCommandOutput>;
36
+ private serialize;
37
+ private deserialize;
38
+ }
@@ -0,0 +1,38 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
4
+ import { DescribeAccessControlConfigurationRequest, DescribeAccessControlConfigurationResponse } from "../models/models_0";
5
+ export interface DescribeAccessControlConfigurationCommandInput extends DescribeAccessControlConfigurationRequest {
6
+ }
7
+ export interface DescribeAccessControlConfigurationCommandOutput extends DescribeAccessControlConfigurationResponse, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Gets information about an access control configuration that you created for your
11
+ * documents in an index. This includes user and group access information for your
12
+ * documents. This is useful for user context filtering, where search results are
13
+ * filtered based on the user or their group access to documents.</p>
14
+ * @example
15
+ * Use a bare-bones client and the command you need to make an API call.
16
+ * ```javascript
17
+ * import { KendraClient, DescribeAccessControlConfigurationCommand } from "@aws-sdk/client-kendra"; // ES Modules import
18
+ * // const { KendraClient, DescribeAccessControlConfigurationCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
19
+ * const client = new KendraClient(config);
20
+ * const command = new DescribeAccessControlConfigurationCommand(input);
21
+ * const response = await client.send(command);
22
+ * ```
23
+ *
24
+ * @see {@link DescribeAccessControlConfigurationCommandInput} for command's `input` shape.
25
+ * @see {@link DescribeAccessControlConfigurationCommandOutput} for command's `response` shape.
26
+ * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
27
+ *
28
+ */
29
+ export declare class DescribeAccessControlConfigurationCommand extends $Command<DescribeAccessControlConfigurationCommandInput, DescribeAccessControlConfigurationCommandOutput, KendraClientResolvedConfig> {
30
+ readonly input: DescribeAccessControlConfigurationCommandInput;
31
+ constructor(input: DescribeAccessControlConfigurationCommandInput);
32
+ /**
33
+ * @internal
34
+ */
35
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeAccessControlConfigurationCommandInput, DescribeAccessControlConfigurationCommandOutput>;
36
+ private serialize;
37
+ private deserialize;
38
+ }
@@ -7,7 +7,7 @@ export interface DescribeIndexCommandInput extends DescribeIndexRequest {
7
7
  export interface DescribeIndexCommandOutput extends DescribeIndexResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Describes an existing Amazon Kendra index.</p>
10
+ * <p>Gets information about an existing Amazon Kendra index.</p>
11
11
  * @example
12
12
  * Use a bare-bones client and the command you need to make an API call.
13
13
  * ```javascript
@@ -7,7 +7,8 @@ export interface DescribeQuerySuggestionsBlockListCommandInput extends DescribeQ
7
7
  export interface DescribeQuerySuggestionsBlockListCommandOutput extends DescribeQuerySuggestionsBlockListResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Describes a block list used for query suggestions for an index.</p>
10
+ * <p>Gets information about a block list used for query suggestions for
11
+ * an index.</p>
11
12
  * <p>This is used to check the current settings that are applied to a
12
13
  * block list.</p>
13
14
  * <p>
@@ -7,7 +7,7 @@ export interface DescribeQuerySuggestionsConfigCommandInput extends DescribeQuer
7
7
  export interface DescribeQuerySuggestionsConfigCommandOutput extends DescribeQuerySuggestionsConfigResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Describes the settings of query suggestions for an index.</p>
10
+ * <p>Gets information on the settings of query suggestions for an index.</p>
11
11
  * <p>This is used to check the current settings applied
12
12
  * to query suggestions.</p>
13
13
  * <p>
@@ -7,7 +7,7 @@ export interface DescribeThesaurusCommandInput extends DescribeThesaurusRequest
7
7
  export interface DescribeThesaurusCommandOutput extends DescribeThesaurusResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Describes an existing Amazon Kendra thesaurus.</p>
10
+ * <p>Gets information about an existing Amazon Kendra thesaurus.</p>
11
11
  * @example
12
12
  * Use a bare-bones client and the command you need to make an API call.
13
13
  * ```javascript
@@ -0,0 +1,38 @@
1
+ import { Command as $Command } from "@aws-sdk/smithy-client";
2
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
+ import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
4
+ import { ListAccessControlConfigurationsRequest, ListAccessControlConfigurationsResponse } from "../models/models_0";
5
+ export interface ListAccessControlConfigurationsCommandInput extends ListAccessControlConfigurationsRequest {
6
+ }
7
+ export interface ListAccessControlConfigurationsCommandOutput extends ListAccessControlConfigurationsResponse, __MetadataBearer {
8
+ }
9
+ /**
10
+ * <p>Lists one or more access control configurations for an index. This
11
+ * includes user and group access information for your documents. This
12
+ * is useful for user context filtering, where search results are filtered
13
+ * based on the user or their group access to documents.</p>
14
+ * @example
15
+ * Use a bare-bones client and the command you need to make an API call.
16
+ * ```javascript
17
+ * import { KendraClient, ListAccessControlConfigurationsCommand } from "@aws-sdk/client-kendra"; // ES Modules import
18
+ * // const { KendraClient, ListAccessControlConfigurationsCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
19
+ * const client = new KendraClient(config);
20
+ * const command = new ListAccessControlConfigurationsCommand(input);
21
+ * const response = await client.send(command);
22
+ * ```
23
+ *
24
+ * @see {@link ListAccessControlConfigurationsCommandInput} for command's `input` shape.
25
+ * @see {@link ListAccessControlConfigurationsCommandOutput} for command's `response` shape.
26
+ * @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
27
+ *
28
+ */
29
+ export declare class ListAccessControlConfigurationsCommand extends $Command<ListAccessControlConfigurationsCommandInput, ListAccessControlConfigurationsCommandOutput, KendraClientResolvedConfig> {
30
+ readonly input: ListAccessControlConfigurationsCommandInput;
31
+ constructor(input: ListAccessControlConfigurationsCommandInput);
32
+ /**
33
+ * @internal
34
+ */
35
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListAccessControlConfigurationsCommandInput, ListAccessControlConfigurationsCommandOutput>;
36
+ private serialize;
37
+ private deserialize;
38
+ }
@@ -7,7 +7,7 @@ export interface ListThesauriCommandInput extends ListThesauriRequest {
7
7
  export interface ListThesauriCommandOutput extends ListThesauriResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Lists the Amazon Kendra thesauri associated with an index.</p>
10
+ * <p>Lists the thesauri for an index.</p>
11
11
  * @example
12
12
  * Use a bare-bones client and the command you need to make an API call.
13
13
  * ```javascript
@@ -16,9 +16,9 @@ export interface PutPrincipalMappingCommandOutput extends __MetadataBearer {
16
16
  * in research and engineering, and therefore belong in the intellectual
17
17
  * property group, can see top-secret company documents in their search
18
18
  * results.</p>
19
- * <p>You map users to their groups when you want to filter search results
20
- * for different users based on their group’s access to documents. For more
21
- * information on filtering search results for different users, see
19
+ * <p>This is useful for user context filtering, where search results are
20
+ * filtered based on the user or their group access to documents. For more
21
+ * information, see
22
22
  * <a href="https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html">Filtering
23
23
  * on user context</a>.</p>
24
24
  * <p>If more than five <code>PUT</code> actions for a group are currently
@@ -1,7 +1,7 @@
1
1
  import { Command as $Command } from "@aws-sdk/smithy-client";
2
2
  import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
3
3
  import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
4
- import { QueryRequest, QueryResult } from "../models/models_0";
4
+ import { QueryRequest, QueryResult } from "../models/models_1";
5
5
  export interface QueryCommandInput extends QueryRequest {
6
6
  }
7
7
  export interface QueryCommandOutput extends QueryResult, __MetadataBearer {