@aws-sdk/client-kendra 3.127.0 → 3.131.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 +32 -0
- package/dist-cjs/Kendra.js +75 -0
- package/dist-cjs/commands/CreateAccessControlConfigurationCommand.js +36 -0
- package/dist-cjs/commands/DeleteAccessControlConfigurationCommand.js +36 -0
- package/dist-cjs/commands/DescribeAccessControlConfigurationCommand.js +36 -0
- package/dist-cjs/commands/ListAccessControlConfigurationsCommand.js +36 -0
- package/dist-cjs/commands/QueryCommand.js +2 -1
- package/dist-cjs/commands/UpdateAccessControlConfigurationCommand.js +36 -0
- package/dist-cjs/commands/index.js +5 -0
- package/dist-cjs/models/index.js +1 -0
- package/dist-cjs/models/models_0.js +72 -12
- package/dist-cjs/models/models_1.js +9 -0
- package/dist-cjs/pagination/ListAccessControlConfigurationsPaginator.js +36 -0
- package/dist-cjs/pagination/index.js +1 -0
- package/dist-cjs/protocols/Aws_json1_1.js +450 -3
- package/dist-es/Kendra.js +75 -0
- package/dist-es/commands/CreateAccessControlConfigurationCommand.js +39 -0
- package/dist-es/commands/DeleteAccessControlConfigurationCommand.js +39 -0
- package/dist-es/commands/DescribeAccessControlConfigurationCommand.js +39 -0
- package/dist-es/commands/ListAccessControlConfigurationsCommand.js +39 -0
- package/dist-es/commands/QueryCommand.js +2 -1
- package/dist-es/commands/UpdateAccessControlConfigurationCommand.js +39 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +44 -4
- package/dist-es/models/models_1.js +5 -0
- package/dist-es/pagination/ListAccessControlConfigurationsPaginator.js +75 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_json1_1.js +523 -1
- package/dist-types/Kendra.d.ts +99 -11
- package/dist-types/KendraClient.d.ts +7 -2
- package/dist-types/commands/CreateAccessControlConfigurationCommand.d.ts +59 -0
- package/dist-types/commands/CreateFaqCommand.d.ts +1 -1
- package/dist-types/commands/CreateIndexCommand.d.ts +1 -1
- package/dist-types/commands/DeleteAccessControlConfigurationCommand.d.ts +38 -0
- package/dist-types/commands/DescribeAccessControlConfigurationCommand.d.ts +38 -0
- package/dist-types/commands/DescribeIndexCommand.d.ts +1 -1
- package/dist-types/commands/DescribeQuerySuggestionsBlockListCommand.d.ts +2 -1
- package/dist-types/commands/DescribeQuerySuggestionsConfigCommand.d.ts +1 -1
- package/dist-types/commands/DescribeThesaurusCommand.d.ts +1 -1
- package/dist-types/commands/ListAccessControlConfigurationsCommand.d.ts +38 -0
- package/dist-types/commands/ListThesauriCommand.d.ts +1 -1
- package/dist-types/commands/PutPrincipalMappingCommand.d.ts +3 -3
- package/dist-types/commands/QueryCommand.d.ts +2 -1
- package/dist-types/commands/UpdateAccessControlConfigurationCommand.d.ts +54 -0
- package/dist-types/commands/UpdateThesaurusCommand.d.ts +1 -1
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +411 -271
- package/dist-types/models/models_1.d.ts +95 -0
- package/dist-types/pagination/ListAccessControlConfigurationsPaginator.d.ts +4 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_json1_1.d.ts +15 -0
- package/dist-types/ts3.4/Kendra.d.ts +25 -0
- package/dist-types/ts3.4/KendraClient.d.ts +7 -2
- package/dist-types/ts3.4/commands/CreateAccessControlConfigurationCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DeleteAccessControlConfigurationCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/DescribeAccessControlConfigurationCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/ListAccessControlConfigurationsCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/QueryCommand.d.ts +2 -1
- package/dist-types/ts3.4/commands/UpdateAccessControlConfigurationCommand.d.ts +17 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/models/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +125 -32
- package/dist-types/ts3.4/models/models_1.d.ts +33 -0
- package/dist-types/ts3.4/pagination/ListAccessControlConfigurationsPaginator.d.ts +4 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +15 -0
- package/package.json +7 -7
package/dist-types/Kendra.d.ts
CHANGED
|
@@ -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,36 @@ 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
|
|
153
|
+
* control without indexing all of your documents again. For example, your
|
|
154
|
+
* index contains top-secret company documents that only certain employees
|
|
155
|
+
* or users should access. One of these users leaves the company or switches
|
|
156
|
+
* to a team that should be blocked from access to top-secret documents.
|
|
157
|
+
* Your documents in your index still give this user access to top-secret
|
|
158
|
+
* documents due to the user having access at the time your documents were
|
|
159
|
+
* indexed. You can create a specific access control configuration for this
|
|
160
|
+
* user with deny access. You can later update the access control
|
|
161
|
+
* configuration to allow access in the case the user returns to the company
|
|
162
|
+
* and re-joins the 'top-secret' team. You can re-configure access control
|
|
163
|
+
* for your documents circumstances change.</p>
|
|
164
|
+
* <p>To apply your access control configuration to certain documents, you call
|
|
165
|
+
* the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">BatchPutDocument</a>
|
|
166
|
+
* API with the <code>AccessControlConfigurationId</code> included in the
|
|
167
|
+
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html">Document</a>
|
|
168
|
+
* object. If you use an S3 bucket as a data source, you update the
|
|
169
|
+
* <code>.metadata.json</code> with the <code>AccessControlConfigurationId</code>
|
|
170
|
+
* and synchronize your data source. Amazon Kendra currently only supports
|
|
171
|
+
* access control configuration for S3 data sources and documents indexed using the
|
|
172
|
+
* <code>BatchPutDocument</code> API.</p>
|
|
173
|
+
*/
|
|
174
|
+
createAccessControlConfiguration(args: CreateAccessControlConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<CreateAccessControlConfigurationCommandOutput>;
|
|
175
|
+
createAccessControlConfiguration(args: CreateAccessControlConfigurationCommandInput, cb: (err: any, data?: CreateAccessControlConfigurationCommandOutput) => void): void;
|
|
176
|
+
createAccessControlConfiguration(args: CreateAccessControlConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccessControlConfigurationCommandOutput) => void): void;
|
|
142
177
|
/**
|
|
143
178
|
* <p>Creates a data source that you want to use with an Amazon Kendra index. </p>
|
|
144
179
|
* <p>You specify a name, data source connector type and description for
|
|
@@ -171,14 +206,14 @@ export declare class Kendra extends KendraClient {
|
|
|
171
206
|
* <p>Creates an new set of frequently asked question (FAQ) questions and answers.</p>
|
|
172
207
|
* <p>Adding FAQs to an index is an asynchronous operation.</p>
|
|
173
208
|
* <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
|
|
209
|
+
* see <a href="https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html#using-faq-file">Using your
|
|
175
210
|
* FAQ file</a>.</p>
|
|
176
211
|
*/
|
|
177
212
|
createFaq(args: CreateFaqCommandInput, options?: __HttpHandlerOptions): Promise<CreateFaqCommandOutput>;
|
|
178
213
|
createFaq(args: CreateFaqCommandInput, cb: (err: any, data?: CreateFaqCommandOutput) => void): void;
|
|
179
214
|
createFaq(args: CreateFaqCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFaqCommandOutput) => void): void;
|
|
180
215
|
/**
|
|
181
|
-
* <p>Creates
|
|
216
|
+
* <p>Creates an Amazon Kendra index. Index creation is an asynchronous
|
|
182
217
|
* API. To determine if index creation has completed, check the
|
|
183
218
|
* <code>Status</code> field returned from a call to
|
|
184
219
|
* <code>DescribeIndex</code>. The <code>Status</code> field is set to
|
|
@@ -224,6 +259,15 @@ export declare class Kendra extends KendraClient {
|
|
|
224
259
|
createThesaurus(args: CreateThesaurusCommandInput, options?: __HttpHandlerOptions): Promise<CreateThesaurusCommandOutput>;
|
|
225
260
|
createThesaurus(args: CreateThesaurusCommandInput, cb: (err: any, data?: CreateThesaurusCommandOutput) => void): void;
|
|
226
261
|
createThesaurus(args: CreateThesaurusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateThesaurusCommandOutput) => void): void;
|
|
262
|
+
/**
|
|
263
|
+
* <p>Deletes an access control configuration that you created for your
|
|
264
|
+
* documents in an index. This includes user and group access information
|
|
265
|
+
* for your documents. This is useful for user context filtering, where search
|
|
266
|
+
* results are filtered based on the user or their group access to documents.</p>
|
|
267
|
+
*/
|
|
268
|
+
deleteAccessControlConfiguration(args: DeleteAccessControlConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAccessControlConfigurationCommandOutput>;
|
|
269
|
+
deleteAccessControlConfiguration(args: DeleteAccessControlConfigurationCommandInput, cb: (err: any, data?: DeleteAccessControlConfigurationCommandOutput) => void): void;
|
|
270
|
+
deleteAccessControlConfiguration(args: DeleteAccessControlConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccessControlConfigurationCommandOutput) => void): void;
|
|
227
271
|
/**
|
|
228
272
|
* <p>Deletes an Amazon Kendra data source. An exception is not thrown if the
|
|
229
273
|
* data source is already being deleted. While the data source is being
|
|
@@ -297,6 +341,15 @@ export declare class Kendra extends KendraClient {
|
|
|
297
341
|
deleteThesaurus(args: DeleteThesaurusCommandInput, options?: __HttpHandlerOptions): Promise<DeleteThesaurusCommandOutput>;
|
|
298
342
|
deleteThesaurus(args: DeleteThesaurusCommandInput, cb: (err: any, data?: DeleteThesaurusCommandOutput) => void): void;
|
|
299
343
|
deleteThesaurus(args: DeleteThesaurusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteThesaurusCommandOutput) => void): void;
|
|
344
|
+
/**
|
|
345
|
+
* <p>Gets information about an access control configuration that you created for your
|
|
346
|
+
* documents in an index. This includes user and group access information for your
|
|
347
|
+
* documents. This is useful for user context filtering, where search results are
|
|
348
|
+
* filtered based on the user or their group access to documents.</p>
|
|
349
|
+
*/
|
|
350
|
+
describeAccessControlConfiguration(args: DescribeAccessControlConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAccessControlConfigurationCommandOutput>;
|
|
351
|
+
describeAccessControlConfiguration(args: DescribeAccessControlConfigurationCommandInput, cb: (err: any, data?: DescribeAccessControlConfigurationCommandOutput) => void): void;
|
|
352
|
+
describeAccessControlConfiguration(args: DescribeAccessControlConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccessControlConfigurationCommandOutput) => void): void;
|
|
300
353
|
/**
|
|
301
354
|
* <p>Gets information about an Amazon Kendra data source.</p>
|
|
302
355
|
*/
|
|
@@ -319,7 +372,7 @@ export declare class Kendra extends KendraClient {
|
|
|
319
372
|
describeFaq(args: DescribeFaqCommandInput, cb: (err: any, data?: DescribeFaqCommandOutput) => void): void;
|
|
320
373
|
describeFaq(args: DescribeFaqCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFaqCommandOutput) => void): void;
|
|
321
374
|
/**
|
|
322
|
-
* <p>
|
|
375
|
+
* <p>Gets information about an existing Amazon Kendra index.</p>
|
|
323
376
|
*/
|
|
324
377
|
describeIndex(args: DescribeIndexCommandInput, options?: __HttpHandlerOptions): Promise<DescribeIndexCommandOutput>;
|
|
325
378
|
describeIndex(args: DescribeIndexCommandInput, cb: (err: any, data?: DescribeIndexCommandOutput) => void): void;
|
|
@@ -339,7 +392,8 @@ export declare class Kendra extends KendraClient {
|
|
|
339
392
|
describePrincipalMapping(args: DescribePrincipalMappingCommandInput, cb: (err: any, data?: DescribePrincipalMappingCommandOutput) => void): void;
|
|
340
393
|
describePrincipalMapping(args: DescribePrincipalMappingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePrincipalMappingCommandOutput) => void): void;
|
|
341
394
|
/**
|
|
342
|
-
* <p>
|
|
395
|
+
* <p>Gets information about a block list used for query suggestions for
|
|
396
|
+
* an index.</p>
|
|
343
397
|
* <p>This is used to check the current settings that are applied to a
|
|
344
398
|
* block list.</p>
|
|
345
399
|
* <p>
|
|
@@ -350,7 +404,7 @@ export declare class Kendra extends KendraClient {
|
|
|
350
404
|
describeQuerySuggestionsBlockList(args: DescribeQuerySuggestionsBlockListCommandInput, cb: (err: any, data?: DescribeQuerySuggestionsBlockListCommandOutput) => void): void;
|
|
351
405
|
describeQuerySuggestionsBlockList(args: DescribeQuerySuggestionsBlockListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeQuerySuggestionsBlockListCommandOutput) => void): void;
|
|
352
406
|
/**
|
|
353
|
-
* <p>
|
|
407
|
+
* <p>Gets information on the settings of query suggestions for an index.</p>
|
|
354
408
|
* <p>This is used to check the current settings applied
|
|
355
409
|
* to query suggestions.</p>
|
|
356
410
|
* <p>
|
|
@@ -361,7 +415,7 @@ export declare class Kendra extends KendraClient {
|
|
|
361
415
|
describeQuerySuggestionsConfig(args: DescribeQuerySuggestionsConfigCommandInput, cb: (err: any, data?: DescribeQuerySuggestionsConfigCommandOutput) => void): void;
|
|
362
416
|
describeQuerySuggestionsConfig(args: DescribeQuerySuggestionsConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeQuerySuggestionsConfigCommandOutput) => void): void;
|
|
363
417
|
/**
|
|
364
|
-
* <p>
|
|
418
|
+
* <p>Gets information about an existing Amazon Kendra thesaurus.</p>
|
|
365
419
|
*/
|
|
366
420
|
describeThesaurus(args: DescribeThesaurusCommandInput, options?: __HttpHandlerOptions): Promise<DescribeThesaurusCommandOutput>;
|
|
367
421
|
describeThesaurus(args: DescribeThesaurusCommandInput, cb: (err: any, data?: DescribeThesaurusCommandOutput) => void): void;
|
|
@@ -403,6 +457,15 @@ export declare class Kendra extends KendraClient {
|
|
|
403
457
|
getSnapshots(args: GetSnapshotsCommandInput, options?: __HttpHandlerOptions): Promise<GetSnapshotsCommandOutput>;
|
|
404
458
|
getSnapshots(args: GetSnapshotsCommandInput, cb: (err: any, data?: GetSnapshotsCommandOutput) => void): void;
|
|
405
459
|
getSnapshots(args: GetSnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSnapshotsCommandOutput) => void): void;
|
|
460
|
+
/**
|
|
461
|
+
* <p>Lists one or more access control configurations for an index. This
|
|
462
|
+
* includes user and group access information for your documents. This
|
|
463
|
+
* is useful for user context filtering, where search results are filtered
|
|
464
|
+
* based on the user or their group access to documents.</p>
|
|
465
|
+
*/
|
|
466
|
+
listAccessControlConfigurations(args: ListAccessControlConfigurationsCommandInput, options?: __HttpHandlerOptions): Promise<ListAccessControlConfigurationsCommandOutput>;
|
|
467
|
+
listAccessControlConfigurations(args: ListAccessControlConfigurationsCommandInput, cb: (err: any, data?: ListAccessControlConfigurationsCommandOutput) => void): void;
|
|
468
|
+
listAccessControlConfigurations(args: ListAccessControlConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccessControlConfigurationsCommandOutput) => void): void;
|
|
406
469
|
/**
|
|
407
470
|
* <p>Lists the data sources that you have created.</p>
|
|
408
471
|
*/
|
|
@@ -484,7 +547,7 @@ export declare class Kendra extends KendraClient {
|
|
|
484
547
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
485
548
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
486
549
|
/**
|
|
487
|
-
* <p>Lists the
|
|
550
|
+
* <p>Lists the thesauri for an index.</p>
|
|
488
551
|
*/
|
|
489
552
|
listThesauri(args: ListThesauriCommandInput, options?: __HttpHandlerOptions): Promise<ListThesauriCommandOutput>;
|
|
490
553
|
listThesauri(args: ListThesauriCommandInput, cb: (err: any, data?: ListThesauriCommandOutput) => void): void;
|
|
@@ -499,9 +562,9 @@ export declare class Kendra extends KendraClient {
|
|
|
499
562
|
* in research and engineering, and therefore belong in the intellectual
|
|
500
563
|
* property group, can see top-secret company documents in their search
|
|
501
564
|
* results.</p>
|
|
502
|
-
* <p>
|
|
503
|
-
*
|
|
504
|
-
* information
|
|
565
|
+
* <p>This is useful for user context filtering, where search results are
|
|
566
|
+
* filtered based on the user or their group access to documents. For more
|
|
567
|
+
* information, see
|
|
505
568
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html">Filtering
|
|
506
569
|
* on user context</a>.</p>
|
|
507
570
|
* <p>If more than five <code>PUT</code> actions for a group are currently
|
|
@@ -579,6 +642,31 @@ export declare class Kendra extends KendraClient {
|
|
|
579
642
|
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
580
643
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
581
644
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
645
|
+
/**
|
|
646
|
+
* <p>Updates an access control configuration for your documents in an index. This
|
|
647
|
+
* includes user and group access information for your documents. This is useful
|
|
648
|
+
* for user context filtering, where search results are filtered based on the user
|
|
649
|
+
* or their group access to documents.</p>
|
|
650
|
+
* <p>You can update an access control configuration you created without indexing all
|
|
651
|
+
* of your documents again. For example, your index contains top-secret company
|
|
652
|
+
* documents that only certain employees or users should access. You created an 'allow'
|
|
653
|
+
* access control configuration for one user who recently joined the 'top-secret' team,
|
|
654
|
+
* switching from a team with 'deny' access to top-secret documents. However, the user
|
|
655
|
+
* suddenly returns to their previous team and should no longer have access to top secret
|
|
656
|
+
* documents. You can update the access control configuration to re-configure access
|
|
657
|
+
* control for your documents as circumstances change.</p>
|
|
658
|
+
* <p>You call the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">BatchPutDocument</a>
|
|
659
|
+
* API to apply the updated access control configuration, with the
|
|
660
|
+
* <code>AccessControlConfigurationId</code> included in the
|
|
661
|
+
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html">Document</a>
|
|
662
|
+
* object. If you use an S3 bucket as a data source, you synchronize your data source to
|
|
663
|
+
* apply the the <code>AccessControlConfigurationId</code> in the <code>.metadata.json</code> file.
|
|
664
|
+
* Amazon Kendra currently only supports access control configuration for S3 data
|
|
665
|
+
* sources and documents indexed using the <code>BatchPutDocument</code> API.</p>
|
|
666
|
+
*/
|
|
667
|
+
updateAccessControlConfiguration(args: UpdateAccessControlConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<UpdateAccessControlConfigurationCommandOutput>;
|
|
668
|
+
updateAccessControlConfiguration(args: UpdateAccessControlConfigurationCommandInput, cb: (err: any, data?: UpdateAccessControlConfigurationCommandOutput) => void): void;
|
|
669
|
+
updateAccessControlConfiguration(args: UpdateAccessControlConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAccessControlConfigurationCommandOutput) => void): void;
|
|
582
670
|
/**
|
|
583
671
|
* <p>Updates an existing Amazon Kendra data source.</p>
|
|
584
672
|
*/
|
|
@@ -633,7 +721,7 @@ export declare class Kendra extends KendraClient {
|
|
|
633
721
|
updateQuerySuggestionsConfig(args: UpdateQuerySuggestionsConfigCommandInput, cb: (err: any, data?: UpdateQuerySuggestionsConfigCommandOutput) => void): void;
|
|
634
722
|
updateQuerySuggestionsConfig(args: UpdateQuerySuggestionsConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateQuerySuggestionsConfigCommandOutput) => void): void;
|
|
635
723
|
/**
|
|
636
|
-
* <p>Updates a thesaurus
|
|
724
|
+
* <p>Updates a thesaurus for an index.</p>
|
|
637
725
|
*/
|
|
638
726
|
updateThesaurus(args: UpdateThesaurusCommandInput, options?: __HttpHandlerOptions): Promise<UpdateThesaurusCommandOutput>;
|
|
639
727
|
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,59 @@
|
|
|
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
|
|
15
|
+
* control without indexing all of your documents again. For example, your
|
|
16
|
+
* index contains top-secret company documents that only certain employees
|
|
17
|
+
* or users should access. One of these users leaves the company or switches
|
|
18
|
+
* to a team that should be blocked from access to top-secret documents.
|
|
19
|
+
* Your documents in your index still give this user access to top-secret
|
|
20
|
+
* documents due to the user having access at the time your documents were
|
|
21
|
+
* indexed. You can create a specific access control configuration for this
|
|
22
|
+
* user with deny access. You can later update the access control
|
|
23
|
+
* configuration to allow access in the case the user returns to the company
|
|
24
|
+
* and re-joins the 'top-secret' team. You can re-configure access control
|
|
25
|
+
* for your documents circumstances change.</p>
|
|
26
|
+
* <p>To apply your access control configuration to certain documents, you call
|
|
27
|
+
* the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">BatchPutDocument</a>
|
|
28
|
+
* API with the <code>AccessControlConfigurationId</code> included in the
|
|
29
|
+
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Document.html">Document</a>
|
|
30
|
+
* object. If you use an S3 bucket as a data source, you update the
|
|
31
|
+
* <code>.metadata.json</code> with the <code>AccessControlConfigurationId</code>
|
|
32
|
+
* and synchronize your data source. Amazon Kendra currently only supports
|
|
33
|
+
* access control configuration for S3 data sources and documents indexed using the
|
|
34
|
+
* <code>BatchPutDocument</code> API.</p>
|
|
35
|
+
* @example
|
|
36
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
37
|
+
* ```javascript
|
|
38
|
+
* import { KendraClient, CreateAccessControlConfigurationCommand } from "@aws-sdk/client-kendra"; // ES Modules import
|
|
39
|
+
* // const { KendraClient, CreateAccessControlConfigurationCommand } = require("@aws-sdk/client-kendra"); // CommonJS import
|
|
40
|
+
* const client = new KendraClient(config);
|
|
41
|
+
* const command = new CreateAccessControlConfigurationCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* ```
|
|
44
|
+
*
|
|
45
|
+
* @see {@link CreateAccessControlConfigurationCommandInput} for command's `input` shape.
|
|
46
|
+
* @see {@link CreateAccessControlConfigurationCommandOutput} for command's `response` shape.
|
|
47
|
+
* @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
|
|
48
|
+
*
|
|
49
|
+
*/
|
|
50
|
+
export declare class CreateAccessControlConfigurationCommand extends $Command<CreateAccessControlConfigurationCommandInput, CreateAccessControlConfigurationCommandOutput, KendraClientResolvedConfig> {
|
|
51
|
+
readonly input: CreateAccessControlConfigurationCommandInput;
|
|
52
|
+
constructor(input: CreateAccessControlConfigurationCommandInput);
|
|
53
|
+
/**
|
|
54
|
+
* @internal
|
|
55
|
+
*/
|
|
56
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreateAccessControlConfigurationCommandInput, CreateAccessControlConfigurationCommandOutput>;
|
|
57
|
+
private serialize;
|
|
58
|
+
private deserialize;
|
|
59
|
+
}
|
|
@@ -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
|
|
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
|
|
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>
|
|
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>
|
|
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>
|
|
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>
|
|
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
|
|
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>
|
|
20
|
-
*
|
|
21
|
-
* information
|
|
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,8 @@
|
|
|
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 {
|
|
4
|
+
import { QueryResult } from "../models/models_0";
|
|
5
|
+
import { QueryRequest } from "../models/models_1";
|
|
5
6
|
export interface QueryCommandInput extends QueryRequest {
|
|
6
7
|
}
|
|
7
8
|
export interface QueryCommandOutput extends QueryResult, __MetadataBearer {
|