@aws-sdk/client-kendra 3.51.0 → 3.54.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 +33 -0
- package/dist-cjs/index.js +3 -0
- package/dist-cjs/models/KendraServiceException.js +11 -0
- package/dist-cjs/models/models_0.js +190 -6
- package/dist-cjs/protocols/Aws_json1_1.js +794 -2572
- package/dist-es/index.js +1 -0
- package/dist-es/models/KendraServiceException.js +12 -0
- package/dist-es/models/models_0.js +166 -1
- package/dist-es/protocols/Aws_json1_1.js +1543 -2773
- package/dist-types/Kendra.d.ts +17 -17
- package/dist-types/KendraClient.d.ts +2 -2
- package/dist-types/commands/BatchDeleteDocumentCommand.d.ts +1 -1
- package/dist-types/commands/BatchGetDocumentStatusCommand.d.ts +5 -5
- package/dist-types/commands/BatchPutDocumentCommand.d.ts +2 -2
- package/dist-types/commands/CreateIndexCommand.d.ts +2 -2
- package/dist-types/commands/DeleteDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/DeleteIndexCommand.d.ts +1 -1
- package/dist-types/commands/DescribeDataSourceCommand.d.ts +1 -1
- package/dist-types/commands/QueryCommand.d.ts +2 -2
- package/dist-types/commands/StopDataSourceSyncJobCommand.d.ts +2 -2
- package/dist-types/index.d.ts +1 -0
- package/dist-types/models/KendraServiceException.d.ts +10 -0
- package/dist-types/models/models_0.d.ts +385 -179
- package/dist-types/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/runtimeConfig.d.ts +1 -1
- package/dist-types/runtimeConfig.native.d.ts +1 -1
- package/dist-types/ts3.4/KendraClient.d.ts +2 -2
- package/dist-types/ts3.4/index.d.ts +1 -0
- package/dist-types/ts3.4/models/KendraServiceException.d.ts +6 -0
- package/dist-types/ts3.4/models/models_0.d.ts +123 -34
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/ts3.4/runtimeConfig.d.ts +1 -1
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -1
- package/package.json +33 -33
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
|
|
2
|
+
import { KendraServiceException as __BaseException } from "./KendraServiceException";
|
|
2
3
|
/**
|
|
3
4
|
* <p>Access Control List files for the documents in a data source. For
|
|
4
5
|
* the format of the file, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/s3-acl.html">Access control for S3 data
|
|
@@ -19,10 +20,14 @@ export declare namespace AccessControlListConfiguration {
|
|
|
19
20
|
/**
|
|
20
21
|
* <p></p>
|
|
21
22
|
*/
|
|
22
|
-
export
|
|
23
|
-
name: "AccessDeniedException";
|
|
24
|
-
$fault: "client";
|
|
23
|
+
export declare class AccessDeniedException extends __BaseException {
|
|
24
|
+
readonly name: "AccessDeniedException";
|
|
25
|
+
readonly $fault: "client";
|
|
25
26
|
Message?: string;
|
|
27
|
+
/**
|
|
28
|
+
* @internal
|
|
29
|
+
*/
|
|
30
|
+
constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
|
|
26
31
|
}
|
|
27
32
|
/**
|
|
28
33
|
* <p>Provides information about the column that should be used for
|
|
@@ -34,7 +39,7 @@ export interface AclConfiguration {
|
|
|
34
39
|
* response based on user context. The document is only returned to
|
|
35
40
|
* users that are in one of the groups specified in the
|
|
36
41
|
* <code>UserContext</code> field of the <code>Query</code>
|
|
37
|
-
*
|
|
42
|
+
* API.</p>
|
|
38
43
|
*/
|
|
39
44
|
AllowedGroupsColumnName: string | undefined;
|
|
40
45
|
}
|
|
@@ -148,7 +153,7 @@ export declare enum EntityType {
|
|
|
148
153
|
USER = "USER"
|
|
149
154
|
}
|
|
150
155
|
/**
|
|
151
|
-
* <p>Provides the configuration information
|
|
156
|
+
* <p>Provides the configuration information for users or groups in
|
|
152
157
|
* your Amazon Web Services SSO identity source to grant access your Amazon Kendra
|
|
153
158
|
* experience.</p>
|
|
154
159
|
*/
|
|
@@ -228,49 +233,69 @@ export declare namespace AssociateEntitiesToExperienceResponse {
|
|
|
228
233
|
/**
|
|
229
234
|
* <p></p>
|
|
230
235
|
*/
|
|
231
|
-
export
|
|
232
|
-
name: "InternalServerException";
|
|
233
|
-
$fault: "server";
|
|
236
|
+
export declare class InternalServerException extends __BaseException {
|
|
237
|
+
readonly name: "InternalServerException";
|
|
238
|
+
readonly $fault: "server";
|
|
234
239
|
Message?: string;
|
|
240
|
+
/**
|
|
241
|
+
* @internal
|
|
242
|
+
*/
|
|
243
|
+
constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
|
|
235
244
|
}
|
|
236
245
|
/**
|
|
237
246
|
* <p></p>
|
|
238
247
|
*/
|
|
239
|
-
export
|
|
240
|
-
name: "ResourceAlreadyExistException";
|
|
241
|
-
$fault: "client";
|
|
248
|
+
export declare class ResourceAlreadyExistException extends __BaseException {
|
|
249
|
+
readonly name: "ResourceAlreadyExistException";
|
|
250
|
+
readonly $fault: "client";
|
|
242
251
|
Message?: string;
|
|
252
|
+
/**
|
|
253
|
+
* @internal
|
|
254
|
+
*/
|
|
255
|
+
constructor(opts: __ExceptionOptionType<ResourceAlreadyExistException, __BaseException>);
|
|
243
256
|
}
|
|
244
257
|
/**
|
|
245
258
|
* <p></p>
|
|
246
259
|
*/
|
|
247
|
-
export
|
|
248
|
-
name: "ResourceNotFoundException";
|
|
249
|
-
$fault: "client";
|
|
260
|
+
export declare class ResourceNotFoundException extends __BaseException {
|
|
261
|
+
readonly name: "ResourceNotFoundException";
|
|
262
|
+
readonly $fault: "client";
|
|
250
263
|
Message?: string;
|
|
264
|
+
/**
|
|
265
|
+
* @internal
|
|
266
|
+
*/
|
|
267
|
+
constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
|
|
251
268
|
}
|
|
252
269
|
/**
|
|
253
270
|
* <p></p>
|
|
254
271
|
*/
|
|
255
|
-
export
|
|
256
|
-
name: "ThrottlingException";
|
|
257
|
-
$fault: "client";
|
|
272
|
+
export declare class ThrottlingException extends __BaseException {
|
|
273
|
+
readonly name: "ThrottlingException";
|
|
274
|
+
readonly $fault: "client";
|
|
258
275
|
Message?: string;
|
|
276
|
+
/**
|
|
277
|
+
* @internal
|
|
278
|
+
*/
|
|
279
|
+
constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
|
|
259
280
|
}
|
|
260
281
|
/**
|
|
261
282
|
* <p></p>
|
|
262
283
|
*/
|
|
263
|
-
export
|
|
264
|
-
name: "ValidationException";
|
|
265
|
-
$fault: "client";
|
|
284
|
+
export declare class ValidationException extends __BaseException {
|
|
285
|
+
readonly name: "ValidationException";
|
|
286
|
+
readonly $fault: "client";
|
|
266
287
|
Message?: string;
|
|
288
|
+
/**
|
|
289
|
+
* @internal
|
|
290
|
+
*/
|
|
291
|
+
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
267
292
|
}
|
|
268
293
|
export declare enum Persona {
|
|
269
294
|
OWNER = "OWNER",
|
|
270
295
|
VIEWER = "VIEWER"
|
|
271
296
|
}
|
|
272
297
|
/**
|
|
273
|
-
* <p>Provides the configuration information
|
|
298
|
+
* <p>Provides the configuration information for users or groups in your
|
|
274
299
|
* Amazon Web Services SSO identity source for access to your Amazon Kendra experience.
|
|
275
300
|
* Specific permissions are defined for each user or group once they are
|
|
276
301
|
* granted access to your Amazon Kendra experience.</p>
|
|
@@ -494,7 +519,7 @@ export declare enum ErrorCode {
|
|
|
494
519
|
/**
|
|
495
520
|
* <p>Provides information about documents that could not be removed
|
|
496
521
|
* from an index by the <code>BatchDeleteDocument</code>
|
|
497
|
-
*
|
|
522
|
+
* API.</p>
|
|
498
523
|
*/
|
|
499
524
|
export interface BatchDeleteDocumentResponseFailedDocument {
|
|
500
525
|
/**
|
|
@@ -536,10 +561,14 @@ export declare namespace BatchDeleteDocumentResponse {
|
|
|
536
561
|
/**
|
|
537
562
|
* <p></p>
|
|
538
563
|
*/
|
|
539
|
-
export
|
|
540
|
-
name: "ConflictException";
|
|
541
|
-
$fault: "client";
|
|
564
|
+
export declare class ConflictException extends __BaseException {
|
|
565
|
+
readonly name: "ConflictException";
|
|
566
|
+
readonly $fault: "client";
|
|
542
567
|
Message?: string;
|
|
568
|
+
/**
|
|
569
|
+
* @internal
|
|
570
|
+
*/
|
|
571
|
+
constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
|
|
543
572
|
}
|
|
544
573
|
/**
|
|
545
574
|
* <p>Identifies a document for which to retrieve status
|
|
@@ -597,8 +626,8 @@ export declare namespace DocumentInfo {
|
|
|
597
626
|
export interface BatchGetDocumentStatusRequest {
|
|
598
627
|
/**
|
|
599
628
|
* <p>The identifier of the index to add documents to. The index ID is
|
|
600
|
-
* returned by the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_CreateIndex.html">
|
|
601
|
-
* </a>
|
|
629
|
+
* returned by the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_CreateIndex.html">CreateIndex
|
|
630
|
+
* </a> API.</p>
|
|
602
631
|
*/
|
|
603
632
|
IndexId: string | undefined;
|
|
604
633
|
/**
|
|
@@ -1008,7 +1037,7 @@ export interface Document {
|
|
|
1008
1037
|
* <p>The contents of the document. </p>
|
|
1009
1038
|
* <p>Documents passed to the <code>Blob</code> parameter must be base64
|
|
1010
1039
|
* encoded. Your code might not need to encode the document file bytes
|
|
1011
|
-
* if you're using an Amazon Web Services SDK to call Amazon Kendra
|
|
1040
|
+
* if you're using an Amazon Web Services SDK to call Amazon Kendra APIs. If you are
|
|
1012
1041
|
* calling the Amazon Kendra endpoint directly using REST, you must base64
|
|
1013
1042
|
* encode the contents before sending.</p>
|
|
1014
1043
|
*/
|
|
@@ -1023,6 +1052,11 @@ export interface Document {
|
|
|
1023
1052
|
* attributes to provide additional information for searching, to
|
|
1024
1053
|
* provide facets for refining searches, and to provide additional
|
|
1025
1054
|
* information in the query response.</p>
|
|
1055
|
+
* <p>For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom
|
|
1056
|
+
* attributes that provide information on the synchronization
|
|
1057
|
+
* of documents running on a data source. Note,
|
|
1058
|
+
* 'DataSourceSyncJobId' could be an optional custom attribute
|
|
1059
|
+
* as Amazon Kendra will use the ID of a running sync job.</p>
|
|
1026
1060
|
*/
|
|
1027
1061
|
Attributes?: DocumentAttribute[];
|
|
1028
1062
|
/**
|
|
@@ -1051,24 +1085,18 @@ export interface BatchPutDocumentRequest {
|
|
|
1051
1085
|
/**
|
|
1052
1086
|
* <p>The identifier of the index to add the documents to. You need to
|
|
1053
1087
|
* create the index first using the <code>CreateIndex</code>
|
|
1054
|
-
*
|
|
1088
|
+
* API.</p>
|
|
1055
1089
|
*/
|
|
1056
1090
|
IndexId: string | undefined;
|
|
1057
1091
|
/**
|
|
1058
1092
|
* <p>The Amazon Resource Name (ARN) of a role that is allowed to run the
|
|
1059
|
-
* <code>BatchPutDocument</code>
|
|
1093
|
+
* <code>BatchPutDocument</code> API. For more information, see
|
|
1060
1094
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM
|
|
1061
|
-
*
|
|
1095
|
+
* Roles for Amazon Kendra</a>.</p>
|
|
1062
1096
|
*/
|
|
1063
1097
|
RoleArn?: string;
|
|
1064
1098
|
/**
|
|
1065
1099
|
* <p>One or more documents to add to the index.</p>
|
|
1066
|
-
* <p>Documents can include custom attributes. For example,
|
|
1067
|
-
* 'DataSourceId' and 'DataSourceSyncJobId' are custom
|
|
1068
|
-
* attributes that provide information on the synchronization
|
|
1069
|
-
* of documents running on a data source. Note,
|
|
1070
|
-
* 'DataSourceSyncJobId' could be an optional custom attribute
|
|
1071
|
-
* as Amazon Kendra will use the ID of a running sync job.</p>
|
|
1072
1100
|
* <p>Documents have the following file size limits.</p>
|
|
1073
1101
|
* <ul>
|
|
1074
1102
|
* <li>
|
|
@@ -1088,7 +1116,7 @@ export interface BatchPutDocumentRequest {
|
|
|
1088
1116
|
/**
|
|
1089
1117
|
* <p>Configuration information for altering your document metadata and content during
|
|
1090
1118
|
* the document ingestion process when you use the <code>BatchPutDocument</code>
|
|
1091
|
-
*
|
|
1119
|
+
* API.</p>
|
|
1092
1120
|
* <p>For more information on how to create, modify and delete document metadata,
|
|
1093
1121
|
* or make other content alterations when you ingest documents into Amazon Kendra, see
|
|
1094
1122
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/custom-document-enrichment.html">Customizing
|
|
@@ -1150,10 +1178,14 @@ export declare namespace BatchPutDocumentResponse {
|
|
|
1150
1178
|
/**
|
|
1151
1179
|
* <p></p>
|
|
1152
1180
|
*/
|
|
1153
|
-
export
|
|
1154
|
-
name: "ServiceQuotaExceededException";
|
|
1155
|
-
$fault: "client";
|
|
1181
|
+
export declare class ServiceQuotaExceededException extends __BaseException {
|
|
1182
|
+
readonly name: "ServiceQuotaExceededException";
|
|
1183
|
+
readonly $fault: "client";
|
|
1156
1184
|
Message?: string;
|
|
1185
|
+
/**
|
|
1186
|
+
* @internal
|
|
1187
|
+
*/
|
|
1188
|
+
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
1157
1189
|
}
|
|
1158
1190
|
export interface ClearQuerySuggestionsRequest {
|
|
1159
1191
|
/**
|
|
@@ -1184,13 +1216,13 @@ export declare enum ConfluenceAttachmentFieldName {
|
|
|
1184
1216
|
* <p>Defines the mapping between a field in the Confluence data source
|
|
1185
1217
|
* to a Amazon Kendra index field.</p>
|
|
1186
1218
|
* <p>You must first create the index field using the
|
|
1187
|
-
* <code>UpdateIndex</code>
|
|
1219
|
+
* <code>UpdateIndex</code> API. </p>
|
|
1188
1220
|
*/
|
|
1189
1221
|
export interface ConfluenceAttachmentToIndexFieldMapping {
|
|
1190
1222
|
/**
|
|
1191
1223
|
* <p>The name of the field in the data source. </p>
|
|
1192
1224
|
* <p>You must first create the index field using the
|
|
1193
|
-
* <code>UpdateIndex</code>
|
|
1225
|
+
* <code>UpdateIndex</code> API. </p>
|
|
1194
1226
|
*/
|
|
1195
1227
|
DataSourceFieldName?: ConfluenceAttachmentFieldName | string;
|
|
1196
1228
|
/**
|
|
@@ -1228,7 +1260,7 @@ export interface ConfluenceAttachmentConfiguration {
|
|
|
1228
1260
|
* <p>Defines how attachment metadata fields should be mapped to index
|
|
1229
1261
|
* fields. Before you can map a field, you must first create an index
|
|
1230
1262
|
* field with a matching type using the console or the
|
|
1231
|
-
* <code>UpdateIndex</code>
|
|
1263
|
+
* <code>UpdateIndex</code> API.</p>
|
|
1232
1264
|
* <p>If you specify the <code>AttachentFieldMappings</code> parameter,
|
|
1233
1265
|
* you must specify at least one field mapping.</p>
|
|
1234
1266
|
*/
|
|
@@ -1255,7 +1287,7 @@ export declare enum ConfluenceBlogFieldName {
|
|
|
1255
1287
|
* <p>Defines the mapping between a blog field in the Confluence data
|
|
1256
1288
|
* source to a Amazon Kendra index field.</p>
|
|
1257
1289
|
* <p>You must first create the index field using the
|
|
1258
|
-
* <code>UpdateIndex</code>
|
|
1290
|
+
* <code>UpdateIndex</code> API. </p>
|
|
1259
1291
|
*/
|
|
1260
1292
|
export interface ConfluenceBlogToIndexFieldMapping {
|
|
1261
1293
|
/**
|
|
@@ -1286,14 +1318,14 @@ export declare namespace ConfluenceBlogToIndexFieldMapping {
|
|
|
1286
1318
|
* <p>Specifies the blog settings for the Confluence data source. Blogs
|
|
1287
1319
|
* are always indexed unless filtered from the index by the
|
|
1288
1320
|
* <code>ExclusionPatterns</code> or <code>InclusionPatterns</code>
|
|
1289
|
-
* fields in the <code>ConfluenceConfiguration</code>
|
|
1321
|
+
* fields in the <code>ConfluenceConfiguration</code> object.</p>
|
|
1290
1322
|
*/
|
|
1291
1323
|
export interface ConfluenceBlogConfiguration {
|
|
1292
1324
|
/**
|
|
1293
1325
|
* <p>Defines how blog metadata fields should be mapped to index fields.
|
|
1294
1326
|
* Before you can map a field, you must first create an index field
|
|
1295
1327
|
* with a matching type using the console or the
|
|
1296
|
-
* <code>UpdateIndex</code>
|
|
1328
|
+
* <code>UpdateIndex</code> API.</p>
|
|
1297
1329
|
* <p>If you specify the <code>BlogFieldMappings</code> parameter, you
|
|
1298
1330
|
* must specify at least one field mapping.</p>
|
|
1299
1331
|
*/
|
|
@@ -1323,7 +1355,7 @@ export declare enum ConfluencePageFieldName {
|
|
|
1323
1355
|
* <p>Defines the mapping between a field in the Confluence data source
|
|
1324
1356
|
* to a Amazon Kendra index field.</p>
|
|
1325
1357
|
* <p>You must first create the index field using the
|
|
1326
|
-
* <code>UpdateIndex</code>
|
|
1358
|
+
* <code>UpdateIndex</code> API.</p>
|
|
1327
1359
|
*/
|
|
1328
1360
|
export interface ConfluencePageToIndexFieldMapping {
|
|
1329
1361
|
/**
|
|
@@ -1358,7 +1390,7 @@ export interface ConfluencePageConfiguration {
|
|
|
1358
1390
|
* <p>Defines how page metadata fields should be mapped to index fields.
|
|
1359
1391
|
* Before you can map a field, you must first create an index field
|
|
1360
1392
|
* with a matching type using the console or the
|
|
1361
|
-
* <code>UpdateIndex</code>
|
|
1393
|
+
* <code>UpdateIndex</code> API.</p>
|
|
1362
1394
|
* <p>If you specify the <code>PageFieldMappings</code> parameter, you
|
|
1363
1395
|
* must specify at least one field mapping.</p>
|
|
1364
1396
|
*/
|
|
@@ -1378,9 +1410,9 @@ export declare enum ConfluenceSpaceFieldName {
|
|
|
1378
1410
|
}
|
|
1379
1411
|
/**
|
|
1380
1412
|
* <p>Defines the mapping between a field in the Confluence data source
|
|
1381
|
-
* to
|
|
1413
|
+
* to an Amazon Kendra index field.</p>
|
|
1382
1414
|
* <p>You must first create the index field using the
|
|
1383
|
-
* <code>UpdateIndex</code>
|
|
1415
|
+
* <code>UpdateIndex</code> API.</p>
|
|
1384
1416
|
*/
|
|
1385
1417
|
export interface ConfluenceSpaceToIndexFieldMapping {
|
|
1386
1418
|
/**
|
|
@@ -1445,7 +1477,7 @@ export interface ConfluenceSpaceConfiguration {
|
|
|
1445
1477
|
* <p>Defines how space metadata fields should be mapped to index
|
|
1446
1478
|
* fields. Before you can map a field, you must first create an index
|
|
1447
1479
|
* field with a matching type using the console or the
|
|
1448
|
-
* <code>UpdateIndex</code>
|
|
1480
|
+
* <code>UpdateIndex</code> API.</p>
|
|
1449
1481
|
* <p>If you specify the <code>SpaceFieldMappings</code> parameter, you
|
|
1450
1482
|
* must specify at least one field mapping.</p>
|
|
1451
1483
|
*/
|
|
@@ -1462,7 +1494,7 @@ export declare enum ConfluenceVersion {
|
|
|
1462
1494
|
SERVER = "SERVER"
|
|
1463
1495
|
}
|
|
1464
1496
|
/**
|
|
1465
|
-
* <p>Provides information
|
|
1497
|
+
* <p>Provides the configuration information to connect to an Amazon VPC.</p>
|
|
1466
1498
|
*/
|
|
1467
1499
|
export interface DataSourceVpcConfiguration {
|
|
1468
1500
|
/**
|
|
@@ -1486,8 +1518,8 @@ export declare namespace DataSourceVpcConfiguration {
|
|
|
1486
1518
|
const filterSensitiveLog: (obj: DataSourceVpcConfiguration) => any;
|
|
1487
1519
|
}
|
|
1488
1520
|
/**
|
|
1489
|
-
* <p>Provides configuration information
|
|
1490
|
-
*
|
|
1521
|
+
* <p>Provides the configuration information to connect to Confluence
|
|
1522
|
+
* as your data source.</p>
|
|
1491
1523
|
*/
|
|
1492
1524
|
export interface ConfluenceConfiguration {
|
|
1493
1525
|
/**
|
|
@@ -1573,7 +1605,7 @@ export declare namespace ConfluenceConfiguration {
|
|
|
1573
1605
|
/**
|
|
1574
1606
|
* <p>Maps a column or attribute in the data source to an index field.
|
|
1575
1607
|
* You must first create the fields in the index using the
|
|
1576
|
-
* <code>UpdateIndex</code>
|
|
1608
|
+
* <code>UpdateIndex</code> API.</p>
|
|
1577
1609
|
*/
|
|
1578
1610
|
export interface DataSourceToIndexFieldMapping {
|
|
1579
1611
|
/**
|
|
@@ -1615,7 +1647,7 @@ export interface ColumnConfiguration {
|
|
|
1615
1647
|
/**
|
|
1616
1648
|
* <p>An array of objects that map database column names to the
|
|
1617
1649
|
* corresponding fields in an index. You must first create the fields
|
|
1618
|
-
* in the index using the <code>UpdateIndex</code>
|
|
1650
|
+
* in the index using the <code>UpdateIndex</code> API.</p>
|
|
1619
1651
|
*/
|
|
1620
1652
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
1621
1653
|
/**
|
|
@@ -1631,7 +1663,7 @@ export declare namespace ColumnConfiguration {
|
|
|
1631
1663
|
const filterSensitiveLog: (obj: ColumnConfiguration) => any;
|
|
1632
1664
|
}
|
|
1633
1665
|
/**
|
|
1634
|
-
* <p>Provides the information
|
|
1666
|
+
* <p>Provides the configuration information that's required to connect to a
|
|
1635
1667
|
* database.</p>
|
|
1636
1668
|
*/
|
|
1637
1669
|
export interface ConnectionConfiguration {
|
|
@@ -1680,7 +1712,7 @@ export declare enum QueryIdentifiersEnclosingOption {
|
|
|
1680
1712
|
NONE = "NONE"
|
|
1681
1713
|
}
|
|
1682
1714
|
/**
|
|
1683
|
-
* <p>Provides
|
|
1715
|
+
* <p>Provides the configuration information to use a SQL
|
|
1684
1716
|
* database.</p>
|
|
1685
1717
|
*/
|
|
1686
1718
|
export interface SqlConfiguration {
|
|
@@ -1707,7 +1739,7 @@ export declare namespace SqlConfiguration {
|
|
|
1707
1739
|
const filterSensitiveLog: (obj: SqlConfiguration) => any;
|
|
1708
1740
|
}
|
|
1709
1741
|
/**
|
|
1710
|
-
* <p>Provides the information
|
|
1742
|
+
* <p>Provides the configuration information to connect to a
|
|
1711
1743
|
* index. </p>
|
|
1712
1744
|
*/
|
|
1713
1745
|
export interface DatabaseConfiguration {
|
|
@@ -1716,11 +1748,11 @@ export interface DatabaseConfiguration {
|
|
|
1716
1748
|
*/
|
|
1717
1749
|
DatabaseEngineType: DatabaseEngineType | string | undefined;
|
|
1718
1750
|
/**
|
|
1719
|
-
* <p>
|
|
1751
|
+
* <p>Configuration information that's required to connect to a database.</p>
|
|
1720
1752
|
*/
|
|
1721
1753
|
ConnectionConfiguration: ConnectionConfiguration | undefined;
|
|
1722
1754
|
/**
|
|
1723
|
-
* <p>Provides information
|
|
1755
|
+
* <p>Provides the configuration information to connect to an Amazon VPC.</p>
|
|
1724
1756
|
*/
|
|
1725
1757
|
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
1726
1758
|
/**
|
|
@@ -1745,9 +1777,92 @@ export declare namespace DatabaseConfiguration {
|
|
|
1745
1777
|
*/
|
|
1746
1778
|
const filterSensitiveLog: (obj: DatabaseConfiguration) => any;
|
|
1747
1779
|
}
|
|
1780
|
+
export declare enum FsxFileSystemType {
|
|
1781
|
+
WINDOWS = "WINDOWS"
|
|
1782
|
+
}
|
|
1783
|
+
/**
|
|
1784
|
+
* <p>Provides the configuration information to connect to Amazon FSx as
|
|
1785
|
+
* your data source.</p>
|
|
1786
|
+
*/
|
|
1787
|
+
export interface FsxConfiguration {
|
|
1788
|
+
/**
|
|
1789
|
+
* <p>The identifier of the Amazon FSx file system.</p>
|
|
1790
|
+
* <p>You can find your file system ID on the file system dashboard in
|
|
1791
|
+
* the Amazon FSx console. For information on how to create a
|
|
1792
|
+
* file system in Amazon FSx console, using Windows File Server
|
|
1793
|
+
* as an example, see <a href="https://docs.aws.amazon.com/fsx/latest/WindowsGuide/getting-started-step1.html">Amazon FSx
|
|
1794
|
+
* Getting started guide</a>.</p>
|
|
1795
|
+
*/
|
|
1796
|
+
FileSystemId: string | undefined;
|
|
1797
|
+
/**
|
|
1798
|
+
* <p>The Amazon FSx file system type. Windows is currently the only
|
|
1799
|
+
* supported type.</p>
|
|
1800
|
+
*/
|
|
1801
|
+
FileSystemType: FsxFileSystemType | string | undefined;
|
|
1802
|
+
/**
|
|
1803
|
+
* <p>Configuration information for connecting to an
|
|
1804
|
+
* Amazon Virtual Private Cloud for your Amazon FSx. Your Amazon FSx
|
|
1805
|
+
* instance must reside inside your VPC.</p>
|
|
1806
|
+
*/
|
|
1807
|
+
VpcConfiguration: DataSourceVpcConfiguration | undefined;
|
|
1808
|
+
/**
|
|
1809
|
+
* <p>The Amazon Resource Name (ARN) of an Secrets Manager secret that
|
|
1810
|
+
* contains the key-value pairs required to connect to your Amazon FSx
|
|
1811
|
+
* file system. Windows is currently the only supported type. The secret must
|
|
1812
|
+
* contain a JSON structure with the following keys:</p>
|
|
1813
|
+
* <ul>
|
|
1814
|
+
* <li>
|
|
1815
|
+
* <p>username—The Active Directory user name, along with the
|
|
1816
|
+
* Domain Name System (DNS) domain name. For example,
|
|
1817
|
+
* <i>user@corp.example.com</i>. The Active Directory
|
|
1818
|
+
* user account must have read and mounting access to the
|
|
1819
|
+
* Amazon FSx file system for Windows.</p>
|
|
1820
|
+
* </li>
|
|
1821
|
+
* <li>
|
|
1822
|
+
* <p>password—The password of the Active Directory user account with
|
|
1823
|
+
* read and mounting access to the Amazon FSx Windows file system.</p>
|
|
1824
|
+
* </li>
|
|
1825
|
+
* </ul>
|
|
1826
|
+
*/
|
|
1827
|
+
SecretArn?: string;
|
|
1828
|
+
/**
|
|
1829
|
+
* <p>A list of regular expression patterns to include certain files
|
|
1830
|
+
* in your Amazon FSx file system. Files that match the patterns
|
|
1831
|
+
* are included in the index. Files that don't match the patterns are
|
|
1832
|
+
* excluded from the index. If a file matches both an inclusion pattern
|
|
1833
|
+
* and an exclusion pattern, the exclusion pattern takes precedence
|
|
1834
|
+
* and the file isn't included in the index.</p>
|
|
1835
|
+
*/
|
|
1836
|
+
InclusionPatterns?: string[];
|
|
1837
|
+
/**
|
|
1838
|
+
* <p>A list of regular expression patterns to exclude certain files
|
|
1839
|
+
* in your Amazon FSx file system. Files that match the patterns
|
|
1840
|
+
* are excluded from the index. Files that don’t match the patterns are
|
|
1841
|
+
* included in the index. If a file matches both an inclusion pattern
|
|
1842
|
+
* and an exclusion pattern, the exclusion pattern takes precedence
|
|
1843
|
+
* and the file isn't included in the index.</p>
|
|
1844
|
+
*/
|
|
1845
|
+
ExclusionPatterns?: string[];
|
|
1846
|
+
/**
|
|
1847
|
+
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that
|
|
1848
|
+
* map Amazon FSx data source attributes or field names to Amazon Kendra
|
|
1849
|
+
* index field names. To create custom fields, use the
|
|
1850
|
+
* <code>UpdateIndex</code> API before you map to Amazon FSx fields.
|
|
1851
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping
|
|
1852
|
+
* data source fields</a>. The Amazon FSx data source field names
|
|
1853
|
+
* must exist in your Amazon FSx custom metadata.</p>
|
|
1854
|
+
*/
|
|
1855
|
+
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
1856
|
+
}
|
|
1857
|
+
export declare namespace FsxConfiguration {
|
|
1858
|
+
/**
|
|
1859
|
+
* @internal
|
|
1860
|
+
*/
|
|
1861
|
+
const filterSensitiveLog: (obj: FsxConfiguration) => any;
|
|
1862
|
+
}
|
|
1748
1863
|
/**
|
|
1749
|
-
* <p>Provides configuration information
|
|
1750
|
-
*
|
|
1864
|
+
* <p>Provides the configuration information to connect to
|
|
1865
|
+
* Google Drive as your data source.</p>
|
|
1751
1866
|
*/
|
|
1752
1867
|
export interface GoogleDriveConfiguration {
|
|
1753
1868
|
/**
|
|
@@ -1781,7 +1896,7 @@ export interface GoogleDriveConfiguration {
|
|
|
1781
1896
|
* <p>If you are using the console, you can define index fields when
|
|
1782
1897
|
* creating the mapping. If you are using the API, you must first
|
|
1783
1898
|
* create the field using the <code>UpdateIndex</code>
|
|
1784
|
-
*
|
|
1899
|
+
* API.</p>
|
|
1785
1900
|
*/
|
|
1786
1901
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
1787
1902
|
/**
|
|
@@ -1836,8 +1951,8 @@ export declare namespace OneDriveUsers {
|
|
|
1836
1951
|
const filterSensitiveLog: (obj: OneDriveUsers) => any;
|
|
1837
1952
|
}
|
|
1838
1953
|
/**
|
|
1839
|
-
* <p>Provides configuration information
|
|
1840
|
-
* to OneDrive.</p>
|
|
1954
|
+
* <p>Provides the configuration information to connect
|
|
1955
|
+
* to OneDrive as your data source.</p>
|
|
1841
1956
|
*/
|
|
1842
1957
|
export interface OneDriveConfiguration {
|
|
1843
1958
|
/**
|
|
@@ -1915,8 +2030,8 @@ export declare namespace DocumentsMetadataConfiguration {
|
|
|
1915
2030
|
const filterSensitiveLog: (obj: DocumentsMetadataConfiguration) => any;
|
|
1916
2031
|
}
|
|
1917
2032
|
/**
|
|
1918
|
-
* <p>Provides configuration information
|
|
1919
|
-
*
|
|
2033
|
+
* <p>Provides the configuration information to connect to
|
|
2034
|
+
* an Amazon S3 bucket.</p>
|
|
1920
2035
|
*/
|
|
1921
2036
|
export interface S3DataSourceConfiguration {
|
|
1922
2037
|
/**
|
|
@@ -2007,7 +2122,7 @@ export declare enum SalesforceChatterFeedIncludeFilterType {
|
|
|
2007
2122
|
STANDARD_USER = "STANDARD_USER"
|
|
2008
2123
|
}
|
|
2009
2124
|
/**
|
|
2010
|
-
* <p>
|
|
2125
|
+
* <p>The configuration information for syncing a Salesforce chatter feed. The
|
|
2011
2126
|
* contents of the object comes from the Salesforce FeedItem
|
|
2012
2127
|
* table.</p>
|
|
2013
2128
|
*/
|
|
@@ -2081,7 +2196,7 @@ export declare enum SalesforceKnowledgeArticleState {
|
|
|
2081
2196
|
PUBLISHED = "PUBLISHED"
|
|
2082
2197
|
}
|
|
2083
2198
|
/**
|
|
2084
|
-
* <p>
|
|
2199
|
+
* <p>Configuration information for standard Salesforce
|
|
2085
2200
|
* knowledge articles.</p>
|
|
2086
2201
|
*/
|
|
2087
2202
|
export interface SalesforceStandardKnowledgeArticleTypeConfiguration {
|
|
@@ -2108,7 +2223,7 @@ export declare namespace SalesforceStandardKnowledgeArticleTypeConfiguration {
|
|
|
2108
2223
|
const filterSensitiveLog: (obj: SalesforceStandardKnowledgeArticleTypeConfiguration) => any;
|
|
2109
2224
|
}
|
|
2110
2225
|
/**
|
|
2111
|
-
* <p>
|
|
2226
|
+
* <p>Provides the configuration information for the knowledge article
|
|
2112
2227
|
* types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge
|
|
2113
2228
|
* articles and the standard fields of knowledge articles, or the
|
|
2114
2229
|
* custom fields of custom knowledge articles, but not both </p>
|
|
@@ -2121,12 +2236,12 @@ export interface SalesforceKnowledgeArticleConfiguration {
|
|
|
2121
2236
|
*/
|
|
2122
2237
|
IncludedStates: (SalesforceKnowledgeArticleState | string)[] | undefined;
|
|
2123
2238
|
/**
|
|
2124
|
-
* <p>
|
|
2239
|
+
* <p>Configuration information for standard Salesforce
|
|
2125
2240
|
* knowledge articles.</p>
|
|
2126
2241
|
*/
|
|
2127
2242
|
StandardKnowledgeArticleTypeConfiguration?: SalesforceStandardKnowledgeArticleTypeConfiguration;
|
|
2128
2243
|
/**
|
|
2129
|
-
* <p>
|
|
2244
|
+
* <p>Configuration information for custom Salesforce knowledge
|
|
2130
2245
|
* articles.</p>
|
|
2131
2246
|
*/
|
|
2132
2247
|
CustomKnowledgeArticleTypeConfigurations?: SalesforceCustomKnowledgeArticleTypeConfiguration[];
|
|
@@ -2138,7 +2253,7 @@ export declare namespace SalesforceKnowledgeArticleConfiguration {
|
|
|
2138
2253
|
const filterSensitiveLog: (obj: SalesforceKnowledgeArticleConfiguration) => any;
|
|
2139
2254
|
}
|
|
2140
2255
|
/**
|
|
2141
|
-
* <p>Provides configuration information for processing attachments to
|
|
2256
|
+
* <p>Provides the configuration information for processing attachments to
|
|
2142
2257
|
* Salesforce standard objects. </p>
|
|
2143
2258
|
*/
|
|
2144
2259
|
export interface SalesforceStandardObjectAttachmentConfiguration {
|
|
@@ -2178,7 +2293,7 @@ export declare enum SalesforceStandardObjectName {
|
|
|
2178
2293
|
USER = "USER"
|
|
2179
2294
|
}
|
|
2180
2295
|
/**
|
|
2181
|
-
* <p>
|
|
2296
|
+
* <p>Provides the configuration information for indexing a single standard
|
|
2182
2297
|
* object.</p>
|
|
2183
2298
|
*/
|
|
2184
2299
|
export interface SalesforceStandardObjectConfiguration {
|
|
@@ -2275,7 +2390,7 @@ export interface SalesforceConfiguration {
|
|
|
2275
2390
|
*/
|
|
2276
2391
|
CrawlAttachments?: boolean;
|
|
2277
2392
|
/**
|
|
2278
|
-
* <p>
|
|
2393
|
+
* <p>Configuration information for processing attachments to
|
|
2279
2394
|
* Salesforce standard objects. </p>
|
|
2280
2395
|
*/
|
|
2281
2396
|
StandardObjectAttachmentConfiguration?: SalesforceStandardObjectAttachmentConfiguration;
|
|
@@ -2309,7 +2424,7 @@ export declare enum ServiceNowAuthenticationType {
|
|
|
2309
2424
|
OAUTH2 = "OAUTH2"
|
|
2310
2425
|
}
|
|
2311
2426
|
/**
|
|
2312
|
-
* <p>Provides configuration information for crawling knowledge articles
|
|
2427
|
+
* <p>Provides the configuration information for crawling knowledge articles
|
|
2313
2428
|
* in the ServiceNow site.</p>
|
|
2314
2429
|
*/
|
|
2315
2430
|
export interface ServiceNowKnowledgeArticleConfiguration {
|
|
@@ -2365,7 +2480,7 @@ export declare namespace ServiceNowKnowledgeArticleConfiguration {
|
|
|
2365
2480
|
const filterSensitiveLog: (obj: ServiceNowKnowledgeArticleConfiguration) => any;
|
|
2366
2481
|
}
|
|
2367
2482
|
/**
|
|
2368
|
-
* <p>Provides configuration information for crawling service catalog
|
|
2483
|
+
* <p>Provides the configuration information for crawling service catalog
|
|
2369
2484
|
* items in the ServiceNow site</p>
|
|
2370
2485
|
*/
|
|
2371
2486
|
export interface ServiceNowServiceCatalogConfiguration {
|
|
@@ -2419,8 +2534,8 @@ export declare enum ServiceNowBuildVersionType {
|
|
|
2419
2534
|
OTHERS = "OTHERS"
|
|
2420
2535
|
}
|
|
2421
2536
|
/**
|
|
2422
|
-
* <p>Provides configuration information
|
|
2423
|
-
* ServiceNow data source.</p>
|
|
2537
|
+
* <p>Provides the configuration information to connect to
|
|
2538
|
+
* ServiceNow as your data source.</p>
|
|
2424
2539
|
*/
|
|
2425
2540
|
export interface ServiceNowConfiguration {
|
|
2426
2541
|
/**
|
|
@@ -2443,12 +2558,12 @@ export interface ServiceNowConfiguration {
|
|
|
2443
2558
|
*/
|
|
2444
2559
|
ServiceNowBuildVersion: ServiceNowBuildVersionType | string | undefined;
|
|
2445
2560
|
/**
|
|
2446
|
-
* <p>
|
|
2561
|
+
* <p>Configuration information for crawling knowledge articles
|
|
2447
2562
|
* in the ServiceNow site.</p>
|
|
2448
2563
|
*/
|
|
2449
2564
|
KnowledgeArticleConfiguration?: ServiceNowKnowledgeArticleConfiguration;
|
|
2450
2565
|
/**
|
|
2451
|
-
* <p>
|
|
2566
|
+
* <p>Configuration information for crawling service catalogs
|
|
2452
2567
|
* in the ServiceNow site.</p>
|
|
2453
2568
|
*/
|
|
2454
2569
|
ServiceCatalogConfiguration?: ServiceNowServiceCatalogConfiguration;
|
|
@@ -2480,8 +2595,8 @@ export declare enum SharePointVersion {
|
|
|
2480
2595
|
SHAREPOINT_ONLINE = "SHAREPOINT_ONLINE"
|
|
2481
2596
|
}
|
|
2482
2597
|
/**
|
|
2483
|
-
* <p>Provides configuration information
|
|
2484
|
-
* SharePoint data source.</p>
|
|
2598
|
+
* <p>Provides the configuration information to connect to Microsoft
|
|
2599
|
+
* SharePoint as your data source.</p>
|
|
2485
2600
|
*/
|
|
2486
2601
|
export interface SharePointConfiguration {
|
|
2487
2602
|
/**
|
|
@@ -2543,14 +2658,14 @@ export interface SharePointConfiguration {
|
|
|
2543
2658
|
*/
|
|
2544
2659
|
ExclusionPatterns?: string[];
|
|
2545
2660
|
/**
|
|
2546
|
-
* <p>Provides information
|
|
2661
|
+
* <p>Provides the configuration information to connect to an Amazon VPC.</p>
|
|
2547
2662
|
*/
|
|
2548
2663
|
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
2549
2664
|
/**
|
|
2550
2665
|
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that
|
|
2551
2666
|
* map Microsoft SharePoint attributes to custom fields in the Amazon Kendra
|
|
2552
2667
|
* index. You must first create the index fields using the
|
|
2553
|
-
* <code>UpdateIndex</code>
|
|
2668
|
+
* <code>UpdateIndex</code> API before you map SharePoint
|
|
2554
2669
|
* attributes. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping Data Source
|
|
2555
2670
|
* Fields</a>.</p>
|
|
2556
2671
|
*/
|
|
@@ -2619,7 +2734,7 @@ export declare enum WebCrawlerMode {
|
|
|
2619
2734
|
SUBDOMAINS = "SUBDOMAINS"
|
|
2620
2735
|
}
|
|
2621
2736
|
/**
|
|
2622
|
-
* <p>Provides the configuration information
|
|
2737
|
+
* <p>Provides the configuration information for the seed or starting point URLs to crawl.</p>
|
|
2623
2738
|
* <p>
|
|
2624
2739
|
* <i>When selecting websites to index, you must adhere to
|
|
2625
2740
|
* the <a href="https://aws.amazon.com/aup/">Amazon Acceptable Use Policy</a>
|
|
@@ -2667,7 +2782,7 @@ export declare namespace SeedUrlConfiguration {
|
|
|
2667
2782
|
const filterSensitiveLog: (obj: SeedUrlConfiguration) => any;
|
|
2668
2783
|
}
|
|
2669
2784
|
/**
|
|
2670
|
-
* <p>Provides the configuration information
|
|
2785
|
+
* <p>Provides the configuration information for the sitemap URLs to crawl.</p>
|
|
2671
2786
|
* <p>
|
|
2672
2787
|
* <i>When selecting websites to index, you must adhere to
|
|
2673
2788
|
* the <a href="https://aws.amazon.com/aup/">Amazon Acceptable Use Policy</a>
|
|
@@ -2705,7 +2820,7 @@ export declare namespace SiteMapsConfiguration {
|
|
|
2705
2820
|
*/
|
|
2706
2821
|
export interface Urls {
|
|
2707
2822
|
/**
|
|
2708
|
-
* <p>
|
|
2823
|
+
* <p>Configuration of the seed or starting point URLs of the websites
|
|
2709
2824
|
* you want to crawl.</p>
|
|
2710
2825
|
* <p>You can choose to crawl only the website host names, or the website host names
|
|
2711
2826
|
* with subdomains, or the website host names with subdomains and other domains
|
|
@@ -2714,7 +2829,7 @@ export interface Urls {
|
|
|
2714
2829
|
*/
|
|
2715
2830
|
SeedUrlConfiguration?: SeedUrlConfiguration;
|
|
2716
2831
|
/**
|
|
2717
|
-
* <p>
|
|
2832
|
+
* <p>Configuration of the sitemap URLs of the websites you want to crawl.</p>
|
|
2718
2833
|
* <p>Only URLs belonging to the same website host names are crawled. You can list up to
|
|
2719
2834
|
* three sitemap URLs.</p>
|
|
2720
2835
|
*/
|
|
@@ -2791,7 +2906,7 @@ export interface WebCrawlerConfiguration {
|
|
|
2791
2906
|
*/
|
|
2792
2907
|
UrlExclusionPatterns?: string[];
|
|
2793
2908
|
/**
|
|
2794
|
-
* <p>
|
|
2909
|
+
* <p>Configuration information required to connect to your internal
|
|
2795
2910
|
* websites via a web proxy.</p>
|
|
2796
2911
|
* <p>You must provide the website host name and port number. For example, the
|
|
2797
2912
|
* host name of https://a.example.com/page1.html is "a.example.com" and the
|
|
@@ -2802,7 +2917,7 @@ export interface WebCrawlerConfiguration {
|
|
|
2802
2917
|
*/
|
|
2803
2918
|
ProxyConfiguration?: ProxyConfiguration;
|
|
2804
2919
|
/**
|
|
2805
|
-
* <p>
|
|
2920
|
+
* <p>Configuration information required to connect to websites using
|
|
2806
2921
|
* authentication.</p>
|
|
2807
2922
|
* <p>You can connect to websites using basic authentication of user name and password.</p>
|
|
2808
2923
|
* <p>You must provide the website host name and port number. For example, the host name
|
|
@@ -2877,7 +2992,7 @@ export interface WorkDocsConfiguration {
|
|
|
2877
2992
|
/**
|
|
2878
2993
|
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map
|
|
2879
2994
|
* Amazon WorkDocs field names to custom index field names in Amazon Kendra. You must first
|
|
2880
|
-
* create the custom index fields using the <code>UpdateIndex</code>
|
|
2995
|
+
* create the custom index fields using the <code>UpdateIndex</code> API before
|
|
2881
2996
|
* you map to Amazon WorkDocs fields. For more information, see
|
|
2882
2997
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping
|
|
2883
2998
|
* Data Source Fields</a>. The Amazon WorkDocs data source field names
|
|
@@ -2892,37 +3007,37 @@ export declare namespace WorkDocsConfiguration {
|
|
|
2892
3007
|
const filterSensitiveLog: (obj: WorkDocsConfiguration) => any;
|
|
2893
3008
|
}
|
|
2894
3009
|
/**
|
|
2895
|
-
* <p>
|
|
3010
|
+
* <p>Provides the configuration information for an Amazon Kendra data source.</p>
|
|
2896
3011
|
*/
|
|
2897
3012
|
export interface DataSourceConfiguration {
|
|
2898
3013
|
/**
|
|
2899
|
-
* <p>Provides information to
|
|
2900
|
-
*
|
|
3014
|
+
* <p>Provides the configuration information to connect to an Amazon S3
|
|
3015
|
+
* bucket as your data source.</p>
|
|
2901
3016
|
*/
|
|
2902
3017
|
S3Configuration?: S3DataSourceConfiguration;
|
|
2903
3018
|
/**
|
|
2904
|
-
* <p>Provides information
|
|
2905
|
-
*
|
|
3019
|
+
* <p>Provides the configuration information to connect to Microsoft SharePoint
|
|
3020
|
+
* as your data source.</p>
|
|
2906
3021
|
*/
|
|
2907
3022
|
SharePointConfiguration?: SharePointConfiguration;
|
|
2908
3023
|
/**
|
|
2909
|
-
* <p>Provides information
|
|
2910
|
-
*
|
|
3024
|
+
* <p>Provides the configuration information to connect to a database as
|
|
3025
|
+
* your data source.</p>
|
|
2911
3026
|
*/
|
|
2912
3027
|
DatabaseConfiguration?: DatabaseConfiguration;
|
|
2913
3028
|
/**
|
|
2914
|
-
* <p>Provides configuration information
|
|
2915
|
-
*
|
|
3029
|
+
* <p>Provides the configuration information to connect to
|
|
3030
|
+
* Salesforce as your data source.</p>
|
|
2916
3031
|
*/
|
|
2917
3032
|
SalesforceConfiguration?: SalesforceConfiguration;
|
|
2918
3033
|
/**
|
|
2919
|
-
* <p>Provides configuration
|
|
2920
|
-
* OneDrive.</p>
|
|
3034
|
+
* <p>Provides the configuration information to connect to Microsoft
|
|
3035
|
+
* OneDrive as your data source.</p>
|
|
2921
3036
|
*/
|
|
2922
3037
|
OneDriveConfiguration?: OneDriveConfiguration;
|
|
2923
3038
|
/**
|
|
2924
|
-
* <p>Provides configuration
|
|
2925
|
-
*
|
|
3039
|
+
* <p>Provides the configuration information to connect to ServiceNow
|
|
3040
|
+
* as your data source.</p>
|
|
2926
3041
|
*/
|
|
2927
3042
|
ServiceNowConfiguration?: ServiceNowConfiguration;
|
|
2928
3043
|
/**
|
|
@@ -2931,8 +3046,8 @@ export interface DataSourceConfiguration {
|
|
|
2931
3046
|
*/
|
|
2932
3047
|
ConfluenceConfiguration?: ConfluenceConfiguration;
|
|
2933
3048
|
/**
|
|
2934
|
-
* <p>Provides configuration
|
|
2935
|
-
* Drive. </p>
|
|
3049
|
+
* <p>Provides the configuration information to connect to Google
|
|
3050
|
+
* Drive as your data source. </p>
|
|
2936
3051
|
*/
|
|
2937
3052
|
GoogleDriveConfiguration?: GoogleDriveConfiguration;
|
|
2938
3053
|
/**
|
|
@@ -2941,10 +3056,15 @@ export interface DataSourceConfiguration {
|
|
|
2941
3056
|
*/
|
|
2942
3057
|
WebCrawlerConfiguration?: WebCrawlerConfiguration;
|
|
2943
3058
|
/**
|
|
2944
|
-
* <p>Provides the configuration information to connect to WorkDocs
|
|
3059
|
+
* <p>Provides the configuration information to connect to Amazon WorkDocs
|
|
2945
3060
|
* as your data source.</p>
|
|
2946
3061
|
*/
|
|
2947
3062
|
WorkDocsConfiguration?: WorkDocsConfiguration;
|
|
3063
|
+
/**
|
|
3064
|
+
* <p>Provides the configuration information to connect to Amazon FSx as
|
|
3065
|
+
* your data source.</p>
|
|
3066
|
+
*/
|
|
3067
|
+
FsxConfiguration?: FsxConfiguration;
|
|
2948
3068
|
}
|
|
2949
3069
|
export declare namespace DataSourceConfiguration {
|
|
2950
3070
|
/**
|
|
@@ -2979,6 +3099,7 @@ export declare enum DataSourceType {
|
|
|
2979
3099
|
CONFLUENCE = "CONFLUENCE",
|
|
2980
3100
|
CUSTOM = "CUSTOM",
|
|
2981
3101
|
DATABASE = "DATABASE",
|
|
3102
|
+
FSX = "FSX",
|
|
2982
3103
|
GOOGLEDRIVE = "GOOGLEDRIVE",
|
|
2983
3104
|
ONEDRIVE = "ONEDRIVE",
|
|
2984
3105
|
S3 = "S3",
|
|
@@ -3004,7 +3125,7 @@ export interface CreateDataSourceRequest {
|
|
|
3004
3125
|
*/
|
|
3005
3126
|
Type: DataSourceType | string | undefined;
|
|
3006
3127
|
/**
|
|
3007
|
-
* <p>
|
|
3128
|
+
* <p>Configuration information that is required to access the data source
|
|
3008
3129
|
* repository.</p>
|
|
3009
3130
|
* <p>You can't specify the <code>Configuration</code> parameter when the
|
|
3010
3131
|
* <code>Type</code> parameter is set to <code>CUSTOM</code>. If you do,
|
|
@@ -3018,10 +3139,10 @@ export interface CreateDataSourceRequest {
|
|
|
3018
3139
|
*/
|
|
3019
3140
|
Description?: string;
|
|
3020
3141
|
/**
|
|
3021
|
-
* <p>Sets the frequency
|
|
3142
|
+
* <p>Sets the frequency for Amazon Kendra to check the documents in your
|
|
3022
3143
|
* repository and update the index. If you don't set a schedule Amazon Kendra
|
|
3023
3144
|
* will not periodically update the index. You can call the
|
|
3024
|
-
* <code>StartDataSourceSyncJob</code>
|
|
3145
|
+
* <code>StartDataSourceSyncJob</code> API to update the
|
|
3025
3146
|
* index.</p>
|
|
3026
3147
|
* <p>You can't specify the <code>Schedule</code> parameter when the
|
|
3027
3148
|
* <code>Type</code> parameter is set to <code>CUSTOM</code>. If you do,
|
|
@@ -3047,7 +3168,7 @@ export interface CreateDataSourceRequest {
|
|
|
3047
3168
|
Tags?: Tag[];
|
|
3048
3169
|
/**
|
|
3049
3170
|
* <p>A token that you provide to identify the request to create a data
|
|
3050
|
-
* source. Multiple calls to the <code>CreateDataSource</code>
|
|
3171
|
+
* source. Multiple calls to the <code>CreateDataSource</code> API with
|
|
3051
3172
|
* the same client token will create only one data source.</p>
|
|
3052
3173
|
*/
|
|
3053
3174
|
ClientToken?: string;
|
|
@@ -3088,7 +3209,7 @@ export declare namespace CreateDataSourceResponse {
|
|
|
3088
3209
|
const filterSensitiveLog: (obj: CreateDataSourceResponse) => any;
|
|
3089
3210
|
}
|
|
3090
3211
|
/**
|
|
3091
|
-
* <p>
|
|
3212
|
+
* <p>Provides the configuration information for your content sources, such as data sources,
|
|
3092
3213
|
* FAQs, and content indexed directly via <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">BatchPutDocument</a>.</p>
|
|
3093
3214
|
*/
|
|
3094
3215
|
export interface ContentSourceConfiguration {
|
|
@@ -3103,7 +3224,7 @@ export interface ContentSourceConfiguration {
|
|
|
3103
3224
|
/**
|
|
3104
3225
|
* <p>
|
|
3105
3226
|
* <code>TRUE</code> to use documents you indexed directly using the
|
|
3106
|
-
* <code>BatchPutDocument</code>
|
|
3227
|
+
* <code>BatchPutDocument</code> API.</p>
|
|
3107
3228
|
*/
|
|
3108
3229
|
DirectPutContent?: boolean;
|
|
3109
3230
|
}
|
|
@@ -3114,7 +3235,7 @@ export declare namespace ContentSourceConfiguration {
|
|
|
3114
3235
|
const filterSensitiveLog: (obj: ContentSourceConfiguration) => any;
|
|
3115
3236
|
}
|
|
3116
3237
|
/**
|
|
3117
|
-
* <p>
|
|
3238
|
+
* <p>Provides the configuration information for the identifiers of your users.</p>
|
|
3118
3239
|
*/
|
|
3119
3240
|
export interface UserIdentityConfiguration {
|
|
3120
3241
|
/**
|
|
@@ -3135,7 +3256,7 @@ export declare namespace UserIdentityConfiguration {
|
|
|
3135
3256
|
const filterSensitiveLog: (obj: UserIdentityConfiguration) => any;
|
|
3136
3257
|
}
|
|
3137
3258
|
/**
|
|
3138
|
-
* <p>
|
|
3259
|
+
* <p>Provides the configuration information for your Amazon Kendra experience. This includes
|
|
3139
3260
|
* the data source IDs and/or FAQ IDs, and user or group information to grant access
|
|
3140
3261
|
* to your Amazon Kendra experience.</p>
|
|
3141
3262
|
*/
|
|
@@ -3143,7 +3264,7 @@ export interface ExperienceConfiguration {
|
|
|
3143
3264
|
/**
|
|
3144
3265
|
* <p>The identifiers of your data sources and FAQs. Or, you can specify
|
|
3145
3266
|
* that you want to use documents indexed via the <code>BatchPutDocument</code>
|
|
3146
|
-
*
|
|
3267
|
+
* API. This is the content you want to use for your Amazon Kendra experience.</p>
|
|
3147
3268
|
*/
|
|
3148
3269
|
ContentSourceConfiguration?: ContentSourceConfiguration;
|
|
3149
3270
|
/**
|
|
@@ -3169,13 +3290,13 @@ export interface CreateExperienceRequest {
|
|
|
3169
3290
|
IndexId: string | undefined;
|
|
3170
3291
|
/**
|
|
3171
3292
|
* <p>The Amazon Resource Name (ARN) of a role with permission to access <code>Query</code>
|
|
3172
|
-
*
|
|
3173
|
-
*
|
|
3293
|
+
* API, <code>QuerySuggestions</code> API, <code>SubmitFeedback</code>
|
|
3294
|
+
* API, and Amazon Web Services SSO that stores your user and group information.
|
|
3174
3295
|
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</p>
|
|
3175
3296
|
*/
|
|
3176
3297
|
RoleArn?: string;
|
|
3177
3298
|
/**
|
|
3178
|
-
* <p>
|
|
3299
|
+
* <p>Configuration information for your Amazon Kendra experience. This includes
|
|
3179
3300
|
* <code>ContentSourceConfiguration</code>, which specifies the data source IDs
|
|
3180
3301
|
* and/or FAQ IDs, and <code>UserIdentityConfiguration</code>, which specifies the
|
|
3181
3302
|
* user or group information to grant access to your Amazon Kendra experience.</p>
|
|
@@ -3187,7 +3308,7 @@ export interface CreateExperienceRequest {
|
|
|
3187
3308
|
Description?: string;
|
|
3188
3309
|
/**
|
|
3189
3310
|
* <p>A token that you provide to identify the request to create your Amazon Kendra experience.
|
|
3190
|
-
* Multiple calls to the <code>CreateExperience</code>
|
|
3311
|
+
* Multiple calls to the <code>CreateExperience</code> API with the same client
|
|
3191
3312
|
* token creates only one Amazon Kendra experience.</p>
|
|
3192
3313
|
*/
|
|
3193
3314
|
ClientToken?: string;
|
|
@@ -3254,7 +3375,7 @@ export interface CreateFaqRequest {
|
|
|
3254
3375
|
FileFormat?: FaqFileFormat | string;
|
|
3255
3376
|
/**
|
|
3256
3377
|
* <p>A token that you provide to identify the request to create a FAQ. Multiple calls to
|
|
3257
|
-
* the <code>CreateFaqRequest</code>
|
|
3378
|
+
* the <code>CreateFaqRequest</code> API with the same client token will create only
|
|
3258
3379
|
* one FAQ. </p>
|
|
3259
3380
|
*/
|
|
3260
3381
|
ClientToken?: string;
|
|
@@ -3323,7 +3444,7 @@ export declare enum UserGroupResolutionMode {
|
|
|
3323
3444
|
* group's access to documents. You can also map your users to their
|
|
3324
3445
|
* groups for user context filtering using the
|
|
3325
3446
|
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html">PutPrincipalMapping
|
|
3326
|
-
*
|
|
3447
|
+
* API</a>.</p>
|
|
3327
3448
|
* <p>To set up an Amazon Web Services SSO identity source in the console to use with
|
|
3328
3449
|
* Amazon Kendra, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html">Getting started
|
|
3329
3450
|
* with an Amazon Web Services SSO identity source</a>. You must also grant the required
|
|
@@ -3332,7 +3453,7 @@ export declare enum UserGroupResolutionMode {
|
|
|
3332
3453
|
* Amazon Web Services SSO</a>.</p>
|
|
3333
3454
|
* <p>Amazon Kendra currently does not support using <code>UserGroupResolutionConfiguration</code>
|
|
3334
3455
|
* with an Amazon Web Services organization member account for your Amazon Web Services SSO
|
|
3335
|
-
* identify source. You must create your index in the
|
|
3456
|
+
* identify source. You must create your index in the management account for the organization
|
|
3336
3457
|
* in order to use <code>UserGroupResolutionConfiguration</code>.</p>
|
|
3337
3458
|
*/
|
|
3338
3459
|
export interface UserGroupResolutionConfiguration {
|
|
@@ -3351,7 +3472,7 @@ export declare namespace UserGroupResolutionConfiguration {
|
|
|
3351
3472
|
const filterSensitiveLog: (obj: UserGroupResolutionConfiguration) => any;
|
|
3352
3473
|
}
|
|
3353
3474
|
/**
|
|
3354
|
-
* <p>
|
|
3475
|
+
* <p>Provides the configuration information for the JSON token type.</p>
|
|
3355
3476
|
*/
|
|
3356
3477
|
export interface JsonTokenTypeConfiguration {
|
|
3357
3478
|
/**
|
|
@@ -3374,7 +3495,7 @@ export declare enum KeyLocation {
|
|
|
3374
3495
|
URL = "URL"
|
|
3375
3496
|
}
|
|
3376
3497
|
/**
|
|
3377
|
-
* <p>
|
|
3498
|
+
* <p>Provides the configuration information for the JWT token type.</p>
|
|
3378
3499
|
*/
|
|
3379
3500
|
export interface JwtTokenTypeConfiguration {
|
|
3380
3501
|
/**
|
|
@@ -3413,7 +3534,7 @@ export declare namespace JwtTokenTypeConfiguration {
|
|
|
3413
3534
|
const filterSensitiveLog: (obj: JwtTokenTypeConfiguration) => any;
|
|
3414
3535
|
}
|
|
3415
3536
|
/**
|
|
3416
|
-
* <p>Provides configuration information for a token
|
|
3537
|
+
* <p>Provides the configuration information for a token.</p>
|
|
3417
3538
|
*/
|
|
3418
3539
|
export interface UserTokenConfiguration {
|
|
3419
3540
|
/**
|
|
@@ -3452,7 +3573,7 @@ export interface CreateIndexRequest {
|
|
|
3452
3573
|
* <p>An Identity and Access Management(IAM) role that gives
|
|
3453
3574
|
* Amazon Kendra permissions to access your Amazon CloudWatch logs and
|
|
3454
3575
|
* metrics. This is also the role used when you use the
|
|
3455
|
-
* <code>BatchPutDocument</code>
|
|
3576
|
+
* <code>BatchPutDocument</code> API to index documents from an
|
|
3456
3577
|
* Amazon S3 bucket.</p>
|
|
3457
3578
|
*/
|
|
3458
3579
|
RoleArn: string | undefined;
|
|
@@ -3468,7 +3589,7 @@ export interface CreateIndexRequest {
|
|
|
3468
3589
|
Description?: string;
|
|
3469
3590
|
/**
|
|
3470
3591
|
* <p>A token that you provide to identify the request to create an index.
|
|
3471
|
-
* Multiple calls to the <code>CreateIndex</code>
|
|
3592
|
+
* Multiple calls to the <code>CreateIndex</code> API with the same
|
|
3472
3593
|
* client token will create only one index.</p>
|
|
3473
3594
|
*/
|
|
3474
3595
|
ClientToken?: string;
|
|
@@ -3565,7 +3686,7 @@ export interface CreateQuerySuggestionsBlockListRequest {
|
|
|
3565
3686
|
/**
|
|
3566
3687
|
* <p>The IAM (Identity and Access Management) role used by Amazon Kendra to
|
|
3567
3688
|
* access the block list text file in your S3 bucket.</p>
|
|
3568
|
-
* <p>You need permissions to the role ARN (Amazon Resource Name).
|
|
3689
|
+
* <p>You need permissions to the role ARN (Amazon Web Services Resource Name).
|
|
3569
3690
|
* The role needs S3 read permissions to your file in S3 and needs
|
|
3570
3691
|
* to give STS (Security Token Service) assume role permissions
|
|
3571
3692
|
* to Amazon Kendra.</p>
|
|
@@ -3629,7 +3750,7 @@ export interface CreateThesaurusRequest {
|
|
|
3629
3750
|
SourceS3Path: S3Path | undefined;
|
|
3630
3751
|
/**
|
|
3631
3752
|
* <p>A token that you provide to identify the request to create a
|
|
3632
|
-
* thesaurus. Multiple calls to the <code>CreateThesaurus</code>
|
|
3753
|
+
* thesaurus. Multiple calls to the <code>CreateThesaurus</code> API
|
|
3633
3754
|
* with the same client token will create only one thesaurus.
|
|
3634
3755
|
* </p>
|
|
3635
3756
|
*/
|
|
@@ -3841,8 +3962,7 @@ export interface DescribeDataSourceResponse {
|
|
|
3841
3962
|
*/
|
|
3842
3963
|
Type?: DataSourceType | string;
|
|
3843
3964
|
/**
|
|
3844
|
-
* <p>
|
|
3845
|
-
* the data source is configured. The specific information in the description
|
|
3965
|
+
* <p>Describes how the data source is configured. The specific information in the description
|
|
3846
3966
|
* depends on the data source provider.</p>
|
|
3847
3967
|
*/
|
|
3848
3968
|
Configuration?: DataSourceConfiguration;
|
|
@@ -3866,7 +3986,7 @@ export interface DescribeDataSourceResponse {
|
|
|
3866
3986
|
*/
|
|
3867
3987
|
Status?: DataSourceStatus | string;
|
|
3868
3988
|
/**
|
|
3869
|
-
* <p>The schedule
|
|
3989
|
+
* <p>The schedule for Amazon Kendra to update the index.</p>
|
|
3870
3990
|
*/
|
|
3871
3991
|
Schedule?: string;
|
|
3872
3992
|
/**
|
|
@@ -3925,7 +4045,7 @@ export declare enum EndpointType {
|
|
|
3925
4045
|
HOME = "HOME"
|
|
3926
4046
|
}
|
|
3927
4047
|
/**
|
|
3928
|
-
* <p>Provides the configuration information
|
|
4048
|
+
* <p>Provides the configuration information for the endpoint for your Amazon Kendra
|
|
3929
4049
|
* experience.</p>
|
|
3930
4050
|
*/
|
|
3931
4051
|
export interface ExperienceEndpoint {
|
|
@@ -3998,8 +4118,8 @@ export interface DescribeExperienceResponse {
|
|
|
3998
4118
|
Status?: ExperienceStatus | string;
|
|
3999
4119
|
/**
|
|
4000
4120
|
* <p>Shows the Amazon Resource Name (ARN) of a role with permission to access
|
|
4001
|
-
* <code>Query</code>
|
|
4002
|
-
* <code>SubmitFeedback</code>
|
|
4121
|
+
* <code>Query</code> API, <code>QuerySuggestions</code> API,
|
|
4122
|
+
* <code>SubmitFeedback</code> API, and Amazon Web Services SSO that stores
|
|
4003
4123
|
* your user and group information.</p>
|
|
4004
4124
|
*/
|
|
4005
4125
|
RoleArn?: string;
|
|
@@ -4692,7 +4812,7 @@ export interface DescribeQuerySuggestionsConfigResponse {
|
|
|
4692
4812
|
* <p>By default, Amazon Kendra enables query suggestions.<code>LEARN_ONLY</code>
|
|
4693
4813
|
* turns off query suggestions for your users. You can change the mode using
|
|
4694
4814
|
* the <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_UpdateQuerySuggestionsConfig.html">UpdateQuerySuggestionsConfig</a>
|
|
4695
|
-
*
|
|
4815
|
+
* API.</p>
|
|
4696
4816
|
*/
|
|
4697
4817
|
Mode?: Mode | string;
|
|
4698
4818
|
/**
|
|
@@ -4796,7 +4916,7 @@ export interface DescribeThesaurusResponse {
|
|
|
4796
4916
|
* more information.
|
|
4797
4917
|
* </p>
|
|
4798
4918
|
* <p>If the status is <code>ACTIVE_BUT_UPDATE_FAILED</code>, it means
|
|
4799
|
-
*
|
|
4919
|
+
* that Amazon Kendra could not ingest the new thesaurus file. The old
|
|
4800
4920
|
* thesaurus file is still active.
|
|
4801
4921
|
* </p>
|
|
4802
4922
|
*/
|
|
@@ -5169,10 +5289,14 @@ export declare namespace GetSnapshotsResponse {
|
|
|
5169
5289
|
/**
|
|
5170
5290
|
* <p>The input to the request is not valid.</p>
|
|
5171
5291
|
*/
|
|
5172
|
-
export
|
|
5173
|
-
name: "InvalidRequestException";
|
|
5174
|
-
$fault: "client";
|
|
5292
|
+
export declare class InvalidRequestException extends __BaseException {
|
|
5293
|
+
readonly name: "InvalidRequestException";
|
|
5294
|
+
readonly $fault: "client";
|
|
5175
5295
|
Message?: string;
|
|
5296
|
+
/**
|
|
5297
|
+
* @internal
|
|
5298
|
+
*/
|
|
5299
|
+
constructor(opts: __ExceptionOptionType<InvalidRequestException, __BaseException>);
|
|
5176
5300
|
}
|
|
5177
5301
|
export interface ListDataSourcesRequest {
|
|
5178
5302
|
/**
|
|
@@ -5198,8 +5322,8 @@ export declare namespace ListDataSourcesRequest {
|
|
|
5198
5322
|
const filterSensitiveLog: (obj: ListDataSourcesRequest) => any;
|
|
5199
5323
|
}
|
|
5200
5324
|
/**
|
|
5201
|
-
* <p>Summary information for
|
|
5202
|
-
* to the <code>DescribeDataSource</code>
|
|
5325
|
+
* <p>Summary information for an Amazon Kendra data source. Returned in a call
|
|
5326
|
+
* to the <code>DescribeDataSource</code> API.</p>
|
|
5203
5327
|
*/
|
|
5204
5328
|
export interface DataSourceSummary {
|
|
5205
5329
|
/**
|
|
@@ -5346,7 +5470,7 @@ export declare namespace DataSourceSyncJobMetrics {
|
|
|
5346
5470
|
const filterSensitiveLog: (obj: DataSourceSyncJobMetrics) => any;
|
|
5347
5471
|
}
|
|
5348
5472
|
/**
|
|
5349
|
-
* <p>Provides information about a synchronization job.</p>
|
|
5473
|
+
* <p>Provides information about a data source synchronization job.</p>
|
|
5350
5474
|
*/
|
|
5351
5475
|
export interface DataSourceSyncJob {
|
|
5352
5476
|
/**
|
|
@@ -5354,11 +5478,11 @@ export interface DataSourceSyncJob {
|
|
|
5354
5478
|
*/
|
|
5355
5479
|
ExecutionId?: string;
|
|
5356
5480
|
/**
|
|
5357
|
-
* <p>The UNIX datetime that the synchronization job
|
|
5481
|
+
* <p>The UNIX datetime that the synchronization job started.</p>
|
|
5358
5482
|
*/
|
|
5359
5483
|
StartTime?: Date;
|
|
5360
5484
|
/**
|
|
5361
|
-
* <p>The UNIX datetime that the synchronization job
|
|
5485
|
+
* <p>The UNIX datetime that the synchronization job
|
|
5362
5486
|
* completed.</p>
|
|
5363
5487
|
*/
|
|
5364
5488
|
EndTime?: Date;
|
|
@@ -5379,8 +5503,8 @@ export interface DataSourceSyncJob {
|
|
|
5379
5503
|
ErrorMessage?: string;
|
|
5380
5504
|
/**
|
|
5381
5505
|
* <p>If the <code>Status</code> field is set to <code>FAILED</code>,
|
|
5382
|
-
* the <code>ErrorCode</code> field
|
|
5383
|
-
*
|
|
5506
|
+
* the <code>ErrorCode</code> field indicates the reason the
|
|
5507
|
+
* synchronization failed.</p>
|
|
5384
5508
|
*/
|
|
5385
5509
|
ErrorCode?: ErrorCode | string;
|
|
5386
5510
|
/**
|
|
@@ -5865,7 +5989,7 @@ export declare namespace ListIndicesRequest {
|
|
|
5865
5989
|
const filterSensitiveLog: (obj: ListIndicesRequest) => any;
|
|
5866
5990
|
}
|
|
5867
5991
|
/**
|
|
5868
|
-
* <p>A summary of information
|
|
5992
|
+
* <p>A summary of information on the configuration of an index.</p>
|
|
5869
5993
|
*/
|
|
5870
5994
|
export interface IndexConfigurationSummary {
|
|
5871
5995
|
/**
|
|
@@ -5874,7 +5998,7 @@ export interface IndexConfigurationSummary {
|
|
|
5874
5998
|
Name?: string;
|
|
5875
5999
|
/**
|
|
5876
6000
|
* <p>A unique identifier for the index. Use this to identify the index
|
|
5877
|
-
* when you are using
|
|
6001
|
+
* when you are using APIs such as <code>Query</code>,
|
|
5878
6002
|
* <code>DescribeIndex</code>, <code>UpdateIndex</code>, and
|
|
5879
6003
|
* <code>DeleteIndex</code>.</p>
|
|
5880
6004
|
*/
|
|
@@ -5890,7 +6014,7 @@ export interface IndexConfigurationSummary {
|
|
|
5890
6014
|
CreatedAt: Date | undefined;
|
|
5891
6015
|
/**
|
|
5892
6016
|
* <p>The Unix timestamp when the index was last updated by the
|
|
5893
|
-
* <code>UpdateIndex</code>
|
|
6017
|
+
* <code>UpdateIndex</code> API.</p>
|
|
5894
6018
|
*/
|
|
5895
6019
|
UpdatedAt: Date | undefined;
|
|
5896
6020
|
/**
|
|
@@ -5907,7 +6031,7 @@ export declare namespace IndexConfigurationSummary {
|
|
|
5907
6031
|
}
|
|
5908
6032
|
export interface ListIndicesResponse {
|
|
5909
6033
|
/**
|
|
5910
|
-
* <p>An array of summary information
|
|
6034
|
+
* <p>An array of summary information on the configuration of one or more indexes.</p>
|
|
5911
6035
|
*/
|
|
5912
6036
|
IndexConfigurationSummaryItems?: IndexConfigurationSummary[];
|
|
5913
6037
|
/**
|
|
@@ -6042,10 +6166,14 @@ export declare namespace ListTagsForResourceResponse {
|
|
|
6042
6166
|
/**
|
|
6043
6167
|
* <p></p>
|
|
6044
6168
|
*/
|
|
6045
|
-
export
|
|
6046
|
-
name: "ResourceUnavailableException";
|
|
6047
|
-
$fault: "client";
|
|
6169
|
+
export declare class ResourceUnavailableException extends __BaseException {
|
|
6170
|
+
readonly name: "ResourceUnavailableException";
|
|
6171
|
+
readonly $fault: "client";
|
|
6048
6172
|
Message?: string;
|
|
6173
|
+
/**
|
|
6174
|
+
* @internal
|
|
6175
|
+
*/
|
|
6176
|
+
constructor(opts: __ExceptionOptionType<ResourceUnavailableException, __BaseException>);
|
|
6049
6177
|
}
|
|
6050
6178
|
export interface ListThesauriRequest {
|
|
6051
6179
|
/**
|
|
@@ -6304,7 +6432,7 @@ export declare enum SortOrder {
|
|
|
6304
6432
|
* <p>Specifies the document attribute to use to sort the response to a
|
|
6305
6433
|
* Amazon Kendra query. You can specify a single attribute for sorting. The
|
|
6306
6434
|
* attribute must have the <code>Sortable</code> flag set to
|
|
6307
|
-
*
|
|
6435
|
+
* <code>true</code>, otherwise Amazon Kendra returns an exception.</p>
|
|
6308
6436
|
* <p>You can sort attributes of the following types.</p>
|
|
6309
6437
|
* <ul>
|
|
6310
6438
|
* <li>
|
|
@@ -6364,9 +6492,29 @@ export declare namespace SortingConfiguration {
|
|
|
6364
6492
|
const filterSensitiveLog: (obj: SortingConfiguration) => any;
|
|
6365
6493
|
}
|
|
6366
6494
|
/**
|
|
6367
|
-
* <p>
|
|
6368
|
-
*
|
|
6369
|
-
*
|
|
6495
|
+
* <p>Provides the configuration information for suggested query spell corrections.</p>
|
|
6496
|
+
* <p>Suggested spell corrections are based on words that appear in your indexed documents
|
|
6497
|
+
* and how closely a corrected word matches a misspelled word.</p>
|
|
6498
|
+
* <p>This feature is designed with certain defaults or limits. For information on the
|
|
6499
|
+
* current limits and how to request more support for some limits, see the
|
|
6500
|
+
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/query-spell-check.html">Spell
|
|
6501
|
+
* Checker documentation</a>.</p>
|
|
6502
|
+
*/
|
|
6503
|
+
export interface SpellCorrectionConfiguration {
|
|
6504
|
+
/**
|
|
6505
|
+
* <p>
|
|
6506
|
+
* <code>TRUE</code> to suggest spell corrections for queries.</p>
|
|
6507
|
+
*/
|
|
6508
|
+
IncludeQuerySpellCheckSuggestions: boolean | undefined;
|
|
6509
|
+
}
|
|
6510
|
+
export declare namespace SpellCorrectionConfiguration {
|
|
6511
|
+
/**
|
|
6512
|
+
* @internal
|
|
6513
|
+
*/
|
|
6514
|
+
const filterSensitiveLog: (obj: SpellCorrectionConfiguration) => any;
|
|
6515
|
+
}
|
|
6516
|
+
/**
|
|
6517
|
+
* <p>Data source information for user context filtering.</p>
|
|
6370
6518
|
*/
|
|
6371
6519
|
export interface DataSourceGroup {
|
|
6372
6520
|
/**
|
|
@@ -6391,8 +6539,7 @@ export declare namespace DataSourceGroup {
|
|
|
6391
6539
|
}
|
|
6392
6540
|
/**
|
|
6393
6541
|
* <p>Provides information about the user context for
|
|
6394
|
-
* an
|
|
6395
|
-
* Amazon Kendra index.</p>
|
|
6542
|
+
* an Amazon Kendra index.</p>
|
|
6396
6543
|
* <p>This is used for filtering search results for different users based on their access
|
|
6397
6544
|
* to documents.</p>
|
|
6398
6545
|
* <p>You provide one of the following:</p>
|
|
@@ -6578,6 +6725,54 @@ export declare namespace QueryResultItem {
|
|
|
6578
6725
|
*/
|
|
6579
6726
|
const filterSensitiveLog: (obj: QueryResultItem) => any;
|
|
6580
6727
|
}
|
|
6728
|
+
/**
|
|
6729
|
+
* <p>A corrected misspelled word in a query.</p>
|
|
6730
|
+
*/
|
|
6731
|
+
export interface Correction {
|
|
6732
|
+
/**
|
|
6733
|
+
* <p>The zero-based location in the response string or text where
|
|
6734
|
+
* the corrected word starts.</p>
|
|
6735
|
+
*/
|
|
6736
|
+
BeginOffset?: number;
|
|
6737
|
+
/**
|
|
6738
|
+
* <p>The zero-based location in the response string or text where
|
|
6739
|
+
* the corrected word ends.</p>
|
|
6740
|
+
*/
|
|
6741
|
+
EndOffset?: number;
|
|
6742
|
+
/**
|
|
6743
|
+
* <p>The string or text of a misspelled word in a query.</p>
|
|
6744
|
+
*/
|
|
6745
|
+
Term?: string;
|
|
6746
|
+
/**
|
|
6747
|
+
* <p>The string or text of a corrected misspelled word in a query.</p>
|
|
6748
|
+
*/
|
|
6749
|
+
CorrectedTerm?: string;
|
|
6750
|
+
}
|
|
6751
|
+
export declare namespace Correction {
|
|
6752
|
+
/**
|
|
6753
|
+
* @internal
|
|
6754
|
+
*/
|
|
6755
|
+
const filterSensitiveLog: (obj: Correction) => any;
|
|
6756
|
+
}
|
|
6757
|
+
/**
|
|
6758
|
+
* <p>A query with suggested spell corrections. </p>
|
|
6759
|
+
*/
|
|
6760
|
+
export interface SpellCorrectedQuery {
|
|
6761
|
+
/**
|
|
6762
|
+
* <p>The query with the suggested spell corrections.</p>
|
|
6763
|
+
*/
|
|
6764
|
+
SuggestedQueryText?: string;
|
|
6765
|
+
/**
|
|
6766
|
+
* <p>The corrected misspelled word or words in a query.</p>
|
|
6767
|
+
*/
|
|
6768
|
+
Corrections?: Correction[];
|
|
6769
|
+
}
|
|
6770
|
+
export declare namespace SpellCorrectedQuery {
|
|
6771
|
+
/**
|
|
6772
|
+
* @internal
|
|
6773
|
+
*/
|
|
6774
|
+
const filterSensitiveLog: (obj: SpellCorrectedQuery) => any;
|
|
6775
|
+
}
|
|
6581
6776
|
export declare enum WarningCode {
|
|
6582
6777
|
QUERY_LANGUAGE_INVALID_SYNTAX = "QUERY_LANGUAGE_INVALID_SYNTAX"
|
|
6583
6778
|
}
|
|
@@ -6630,6 +6825,10 @@ export interface QueryResult {
|
|
|
6630
6825
|
* with advanced query syntax</a>.</p>
|
|
6631
6826
|
*/
|
|
6632
6827
|
Warnings?: Warning[];
|
|
6828
|
+
/**
|
|
6829
|
+
* <p>A list of information related to suggested spell corrections for a query.</p>
|
|
6830
|
+
*/
|
|
6831
|
+
SpellCorrectedQueries?: SpellCorrectedQuery[];
|
|
6633
6832
|
}
|
|
6634
6833
|
export declare namespace QueryResult {
|
|
6635
6834
|
/**
|
|
@@ -6640,10 +6839,14 @@ export declare namespace QueryResult {
|
|
|
6640
6839
|
/**
|
|
6641
6840
|
* <p></p>
|
|
6642
6841
|
*/
|
|
6643
|
-
export
|
|
6644
|
-
name: "ResourceInUseException";
|
|
6645
|
-
$fault: "client";
|
|
6842
|
+
export declare class ResourceInUseException extends __BaseException {
|
|
6843
|
+
readonly name: "ResourceInUseException";
|
|
6844
|
+
readonly $fault: "client";
|
|
6646
6845
|
Message?: string;
|
|
6846
|
+
/**
|
|
6847
|
+
* @internal
|
|
6848
|
+
*/
|
|
6849
|
+
constructor(opts: __ExceptionOptionType<ResourceInUseException, __BaseException>);
|
|
6647
6850
|
}
|
|
6648
6851
|
export interface StartDataSourceSyncJobRequest {
|
|
6649
6852
|
/**
|
|
@@ -6693,7 +6896,7 @@ export declare namespace StopDataSourceSyncJobRequest {
|
|
|
6693
6896
|
/**
|
|
6694
6897
|
* <p>Gathers information about when a particular result was clicked by
|
|
6695
6898
|
* a user. Your application uses the <code>SubmitFeedback</code>
|
|
6696
|
-
*
|
|
6899
|
+
* API to provide click information.</p>
|
|
6697
6900
|
*/
|
|
6698
6901
|
export interface ClickFeedback {
|
|
6699
6902
|
/**
|
|
@@ -6719,7 +6922,7 @@ export declare enum RelevanceType {
|
|
|
6719
6922
|
}
|
|
6720
6923
|
/**
|
|
6721
6924
|
* <p>Provides feedback on how relevant a document is to a search. Your
|
|
6722
|
-
* application uses the <code>SubmitFeedback</code>
|
|
6925
|
+
* application uses the <code>SubmitFeedback</code> API to
|
|
6723
6926
|
* provide relevance information.</p>
|
|
6724
6927
|
*/
|
|
6725
6928
|
export interface RelevanceFeedback {
|
|
@@ -6748,7 +6951,7 @@ export interface SubmitFeedbackRequest {
|
|
|
6748
6951
|
/**
|
|
6749
6952
|
* <p>The identifier of the specific query for which you are submitting
|
|
6750
6953
|
* feedback. The query ID is returned in the response to the
|
|
6751
|
-
* <code>Query</code>
|
|
6954
|
+
* <code>Query</code> API.</p>
|
|
6752
6955
|
*/
|
|
6753
6956
|
QueryId: string | undefined;
|
|
6754
6957
|
/**
|
|
@@ -6837,7 +7040,7 @@ export interface UpdateDataSourceRequest {
|
|
|
6837
7040
|
*/
|
|
6838
7041
|
IndexId: string | undefined;
|
|
6839
7042
|
/**
|
|
6840
|
-
* <p>Configuration information for an Amazon Kendra data source.</p>
|
|
7043
|
+
* <p>Configuration information for an Amazon Kendra data source you want to update.</p>
|
|
6841
7044
|
*/
|
|
6842
7045
|
Configuration?: DataSourceConfiguration;
|
|
6843
7046
|
/**
|
|
@@ -6892,14 +7095,13 @@ export interface UpdateExperienceRequest {
|
|
|
6892
7095
|
IndexId: string | undefined;
|
|
6893
7096
|
/**
|
|
6894
7097
|
* <p>The Amazon Resource Name (ARN) of a role with permission to access <code>Query</code>
|
|
6895
|
-
*
|
|
6896
|
-
*
|
|
7098
|
+
* API, <code>QuerySuggestions</code> API, <code>SubmitFeedback</code>
|
|
7099
|
+
* API, and Amazon Web Services SSO that stores your user and group information.
|
|
6897
7100
|
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM roles for Amazon Kendra</a>.</p>
|
|
6898
7101
|
*/
|
|
6899
7102
|
RoleArn?: string;
|
|
6900
7103
|
/**
|
|
6901
|
-
* <p>
|
|
6902
|
-
* field name that contains the identifiers of your users, such as their emails.</p>
|
|
7104
|
+
* <p>Configuration information for your Amazon Kendra you want to update.</p>
|
|
6903
7105
|
*/
|
|
6904
7106
|
Configuration?: ExperienceConfiguration;
|
|
6905
7107
|
/**
|
|
@@ -6932,7 +7134,7 @@ export interface UpdateIndexRequest {
|
|
|
6932
7134
|
*/
|
|
6933
7135
|
Description?: string;
|
|
6934
7136
|
/**
|
|
6935
|
-
* <p>The document metadata to update
|
|
7137
|
+
* <p>The document metadata you want to update.</p>
|
|
6936
7138
|
*/
|
|
6937
7139
|
DocumentMetadataConfigurationUpdates?: DocumentMetadataConfiguration[];
|
|
6938
7140
|
/**
|
|
@@ -7196,7 +7398,7 @@ export interface QueryRequest {
|
|
|
7196
7398
|
/**
|
|
7197
7399
|
* <p>The unique identifier of the index to search. The identifier is
|
|
7198
7400
|
* returned in the response from the <code>CreateIndex</code>
|
|
7199
|
-
*
|
|
7401
|
+
* API.</p>
|
|
7200
7402
|
*/
|
|
7201
7403
|
IndexId: string | undefined;
|
|
7202
7404
|
/**
|
|
@@ -7243,7 +7445,7 @@ export interface QueryRequest {
|
|
|
7243
7445
|
DocumentRelevanceOverrideConfigurations?: DocumentRelevanceConfiguration[];
|
|
7244
7446
|
/**
|
|
7245
7447
|
* <p>Query results are returned in pages the size of the
|
|
7246
|
-
*
|
|
7448
|
+
* <code>PageSize</code> parameter. By default, Amazon Kendra returns
|
|
7247
7449
|
* the first page of results. Use this parameter to get result pages after
|
|
7248
7450
|
* the first one.</p>
|
|
7249
7451
|
*/
|
|
@@ -7276,6 +7478,10 @@ export interface QueryRequest {
|
|
|
7276
7478
|
* email address, as the <code>VisitorId</code>.</p>
|
|
7277
7479
|
*/
|
|
7278
7480
|
VisitorId?: string;
|
|
7481
|
+
/**
|
|
7482
|
+
* <p>Enables suggested spell corrections for queries.</p>
|
|
7483
|
+
*/
|
|
7484
|
+
SpellCorrectionConfiguration?: SpellCorrectionConfiguration;
|
|
7279
7485
|
}
|
|
7280
7486
|
export declare namespace QueryRequest {
|
|
7281
7487
|
/**
|