@aws-sdk/client-kendra 3.296.0 → 3.297.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/dist-types/Kendra.d.ts +61 -0
- package/dist-types/KendraClient.d.ts +24 -4
- package/dist-types/commands/AssociateEntitiesToExperienceCommand.d.ts +16 -0
- package/dist-types/commands/AssociatePersonasToEntitiesCommand.d.ts +16 -0
- package/dist-types/commands/BatchDeleteDocumentCommand.d.ts +16 -0
- package/dist-types/commands/BatchGetDocumentStatusCommand.d.ts +16 -0
- package/dist-types/commands/BatchPutDocumentCommand.d.ts +16 -0
- package/dist-types/commands/ClearQuerySuggestionsCommand.d.ts +16 -0
- package/dist-types/commands/CreateAccessControlConfigurationCommand.d.ts +16 -0
- package/dist-types/commands/CreateDataSourceCommand.d.ts +16 -0
- package/dist-types/commands/CreateExperienceCommand.d.ts +16 -0
- package/dist-types/commands/CreateFaqCommand.d.ts +16 -0
- package/dist-types/commands/CreateIndexCommand.d.ts +16 -0
- package/dist-types/commands/CreateQuerySuggestionsBlockListCommand.d.ts +16 -0
- package/dist-types/commands/CreateThesaurusCommand.d.ts +16 -0
- package/dist-types/commands/DeleteAccessControlConfigurationCommand.d.ts +16 -0
- package/dist-types/commands/DeleteDataSourceCommand.d.ts +16 -0
- package/dist-types/commands/DeleteExperienceCommand.d.ts +16 -0
- package/dist-types/commands/DeleteFaqCommand.d.ts +16 -0
- package/dist-types/commands/DeleteIndexCommand.d.ts +16 -0
- package/dist-types/commands/DeletePrincipalMappingCommand.d.ts +16 -0
- package/dist-types/commands/DeleteQuerySuggestionsBlockListCommand.d.ts +16 -0
- package/dist-types/commands/DeleteThesaurusCommand.d.ts +16 -0
- package/dist-types/commands/DescribeAccessControlConfigurationCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDataSourceCommand.d.ts +16 -0
- package/dist-types/commands/DescribeExperienceCommand.d.ts +16 -0
- package/dist-types/commands/DescribeFaqCommand.d.ts +16 -0
- package/dist-types/commands/DescribeIndexCommand.d.ts +16 -0
- package/dist-types/commands/DescribePrincipalMappingCommand.d.ts +16 -0
- package/dist-types/commands/DescribeQuerySuggestionsBlockListCommand.d.ts +16 -0
- package/dist-types/commands/DescribeQuerySuggestionsConfigCommand.d.ts +16 -0
- package/dist-types/commands/DescribeThesaurusCommand.d.ts +16 -0
- package/dist-types/commands/DisassociateEntitiesFromExperienceCommand.d.ts +16 -0
- package/dist-types/commands/DisassociatePersonasFromEntitiesCommand.d.ts +16 -0
- package/dist-types/commands/GetQuerySuggestionsCommand.d.ts +16 -0
- package/dist-types/commands/GetSnapshotsCommand.d.ts +16 -0
- package/dist-types/commands/ListAccessControlConfigurationsCommand.d.ts +16 -0
- package/dist-types/commands/ListDataSourceSyncJobsCommand.d.ts +16 -0
- package/dist-types/commands/ListDataSourcesCommand.d.ts +16 -0
- package/dist-types/commands/ListEntityPersonasCommand.d.ts +16 -0
- package/dist-types/commands/ListExperienceEntitiesCommand.d.ts +16 -0
- package/dist-types/commands/ListExperiencesCommand.d.ts +16 -0
- package/dist-types/commands/ListFaqsCommand.d.ts +16 -0
- package/dist-types/commands/ListGroupsOlderThanOrderingIdCommand.d.ts +16 -0
- package/dist-types/commands/ListIndicesCommand.d.ts +16 -0
- package/dist-types/commands/ListQuerySuggestionsBlockListsCommand.d.ts +16 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
- package/dist-types/commands/ListThesauriCommand.d.ts +16 -0
- package/dist-types/commands/PutPrincipalMappingCommand.d.ts +16 -0
- package/dist-types/commands/QueryCommand.d.ts +16 -0
- package/dist-types/commands/StartDataSourceSyncJobCommand.d.ts +16 -0
- package/dist-types/commands/StopDataSourceSyncJobCommand.d.ts +16 -0
- package/dist-types/commands/SubmitFeedbackCommand.d.ts +16 -0
- package/dist-types/commands/TagResourceCommand.d.ts +16 -0
- package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
- package/dist-types/commands/UpdateAccessControlConfigurationCommand.d.ts +16 -0
- package/dist-types/commands/UpdateDataSourceCommand.d.ts +16 -0
- package/dist-types/commands/UpdateExperienceCommand.d.ts +16 -0
- package/dist-types/commands/UpdateIndexCommand.d.ts +16 -0
- package/dist-types/commands/UpdateQuerySuggestionsBlockListCommand.d.ts +16 -0
- package/dist-types/commands/UpdateQuerySuggestionsConfigCommand.d.ts +16 -0
- package/dist-types/commands/UpdateThesaurusCommand.d.ts +16 -0
- package/dist-types/models/KendraServiceException.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +617 -1
- package/dist-types/models/models_1.d.ts +16 -0
- package/dist-types/pagination/GetSnapshotsPaginator.d.ts +3 -0
- package/dist-types/pagination/Interfaces.d.ts +3 -0
- package/dist-types/pagination/ListAccessControlConfigurationsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListDataSourceSyncJobsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListDataSourcesPaginator.d.ts +3 -0
- package/dist-types/pagination/ListEntityPersonasPaginator.d.ts +3 -0
- package/dist-types/pagination/ListExperienceEntitiesPaginator.d.ts +3 -0
- package/dist-types/pagination/ListExperiencesPaginator.d.ts +3 -0
- package/dist-types/pagination/ListFaqsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListGroupsOlderThanOrderingIdPaginator.d.ts +3 -0
- package/dist-types/pagination/ListIndicesPaginator.d.ts +3 -0
- package/dist-types/pagination/ListQuerySuggestionsBlockListsPaginator.d.ts +3 -0
- package/dist-types/pagination/ListThesauriPaginator.d.ts +3 -0
- package/package.json +3 -3
package/dist-types/Kendra.d.ts
CHANGED
|
@@ -61,10 +61,12 @@ import { UpdateQuerySuggestionsConfigCommandInput, UpdateQuerySuggestionsConfigC
|
|
|
61
61
|
import { UpdateThesaurusCommandInput, UpdateThesaurusCommandOutput } from "./commands/UpdateThesaurusCommand";
|
|
62
62
|
import { KendraClient } from "./KendraClient";
|
|
63
63
|
/**
|
|
64
|
+
* @public
|
|
64
65
|
* <p>Amazon Kendra is a service for indexing large document sets.</p>
|
|
65
66
|
*/
|
|
66
67
|
export declare class Kendra extends KendraClient {
|
|
67
68
|
/**
|
|
69
|
+
* @public
|
|
68
70
|
* <p>Grants users or groups in your IAM Identity Center identity source access
|
|
69
71
|
* to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a
|
|
70
72
|
* search application. For more information on creating a search application
|
|
@@ -75,6 +77,7 @@ export declare class Kendra extends KendraClient {
|
|
|
75
77
|
associateEntitiesToExperience(args: AssociateEntitiesToExperienceCommandInput, cb: (err: any, data?: AssociateEntitiesToExperienceCommandOutput) => void): void;
|
|
76
78
|
associateEntitiesToExperience(args: AssociateEntitiesToExperienceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateEntitiesToExperienceCommandOutput) => void): void;
|
|
77
79
|
/**
|
|
80
|
+
* @public
|
|
78
81
|
* <p>Defines the specific permissions of users or groups in your IAM Identity Center
|
|
79
82
|
* identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra
|
|
80
83
|
* experience such as a search application. For more information on creating a
|
|
@@ -85,6 +88,7 @@ export declare class Kendra extends KendraClient {
|
|
|
85
88
|
associatePersonasToEntities(args: AssociatePersonasToEntitiesCommandInput, cb: (err: any, data?: AssociatePersonasToEntitiesCommandOutput) => void): void;
|
|
86
89
|
associatePersonasToEntities(args: AssociatePersonasToEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociatePersonasToEntitiesCommandOutput) => void): void;
|
|
87
90
|
/**
|
|
91
|
+
* @public
|
|
88
92
|
* <p>Removes one or more documents from an index. The documents must have
|
|
89
93
|
* been added with the <code>BatchPutDocument</code> API.</p>
|
|
90
94
|
* <p>The documents are deleted asynchronously. You can see the progress of
|
|
@@ -95,6 +99,7 @@ export declare class Kendra extends KendraClient {
|
|
|
95
99
|
batchDeleteDocument(args: BatchDeleteDocumentCommandInput, cb: (err: any, data?: BatchDeleteDocumentCommandOutput) => void): void;
|
|
96
100
|
batchDeleteDocument(args: BatchDeleteDocumentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchDeleteDocumentCommandOutput) => void): void;
|
|
97
101
|
/**
|
|
102
|
+
* @public
|
|
98
103
|
* <p>Returns the indexing status for one or more documents submitted
|
|
99
104
|
* with the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">
|
|
100
105
|
* BatchPutDocument</a> API.</p>
|
|
@@ -113,6 +118,7 @@ export declare class Kendra extends KendraClient {
|
|
|
113
118
|
batchGetDocumentStatus(args: BatchGetDocumentStatusCommandInput, cb: (err: any, data?: BatchGetDocumentStatusCommandOutput) => void): void;
|
|
114
119
|
batchGetDocumentStatus(args: BatchGetDocumentStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetDocumentStatusCommandOutput) => void): void;
|
|
115
120
|
/**
|
|
121
|
+
* @public
|
|
116
122
|
* <p>Adds one or more documents to an index.</p>
|
|
117
123
|
* <p>The <code>BatchPutDocument</code> API enables you to ingest
|
|
118
124
|
* inline documents or a set of documents stored in an Amazon S3 bucket. Use
|
|
@@ -130,6 +136,7 @@ export declare class Kendra extends KendraClient {
|
|
|
130
136
|
batchPutDocument(args: BatchPutDocumentCommandInput, cb: (err: any, data?: BatchPutDocumentCommandOutput) => void): void;
|
|
131
137
|
batchPutDocument(args: BatchPutDocumentCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchPutDocumentCommandOutput) => void): void;
|
|
132
138
|
/**
|
|
139
|
+
* @public
|
|
133
140
|
* <p>Clears existing query suggestions from an index.</p>
|
|
134
141
|
* <p>This deletes existing suggestions only, not the queries
|
|
135
142
|
* in the query log. After you clear suggestions, Amazon Kendra learns
|
|
@@ -145,6 +152,7 @@ export declare class Kendra extends KendraClient {
|
|
|
145
152
|
clearQuerySuggestions(args: ClearQuerySuggestionsCommandInput, cb: (err: any, data?: ClearQuerySuggestionsCommandOutput) => void): void;
|
|
146
153
|
clearQuerySuggestions(args: ClearQuerySuggestionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ClearQuerySuggestionsCommandOutput) => void): void;
|
|
147
154
|
/**
|
|
155
|
+
* @public
|
|
148
156
|
* <p>Creates an access configuration for your documents. This includes
|
|
149
157
|
* user and group access information for your documents. This is useful
|
|
150
158
|
* for user context filtering, where search results are filtered based
|
|
@@ -173,6 +181,7 @@ export declare class Kendra extends KendraClient {
|
|
|
173
181
|
createAccessControlConfiguration(args: CreateAccessControlConfigurationCommandInput, cb: (err: any, data?: CreateAccessControlConfigurationCommandOutput) => void): void;
|
|
174
182
|
createAccessControlConfiguration(args: CreateAccessControlConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAccessControlConfigurationCommandOutput) => void): void;
|
|
175
183
|
/**
|
|
184
|
+
* @public
|
|
176
185
|
* <p>Creates a data source connector that you want to use with an Amazon Kendra
|
|
177
186
|
* index.</p>
|
|
178
187
|
* <p>You specify a name, data source connector type and description for your data source. You
|
|
@@ -191,6 +200,7 @@ export declare class Kendra extends KendraClient {
|
|
|
191
200
|
createDataSource(args: CreateDataSourceCommandInput, cb: (err: any, data?: CreateDataSourceCommandOutput) => void): void;
|
|
192
201
|
createDataSource(args: CreateDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateDataSourceCommandOutput) => void): void;
|
|
193
202
|
/**
|
|
203
|
+
* @public
|
|
194
204
|
* <p>Creates an Amazon Kendra experience such as a search application. For more information
|
|
195
205
|
* on creating a search application experience, including using the Python and Java SDKs,
|
|
196
206
|
* see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building a
|
|
@@ -200,6 +210,7 @@ export declare class Kendra extends KendraClient {
|
|
|
200
210
|
createExperience(args: CreateExperienceCommandInput, cb: (err: any, data?: CreateExperienceCommandOutput) => void): void;
|
|
201
211
|
createExperience(args: CreateExperienceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateExperienceCommandOutput) => void): void;
|
|
202
212
|
/**
|
|
213
|
+
* @public
|
|
203
214
|
* <p>Creates an new set of frequently asked question (FAQ) questions and answers.</p>
|
|
204
215
|
* <p>Adding FAQs to an index is an asynchronous operation.</p>
|
|
205
216
|
* <p>For an example of adding an FAQ to an index using Python and Java SDKs,
|
|
@@ -210,6 +221,7 @@ export declare class Kendra extends KendraClient {
|
|
|
210
221
|
createFaq(args: CreateFaqCommandInput, cb: (err: any, data?: CreateFaqCommandOutput) => void): void;
|
|
211
222
|
createFaq(args: CreateFaqCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFaqCommandOutput) => void): void;
|
|
212
223
|
/**
|
|
224
|
+
* @public
|
|
213
225
|
* <p>Creates an Amazon Kendra index. Index creation is an asynchronous API. To determine
|
|
214
226
|
* if index creation has completed, check the <code>Status</code> field returned from a call to
|
|
215
227
|
* <code>DescribeIndex</code>. The <code>Status</code> field is set to <code>ACTIVE</code> when
|
|
@@ -225,6 +237,7 @@ export declare class Kendra extends KendraClient {
|
|
|
225
237
|
createIndex(args: CreateIndexCommandInput, cb: (err: any, data?: CreateIndexCommandOutput) => void): void;
|
|
226
238
|
createIndex(args: CreateIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIndexCommandOutput) => void): void;
|
|
227
239
|
/**
|
|
240
|
+
* @public
|
|
228
241
|
* <p>Creates a block list to exlcude certain queries from suggestions.</p>
|
|
229
242
|
* <p>Any query that contains words or phrases specified in the block
|
|
230
243
|
* list is blocked or filtered out from being shown as a suggestion.</p>
|
|
@@ -245,6 +258,7 @@ export declare class Kendra extends KendraClient {
|
|
|
245
258
|
createQuerySuggestionsBlockList(args: CreateQuerySuggestionsBlockListCommandInput, cb: (err: any, data?: CreateQuerySuggestionsBlockListCommandOutput) => void): void;
|
|
246
259
|
createQuerySuggestionsBlockList(args: CreateQuerySuggestionsBlockListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateQuerySuggestionsBlockListCommandOutput) => void): void;
|
|
247
260
|
/**
|
|
261
|
+
* @public
|
|
248
262
|
* <p>Creates a thesaurus for an index. The thesaurus
|
|
249
263
|
* contains a list of synonyms in Solr format.</p>
|
|
250
264
|
* <p>For an example of adding a thesaurus file to an index, see
|
|
@@ -255,6 +269,7 @@ export declare class Kendra extends KendraClient {
|
|
|
255
269
|
createThesaurus(args: CreateThesaurusCommandInput, cb: (err: any, data?: CreateThesaurusCommandOutput) => void): void;
|
|
256
270
|
createThesaurus(args: CreateThesaurusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateThesaurusCommandOutput) => void): void;
|
|
257
271
|
/**
|
|
272
|
+
* @public
|
|
258
273
|
* <p>Deletes an access control configuration that you created for your
|
|
259
274
|
* documents in an index. This includes user and group access information
|
|
260
275
|
* for your documents. This is useful for user context filtering, where search
|
|
@@ -264,6 +279,7 @@ export declare class Kendra extends KendraClient {
|
|
|
264
279
|
deleteAccessControlConfiguration(args: DeleteAccessControlConfigurationCommandInput, cb: (err: any, data?: DeleteAccessControlConfigurationCommandOutput) => void): void;
|
|
265
280
|
deleteAccessControlConfiguration(args: DeleteAccessControlConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAccessControlConfigurationCommandOutput) => void): void;
|
|
266
281
|
/**
|
|
282
|
+
* @public
|
|
267
283
|
* <p>Deletes an Amazon Kendra data source connector. An exception is not thrown if the
|
|
268
284
|
* data source is already being deleted. While the data source is being deleted, the
|
|
269
285
|
* <code>Status</code> field returned by a call to the <code>DescribeDataSource</code> API is
|
|
@@ -273,6 +289,7 @@ export declare class Kendra extends KendraClient {
|
|
|
273
289
|
deleteDataSource(args: DeleteDataSourceCommandInput, cb: (err: any, data?: DeleteDataSourceCommandOutput) => void): void;
|
|
274
290
|
deleteDataSource(args: DeleteDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteDataSourceCommandOutput) => void): void;
|
|
275
291
|
/**
|
|
292
|
+
* @public
|
|
276
293
|
* <p>Deletes your Amazon Kendra experience such as a search application. For more information on
|
|
277
294
|
* creating a search application experience, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building a search
|
|
278
295
|
* experience with no code</a>.</p>
|
|
@@ -281,12 +298,14 @@ export declare class Kendra extends KendraClient {
|
|
|
281
298
|
deleteExperience(args: DeleteExperienceCommandInput, cb: (err: any, data?: DeleteExperienceCommandOutput) => void): void;
|
|
282
299
|
deleteExperience(args: DeleteExperienceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteExperienceCommandOutput) => void): void;
|
|
283
300
|
/**
|
|
301
|
+
* @public
|
|
284
302
|
* <p>Removes an FAQ from an index.</p>
|
|
285
303
|
*/
|
|
286
304
|
deleteFaq(args: DeleteFaqCommandInput, options?: __HttpHandlerOptions): Promise<DeleteFaqCommandOutput>;
|
|
287
305
|
deleteFaq(args: DeleteFaqCommandInput, cb: (err: any, data?: DeleteFaqCommandOutput) => void): void;
|
|
288
306
|
deleteFaq(args: DeleteFaqCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFaqCommandOutput) => void): void;
|
|
289
307
|
/**
|
|
308
|
+
* @public
|
|
290
309
|
* <p>Deletes an existing Amazon Kendra index. An exception is not thrown if the index is
|
|
291
310
|
* already being deleted. While the index is being deleted, the <code>Status</code> field
|
|
292
311
|
* returned by a call to the <code>DescribeIndex</code> API is set to
|
|
@@ -296,6 +315,7 @@ export declare class Kendra extends KendraClient {
|
|
|
296
315
|
deleteIndex(args: DeleteIndexCommandInput, cb: (err: any, data?: DeleteIndexCommandOutput) => void): void;
|
|
297
316
|
deleteIndex(args: DeleteIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIndexCommandOutput) => void): void;
|
|
298
317
|
/**
|
|
318
|
+
* @public
|
|
299
319
|
* <p>Deletes a group so that all users and sub groups that belong to the group can
|
|
300
320
|
* no longer access documents only available to that group.</p>
|
|
301
321
|
* <p>For example, after deleting the group "Summer Interns", all interns who
|
|
@@ -316,6 +336,7 @@ export declare class Kendra extends KendraClient {
|
|
|
316
336
|
deletePrincipalMapping(args: DeletePrincipalMappingCommandInput, cb: (err: any, data?: DeletePrincipalMappingCommandOutput) => void): void;
|
|
317
337
|
deletePrincipalMapping(args: DeletePrincipalMappingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePrincipalMappingCommandOutput) => void): void;
|
|
318
338
|
/**
|
|
339
|
+
* @public
|
|
319
340
|
* <p>Deletes a block list used for query suggestions for an index.</p>
|
|
320
341
|
* <p>A deleted block list might not take effect right away. Amazon Kendra
|
|
321
342
|
* needs to refresh the entire suggestions list to add back the
|
|
@@ -328,6 +349,7 @@ export declare class Kendra extends KendraClient {
|
|
|
328
349
|
deleteQuerySuggestionsBlockList(args: DeleteQuerySuggestionsBlockListCommandInput, cb: (err: any, data?: DeleteQuerySuggestionsBlockListCommandOutput) => void): void;
|
|
329
350
|
deleteQuerySuggestionsBlockList(args: DeleteQuerySuggestionsBlockListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteQuerySuggestionsBlockListCommandOutput) => void): void;
|
|
330
351
|
/**
|
|
352
|
+
* @public
|
|
331
353
|
* <p>Deletes an existing Amazon Kendra thesaurus.
|
|
332
354
|
* </p>
|
|
333
355
|
*/
|
|
@@ -335,6 +357,7 @@ export declare class Kendra extends KendraClient {
|
|
|
335
357
|
deleteThesaurus(args: DeleteThesaurusCommandInput, cb: (err: any, data?: DeleteThesaurusCommandOutput) => void): void;
|
|
336
358
|
deleteThesaurus(args: DeleteThesaurusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteThesaurusCommandOutput) => void): void;
|
|
337
359
|
/**
|
|
360
|
+
* @public
|
|
338
361
|
* <p>Gets information about an access control configuration that you created for your
|
|
339
362
|
* documents in an index. This includes user and group access information for your
|
|
340
363
|
* documents. This is useful for user context filtering, where search results are
|
|
@@ -344,12 +367,14 @@ export declare class Kendra extends KendraClient {
|
|
|
344
367
|
describeAccessControlConfiguration(args: DescribeAccessControlConfigurationCommandInput, cb: (err: any, data?: DescribeAccessControlConfigurationCommandOutput) => void): void;
|
|
345
368
|
describeAccessControlConfiguration(args: DescribeAccessControlConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAccessControlConfigurationCommandOutput) => void): void;
|
|
346
369
|
/**
|
|
370
|
+
* @public
|
|
347
371
|
* <p>Gets information about an Amazon Kendra data source connector.</p>
|
|
348
372
|
*/
|
|
349
373
|
describeDataSource(args: DescribeDataSourceCommandInput, options?: __HttpHandlerOptions): Promise<DescribeDataSourceCommandOutput>;
|
|
350
374
|
describeDataSource(args: DescribeDataSourceCommandInput, cb: (err: any, data?: DescribeDataSourceCommandOutput) => void): void;
|
|
351
375
|
describeDataSource(args: DescribeDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeDataSourceCommandOutput) => void): void;
|
|
352
376
|
/**
|
|
377
|
+
* @public
|
|
353
378
|
* <p>Gets information about your Amazon Kendra experience such as a search application.
|
|
354
379
|
* For more information on creating a search application experience,
|
|
355
380
|
* see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building
|
|
@@ -359,18 +384,21 @@ export declare class Kendra extends KendraClient {
|
|
|
359
384
|
describeExperience(args: DescribeExperienceCommandInput, cb: (err: any, data?: DescribeExperienceCommandOutput) => void): void;
|
|
360
385
|
describeExperience(args: DescribeExperienceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeExperienceCommandOutput) => void): void;
|
|
361
386
|
/**
|
|
387
|
+
* @public
|
|
362
388
|
* <p>Gets information about an FAQ list.</p>
|
|
363
389
|
*/
|
|
364
390
|
describeFaq(args: DescribeFaqCommandInput, options?: __HttpHandlerOptions): Promise<DescribeFaqCommandOutput>;
|
|
365
391
|
describeFaq(args: DescribeFaqCommandInput, cb: (err: any, data?: DescribeFaqCommandOutput) => void): void;
|
|
366
392
|
describeFaq(args: DescribeFaqCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFaqCommandOutput) => void): void;
|
|
367
393
|
/**
|
|
394
|
+
* @public
|
|
368
395
|
* <p>Gets information about an existing Amazon Kendra index.</p>
|
|
369
396
|
*/
|
|
370
397
|
describeIndex(args: DescribeIndexCommandInput, options?: __HttpHandlerOptions): Promise<DescribeIndexCommandOutput>;
|
|
371
398
|
describeIndex(args: DescribeIndexCommandInput, cb: (err: any, data?: DescribeIndexCommandOutput) => void): void;
|
|
372
399
|
describeIndex(args: DescribeIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeIndexCommandOutput) => void): void;
|
|
373
400
|
/**
|
|
401
|
+
* @public
|
|
374
402
|
* <p>Describes the processing of <code>PUT</code> and <code>DELETE</code> actions
|
|
375
403
|
* for mapping users to their groups. This includes information on the status of
|
|
376
404
|
* actions currently processing or yet to be processed, when actions were last updated,
|
|
@@ -385,6 +413,7 @@ export declare class Kendra extends KendraClient {
|
|
|
385
413
|
describePrincipalMapping(args: DescribePrincipalMappingCommandInput, cb: (err: any, data?: DescribePrincipalMappingCommandOutput) => void): void;
|
|
386
414
|
describePrincipalMapping(args: DescribePrincipalMappingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePrincipalMappingCommandOutput) => void): void;
|
|
387
415
|
/**
|
|
416
|
+
* @public
|
|
388
417
|
* <p>Gets information about a block list used for query suggestions for
|
|
389
418
|
* an index.</p>
|
|
390
419
|
* <p>This is used to check the current settings that are applied to a
|
|
@@ -397,6 +426,7 @@ export declare class Kendra extends KendraClient {
|
|
|
397
426
|
describeQuerySuggestionsBlockList(args: DescribeQuerySuggestionsBlockListCommandInput, cb: (err: any, data?: DescribeQuerySuggestionsBlockListCommandOutput) => void): void;
|
|
398
427
|
describeQuerySuggestionsBlockList(args: DescribeQuerySuggestionsBlockListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeQuerySuggestionsBlockListCommandOutput) => void): void;
|
|
399
428
|
/**
|
|
429
|
+
* @public
|
|
400
430
|
* <p>Gets information on the settings of query suggestions for an index.</p>
|
|
401
431
|
* <p>This is used to check the current settings applied
|
|
402
432
|
* to query suggestions.</p>
|
|
@@ -408,12 +438,14 @@ export declare class Kendra extends KendraClient {
|
|
|
408
438
|
describeQuerySuggestionsConfig(args: DescribeQuerySuggestionsConfigCommandInput, cb: (err: any, data?: DescribeQuerySuggestionsConfigCommandOutput) => void): void;
|
|
409
439
|
describeQuerySuggestionsConfig(args: DescribeQuerySuggestionsConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeQuerySuggestionsConfigCommandOutput) => void): void;
|
|
410
440
|
/**
|
|
441
|
+
* @public
|
|
411
442
|
* <p>Gets information about an existing Amazon Kendra thesaurus.</p>
|
|
412
443
|
*/
|
|
413
444
|
describeThesaurus(args: DescribeThesaurusCommandInput, options?: __HttpHandlerOptions): Promise<DescribeThesaurusCommandOutput>;
|
|
414
445
|
describeThesaurus(args: DescribeThesaurusCommandInput, cb: (err: any, data?: DescribeThesaurusCommandOutput) => void): void;
|
|
415
446
|
describeThesaurus(args: DescribeThesaurusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeThesaurusCommandOutput) => void): void;
|
|
416
447
|
/**
|
|
448
|
+
* @public
|
|
417
449
|
* <p>Prevents users or groups in your IAM Identity Center identity source
|
|
418
450
|
* from accessing your Amazon Kendra experience. You can create an Amazon Kendra experience
|
|
419
451
|
* such as a search application. For more information on creating a search
|
|
@@ -424,6 +456,7 @@ export declare class Kendra extends KendraClient {
|
|
|
424
456
|
disassociateEntitiesFromExperience(args: DisassociateEntitiesFromExperienceCommandInput, cb: (err: any, data?: DisassociateEntitiesFromExperienceCommandOutput) => void): void;
|
|
425
457
|
disassociateEntitiesFromExperience(args: DisassociateEntitiesFromExperienceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateEntitiesFromExperienceCommandOutput) => void): void;
|
|
426
458
|
/**
|
|
459
|
+
* @public
|
|
427
460
|
* <p>Removes the specific permissions of users or groups in your IAM Identity Center
|
|
428
461
|
* identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra
|
|
429
462
|
* experience such as a search application. For more information on creating a
|
|
@@ -434,6 +467,7 @@ export declare class Kendra extends KendraClient {
|
|
|
434
467
|
disassociatePersonasFromEntities(args: DisassociatePersonasFromEntitiesCommandInput, cb: (err: any, data?: DisassociatePersonasFromEntitiesCommandOutput) => void): void;
|
|
435
468
|
disassociatePersonasFromEntities(args: DisassociatePersonasFromEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociatePersonasFromEntitiesCommandOutput) => void): void;
|
|
436
469
|
/**
|
|
470
|
+
* @public
|
|
437
471
|
* <p>Fetches the queries that are suggested to your users.</p>
|
|
438
472
|
* <p>
|
|
439
473
|
* <code>GetQuerySuggestions</code> is currently not supported in the
|
|
@@ -443,6 +477,7 @@ export declare class Kendra extends KendraClient {
|
|
|
443
477
|
getQuerySuggestions(args: GetQuerySuggestionsCommandInput, cb: (err: any, data?: GetQuerySuggestionsCommandOutput) => void): void;
|
|
444
478
|
getQuerySuggestions(args: GetQuerySuggestionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetQuerySuggestionsCommandOutput) => void): void;
|
|
445
479
|
/**
|
|
480
|
+
* @public
|
|
446
481
|
* <p>Retrieves search metrics data. The data provides a snapshot of how
|
|
447
482
|
* your users interact with your search application and how effective
|
|
448
483
|
* the application is.</p>
|
|
@@ -451,6 +486,7 @@ export declare class Kendra extends KendraClient {
|
|
|
451
486
|
getSnapshots(args: GetSnapshotsCommandInput, cb: (err: any, data?: GetSnapshotsCommandOutput) => void): void;
|
|
452
487
|
getSnapshots(args: GetSnapshotsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSnapshotsCommandOutput) => void): void;
|
|
453
488
|
/**
|
|
489
|
+
* @public
|
|
454
490
|
* <p>Lists one or more access control configurations for an index. This
|
|
455
491
|
* includes user and group access information for your documents. This
|
|
456
492
|
* is useful for user context filtering, where search results are filtered
|
|
@@ -460,18 +496,21 @@ export declare class Kendra extends KendraClient {
|
|
|
460
496
|
listAccessControlConfigurations(args: ListAccessControlConfigurationsCommandInput, cb: (err: any, data?: ListAccessControlConfigurationsCommandOutput) => void): void;
|
|
461
497
|
listAccessControlConfigurations(args: ListAccessControlConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAccessControlConfigurationsCommandOutput) => void): void;
|
|
462
498
|
/**
|
|
499
|
+
* @public
|
|
463
500
|
* <p>Lists the data source connectors that you have created.</p>
|
|
464
501
|
*/
|
|
465
502
|
listDataSources(args: ListDataSourcesCommandInput, options?: __HttpHandlerOptions): Promise<ListDataSourcesCommandOutput>;
|
|
466
503
|
listDataSources(args: ListDataSourcesCommandInput, cb: (err: any, data?: ListDataSourcesCommandOutput) => void): void;
|
|
467
504
|
listDataSources(args: ListDataSourcesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataSourcesCommandOutput) => void): void;
|
|
468
505
|
/**
|
|
506
|
+
* @public
|
|
469
507
|
* <p>Gets statistics about synchronizing a data source connector.</p>
|
|
470
508
|
*/
|
|
471
509
|
listDataSourceSyncJobs(args: ListDataSourceSyncJobsCommandInput, options?: __HttpHandlerOptions): Promise<ListDataSourceSyncJobsCommandOutput>;
|
|
472
510
|
listDataSourceSyncJobs(args: ListDataSourceSyncJobsCommandInput, cb: (err: any, data?: ListDataSourceSyncJobsCommandOutput) => void): void;
|
|
473
511
|
listDataSourceSyncJobs(args: ListDataSourceSyncJobsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListDataSourceSyncJobsCommandOutput) => void): void;
|
|
474
512
|
/**
|
|
513
|
+
* @public
|
|
475
514
|
* <p>Lists specific permissions of users and groups with access to your
|
|
476
515
|
* Amazon Kendra experience.</p>
|
|
477
516
|
*/
|
|
@@ -479,6 +518,7 @@ export declare class Kendra extends KendraClient {
|
|
|
479
518
|
listEntityPersonas(args: ListEntityPersonasCommandInput, cb: (err: any, data?: ListEntityPersonasCommandOutput) => void): void;
|
|
480
519
|
listEntityPersonas(args: ListEntityPersonasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListEntityPersonasCommandOutput) => void): void;
|
|
481
520
|
/**
|
|
521
|
+
* @public
|
|
482
522
|
* <p>Lists users or groups in your IAM Identity Center identity source that are
|
|
483
523
|
* granted access to your Amazon Kendra experience. You can create an Amazon Kendra experience
|
|
484
524
|
* such as a search application. For more information on creating a search
|
|
@@ -489,6 +529,7 @@ export declare class Kendra extends KendraClient {
|
|
|
489
529
|
listExperienceEntities(args: ListExperienceEntitiesCommandInput, cb: (err: any, data?: ListExperienceEntitiesCommandOutput) => void): void;
|
|
490
530
|
listExperienceEntities(args: ListExperienceEntitiesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExperienceEntitiesCommandOutput) => void): void;
|
|
491
531
|
/**
|
|
532
|
+
* @public
|
|
492
533
|
* <p>Lists one or more Amazon Kendra experiences. You can create an Amazon Kendra experience such
|
|
493
534
|
* as a search application. For more information on creating a search application
|
|
494
535
|
* experience, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building a
|
|
@@ -498,12 +539,14 @@ export declare class Kendra extends KendraClient {
|
|
|
498
539
|
listExperiences(args: ListExperiencesCommandInput, cb: (err: any, data?: ListExperiencesCommandOutput) => void): void;
|
|
499
540
|
listExperiences(args: ListExperiencesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListExperiencesCommandOutput) => void): void;
|
|
500
541
|
/**
|
|
542
|
+
* @public
|
|
501
543
|
* <p>Gets a list of FAQ lists associated with an index.</p>
|
|
502
544
|
*/
|
|
503
545
|
listFaqs(args: ListFaqsCommandInput, options?: __HttpHandlerOptions): Promise<ListFaqsCommandOutput>;
|
|
504
546
|
listFaqs(args: ListFaqsCommandInput, cb: (err: any, data?: ListFaqsCommandOutput) => void): void;
|
|
505
547
|
listFaqs(args: ListFaqsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFaqsCommandOutput) => void): void;
|
|
506
548
|
/**
|
|
549
|
+
* @public
|
|
507
550
|
* <p>Provides a list of groups that are mapped to users before a
|
|
508
551
|
* given ordering or timestamp identifier.</p>
|
|
509
552
|
* <p>
|
|
@@ -514,12 +557,14 @@ export declare class Kendra extends KendraClient {
|
|
|
514
557
|
listGroupsOlderThanOrderingId(args: ListGroupsOlderThanOrderingIdCommandInput, cb: (err: any, data?: ListGroupsOlderThanOrderingIdCommandOutput) => void): void;
|
|
515
558
|
listGroupsOlderThanOrderingId(args: ListGroupsOlderThanOrderingIdCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGroupsOlderThanOrderingIdCommandOutput) => void): void;
|
|
516
559
|
/**
|
|
560
|
+
* @public
|
|
517
561
|
* <p>Lists the Amazon Kendra indexes that you created.</p>
|
|
518
562
|
*/
|
|
519
563
|
listIndices(args: ListIndicesCommandInput, options?: __HttpHandlerOptions): Promise<ListIndicesCommandOutput>;
|
|
520
564
|
listIndices(args: ListIndicesCommandInput, cb: (err: any, data?: ListIndicesCommandOutput) => void): void;
|
|
521
565
|
listIndices(args: ListIndicesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIndicesCommandOutput) => void): void;
|
|
522
566
|
/**
|
|
567
|
+
* @public
|
|
523
568
|
* <p>Lists the block lists used for query suggestions for an index.</p>
|
|
524
569
|
* <p>For information on the current quota limits for block lists, see
|
|
525
570
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/quotas.html">Quotas
|
|
@@ -532,6 +577,7 @@ export declare class Kendra extends KendraClient {
|
|
|
532
577
|
listQuerySuggestionsBlockLists(args: ListQuerySuggestionsBlockListsCommandInput, cb: (err: any, data?: ListQuerySuggestionsBlockListsCommandOutput) => void): void;
|
|
533
578
|
listQuerySuggestionsBlockLists(args: ListQuerySuggestionsBlockListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListQuerySuggestionsBlockListsCommandOutput) => void): void;
|
|
534
579
|
/**
|
|
580
|
+
* @public
|
|
535
581
|
* <p>Gets a list of tags associated with a specified resource. Indexes,
|
|
536
582
|
* FAQs, and data sources can have tags associated with them.</p>
|
|
537
583
|
*/
|
|
@@ -539,12 +585,14 @@ export declare class Kendra extends KendraClient {
|
|
|
539
585
|
listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
540
586
|
listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
|
|
541
587
|
/**
|
|
588
|
+
* @public
|
|
542
589
|
* <p>Lists the thesauri for an index.</p>
|
|
543
590
|
*/
|
|
544
591
|
listThesauri(args: ListThesauriCommandInput, options?: __HttpHandlerOptions): Promise<ListThesauriCommandOutput>;
|
|
545
592
|
listThesauri(args: ListThesauriCommandInput, cb: (err: any, data?: ListThesauriCommandOutput) => void): void;
|
|
546
593
|
listThesauri(args: ListThesauriCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListThesauriCommandOutput) => void): void;
|
|
547
594
|
/**
|
|
595
|
+
* @public
|
|
548
596
|
* <p>Maps users to their groups so that you only need to provide
|
|
549
597
|
* the user ID when you issue the query.</p>
|
|
550
598
|
* <p>You can also map sub groups to groups.
|
|
@@ -569,6 +617,7 @@ export declare class Kendra extends KendraClient {
|
|
|
569
617
|
putPrincipalMapping(args: PutPrincipalMappingCommandInput, cb: (err: any, data?: PutPrincipalMappingCommandOutput) => void): void;
|
|
570
618
|
putPrincipalMapping(args: PutPrincipalMappingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPrincipalMappingCommandOutput) => void): void;
|
|
571
619
|
/**
|
|
620
|
+
* @public
|
|
572
621
|
* <p>Searches an active index. Use this API to search your documents using query. The
|
|
573
622
|
* <code>Query</code> API enables to do faceted search and to filter results based on
|
|
574
623
|
* document attributes.</p>
|
|
@@ -595,6 +644,7 @@ export declare class Kendra extends KendraClient {
|
|
|
595
644
|
query(args: QueryCommandInput, cb: (err: any, data?: QueryCommandOutput) => void): void;
|
|
596
645
|
query(args: QueryCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: QueryCommandOutput) => void): void;
|
|
597
646
|
/**
|
|
647
|
+
* @public
|
|
598
648
|
* <p>Starts a synchronization job for a data source connector. If a synchronization job is
|
|
599
649
|
* already in progress, Amazon Kendra returns a <code>ResourceInUseException</code>
|
|
600
650
|
* exception.</p>
|
|
@@ -603,6 +653,7 @@ export declare class Kendra extends KendraClient {
|
|
|
603
653
|
startDataSourceSyncJob(args: StartDataSourceSyncJobCommandInput, cb: (err: any, data?: StartDataSourceSyncJobCommandOutput) => void): void;
|
|
604
654
|
startDataSourceSyncJob(args: StartDataSourceSyncJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartDataSourceSyncJobCommandOutput) => void): void;
|
|
605
655
|
/**
|
|
656
|
+
* @public
|
|
606
657
|
* <p>Stops a synchronization job that is currently running. You can't stop a scheduled
|
|
607
658
|
* synchronization job.</p>
|
|
608
659
|
*/
|
|
@@ -610,6 +661,7 @@ export declare class Kendra extends KendraClient {
|
|
|
610
661
|
stopDataSourceSyncJob(args: StopDataSourceSyncJobCommandInput, cb: (err: any, data?: StopDataSourceSyncJobCommandOutput) => void): void;
|
|
611
662
|
stopDataSourceSyncJob(args: StopDataSourceSyncJobCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopDataSourceSyncJobCommandOutput) => void): void;
|
|
612
663
|
/**
|
|
664
|
+
* @public
|
|
613
665
|
* <p>Enables you to provide feedback to Amazon Kendra to improve the
|
|
614
666
|
* performance of your index.</p>
|
|
615
667
|
* <p>
|
|
@@ -620,6 +672,7 @@ export declare class Kendra extends KendraClient {
|
|
|
620
672
|
submitFeedback(args: SubmitFeedbackCommandInput, cb: (err: any, data?: SubmitFeedbackCommandOutput) => void): void;
|
|
621
673
|
submitFeedback(args: SubmitFeedbackCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SubmitFeedbackCommandOutput) => void): void;
|
|
622
674
|
/**
|
|
675
|
+
* @public
|
|
623
676
|
* <p>Adds the specified tag to the specified index, FAQ, or data source
|
|
624
677
|
* resource. If the tag already exists, the existing value is replaced with
|
|
625
678
|
* the new value.</p>
|
|
@@ -628,12 +681,14 @@ export declare class Kendra extends KendraClient {
|
|
|
628
681
|
tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
629
682
|
tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
|
|
630
683
|
/**
|
|
684
|
+
* @public
|
|
631
685
|
* <p>Removes a tag from an index, FAQ, or a data source.</p>
|
|
632
686
|
*/
|
|
633
687
|
untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
|
|
634
688
|
untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
635
689
|
untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
|
|
636
690
|
/**
|
|
691
|
+
* @public
|
|
637
692
|
* <p>Updates an access control configuration for your documents in an index. This
|
|
638
693
|
* includes user and group access information for your documents. This is useful
|
|
639
694
|
* for user context filtering, where search results are filtered based on the user
|
|
@@ -659,12 +714,14 @@ export declare class Kendra extends KendraClient {
|
|
|
659
714
|
updateAccessControlConfiguration(args: UpdateAccessControlConfigurationCommandInput, cb: (err: any, data?: UpdateAccessControlConfigurationCommandOutput) => void): void;
|
|
660
715
|
updateAccessControlConfiguration(args: UpdateAccessControlConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAccessControlConfigurationCommandOutput) => void): void;
|
|
661
716
|
/**
|
|
717
|
+
* @public
|
|
662
718
|
* <p>Updates an existing Amazon Kendra data source connector.</p>
|
|
663
719
|
*/
|
|
664
720
|
updateDataSource(args: UpdateDataSourceCommandInput, options?: __HttpHandlerOptions): Promise<UpdateDataSourceCommandOutput>;
|
|
665
721
|
updateDataSource(args: UpdateDataSourceCommandInput, cb: (err: any, data?: UpdateDataSourceCommandOutput) => void): void;
|
|
666
722
|
updateDataSource(args: UpdateDataSourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateDataSourceCommandOutput) => void): void;
|
|
667
723
|
/**
|
|
724
|
+
* @public
|
|
668
725
|
* <p>Updates your Amazon Kendra experience such as a search application. For more information on
|
|
669
726
|
* creating a search application experience, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/deploying-search-experience-no-code.html">Building a
|
|
670
727
|
* search experience with no code</a>.</p>
|
|
@@ -673,12 +730,14 @@ export declare class Kendra extends KendraClient {
|
|
|
673
730
|
updateExperience(args: UpdateExperienceCommandInput, cb: (err: any, data?: UpdateExperienceCommandOutput) => void): void;
|
|
674
731
|
updateExperience(args: UpdateExperienceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateExperienceCommandOutput) => void): void;
|
|
675
732
|
/**
|
|
733
|
+
* @public
|
|
676
734
|
* <p>Updates an existing Amazon Kendra index.</p>
|
|
677
735
|
*/
|
|
678
736
|
updateIndex(args: UpdateIndexCommandInput, options?: __HttpHandlerOptions): Promise<UpdateIndexCommandOutput>;
|
|
679
737
|
updateIndex(args: UpdateIndexCommandInput, cb: (err: any, data?: UpdateIndexCommandOutput) => void): void;
|
|
680
738
|
updateIndex(args: UpdateIndexCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIndexCommandOutput) => void): void;
|
|
681
739
|
/**
|
|
740
|
+
* @public
|
|
682
741
|
* <p>Updates a block list used for query suggestions for an index.</p>
|
|
683
742
|
* <p>Updates to a block list might not take effect right away. Amazon Kendra
|
|
684
743
|
* needs to refresh the entire suggestions list to apply any updates to the
|
|
@@ -695,6 +754,7 @@ export declare class Kendra extends KendraClient {
|
|
|
695
754
|
updateQuerySuggestionsBlockList(args: UpdateQuerySuggestionsBlockListCommandInput, cb: (err: any, data?: UpdateQuerySuggestionsBlockListCommandOutput) => void): void;
|
|
696
755
|
updateQuerySuggestionsBlockList(args: UpdateQuerySuggestionsBlockListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateQuerySuggestionsBlockListCommandOutput) => void): void;
|
|
697
756
|
/**
|
|
757
|
+
* @public
|
|
698
758
|
* <p>Updates the settings of query suggestions for an index.</p>
|
|
699
759
|
* <p>Amazon Kendra supports partial updates, so you only need to provide
|
|
700
760
|
* the fields you want to update.</p>
|
|
@@ -712,6 +772,7 @@ export declare class Kendra extends KendraClient {
|
|
|
712
772
|
updateQuerySuggestionsConfig(args: UpdateQuerySuggestionsConfigCommandInput, cb: (err: any, data?: UpdateQuerySuggestionsConfigCommandOutput) => void): void;
|
|
713
773
|
updateQuerySuggestionsConfig(args: UpdateQuerySuggestionsConfigCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateQuerySuggestionsConfigCommandOutput) => void): void;
|
|
714
774
|
/**
|
|
775
|
+
* @public
|
|
715
776
|
* <p>Updates a thesaurus for an index.</p>
|
|
716
777
|
*/
|
|
717
778
|
updateThesaurus(args: UpdateThesaurusCommandInput, options?: __HttpHandlerOptions): Promise<UpdateThesaurusCommandOutput>;
|
|
@@ -68,15 +68,24 @@ import { UpdateQuerySuggestionsBlockListCommandInput, UpdateQuerySuggestionsBloc
|
|
|
68
68
|
import { UpdateQuerySuggestionsConfigCommandInput, UpdateQuerySuggestionsConfigCommandOutput } from "./commands/UpdateQuerySuggestionsConfigCommand";
|
|
69
69
|
import { UpdateThesaurusCommandInput, UpdateThesaurusCommandOutput } from "./commands/UpdateThesaurusCommand";
|
|
70
70
|
import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
|
|
71
|
+
/**
|
|
72
|
+
* @public
|
|
73
|
+
*/
|
|
71
74
|
export 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;
|
|
75
|
+
/**
|
|
76
|
+
* @public
|
|
77
|
+
*/
|
|
72
78
|
export 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;
|
|
79
|
+
/**
|
|
80
|
+
* @public
|
|
81
|
+
*/
|
|
73
82
|
export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__HttpHandlerOptions>> {
|
|
74
83
|
/**
|
|
75
84
|
* The HTTP handler to use. Fetch in browser and Https in Nodejs.
|
|
76
85
|
*/
|
|
77
86
|
requestHandler?: __HttpHandler;
|
|
78
87
|
/**
|
|
79
|
-
* A constructor for a class implementing the {@link
|
|
88
|
+
* A constructor for a class implementing the {@link @aws-sdk/types#ChecksumConstructor} interface
|
|
80
89
|
* that computes the SHA-256 HMAC or checksum of a string or binary buffer.
|
|
81
90
|
* @internal
|
|
82
91
|
*/
|
|
@@ -166,23 +175,34 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
|
|
|
166
175
|
*/
|
|
167
176
|
logger?: __Logger;
|
|
168
177
|
/**
|
|
169
|
-
* The {@link
|
|
178
|
+
* The {@link @aws-sdk/smithy-client#DefaultsMode} that will be used to determine how certain default configuration options are resolved in the SDK.
|
|
170
179
|
*/
|
|
171
180
|
defaultsMode?: __DefaultsMode | __Provider<__DefaultsMode>;
|
|
172
181
|
}
|
|
182
|
+
/**
|
|
183
|
+
* @public
|
|
184
|
+
*/
|
|
173
185
|
type KendraClientConfigType = Partial<__SmithyConfiguration<__HttpHandlerOptions>> & ClientDefaults & RegionInputConfig & EndpointInputConfig<EndpointParameters> & RetryInputConfig & HostHeaderInputConfig & AwsAuthInputConfig & UserAgentInputConfig & ClientInputEndpointParameters;
|
|
174
186
|
/**
|
|
175
|
-
*
|
|
187
|
+
* @public
|
|
188
|
+
*
|
|
189
|
+
* The configuration interface of KendraClient class constructor that set the region, credentials and other options.
|
|
176
190
|
*/
|
|
177
191
|
export interface KendraClientConfig extends KendraClientConfigType {
|
|
178
192
|
}
|
|
193
|
+
/**
|
|
194
|
+
* @public
|
|
195
|
+
*/
|
|
179
196
|
type KendraClientResolvedConfigType = __SmithyResolvedConfiguration<__HttpHandlerOptions> & Required<ClientDefaults> & RegionResolvedConfig & EndpointResolvedConfig<EndpointParameters> & RetryResolvedConfig & HostHeaderResolvedConfig & AwsAuthResolvedConfig & UserAgentResolvedConfig & ClientResolvedEndpointParameters;
|
|
180
197
|
/**
|
|
181
|
-
*
|
|
198
|
+
* @public
|
|
199
|
+
*
|
|
200
|
+
* The resolved configuration interface of KendraClient class. This is resolved and normalized from the {@link KendraClientConfig | constructor configuration interface}.
|
|
182
201
|
*/
|
|
183
202
|
export interface KendraClientResolvedConfig extends KendraClientResolvedConfigType {
|
|
184
203
|
}
|
|
185
204
|
/**
|
|
205
|
+
* @public
|
|
186
206
|
* <p>Amazon Kendra is a service for indexing large document sets.</p>
|
|
187
207
|
*/
|
|
188
208
|
export declare class KendraClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, KendraClientResolvedConfig> {
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
|
|
5
5
|
import { AssociateEntitiesToExperienceRequest, AssociateEntitiesToExperienceResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link AssociateEntitiesToExperienceCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface AssociateEntitiesToExperienceCommandInput extends AssociateEntitiesToExperienceRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link AssociateEntitiesToExperienceCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface AssociateEntitiesToExperienceCommandOutput extends AssociateEntitiesToExperienceResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Grants users or groups in your IAM Identity Center identity source access
|
|
18
23
|
* to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a
|
|
19
24
|
* search application. For more information on creating a search application
|
|
@@ -29,6 +34,8 @@ export interface AssociateEntitiesToExperienceCommandOutput extends AssociateEnt
|
|
|
29
34
|
* const response = await client.send(command);
|
|
30
35
|
* ```
|
|
31
36
|
*
|
|
37
|
+
* @param AssociateEntitiesToExperienceCommandInput - {@link AssociateEntitiesToExperienceCommandInput}
|
|
38
|
+
* @returns {@link AssociateEntitiesToExperienceCommandOutput}
|
|
32
39
|
* @see {@link AssociateEntitiesToExperienceCommandInput} for command's `input` shape.
|
|
33
40
|
* @see {@link AssociateEntitiesToExperienceCommandOutput} for command's `response` shape.
|
|
34
41
|
* @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
|
|
@@ -62,11 +69,20 @@ export interface AssociateEntitiesToExperienceCommandOutput extends AssociateEnt
|
|
|
62
69
|
export declare class AssociateEntitiesToExperienceCommand extends $Command<AssociateEntitiesToExperienceCommandInput, AssociateEntitiesToExperienceCommandOutput, KendraClientResolvedConfig> {
|
|
63
70
|
readonly input: AssociateEntitiesToExperienceCommandInput;
|
|
64
71
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
72
|
+
/**
|
|
73
|
+
* @public
|
|
74
|
+
*/
|
|
65
75
|
constructor(input: AssociateEntitiesToExperienceCommandInput);
|
|
66
76
|
/**
|
|
67
77
|
* @internal
|
|
68
78
|
*/
|
|
69
79
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AssociateEntitiesToExperienceCommandInput, AssociateEntitiesToExperienceCommandOutput>;
|
|
80
|
+
/**
|
|
81
|
+
* @internal
|
|
82
|
+
*/
|
|
70
83
|
private serialize;
|
|
84
|
+
/**
|
|
85
|
+
* @internal
|
|
86
|
+
*/
|
|
71
87
|
private deserialize;
|
|
72
88
|
}
|
|
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
|
|
|
4
4
|
import { KendraClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../KendraClient";
|
|
5
5
|
import { AssociatePersonasToEntitiesRequest, AssociatePersonasToEntitiesResponse } from "../models/models_0";
|
|
6
6
|
/**
|
|
7
|
+
* @public
|
|
8
|
+
*
|
|
7
9
|
* The input for {@link AssociatePersonasToEntitiesCommand}.
|
|
8
10
|
*/
|
|
9
11
|
export interface AssociatePersonasToEntitiesCommandInput extends AssociatePersonasToEntitiesRequest {
|
|
10
12
|
}
|
|
11
13
|
/**
|
|
14
|
+
* @public
|
|
15
|
+
*
|
|
12
16
|
* The output of {@link AssociatePersonasToEntitiesCommand}.
|
|
13
17
|
*/
|
|
14
18
|
export interface AssociatePersonasToEntitiesCommandOutput extends AssociatePersonasToEntitiesResponse, __MetadataBearer {
|
|
15
19
|
}
|
|
16
20
|
/**
|
|
21
|
+
* @public
|
|
17
22
|
* <p>Defines the specific permissions of users or groups in your IAM Identity Center
|
|
18
23
|
* identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra
|
|
19
24
|
* experience such as a search application. For more information on creating a
|
|
@@ -29,6 +34,8 @@ export interface AssociatePersonasToEntitiesCommandOutput extends AssociatePerso
|
|
|
29
34
|
* const response = await client.send(command);
|
|
30
35
|
* ```
|
|
31
36
|
*
|
|
37
|
+
* @param AssociatePersonasToEntitiesCommandInput - {@link AssociatePersonasToEntitiesCommandInput}
|
|
38
|
+
* @returns {@link AssociatePersonasToEntitiesCommandOutput}
|
|
32
39
|
* @see {@link AssociatePersonasToEntitiesCommandInput} for command's `input` shape.
|
|
33
40
|
* @see {@link AssociatePersonasToEntitiesCommandOutput} for command's `response` shape.
|
|
34
41
|
* @see {@link KendraClientResolvedConfig | config} for KendraClient's `config` shape.
|
|
@@ -62,11 +69,20 @@ export interface AssociatePersonasToEntitiesCommandOutput extends AssociatePerso
|
|
|
62
69
|
export declare class AssociatePersonasToEntitiesCommand extends $Command<AssociatePersonasToEntitiesCommandInput, AssociatePersonasToEntitiesCommandOutput, KendraClientResolvedConfig> {
|
|
63
70
|
readonly input: AssociatePersonasToEntitiesCommandInput;
|
|
64
71
|
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
72
|
+
/**
|
|
73
|
+
* @public
|
|
74
|
+
*/
|
|
65
75
|
constructor(input: AssociatePersonasToEntitiesCommandInput);
|
|
66
76
|
/**
|
|
67
77
|
* @internal
|
|
68
78
|
*/
|
|
69
79
|
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: KendraClientResolvedConfig, options?: __HttpHandlerOptions): Handler<AssociatePersonasToEntitiesCommandInput, AssociatePersonasToEntitiesCommandOutput>;
|
|
80
|
+
/**
|
|
81
|
+
* @internal
|
|
82
|
+
*/
|
|
70
83
|
private serialize;
|
|
84
|
+
/**
|
|
85
|
+
* @internal
|
|
86
|
+
*/
|
|
71
87
|
private deserialize;
|
|
72
88
|
}
|