@aws-sdk/client-kendra 3.53.0 → 3.55.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 +30 -0
- package/dist-cjs/KendraClient.js +13 -13
- package/dist-cjs/commands/AssociateEntitiesToExperienceCommand.js +3 -3
- package/dist-cjs/commands/AssociatePersonasToEntitiesCommand.js +3 -3
- package/dist-cjs/commands/BatchDeleteDocumentCommand.js +3 -3
- package/dist-cjs/commands/BatchGetDocumentStatusCommand.js +3 -3
- package/dist-cjs/commands/BatchPutDocumentCommand.js +3 -3
- package/dist-cjs/commands/ClearQuerySuggestionsCommand.js +3 -3
- package/dist-cjs/commands/CreateDataSourceCommand.js +3 -3
- package/dist-cjs/commands/CreateExperienceCommand.js +3 -3
- package/dist-cjs/commands/CreateFaqCommand.js +3 -3
- package/dist-cjs/commands/CreateIndexCommand.js +3 -3
- package/dist-cjs/commands/CreateQuerySuggestionsBlockListCommand.js +3 -3
- package/dist-cjs/commands/CreateThesaurusCommand.js +3 -3
- package/dist-cjs/commands/DeleteDataSourceCommand.js +3 -3
- package/dist-cjs/commands/DeleteExperienceCommand.js +3 -3
- package/dist-cjs/commands/DeleteFaqCommand.js +3 -3
- package/dist-cjs/commands/DeleteIndexCommand.js +3 -3
- package/dist-cjs/commands/DeletePrincipalMappingCommand.js +3 -3
- package/dist-cjs/commands/DeleteQuerySuggestionsBlockListCommand.js +3 -3
- package/dist-cjs/commands/DeleteThesaurusCommand.js +3 -3
- package/dist-cjs/commands/DescribeDataSourceCommand.js +3 -3
- package/dist-cjs/commands/DescribeExperienceCommand.js +3 -3
- package/dist-cjs/commands/DescribeFaqCommand.js +3 -3
- package/dist-cjs/commands/DescribeIndexCommand.js +3 -3
- package/dist-cjs/commands/DescribePrincipalMappingCommand.js +3 -3
- package/dist-cjs/commands/DescribeQuerySuggestionsBlockListCommand.js +3 -3
- package/dist-cjs/commands/DescribeQuerySuggestionsConfigCommand.js +3 -3
- package/dist-cjs/commands/DescribeThesaurusCommand.js +3 -3
- package/dist-cjs/commands/DisassociateEntitiesFromExperienceCommand.js +3 -3
- package/dist-cjs/commands/DisassociatePersonasFromEntitiesCommand.js +3 -3
- package/dist-cjs/commands/GetQuerySuggestionsCommand.js +3 -3
- package/dist-cjs/commands/GetSnapshotsCommand.js +3 -3
- package/dist-cjs/commands/ListDataSourceSyncJobsCommand.js +3 -3
- package/dist-cjs/commands/ListDataSourcesCommand.js +3 -3
- package/dist-cjs/commands/ListEntityPersonasCommand.js +3 -3
- package/dist-cjs/commands/ListExperienceEntitiesCommand.js +3 -3
- package/dist-cjs/commands/ListExperiencesCommand.js +3 -3
- package/dist-cjs/commands/ListFaqsCommand.js +3 -3
- package/dist-cjs/commands/ListGroupsOlderThanOrderingIdCommand.js +3 -3
- package/dist-cjs/commands/ListIndicesCommand.js +3 -3
- package/dist-cjs/commands/ListQuerySuggestionsBlockListsCommand.js +3 -3
- package/dist-cjs/commands/ListTagsForResourceCommand.js +3 -3
- package/dist-cjs/commands/ListThesauriCommand.js +3 -3
- package/dist-cjs/commands/PutPrincipalMappingCommand.js +3 -3
- package/dist-cjs/commands/QueryCommand.js +3 -3
- package/dist-cjs/commands/StartDataSourceSyncJobCommand.js +3 -3
- package/dist-cjs/commands/StopDataSourceSyncJobCommand.js +3 -3
- package/dist-cjs/commands/SubmitFeedbackCommand.js +3 -3
- package/dist-cjs/commands/TagResourceCommand.js +3 -3
- package/dist-cjs/commands/UntagResourceCommand.js +3 -3
- package/dist-cjs/commands/UpdateDataSourceCommand.js +3 -3
- package/dist-cjs/commands/UpdateExperienceCommand.js +3 -3
- package/dist-cjs/commands/UpdateIndexCommand.js +3 -3
- package/dist-cjs/commands/UpdateQuerySuggestionsBlockListCommand.js +3 -3
- package/dist-cjs/commands/UpdateQuerySuggestionsConfigCommand.js +3 -3
- package/dist-cjs/commands/UpdateThesaurusCommand.js +3 -3
- package/dist-cjs/endpoints.js +1 -1
- package/dist-cjs/models/models_0.js +36 -4
- package/dist-cjs/protocols/Aws_json1_1.js +640 -442
- package/dist-cjs/runtimeConfig.browser.js +4 -4
- package/dist-cjs/runtimeConfig.js +9 -9
- package/dist-cjs/runtimeConfig.native.js +1 -1
- package/dist-es/Kendra.js +55 -55
- package/dist-es/models/models_0.js +24 -0
- package/dist-es/pagination/GetSnapshotsPaginator.js +4 -4
- package/dist-es/pagination/ListDataSourceSyncJobsPaginator.js +4 -4
- package/dist-es/pagination/ListDataSourcesPaginator.js +4 -4
- package/dist-es/pagination/ListEntityPersonasPaginator.js +4 -4
- package/dist-es/pagination/ListExperienceEntitiesPaginator.js +4 -4
- package/dist-es/pagination/ListExperiencesPaginator.js +4 -4
- package/dist-es/pagination/ListIndicesPaginator.js +4 -4
- package/dist-es/protocols/Aws_json1_1.js +181 -2
- package/dist-types/KendraClient.d.ts +2 -2
- package/dist-types/models/models_0.d.ts +508 -288
- package/dist-types/runtimeConfig.browser.d.ts +1 -1
- package/dist-types/runtimeConfig.d.ts +1 -1
- package/dist-types/runtimeConfig.native.d.ts +3 -3
- package/dist-types/ts3.4/KendraClient.d.ts +2 -2
- package/dist-types/ts3.4/models/models_0.d.ts +83 -0
- 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 +3 -3
- package/package.json +34 -34
|
@@ -153,7 +153,7 @@ export declare enum EntityType {
|
|
|
153
153
|
USER = "USER"
|
|
154
154
|
}
|
|
155
155
|
/**
|
|
156
|
-
* <p>Provides the configuration information
|
|
156
|
+
* <p>Provides the configuration information for users or groups in
|
|
157
157
|
* your Amazon Web Services SSO identity source to grant access your Amazon Kendra
|
|
158
158
|
* experience.</p>
|
|
159
159
|
*/
|
|
@@ -295,7 +295,7 @@ export declare enum Persona {
|
|
|
295
295
|
VIEWER = "VIEWER"
|
|
296
296
|
}
|
|
297
297
|
/**
|
|
298
|
-
* <p>Provides the configuration information
|
|
298
|
+
* <p>Provides the configuration information for users or groups in your
|
|
299
299
|
* Amazon Web Services SSO identity source for access to your Amazon Kendra experience.
|
|
300
300
|
* Specific permissions are defined for each user or group once they are
|
|
301
301
|
* granted access to your Amazon Kendra experience.</p>
|
|
@@ -1213,10 +1213,11 @@ export declare enum ConfluenceAttachmentFieldName {
|
|
|
1213
1213
|
VERSION = "VERSION"
|
|
1214
1214
|
}
|
|
1215
1215
|
/**
|
|
1216
|
-
* <p>
|
|
1217
|
-
*
|
|
1218
|
-
*
|
|
1219
|
-
*
|
|
1216
|
+
* <p>Maps attributes or field names of Confluence attachments to Amazon Kendra index field
|
|
1217
|
+
* names. To create custom fields, use the <code>UpdateIndex</code> API before
|
|
1218
|
+
* you map to Confluence fields.
|
|
1219
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>.
|
|
1220
|
+
* The Confuence data source field names must exist in your Confluence custom metadata.</p>
|
|
1220
1221
|
*/
|
|
1221
1222
|
export interface ConfluenceAttachmentToIndexFieldMapping {
|
|
1222
1223
|
/**
|
|
@@ -1246,7 +1247,7 @@ export declare namespace ConfluenceAttachmentToIndexFieldMapping {
|
|
|
1246
1247
|
const filterSensitiveLog: (obj: ConfluenceAttachmentToIndexFieldMapping) => any;
|
|
1247
1248
|
}
|
|
1248
1249
|
/**
|
|
1249
|
-
* <p>
|
|
1250
|
+
* <p>Configuration of attachment settings for the Confluence data source.
|
|
1250
1251
|
* Attachment settings are optional, if you don't specify settings
|
|
1251
1252
|
* attachments, Amazon Kendra won't index them.</p>
|
|
1252
1253
|
*/
|
|
@@ -1257,12 +1258,13 @@ export interface ConfluenceAttachmentConfiguration {
|
|
|
1257
1258
|
*/
|
|
1258
1259
|
CrawlAttachments?: boolean;
|
|
1259
1260
|
/**
|
|
1260
|
-
* <p>
|
|
1261
|
-
*
|
|
1262
|
-
*
|
|
1263
|
-
*
|
|
1264
|
-
*
|
|
1265
|
-
*
|
|
1261
|
+
* <p>Maps attributes or field names of Confluence attachments to Amazon Kendra index field
|
|
1262
|
+
* names. To create custom fields, use the <code>UpdateIndex</code> API before
|
|
1263
|
+
* you map to Confluence fields.
|
|
1264
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>.
|
|
1265
|
+
* The Confluence data source field names must exist in your Confluence custom metadata.</p>
|
|
1266
|
+
* <p>If you specify the <code>AttachentFieldMappings</code> parameter, you must specify
|
|
1267
|
+
* at least one field mapping.</p>
|
|
1266
1268
|
*/
|
|
1267
1269
|
AttachmentFieldMappings?: ConfluenceAttachmentToIndexFieldMapping[];
|
|
1268
1270
|
}
|
|
@@ -1284,10 +1286,11 @@ export declare enum ConfluenceBlogFieldName {
|
|
|
1284
1286
|
VERSION = "VERSION"
|
|
1285
1287
|
}
|
|
1286
1288
|
/**
|
|
1287
|
-
* <p>
|
|
1288
|
-
*
|
|
1289
|
-
*
|
|
1290
|
-
*
|
|
1289
|
+
* <p>Maps attributes or field names of Confluence blog to Amazon Kendra index field
|
|
1290
|
+
* names. To create custom fields, use the <code>UpdateIndex</code> API before
|
|
1291
|
+
* you map to Confluence fields.
|
|
1292
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>.
|
|
1293
|
+
* The Confluence data source field names must exist in your Confluence custom metadata.</p>
|
|
1291
1294
|
*/
|
|
1292
1295
|
export interface ConfluenceBlogToIndexFieldMapping {
|
|
1293
1296
|
/**
|
|
@@ -1315,17 +1318,18 @@ export declare namespace ConfluenceBlogToIndexFieldMapping {
|
|
|
1315
1318
|
const filterSensitiveLog: (obj: ConfluenceBlogToIndexFieldMapping) => any;
|
|
1316
1319
|
}
|
|
1317
1320
|
/**
|
|
1318
|
-
* <p>
|
|
1321
|
+
* <p>Configuration of blog settings for the Confluence data source. Blogs
|
|
1319
1322
|
* are always indexed unless filtered from the index by the
|
|
1320
1323
|
* <code>ExclusionPatterns</code> or <code>InclusionPatterns</code>
|
|
1321
1324
|
* fields in the <code>ConfluenceConfiguration</code> object.</p>
|
|
1322
1325
|
*/
|
|
1323
1326
|
export interface ConfluenceBlogConfiguration {
|
|
1324
1327
|
/**
|
|
1325
|
-
* <p>
|
|
1326
|
-
*
|
|
1327
|
-
*
|
|
1328
|
-
*
|
|
1328
|
+
* <p>Maps attributes or field names of Confluence blogs to Amazon Kendra index field
|
|
1329
|
+
* names. To create custom fields, use the <code>UpdateIndex</code> API before
|
|
1330
|
+
* you map to Confluence fields.
|
|
1331
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>.
|
|
1332
|
+
* The Confluence data source field names must exist in your Confluence custom metadata.</p>
|
|
1329
1333
|
* <p>If you specify the <code>BlogFieldMappings</code> parameter, you
|
|
1330
1334
|
* must specify at least one field mapping.</p>
|
|
1331
1335
|
*/
|
|
@@ -1352,14 +1356,15 @@ export declare enum ConfluencePageFieldName {
|
|
|
1352
1356
|
VERSION = "VERSION"
|
|
1353
1357
|
}
|
|
1354
1358
|
/**
|
|
1355
|
-
* <p
|
|
1356
|
-
*
|
|
1357
|
-
*
|
|
1358
|
-
*
|
|
1359
|
+
* <p>>Maps attributes or field names of Confluence pages to Amazon Kendra index field
|
|
1360
|
+
* names. To create custom fields, use the <code>UpdateIndex</code> API before
|
|
1361
|
+
* you map to Confluence fields.
|
|
1362
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>.
|
|
1363
|
+
* The Confluence data source field names must exist in your Confluence custom metadata.</p>
|
|
1359
1364
|
*/
|
|
1360
1365
|
export interface ConfluencePageToIndexFieldMapping {
|
|
1361
1366
|
/**
|
|
1362
|
-
* <p>The name of the field in the data source
|
|
1367
|
+
* <p>The name of the field in the data source.</p>
|
|
1363
1368
|
*/
|
|
1364
1369
|
DataSourceFieldName?: ConfluencePageFieldName | string;
|
|
1365
1370
|
/**
|
|
@@ -1383,14 +1388,15 @@ export declare namespace ConfluencePageToIndexFieldMapping {
|
|
|
1383
1388
|
const filterSensitiveLog: (obj: ConfluencePageToIndexFieldMapping) => any;
|
|
1384
1389
|
}
|
|
1385
1390
|
/**
|
|
1386
|
-
* <p>
|
|
1391
|
+
* <p>Configuration of the page settings for the Confluence data source.</p>
|
|
1387
1392
|
*/
|
|
1388
1393
|
export interface ConfluencePageConfiguration {
|
|
1389
1394
|
/**
|
|
1390
|
-
* <p
|
|
1391
|
-
*
|
|
1392
|
-
*
|
|
1393
|
-
*
|
|
1395
|
+
* <p>>Maps attributes or field names of Confluence pages to Amazon Kendra index field
|
|
1396
|
+
* names. To create custom fields, use the <code>UpdateIndex</code> API before
|
|
1397
|
+
* you map to Confluence fields.
|
|
1398
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>.
|
|
1399
|
+
* The Confluence data source field names must exist in your Confluence custom metadata.</p>
|
|
1394
1400
|
* <p>If you specify the <code>PageFieldMappings</code> parameter, you
|
|
1395
1401
|
* must specify at least one field mapping.</p>
|
|
1396
1402
|
*/
|
|
@@ -1409,10 +1415,11 @@ export declare enum ConfluenceSpaceFieldName {
|
|
|
1409
1415
|
URL = "URL"
|
|
1410
1416
|
}
|
|
1411
1417
|
/**
|
|
1412
|
-
* <p
|
|
1413
|
-
*
|
|
1414
|
-
*
|
|
1415
|
-
*
|
|
1418
|
+
* <p>>Maps attributes or field names of Confluence spaces to Amazon Kendra index field
|
|
1419
|
+
* names. To create custom fields, use the <code>UpdateIndex</code> API before
|
|
1420
|
+
* you map to Confluence fields.
|
|
1421
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>.
|
|
1422
|
+
* The Confluence data source field names must exist in your Confluence custom metadata.</p>
|
|
1416
1423
|
*/
|
|
1417
1424
|
export interface ConfluenceSpaceToIndexFieldMapping {
|
|
1418
1425
|
/**
|
|
@@ -1440,7 +1447,7 @@ export declare namespace ConfluenceSpaceToIndexFieldMapping {
|
|
|
1440
1447
|
const filterSensitiveLog: (obj: ConfluenceSpaceToIndexFieldMapping) => any;
|
|
1441
1448
|
}
|
|
1442
1449
|
/**
|
|
1443
|
-
* <p>
|
|
1450
|
+
* <p>Configuration information for indexing Confluence spaces.</p>
|
|
1444
1451
|
*/
|
|
1445
1452
|
export interface ConfluenceSpaceConfiguration {
|
|
1446
1453
|
/**
|
|
@@ -1474,10 +1481,11 @@ export interface ConfluenceSpaceConfiguration {
|
|
|
1474
1481
|
*/
|
|
1475
1482
|
ExcludeSpaces?: string[];
|
|
1476
1483
|
/**
|
|
1477
|
-
* <p>
|
|
1478
|
-
*
|
|
1479
|
-
*
|
|
1480
|
-
*
|
|
1484
|
+
* <p>Maps attributes or field names of Confluence spaces to Amazon Kendra index field
|
|
1485
|
+
* names. To create custom fields, use the <code>UpdateIndex</code> API before
|
|
1486
|
+
* you map to Confluence fields.
|
|
1487
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>.
|
|
1488
|
+
* The Confluence data source field names must exist in your Confluence custom metadata.</p>
|
|
1481
1489
|
* <p>If you specify the <code>SpaceFieldMappings</code> parameter, you
|
|
1482
1490
|
* must specify at least one field mapping.</p>
|
|
1483
1491
|
*/
|
|
@@ -1494,7 +1502,7 @@ export declare enum ConfluenceVersion {
|
|
|
1494
1502
|
SERVER = "SERVER"
|
|
1495
1503
|
}
|
|
1496
1504
|
/**
|
|
1497
|
-
* <p>Provides information
|
|
1505
|
+
* <p>Provides the configuration information to connect to an Amazon VPC.</p>
|
|
1498
1506
|
*/
|
|
1499
1507
|
export interface DataSourceVpcConfiguration {
|
|
1500
1508
|
/**
|
|
@@ -1518,29 +1526,29 @@ export declare namespace DataSourceVpcConfiguration {
|
|
|
1518
1526
|
const filterSensitiveLog: (obj: DataSourceVpcConfiguration) => any;
|
|
1519
1527
|
}
|
|
1520
1528
|
/**
|
|
1521
|
-
* <p>Provides configuration information
|
|
1522
|
-
*
|
|
1529
|
+
* <p>Provides the configuration information to connect to Confluence
|
|
1530
|
+
* as your data source.</p>
|
|
1523
1531
|
*/
|
|
1524
1532
|
export interface ConfluenceConfiguration {
|
|
1525
1533
|
/**
|
|
1526
1534
|
* <p>The URL of your Confluence instance. Use the full URL of the
|
|
1527
|
-
* server. For example, <
|
|
1535
|
+
* server. For example, <i>https://server.example.com:port/</i>.
|
|
1528
1536
|
* You can also use an IP address, for example,
|
|
1529
|
-
* <
|
|
1537
|
+
* <i>https://192.168.1.113/</i>.</p>
|
|
1530
1538
|
*/
|
|
1531
1539
|
ServerUrl: string | undefined;
|
|
1532
1540
|
/**
|
|
1533
1541
|
* <p>The Amazon Resource Name (ARN) of an Secrets Manager secret
|
|
1534
|
-
* that contains the key
|
|
1542
|
+
* that contains the key-value pairs required to connect to your
|
|
1535
1543
|
* Confluence server. The secret must contain a JSON structure with the
|
|
1536
1544
|
* following keys:</p>
|
|
1537
1545
|
* <ul>
|
|
1538
1546
|
* <li>
|
|
1539
|
-
* <p>username
|
|
1547
|
+
* <p>username—The user name or email address of a user with
|
|
1540
1548
|
* administrative privileges for the Confluence server.</p>
|
|
1541
1549
|
* </li>
|
|
1542
1550
|
* <li>
|
|
1543
|
-
* <p>password
|
|
1551
|
+
* <p>password—The password associated with the user logging
|
|
1544
1552
|
* in to the Confluence server.</p>
|
|
1545
1553
|
* </li>
|
|
1546
1554
|
* </ul>
|
|
@@ -1552,47 +1560,41 @@ export interface ConfluenceConfiguration {
|
|
|
1552
1560
|
*/
|
|
1553
1561
|
Version: ConfluenceVersion | string | undefined;
|
|
1554
1562
|
/**
|
|
1555
|
-
* <p>
|
|
1556
|
-
* spaces.</p>
|
|
1563
|
+
* <p>Configuration information for indexing Confluence spaces.</p>
|
|
1557
1564
|
*/
|
|
1558
1565
|
SpaceConfiguration?: ConfluenceSpaceConfiguration;
|
|
1559
1566
|
/**
|
|
1560
|
-
* <p>
|
|
1561
|
-
* pages.</p>
|
|
1567
|
+
* <p>Configuration information for indexing Confluence pages.</p>
|
|
1562
1568
|
*/
|
|
1563
1569
|
PageConfiguration?: ConfluencePageConfiguration;
|
|
1564
1570
|
/**
|
|
1565
|
-
* <p>
|
|
1566
|
-
* blogs.</p>
|
|
1571
|
+
* <p>Configuration information for indexing Confluence blogs.</p>
|
|
1567
1572
|
*/
|
|
1568
1573
|
BlogConfiguration?: ConfluenceBlogConfiguration;
|
|
1569
1574
|
/**
|
|
1570
|
-
* <p>
|
|
1575
|
+
* <p>Configuration information for indexing attachments to
|
|
1571
1576
|
* Confluence blogs and pages.</p>
|
|
1572
1577
|
*/
|
|
1573
1578
|
AttachmentConfiguration?: ConfluenceAttachmentConfiguration;
|
|
1574
1579
|
/**
|
|
1575
|
-
* <p>
|
|
1580
|
+
* <p>Configuration information for an Amazon Virtual Private Cloud to connect to your Confluence.
|
|
1581
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html">Configuring a VPC</a>.</p>
|
|
1576
1582
|
*/
|
|
1577
1583
|
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
1578
1584
|
/**
|
|
1579
|
-
* <p>A list of regular expression patterns
|
|
1580
|
-
*
|
|
1581
|
-
*
|
|
1582
|
-
*
|
|
1583
|
-
*
|
|
1584
|
-
* pattern and an exclusion pattern, the item isn't included in the
|
|
1585
|
-
* index.</p>
|
|
1585
|
+
* <p>A list of regular expression patterns to include certain blog posts, pages,
|
|
1586
|
+
* spaces, or attachments in your Confluence. Content that matches the patterns are
|
|
1587
|
+
* included in the index. Content that doesn't match the patterns is excluded from
|
|
1588
|
+
* the index. If content matches both an inclusion and exclusion pattern, the
|
|
1589
|
+
* exclusion pattern takes precedence and the content isn't included in the index.</p>
|
|
1586
1590
|
*/
|
|
1587
1591
|
InclusionPatterns?: string[];
|
|
1588
1592
|
/**
|
|
1589
|
-
* <p
|
|
1590
|
-
*
|
|
1591
|
-
*
|
|
1592
|
-
*
|
|
1593
|
-
*
|
|
1594
|
-
* and an inclusion pattern, the item isn't included in the
|
|
1595
|
-
* index.</p>
|
|
1593
|
+
* <p>>A list of regular expression patterns to exclude certain blog posts, pages,
|
|
1594
|
+
* spaces, or attachments in your Confluence. Content that matches the patterns are
|
|
1595
|
+
* excluded from the index. Content that doesn't match the patterns is included in
|
|
1596
|
+
* the index. If content matches both an inclusion and exclusion pattern, the
|
|
1597
|
+
* exclusion pattern takes precedence and the content isn't included in the index.</p>
|
|
1596
1598
|
*/
|
|
1597
1599
|
ExclusionPatterns?: string[];
|
|
1598
1600
|
}
|
|
@@ -1663,7 +1665,7 @@ export declare namespace ColumnConfiguration {
|
|
|
1663
1665
|
const filterSensitiveLog: (obj: ColumnConfiguration) => any;
|
|
1664
1666
|
}
|
|
1665
1667
|
/**
|
|
1666
|
-
* <p>Provides the information
|
|
1668
|
+
* <p>Provides the configuration information that's required to connect to a
|
|
1667
1669
|
* database.</p>
|
|
1668
1670
|
*/
|
|
1669
1671
|
export interface ConnectionConfiguration {
|
|
@@ -1712,7 +1714,7 @@ export declare enum QueryIdentifiersEnclosingOption {
|
|
|
1712
1714
|
NONE = "NONE"
|
|
1713
1715
|
}
|
|
1714
1716
|
/**
|
|
1715
|
-
* <p>Provides
|
|
1717
|
+
* <p>Provides the configuration information to use a SQL
|
|
1716
1718
|
* database.</p>
|
|
1717
1719
|
*/
|
|
1718
1720
|
export interface SqlConfiguration {
|
|
@@ -1739,7 +1741,7 @@ export declare namespace SqlConfiguration {
|
|
|
1739
1741
|
const filterSensitiveLog: (obj: SqlConfiguration) => any;
|
|
1740
1742
|
}
|
|
1741
1743
|
/**
|
|
1742
|
-
* <p>Provides the information
|
|
1744
|
+
* <p>Provides the configuration information to connect to a
|
|
1743
1745
|
* index. </p>
|
|
1744
1746
|
*/
|
|
1745
1747
|
export interface DatabaseConfiguration {
|
|
@@ -1748,11 +1750,11 @@ export interface DatabaseConfiguration {
|
|
|
1748
1750
|
*/
|
|
1749
1751
|
DatabaseEngineType: DatabaseEngineType | string | undefined;
|
|
1750
1752
|
/**
|
|
1751
|
-
* <p>
|
|
1753
|
+
* <p>Configuration information that's required to connect to a database.</p>
|
|
1752
1754
|
*/
|
|
1753
1755
|
ConnectionConfiguration: ConnectionConfiguration | undefined;
|
|
1754
1756
|
/**
|
|
1755
|
-
* <p>Provides information
|
|
1757
|
+
* <p>Provides the configuration information to connect to an Amazon VPC.</p>
|
|
1756
1758
|
*/
|
|
1757
1759
|
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
1758
1760
|
/**
|
|
@@ -1800,8 +1802,8 @@ export interface FsxConfiguration {
|
|
|
1800
1802
|
*/
|
|
1801
1803
|
FileSystemType: FsxFileSystemType | string | undefined;
|
|
1802
1804
|
/**
|
|
1803
|
-
* <p>
|
|
1804
|
-
*
|
|
1805
|
+
* <p>Configuration information for an Amazon Virtual Private Cloud to connect
|
|
1806
|
+
* to your Amazon FSx. Your Amazon FSx
|
|
1805
1807
|
* instance must reside inside your VPC.</p>
|
|
1806
1808
|
*/
|
|
1807
1809
|
VpcConfiguration: DataSourceVpcConfiguration | undefined;
|
|
@@ -1819,8 +1821,8 @@ export interface FsxConfiguration {
|
|
|
1819
1821
|
* Amazon FSx file system for Windows.</p>
|
|
1820
1822
|
* </li>
|
|
1821
1823
|
* <li>
|
|
1822
|
-
* <p>password—The password of the
|
|
1823
|
-
* read and mounting access Amazon FSx Windows file system.</p>
|
|
1824
|
+
* <p>password—The password of the Active Directory user account with
|
|
1825
|
+
* read and mounting access to the Amazon FSx Windows file system.</p>
|
|
1824
1826
|
* </li>
|
|
1825
1827
|
* </ul>
|
|
1826
1828
|
*/
|
|
@@ -1829,24 +1831,24 @@ export interface FsxConfiguration {
|
|
|
1829
1831
|
* <p>A list of regular expression patterns to include certain files
|
|
1830
1832
|
* in your Amazon FSx file system. Files that match the patterns
|
|
1831
1833
|
* 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
|
|
1833
|
-
*
|
|
1834
|
-
*
|
|
1834
|
+
* excluded from the index. If a file matches both an inclusion and
|
|
1835
|
+
* exclusion pattern, the exclusion pattern takes precedence and the file
|
|
1836
|
+
* isn't included in the index.</p>
|
|
1835
1837
|
*/
|
|
1836
1838
|
InclusionPatterns?: string[];
|
|
1837
1839
|
/**
|
|
1838
1840
|
* <p>A list of regular expression patterns to exclude certain files
|
|
1839
1841
|
* in your Amazon FSx file system. Files that match the patterns
|
|
1840
|
-
* are excluded from the index. Files that don
|
|
1841
|
-
* included in the index. If a file matches both an inclusion
|
|
1842
|
-
*
|
|
1843
|
-
*
|
|
1842
|
+
* are excluded from the index. Files that don't match the patterns are
|
|
1843
|
+
* included in the index. If a file matches both an inclusion and exclusion
|
|
1844
|
+
* pattern, the exclusion pattern takes precedence and the file isn't included
|
|
1845
|
+
* in the index.</p>
|
|
1844
1846
|
*/
|
|
1845
1847
|
ExclusionPatterns?: string[];
|
|
1846
1848
|
/**
|
|
1847
1849
|
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that
|
|
1848
1850
|
* map Amazon FSx data source attributes or field names to Amazon Kendra
|
|
1849
|
-
* index field names
|
|
1851
|
+
* index field names. To create custom fields, use the
|
|
1850
1852
|
* <code>UpdateIndex</code> API before you map to Amazon FSx fields.
|
|
1851
1853
|
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping
|
|
1852
1854
|
* data source fields</a>. The Amazon FSx data source field names
|
|
@@ -1861,8 +1863,8 @@ export declare namespace FsxConfiguration {
|
|
|
1861
1863
|
const filterSensitiveLog: (obj: FsxConfiguration) => any;
|
|
1862
1864
|
}
|
|
1863
1865
|
/**
|
|
1864
|
-
* <p>Provides configuration information
|
|
1865
|
-
*
|
|
1866
|
+
* <p>Provides the configuration information to connect to
|
|
1867
|
+
* Google Drive as your data source.</p>
|
|
1866
1868
|
*/
|
|
1867
1869
|
export interface GoogleDriveConfiguration {
|
|
1868
1870
|
/**
|
|
@@ -1873,30 +1875,29 @@ export interface GoogleDriveConfiguration {
|
|
|
1873
1875
|
*/
|
|
1874
1876
|
SecretArn: string | undefined;
|
|
1875
1877
|
/**
|
|
1876
|
-
* <p>A list of regular expression patterns
|
|
1877
|
-
* Drive
|
|
1878
|
-
*
|
|
1879
|
-
*
|
|
1880
|
-
* inclusion
|
|
1881
|
-
* index.</p>
|
|
1878
|
+
* <p>A list of regular expression patterns to include certain items in your
|
|
1879
|
+
* Google Drive, including shared drives and users' My Drives. Items that
|
|
1880
|
+
* match the patterns are included in the index. Items that
|
|
1881
|
+
* don't match the patterns are excluded from the index. If an item matches both
|
|
1882
|
+
* an inclusion and exclusion pattern, the exclusion pattern takes precedence and the
|
|
1883
|
+
* item isn't included in the index.</p>
|
|
1882
1884
|
*/
|
|
1883
1885
|
InclusionPatterns?: string[];
|
|
1884
1886
|
/**
|
|
1885
|
-
* <p>A list of regular expression patterns
|
|
1886
|
-
* Google Drive
|
|
1887
|
-
*
|
|
1888
|
-
* match the
|
|
1889
|
-
* an exclusion pattern
|
|
1890
|
-
* the index.</p>
|
|
1887
|
+
* <p>A list of regular expression patterns to exclude certain items in your
|
|
1888
|
+
* Google Drive, including shared drives and users' My Drives. Items that
|
|
1889
|
+
* match the patterns are excluded from the index. Items that
|
|
1890
|
+
* don't match the patterns are included in the index. If an item matches both
|
|
1891
|
+
* an inclusion and exclusion pattern, the exclusion pattern takes precedence and the
|
|
1892
|
+
* item isn't included in the index.</p>
|
|
1891
1893
|
*/
|
|
1892
1894
|
ExclusionPatterns?: string[];
|
|
1893
1895
|
/**
|
|
1894
|
-
* <p>
|
|
1895
|
-
*
|
|
1896
|
-
*
|
|
1897
|
-
*
|
|
1898
|
-
*
|
|
1899
|
-
* API.</p>
|
|
1896
|
+
* <p>Maps Google Drive data source attributes or field names to Amazon Kendra index
|
|
1897
|
+
* field names. To create custom fields, use the <code>UpdateIndex</code> API before
|
|
1898
|
+
* you map to Google Drive fields.
|
|
1899
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>.
|
|
1900
|
+
* The Google Drive data source field names must exist in your Google Drive custom metadata.</p>
|
|
1900
1901
|
*/
|
|
1901
1902
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
1902
1903
|
/**
|
|
@@ -1951,8 +1952,8 @@ export declare namespace OneDriveUsers {
|
|
|
1951
1952
|
const filterSensitiveLog: (obj: OneDriveUsers) => any;
|
|
1952
1953
|
}
|
|
1953
1954
|
/**
|
|
1954
|
-
* <p>Provides configuration information
|
|
1955
|
-
* to OneDrive.</p>
|
|
1955
|
+
* <p>Provides the configuration information to connect
|
|
1956
|
+
* to OneDrive as your data source.</p>
|
|
1956
1957
|
*/
|
|
1957
1958
|
export interface OneDriveConfiguration {
|
|
1958
1959
|
/**
|
|
@@ -1972,27 +1973,31 @@ export interface OneDriveConfiguration {
|
|
|
1972
1973
|
*/
|
|
1973
1974
|
OneDriveUsers: OneDriveUsers | undefined;
|
|
1974
1975
|
/**
|
|
1975
|
-
* <p>A list of regular expression patterns
|
|
1976
|
-
*
|
|
1977
|
-
*
|
|
1978
|
-
*
|
|
1979
|
-
*
|
|
1980
|
-
*
|
|
1976
|
+
* <p>A list of regular expression patterns to include certain documents
|
|
1977
|
+
* in your OneDrive. Documents that match the
|
|
1978
|
+
* patterns are included in the index. Documents that don't match the
|
|
1979
|
+
* patterns are excluded from the index. If a document matches both an
|
|
1980
|
+
* inclusion and exclusion pattern, the exclusion pattern takes
|
|
1981
|
+
* precedence and the document isn't included in the index.</p>
|
|
1982
|
+
* <p>The pattern is applied to the file name.</p>
|
|
1981
1983
|
*/
|
|
1982
1984
|
InclusionPatterns?: string[];
|
|
1983
1985
|
/**
|
|
1984
|
-
* <p>
|
|
1985
|
-
*
|
|
1986
|
-
*
|
|
1987
|
-
*
|
|
1988
|
-
*
|
|
1986
|
+
* <p>A list of regular expression patterns to exclude certain documents
|
|
1987
|
+
* in your OneDrive. Documents that match the
|
|
1988
|
+
* patterns are excluded from the index. Documents that don't match the
|
|
1989
|
+
* patterns are included in the index. If a document matches both an
|
|
1990
|
+
* inclusion and exclusion pattern, the exclusion pattern takes
|
|
1991
|
+
* precedence and the document isn't included in the index.</p>
|
|
1992
|
+
* <p>The pattern is applied to the file name.</p>
|
|
1989
1993
|
*/
|
|
1990
1994
|
ExclusionPatterns?: string[];
|
|
1991
1995
|
/**
|
|
1992
|
-
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that
|
|
1993
|
-
*
|
|
1994
|
-
*
|
|
1995
|
-
*
|
|
1996
|
+
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map OneDrive data
|
|
1997
|
+
* source attributes or field names to Amazon Kendra index field names. To create
|
|
1998
|
+
* custom fields, use the <code>UpdateIndex</code> API before you map to OneDrive fields.
|
|
1999
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>.
|
|
2000
|
+
* The OneDrive data source field names must exist in your OneDrive custom metadata.</p>
|
|
1996
2001
|
*/
|
|
1997
2002
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
1998
2003
|
/**
|
|
@@ -2030,8 +2035,8 @@ export declare namespace DocumentsMetadataConfiguration {
|
|
|
2030
2035
|
const filterSensitiveLog: (obj: DocumentsMetadataConfiguration) => any;
|
|
2031
2036
|
}
|
|
2032
2037
|
/**
|
|
2033
|
-
* <p>Provides configuration information
|
|
2034
|
-
*
|
|
2038
|
+
* <p>Provides the configuration information to connect to
|
|
2039
|
+
* an Amazon S3 bucket.</p>
|
|
2035
2040
|
*/
|
|
2036
2041
|
export interface S3DataSourceConfiguration {
|
|
2037
2042
|
/**
|
|
@@ -2122,7 +2127,7 @@ export declare enum SalesforceChatterFeedIncludeFilterType {
|
|
|
2122
2127
|
STANDARD_USER = "STANDARD_USER"
|
|
2123
2128
|
}
|
|
2124
2129
|
/**
|
|
2125
|
-
* <p>
|
|
2130
|
+
* <p>The configuration information for syncing a Salesforce chatter feed. The
|
|
2126
2131
|
* contents of the object comes from the Salesforce FeedItem
|
|
2127
2132
|
* table.</p>
|
|
2128
2133
|
*/
|
|
@@ -2160,7 +2165,7 @@ export declare namespace SalesforceChatterFeedConfiguration {
|
|
|
2160
2165
|
const filterSensitiveLog: (obj: SalesforceChatterFeedConfiguration) => any;
|
|
2161
2166
|
}
|
|
2162
2167
|
/**
|
|
2163
|
-
* <p>Provides configuration information for indexing Salesforce custom
|
|
2168
|
+
* <p>Provides the configuration information for indexing Salesforce custom
|
|
2164
2169
|
* articles.</p>
|
|
2165
2170
|
*/
|
|
2166
2171
|
export interface SalesforceCustomKnowledgeArticleTypeConfiguration {
|
|
@@ -2179,8 +2184,11 @@ export interface SalesforceCustomKnowledgeArticleTypeConfiguration {
|
|
|
2179
2184
|
*/
|
|
2180
2185
|
DocumentTitleFieldName?: string;
|
|
2181
2186
|
/**
|
|
2182
|
-
* <p>
|
|
2183
|
-
*
|
|
2187
|
+
* <p>Maps attributes or field names of the custom knowledge article to Amazon Kendra
|
|
2188
|
+
* index field names. To create custom fields, use the <code>UpdateIndex</code> API
|
|
2189
|
+
* before you map to Salesforce fields.
|
|
2190
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>.
|
|
2191
|
+
* The Salesforce data source field names must exist in your Salesforce custom metadata.</p>
|
|
2184
2192
|
*/
|
|
2185
2193
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2186
2194
|
}
|
|
@@ -2196,7 +2204,7 @@ export declare enum SalesforceKnowledgeArticleState {
|
|
|
2196
2204
|
PUBLISHED = "PUBLISHED"
|
|
2197
2205
|
}
|
|
2198
2206
|
/**
|
|
2199
|
-
* <p>Provides configuration information for standard Salesforce
|
|
2207
|
+
* <p>Provides the configuration information for standard Salesforce
|
|
2200
2208
|
* knowledge articles.</p>
|
|
2201
2209
|
*/
|
|
2202
2210
|
export interface SalesforceStandardKnowledgeArticleTypeConfiguration {
|
|
@@ -2210,9 +2218,11 @@ export interface SalesforceStandardKnowledgeArticleTypeConfiguration {
|
|
|
2210
2218
|
*/
|
|
2211
2219
|
DocumentTitleFieldName?: string;
|
|
2212
2220
|
/**
|
|
2213
|
-
* <p>
|
|
2214
|
-
*
|
|
2215
|
-
*
|
|
2221
|
+
* <p>Maps attributes or field names of the knowledge article to Amazon Kendra
|
|
2222
|
+
* index field names. To create custom fields, use the <code>UpdateIndex</code> API
|
|
2223
|
+
* before you map to Salesforce fields.
|
|
2224
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>.
|
|
2225
|
+
* The Salesforce data source field names must exist in your Salesforce custom metadata.</p>
|
|
2216
2226
|
*/
|
|
2217
2227
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2218
2228
|
}
|
|
@@ -2223,7 +2233,7 @@ export declare namespace SalesforceStandardKnowledgeArticleTypeConfiguration {
|
|
|
2223
2233
|
const filterSensitiveLog: (obj: SalesforceStandardKnowledgeArticleTypeConfiguration) => any;
|
|
2224
2234
|
}
|
|
2225
2235
|
/**
|
|
2226
|
-
* <p>
|
|
2236
|
+
* <p>Provides the configuration information for the knowledge article
|
|
2227
2237
|
* types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge
|
|
2228
2238
|
* articles and the standard fields of knowledge articles, or the
|
|
2229
2239
|
* custom fields of custom knowledge articles, but not both </p>
|
|
@@ -2236,12 +2246,12 @@ export interface SalesforceKnowledgeArticleConfiguration {
|
|
|
2236
2246
|
*/
|
|
2237
2247
|
IncludedStates: (SalesforceKnowledgeArticleState | string)[] | undefined;
|
|
2238
2248
|
/**
|
|
2239
|
-
* <p>
|
|
2249
|
+
* <p>Configuration information for standard Salesforce
|
|
2240
2250
|
* knowledge articles.</p>
|
|
2241
2251
|
*/
|
|
2242
2252
|
StandardKnowledgeArticleTypeConfiguration?: SalesforceStandardKnowledgeArticleTypeConfiguration;
|
|
2243
2253
|
/**
|
|
2244
|
-
* <p>
|
|
2254
|
+
* <p>Configuration information for custom Salesforce knowledge
|
|
2245
2255
|
* articles.</p>
|
|
2246
2256
|
*/
|
|
2247
2257
|
CustomKnowledgeArticleTypeConfigurations?: SalesforceCustomKnowledgeArticleTypeConfiguration[];
|
|
@@ -2253,8 +2263,8 @@ export declare namespace SalesforceKnowledgeArticleConfiguration {
|
|
|
2253
2263
|
const filterSensitiveLog: (obj: SalesforceKnowledgeArticleConfiguration) => any;
|
|
2254
2264
|
}
|
|
2255
2265
|
/**
|
|
2256
|
-
* <p>Provides configuration information for processing attachments to
|
|
2257
|
-
* Salesforce standard objects
|
|
2266
|
+
* <p>Provides the configuration information for processing attachments to
|
|
2267
|
+
* Salesforce standard objects.</p>
|
|
2258
2268
|
*/
|
|
2259
2269
|
export interface SalesforceStandardObjectAttachmentConfiguration {
|
|
2260
2270
|
/**
|
|
@@ -2293,7 +2303,7 @@ export declare enum SalesforceStandardObjectName {
|
|
|
2293
2303
|
USER = "USER"
|
|
2294
2304
|
}
|
|
2295
2305
|
/**
|
|
2296
|
-
* <p>
|
|
2306
|
+
* <p>Provides the configuration information for indexing a single standard
|
|
2297
2307
|
* object.</p>
|
|
2298
2308
|
*/
|
|
2299
2309
|
export interface SalesforceStandardObjectConfiguration {
|
|
@@ -2312,9 +2322,11 @@ export interface SalesforceStandardObjectConfiguration {
|
|
|
2312
2322
|
*/
|
|
2313
2323
|
DocumentTitleFieldName?: string;
|
|
2314
2324
|
/**
|
|
2315
|
-
* <p>
|
|
2316
|
-
*
|
|
2317
|
-
*
|
|
2325
|
+
* <p>Maps attributes or field names of the standard object to Amazon Kendra
|
|
2326
|
+
* index field names. To create custom fields, use the <code>UpdateIndex</code> API
|
|
2327
|
+
* before you map to Salesforce fields.
|
|
2328
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>.
|
|
2329
|
+
* The Salesforce data source field names must exist in your Salesforce custom metadata.</p>
|
|
2318
2330
|
*/
|
|
2319
2331
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2320
2332
|
}
|
|
@@ -2325,8 +2337,8 @@ export declare namespace SalesforceStandardObjectConfiguration {
|
|
|
2325
2337
|
const filterSensitiveLog: (obj: SalesforceStandardObjectConfiguration) => any;
|
|
2326
2338
|
}
|
|
2327
2339
|
/**
|
|
2328
|
-
* <p>Provides configuration information
|
|
2329
|
-
* data source.</p>
|
|
2340
|
+
* <p>Provides the configuration information to connect to Salesforce
|
|
2341
|
+
* as your data source.</p>
|
|
2330
2342
|
*/
|
|
2331
2343
|
export interface SalesforceConfiguration {
|
|
2332
2344
|
/**
|
|
@@ -2368,20 +2380,19 @@ export interface SalesforceConfiguration {
|
|
|
2368
2380
|
*/
|
|
2369
2381
|
SecretArn: string | undefined;
|
|
2370
2382
|
/**
|
|
2371
|
-
* <p>
|
|
2383
|
+
* <p>Configuration of the Salesforce standard objects that Amazon Kendra
|
|
2372
2384
|
* indexes.</p>
|
|
2373
2385
|
*/
|
|
2374
2386
|
StandardObjectConfigurations?: SalesforceStandardObjectConfiguration[];
|
|
2375
2387
|
/**
|
|
2376
|
-
* <p>
|
|
2388
|
+
* <p>Configuration information for the knowledge article
|
|
2377
2389
|
* types that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge
|
|
2378
2390
|
* articles and the standard fields of knowledge articles, or the
|
|
2379
2391
|
* custom fields of custom knowledge articles, but not both.</p>
|
|
2380
2392
|
*/
|
|
2381
2393
|
KnowledgeArticleConfiguration?: SalesforceKnowledgeArticleConfiguration;
|
|
2382
2394
|
/**
|
|
2383
|
-
* <p>
|
|
2384
|
-
* feeds.</p>
|
|
2395
|
+
* <p>Configuration information for Salesforce chatter feeds.</p>
|
|
2385
2396
|
*/
|
|
2386
2397
|
ChatterFeedConfiguration?: SalesforceChatterFeedConfiguration;
|
|
2387
2398
|
/**
|
|
@@ -2390,26 +2401,26 @@ export interface SalesforceConfiguration {
|
|
|
2390
2401
|
*/
|
|
2391
2402
|
CrawlAttachments?: boolean;
|
|
2392
2403
|
/**
|
|
2393
|
-
* <p>
|
|
2404
|
+
* <p>Configuration information for processing attachments to
|
|
2394
2405
|
* Salesforce standard objects. </p>
|
|
2395
2406
|
*/
|
|
2396
2407
|
StandardObjectAttachmentConfiguration?: SalesforceStandardObjectAttachmentConfiguration;
|
|
2397
2408
|
/**
|
|
2398
|
-
* <p>A list of regular expression patterns
|
|
2399
|
-
* patterns are included in the index. Documents that
|
|
2400
|
-
* patterns are excluded from the index. If a document matches both
|
|
2401
|
-
* inclusion
|
|
2402
|
-
* included in the index.</p>
|
|
2403
|
-
* <p>The
|
|
2409
|
+
* <p>A list of regular expression patterns to include certain documents in your Salesforce.
|
|
2410
|
+
* Documents that match the patterns are included in the index. Documents that
|
|
2411
|
+
* don't match the patterns are excluded from the index. If a document matches both
|
|
2412
|
+
* an inclusion and exclusion pattern, the exclusion pattern takes precedence and the
|
|
2413
|
+
* document isn't included in the index.</p>
|
|
2414
|
+
* <p>The pattern is applied to the name of the attached file.</p>
|
|
2404
2415
|
*/
|
|
2405
2416
|
IncludeAttachmentFilePatterns?: string[];
|
|
2406
2417
|
/**
|
|
2407
|
-
* <p>A list of regular expression patterns
|
|
2408
|
-
* patterns are excluded from the index. Documents that
|
|
2409
|
-
* patterns are included in the index. If a document matches both
|
|
2410
|
-
*
|
|
2411
|
-
* included in the index.</p>
|
|
2412
|
-
* <p>The
|
|
2418
|
+
* <p>A list of regular expression patterns to exclude certain documents in your Salesforce.
|
|
2419
|
+
* Documents that match the patterns are excluded from the index. Documents that
|
|
2420
|
+
* don't match the patterns are included in the index. If a document matches both
|
|
2421
|
+
* an inclusion and exclusion pattern, the exclusion pattern takes precedence and the
|
|
2422
|
+
* document isn't included in the index.</p>
|
|
2423
|
+
* <p>The pattern is applied to the name of the attached file.</p>
|
|
2413
2424
|
*/
|
|
2414
2425
|
ExcludeAttachmentFilePatterns?: string[];
|
|
2415
2426
|
}
|
|
@@ -2424,7 +2435,7 @@ export declare enum ServiceNowAuthenticationType {
|
|
|
2424
2435
|
OAUTH2 = "OAUTH2"
|
|
2425
2436
|
}
|
|
2426
2437
|
/**
|
|
2427
|
-
* <p>Provides configuration information for crawling knowledge articles
|
|
2438
|
+
* <p>Provides the configuration information for crawling knowledge articles
|
|
2428
2439
|
* in the ServiceNow site.</p>
|
|
2429
2440
|
*/
|
|
2430
2441
|
export interface ServiceNowKnowledgeArticleConfiguration {
|
|
@@ -2434,18 +2445,23 @@ export interface ServiceNowKnowledgeArticleConfiguration {
|
|
|
2434
2445
|
*/
|
|
2435
2446
|
CrawlAttachments?: boolean;
|
|
2436
2447
|
/**
|
|
2437
|
-
* <p>
|
|
2438
|
-
* that
|
|
2439
|
-
*
|
|
2440
|
-
*
|
|
2448
|
+
* <p>A list of regular expression patterns to include certain attachments of knowledge articles in
|
|
2449
|
+
* your ServiceNow. Item that match the patterns are included in the index. Items that
|
|
2450
|
+
* don't match the patterns are excluded from the index. If an item matches both
|
|
2451
|
+
* an inclusion and exclusion pattern, the exclusion pattern takes precedence and the
|
|
2452
|
+
* item isn't included in the index.</p>
|
|
2453
|
+
* <p>The regex is
|
|
2454
|
+
* applied to the field specified in the <code>PatternTargetField</code>.</p>
|
|
2441
2455
|
*/
|
|
2442
2456
|
IncludeAttachmentFilePatterns?: string[];
|
|
2443
2457
|
/**
|
|
2444
|
-
* <p>
|
|
2445
|
-
* that
|
|
2446
|
-
*
|
|
2447
|
-
*
|
|
2448
|
-
*
|
|
2458
|
+
* <p>A list of regular expression patterns to exclude certain attachments of knowledge articles in
|
|
2459
|
+
* your ServiceNow. Item that match the patterns are excluded from the index. Items that
|
|
2460
|
+
* don't match the patterns are included in the index. If an item matches both
|
|
2461
|
+
* an inclusion and exclusion pattern, the exclusion pattern takes precedence and the
|
|
2462
|
+
* item isn't included in the index.</p>
|
|
2463
|
+
* <p>The regex is
|
|
2464
|
+
* applied to the field specified in the <code>PatternTargetField</code>.</p>
|
|
2449
2465
|
*/
|
|
2450
2466
|
ExcludeAttachmentFilePatterns?: string[];
|
|
2451
2467
|
/**
|
|
@@ -2459,8 +2475,11 @@ export interface ServiceNowKnowledgeArticleConfiguration {
|
|
|
2459
2475
|
*/
|
|
2460
2476
|
DocumentTitleFieldName?: string;
|
|
2461
2477
|
/**
|
|
2462
|
-
* <p>
|
|
2463
|
-
*
|
|
2478
|
+
* <p>Maps attributes or field names of knoweldge articles to Amazon Kendra index
|
|
2479
|
+
* field names. To create custom fields, use the <code>UpdateIndex</code> API before
|
|
2480
|
+
* you map to ServiceNow fields.
|
|
2481
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>.
|
|
2482
|
+
* The ServiceNow data source field names must exist in your ServiceNow custom metadata.</p>
|
|
2464
2483
|
*/
|
|
2465
2484
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2466
2485
|
/**
|
|
@@ -2480,7 +2499,7 @@ export declare namespace ServiceNowKnowledgeArticleConfiguration {
|
|
|
2480
2499
|
const filterSensitiveLog: (obj: ServiceNowKnowledgeArticleConfiguration) => any;
|
|
2481
2500
|
}
|
|
2482
2501
|
/**
|
|
2483
|
-
* <p>Provides configuration information for crawling service catalog
|
|
2502
|
+
* <p>Provides the configuration information for crawling service catalog
|
|
2484
2503
|
* items in the ServiceNow site</p>
|
|
2485
2504
|
*/
|
|
2486
2505
|
export interface ServiceNowServiceCatalogConfiguration {
|
|
@@ -2490,20 +2509,20 @@ export interface ServiceNowServiceCatalogConfiguration {
|
|
|
2490
2509
|
*/
|
|
2491
2510
|
CrawlAttachments?: boolean;
|
|
2492
2511
|
/**
|
|
2493
|
-
* <p>A list of regular expression patterns
|
|
2494
|
-
* patterns are included in the index.
|
|
2495
|
-
* patterns are excluded from the index. If
|
|
2496
|
-
*
|
|
2497
|
-
* included in the index.</p>
|
|
2512
|
+
* <p>A list of regular expression patterns to include certain attachments of catalogs in
|
|
2513
|
+
* your ServiceNow. Item that match the patterns are included in the index. Items that
|
|
2514
|
+
* don't match the patterns are excluded from the index. If an item matches both
|
|
2515
|
+
* an inclusion and exclusion pattern, the exclusion pattern takes precedence and the
|
|
2516
|
+
* item isn't included in the index.</p>
|
|
2498
2517
|
* <p>The regex is applied to the file name of the attachment.</p>
|
|
2499
2518
|
*/
|
|
2500
2519
|
IncludeAttachmentFilePatterns?: string[];
|
|
2501
2520
|
/**
|
|
2502
|
-
* <p>A list of regular expression patterns
|
|
2503
|
-
* patterns are excluded from the index.
|
|
2504
|
-
* patterns are included in the index. If
|
|
2505
|
-
*
|
|
2506
|
-
* included in the index.</p>
|
|
2521
|
+
* <p>A list of regular expression patterns to exclude certain attachments of catalogs in
|
|
2522
|
+
* your ServiceNow. Item that match the patterns are excluded from the index. Items that
|
|
2523
|
+
* don't match the patterns are included in the index. If an item matches both
|
|
2524
|
+
* an inclusion and exclusion pattern, the exclusion pattern takes precedence and the
|
|
2525
|
+
* item isn't included in the index.</p>
|
|
2507
2526
|
* <p>The regex is applied to the file name of the attachment.</p>
|
|
2508
2527
|
*/
|
|
2509
2528
|
ExcludeAttachmentFilePatterns?: string[];
|
|
@@ -2518,8 +2537,11 @@ export interface ServiceNowServiceCatalogConfiguration {
|
|
|
2518
2537
|
*/
|
|
2519
2538
|
DocumentTitleFieldName?: string;
|
|
2520
2539
|
/**
|
|
2521
|
-
* <p>
|
|
2522
|
-
*
|
|
2540
|
+
* <p>Maps attributes or field names of catalogs to Amazon Kendra index
|
|
2541
|
+
* field names. To create custom fields, use the <code>UpdateIndex</code> API before
|
|
2542
|
+
* you map to ServiceNow fields.
|
|
2543
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>.
|
|
2544
|
+
* The ServiceNow data source field names must exist in your ServiceNow custom metadata.</p>
|
|
2523
2545
|
*/
|
|
2524
2546
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2525
2547
|
}
|
|
@@ -2534,14 +2556,14 @@ export declare enum ServiceNowBuildVersionType {
|
|
|
2534
2556
|
OTHERS = "OTHERS"
|
|
2535
2557
|
}
|
|
2536
2558
|
/**
|
|
2537
|
-
* <p>Provides configuration information
|
|
2538
|
-
* ServiceNow data source.</p>
|
|
2559
|
+
* <p>Provides the configuration information to connect to
|
|
2560
|
+
* ServiceNow as your data source.</p>
|
|
2539
2561
|
*/
|
|
2540
2562
|
export interface ServiceNowConfiguration {
|
|
2541
2563
|
/**
|
|
2542
2564
|
* <p>The ServiceNow instance that the data source connects to. The host
|
|
2543
2565
|
* endpoint should look like the following:
|
|
2544
|
-
* <
|
|
2566
|
+
* <i>{instance}.service-now.com.</i>
|
|
2545
2567
|
* </p>
|
|
2546
2568
|
*/
|
|
2547
2569
|
HostUrl: string | undefined;
|
|
@@ -2558,17 +2580,17 @@ export interface ServiceNowConfiguration {
|
|
|
2558
2580
|
*/
|
|
2559
2581
|
ServiceNowBuildVersion: ServiceNowBuildVersionType | string | undefined;
|
|
2560
2582
|
/**
|
|
2561
|
-
* <p>
|
|
2583
|
+
* <p>Configuration information for crawling knowledge articles
|
|
2562
2584
|
* in the ServiceNow site.</p>
|
|
2563
2585
|
*/
|
|
2564
2586
|
KnowledgeArticleConfiguration?: ServiceNowKnowledgeArticleConfiguration;
|
|
2565
2587
|
/**
|
|
2566
|
-
* <p>
|
|
2588
|
+
* <p>Configuration information for crawling service catalogs
|
|
2567
2589
|
* in the ServiceNow site.</p>
|
|
2568
2590
|
*/
|
|
2569
2591
|
ServiceCatalogConfiguration?: ServiceNowServiceCatalogConfiguration;
|
|
2570
2592
|
/**
|
|
2571
|
-
* <p>
|
|
2593
|
+
* <p>The type of authentication used to connect to the
|
|
2572
2594
|
* ServiceNow instance. If you choose <code>HTTP_BASIC</code>, Amazon Kendra is
|
|
2573
2595
|
* authenticated using the user name and password provided in the
|
|
2574
2596
|
* Secrets Manager secret in the <code>SecretArn</code> field. When you
|
|
@@ -2595,8 +2617,8 @@ export declare enum SharePointVersion {
|
|
|
2595
2617
|
SHAREPOINT_ONLINE = "SHAREPOINT_ONLINE"
|
|
2596
2618
|
}
|
|
2597
2619
|
/**
|
|
2598
|
-
* <p>Provides configuration information
|
|
2599
|
-
* SharePoint data source.</p>
|
|
2620
|
+
* <p>Provides the configuration information to connect to Microsoft
|
|
2621
|
+
* SharePoint as your data source.</p>
|
|
2600
2622
|
*/
|
|
2601
2623
|
export interface SharePointConfiguration {
|
|
2602
2624
|
/**
|
|
@@ -2629,45 +2651,43 @@ export interface SharePointConfiguration {
|
|
|
2629
2651
|
*/
|
|
2630
2652
|
CrawlAttachments?: boolean;
|
|
2631
2653
|
/**
|
|
2632
|
-
* <p>
|
|
2633
|
-
*
|
|
2634
|
-
*
|
|
2635
|
-
* longer for Amazon Kendra to use the change log than
|
|
2636
|
-
*
|
|
2637
|
-
* crawler.</p>
|
|
2654
|
+
* <p>
|
|
2655
|
+
* <code>TRUE</code> to use the SharePoint change log to determine which documents
|
|
2656
|
+
* require updating in the index. Depending on the change log's
|
|
2657
|
+
* size, it may take longer for Amazon Kendra to use the change log than to
|
|
2658
|
+
* scan all of your documents in SharePoint.</p>
|
|
2638
2659
|
*/
|
|
2639
2660
|
UseChangeLog?: boolean;
|
|
2640
2661
|
/**
|
|
2641
|
-
* <p>A list of regular expression patterns
|
|
2642
|
-
* patterns are included in the index. Documents that
|
|
2643
|
-
* patterns are excluded from the index. If a document matches both
|
|
2644
|
-
* inclusion
|
|
2645
|
-
* included in the index.</p>
|
|
2662
|
+
* <p>A list of regular expression patterns to include certain documents in your SharePoint.
|
|
2663
|
+
* Documents that match the patterns are included in the index. Documents that
|
|
2664
|
+
* don't match the patterns are excluded from the index. If a document matches both
|
|
2665
|
+
* an inclusion and exclusion pattern, the exclusion pattern takes precedence and the
|
|
2666
|
+
* document isn't included in the index.</p>
|
|
2646
2667
|
* <p>The regex is applied to the display URL of the SharePoint
|
|
2647
2668
|
* document.</p>
|
|
2648
2669
|
*/
|
|
2649
2670
|
InclusionPatterns?: string[];
|
|
2650
2671
|
/**
|
|
2651
|
-
* <p>A list of regular expression patterns
|
|
2652
|
-
* patterns are excluded from the index. Documents that
|
|
2653
|
-
* patterns are included in the index. If a document matches both
|
|
2654
|
-
*
|
|
2655
|
-
* included in the index.</p>
|
|
2672
|
+
* <p>A list of regular expression patterns to exclude certain documents in your SharePoint.
|
|
2673
|
+
* Documents that match the patterns are excluded from the index. Documents that
|
|
2674
|
+
* don't match the patterns are included in the index. If a document matches both
|
|
2675
|
+
* an inclusion and exclusion pattern, the exclusion pattern takes precedence and the
|
|
2676
|
+
* document isn't included in the index.</p>
|
|
2656
2677
|
* <p>The regex is applied to the display URL of the SharePoint
|
|
2657
2678
|
* document.</p>
|
|
2658
2679
|
*/
|
|
2659
2680
|
ExclusionPatterns?: string[];
|
|
2660
2681
|
/**
|
|
2661
|
-
* <p>Provides information
|
|
2682
|
+
* <p>Provides the configuration information to connect to an Amazon VPC.</p>
|
|
2662
2683
|
*/
|
|
2663
2684
|
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
2664
2685
|
/**
|
|
2665
|
-
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that
|
|
2666
|
-
*
|
|
2667
|
-
*
|
|
2668
|
-
*
|
|
2669
|
-
*
|
|
2670
|
-
* Fields</a>.</p>
|
|
2686
|
+
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map SharePoint data
|
|
2687
|
+
* source attributes or field names to Amazon Kendra index field names. To create
|
|
2688
|
+
* custom fields, use the <code>UpdateIndex</code> API before you map to SharePoint fields.
|
|
2689
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>.
|
|
2690
|
+
* The SharePoint data source field names must exist in your SharePoint custom metadata.</p>
|
|
2671
2691
|
*/
|
|
2672
2692
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2673
2693
|
/**
|
|
@@ -2693,6 +2713,125 @@ export declare namespace SharePointConfiguration {
|
|
|
2693
2713
|
*/
|
|
2694
2714
|
const filterSensitiveLog: (obj: SharePointConfiguration) => any;
|
|
2695
2715
|
}
|
|
2716
|
+
export declare enum SlackEntity {
|
|
2717
|
+
DIRECT_MESSAGE = "DIRECT_MESSAGE",
|
|
2718
|
+
GROUP_MESSAGE = "GROUP_MESSAGE",
|
|
2719
|
+
PRIVATE_CHANNEL = "PRIVATE_CHANNEL",
|
|
2720
|
+
PUBLIC_CHANNEL = "PUBLIC_CHANNEL"
|
|
2721
|
+
}
|
|
2722
|
+
/**
|
|
2723
|
+
* <p>Provides the configuration information to connect to Slack as your
|
|
2724
|
+
* data source.</p>
|
|
2725
|
+
*/
|
|
2726
|
+
export interface SlackConfiguration {
|
|
2727
|
+
/**
|
|
2728
|
+
* <p>The identifier of the team in the Slack workspace. For example,
|
|
2729
|
+
* <i>T0123456789</i>.</p>
|
|
2730
|
+
* <p>You can find your team ID in the URL of the main page of your Slack workspace.
|
|
2731
|
+
* When you log in to Slack via a browser, you are directed to the URL of the main
|
|
2732
|
+
* page. For example, <i>https://app.slack.com/client/<b>T0123456789</b>/...</i>.</p>
|
|
2733
|
+
*/
|
|
2734
|
+
TeamId: string | undefined;
|
|
2735
|
+
/**
|
|
2736
|
+
* <p>The Amazon Resource Name (ARN) of an Secrets Manager secret that contains
|
|
2737
|
+
* the key-value pairs required to connect to your Slack workspace team. The secret
|
|
2738
|
+
* must contain a JSON structure with the following keys:</p>
|
|
2739
|
+
* <ul>
|
|
2740
|
+
* <li>
|
|
2741
|
+
* <p>slackToken—The user or bot token created in Slack. For more
|
|
2742
|
+
* information on creating a token in Slack, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/data-source-slack.html#slack-authentication">Authentication
|
|
2743
|
+
* for a Slack data source</a>.</p>
|
|
2744
|
+
* </li>
|
|
2745
|
+
* </ul>
|
|
2746
|
+
*/
|
|
2747
|
+
SecretArn: string | undefined;
|
|
2748
|
+
/**
|
|
2749
|
+
* <p>Configuration information for an Amazon Virtual Private Cloud to connect to your Slack.
|
|
2750
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html">Configuring a VPC</a>.</p>
|
|
2751
|
+
*/
|
|
2752
|
+
VpcConfiguration?: DataSourceVpcConfiguration;
|
|
2753
|
+
/**
|
|
2754
|
+
* <p>Specify whether to index public channels, private channels, group messages, and
|
|
2755
|
+
* direct messages. You can specify one or more of these options.</p>
|
|
2756
|
+
*/
|
|
2757
|
+
SlackEntityList: (SlackEntity | string)[] | undefined;
|
|
2758
|
+
/**
|
|
2759
|
+
* <p>
|
|
2760
|
+
* <code>TRUE</code> to use the Slack change log to determine which documents
|
|
2761
|
+
* require updating in the index. Depending on the Slack change log's
|
|
2762
|
+
* size, it may take longer for Amazon Kendra to use the change log than to
|
|
2763
|
+
* scan all of your documents in Slack.</p>
|
|
2764
|
+
*/
|
|
2765
|
+
UseChangeLog?: boolean;
|
|
2766
|
+
/**
|
|
2767
|
+
* <p>
|
|
2768
|
+
* <code>TRUE</code> to index bot messages from your Slack workspace team.</p>
|
|
2769
|
+
*/
|
|
2770
|
+
CrawlBotMessage?: boolean;
|
|
2771
|
+
/**
|
|
2772
|
+
* <p>
|
|
2773
|
+
* <code>TRUE</code> to exclude archived messages to index from your Slack
|
|
2774
|
+
* workspace team.</p>
|
|
2775
|
+
*/
|
|
2776
|
+
ExcludeArchived?: boolean;
|
|
2777
|
+
/**
|
|
2778
|
+
* <p>The date to start crawling your data from your Slack workspace team. The date
|
|
2779
|
+
* must follow this format: <code>yyyy-mm-dd</code>.</p>
|
|
2780
|
+
*/
|
|
2781
|
+
SinceCrawlDate: string | undefined;
|
|
2782
|
+
/**
|
|
2783
|
+
* <p>The number of hours for change log to look back from when you last synchronized
|
|
2784
|
+
* your data. You can look back up to 7 days or 168 hours.</p>
|
|
2785
|
+
* <p>Change log updates your index only if new content was added since you
|
|
2786
|
+
* last synced your data. Updated or deleted content from before you last synced
|
|
2787
|
+
* does not get updated in your index. To capture updated or deleted content before you
|
|
2788
|
+
* last synced, set the <code>LookBackPeriod</code> to the number of hours you want
|
|
2789
|
+
* change log to look back.</p>
|
|
2790
|
+
*/
|
|
2791
|
+
LookBackPeriod?: number;
|
|
2792
|
+
/**
|
|
2793
|
+
* <p>The list of private channel names from your Slack workspace team. You use this if
|
|
2794
|
+
* you want to index specific private channels, not all private channels. You can also
|
|
2795
|
+
* use regular expression patterns to filter private channels.</p>
|
|
2796
|
+
*/
|
|
2797
|
+
PrivateChannelFilter?: string[];
|
|
2798
|
+
/**
|
|
2799
|
+
* <p>The list of public channel names to index from your Slack workspace team. You use
|
|
2800
|
+
* this if you want to index specific public channels, not all public channels. You can
|
|
2801
|
+
* also use regular expression patterns to filter public channels.</p>
|
|
2802
|
+
*/
|
|
2803
|
+
PublicChannelFilter?: string[];
|
|
2804
|
+
/**
|
|
2805
|
+
* <p>A list of regular expression patterns to include certain attached files in your Slack
|
|
2806
|
+
* workspace team. Files that match the patterns are included in the index. Files that
|
|
2807
|
+
* don't match the patterns are excluded from the index. If a file matches both
|
|
2808
|
+
* an inclusion and exclusion pattern, the exclusion pattern takes precedence and the
|
|
2809
|
+
* file isn't included in the index.</p>
|
|
2810
|
+
*/
|
|
2811
|
+
InclusionPatterns?: string[];
|
|
2812
|
+
/**
|
|
2813
|
+
* <p>A list of regular expression patterns to exclude certain attached files in your Slack
|
|
2814
|
+
* workspace team. Files that match the patterns are excluded from the index. Files that
|
|
2815
|
+
* don’t match the patterns are included in the index. If a file matches both
|
|
2816
|
+
* an inclusion and exclusion pattern, the exclusion pattern takes precedence and the file
|
|
2817
|
+
* isn't included in the index.</p>
|
|
2818
|
+
*/
|
|
2819
|
+
ExclusionPatterns?: string[];
|
|
2820
|
+
/**
|
|
2821
|
+
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that map Slack data
|
|
2822
|
+
* source attributes or field names to Amazon Kendra index field names. To create
|
|
2823
|
+
* custom fields, use the <code>UpdateIndex</code> API before you map to Slack fields.
|
|
2824
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping data source fields</a>.
|
|
2825
|
+
* The Slack data source field names must exist in your Slack custom metadata.</p>
|
|
2826
|
+
*/
|
|
2827
|
+
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
2828
|
+
}
|
|
2829
|
+
export declare namespace SlackConfiguration {
|
|
2830
|
+
/**
|
|
2831
|
+
* @internal
|
|
2832
|
+
*/
|
|
2833
|
+
const filterSensitiveLog: (obj: SlackConfiguration) => any;
|
|
2834
|
+
}
|
|
2696
2835
|
/**
|
|
2697
2836
|
* <p>Provides the configuration information for a web proxy to connect to
|
|
2698
2837
|
* website hosts.</p>
|
|
@@ -2734,7 +2873,7 @@ export declare enum WebCrawlerMode {
|
|
|
2734
2873
|
SUBDOMAINS = "SUBDOMAINS"
|
|
2735
2874
|
}
|
|
2736
2875
|
/**
|
|
2737
|
-
* <p>Provides the configuration information
|
|
2876
|
+
* <p>Provides the configuration information for the seed or starting point URLs to crawl.</p>
|
|
2738
2877
|
* <p>
|
|
2739
2878
|
* <i>When selecting websites to index, you must adhere to
|
|
2740
2879
|
* the <a href="https://aws.amazon.com/aup/">Amazon Acceptable Use Policy</a>
|
|
@@ -2782,7 +2921,7 @@ export declare namespace SeedUrlConfiguration {
|
|
|
2782
2921
|
const filterSensitiveLog: (obj: SeedUrlConfiguration) => any;
|
|
2783
2922
|
}
|
|
2784
2923
|
/**
|
|
2785
|
-
* <p>Provides the configuration information
|
|
2924
|
+
* <p>Provides the configuration information for the sitemap URLs to crawl.</p>
|
|
2786
2925
|
* <p>
|
|
2787
2926
|
* <i>When selecting websites to index, you must adhere to
|
|
2788
2927
|
* the <a href="https://aws.amazon.com/aup/">Amazon Acceptable Use Policy</a>
|
|
@@ -2820,7 +2959,7 @@ export declare namespace SiteMapsConfiguration {
|
|
|
2820
2959
|
*/
|
|
2821
2960
|
export interface Urls {
|
|
2822
2961
|
/**
|
|
2823
|
-
* <p>
|
|
2962
|
+
* <p>Configuration of the seed or starting point URLs of the websites
|
|
2824
2963
|
* you want to crawl.</p>
|
|
2825
2964
|
* <p>You can choose to crawl only the website host names, or the website host names
|
|
2826
2965
|
* with subdomains, or the website host names with subdomains and other domains
|
|
@@ -2829,7 +2968,7 @@ export interface Urls {
|
|
|
2829
2968
|
*/
|
|
2830
2969
|
SeedUrlConfiguration?: SeedUrlConfiguration;
|
|
2831
2970
|
/**
|
|
2832
|
-
* <p>
|
|
2971
|
+
* <p>Configuration of the sitemap URLs of the websites you want to crawl.</p>
|
|
2833
2972
|
* <p>Only URLs belonging to the same website host names are crawled. You can list up to
|
|
2834
2973
|
* three sitemap URLs.</p>
|
|
2835
2974
|
*/
|
|
@@ -2894,19 +3033,23 @@ export interface WebCrawlerConfiguration {
|
|
|
2894
3033
|
*/
|
|
2895
3034
|
MaxUrlsPerMinuteCrawlRate?: number;
|
|
2896
3035
|
/**
|
|
2897
|
-
* <p>
|
|
2898
|
-
*
|
|
2899
|
-
*
|
|
3036
|
+
* <p>A list of regular expression patterns to include certain URLs to crawl. URLs
|
|
3037
|
+
* that match the patterns are included in the index. URLs that
|
|
3038
|
+
* don't match the patterns are excluded from the index. If a URL matches both
|
|
3039
|
+
* an inclusion and exclusion pattern, the exclusion pattern takes precedence and the
|
|
3040
|
+
* URL file isn't included in the index.</p>
|
|
2900
3041
|
*/
|
|
2901
3042
|
UrlInclusionPatterns?: string[];
|
|
2902
3043
|
/**
|
|
2903
|
-
* <p>
|
|
2904
|
-
*
|
|
2905
|
-
*
|
|
3044
|
+
* <p>A list of regular expression patterns to exclude certain URLs to crawl. URLs
|
|
3045
|
+
* that match the patterns are excluded from the index. URLs that
|
|
3046
|
+
* don't match the patterns are included in the index. If a URL matches both
|
|
3047
|
+
* an inclusion and exclusion pattern, the exclusion pattern takes precedence and the
|
|
3048
|
+
* URL file isn't included in the index.</p>
|
|
2906
3049
|
*/
|
|
2907
3050
|
UrlExclusionPatterns?: string[];
|
|
2908
3051
|
/**
|
|
2909
|
-
* <p>
|
|
3052
|
+
* <p>Configuration information required to connect to your internal
|
|
2910
3053
|
* websites via a web proxy.</p>
|
|
2911
3054
|
* <p>You must provide the website host name and port number. For example, the
|
|
2912
3055
|
* host name of https://a.example.com/page1.html is "a.example.com" and the
|
|
@@ -2917,7 +3060,7 @@ export interface WebCrawlerConfiguration {
|
|
|
2917
3060
|
*/
|
|
2918
3061
|
ProxyConfiguration?: ProxyConfiguration;
|
|
2919
3062
|
/**
|
|
2920
|
-
* <p>
|
|
3063
|
+
* <p>Configuration information required to connect to websites using
|
|
2921
3064
|
* authentication.</p>
|
|
2922
3065
|
* <p>You can connect to websites using basic authentication of user name and password.</p>
|
|
2923
3066
|
* <p>You must provide the website host name and port number. For example, the host name
|
|
@@ -2962,41 +3105,38 @@ export interface WorkDocsConfiguration {
|
|
|
2962
3105
|
CrawlComments?: boolean;
|
|
2963
3106
|
/**
|
|
2964
3107
|
* <p>
|
|
2965
|
-
* <code>TRUE</code> to use the change
|
|
2966
|
-
* index
|
|
2967
|
-
*
|
|
2968
|
-
*
|
|
2969
|
-
* use the change logs to update your documents in your index for
|
|
2970
|
-
* future syncs.</p>
|
|
2971
|
-
* <p>The default is set to <code>FALSE</code>.</p>
|
|
3108
|
+
* <code>TRUE</code> to use the Amazon WorkDocs change log to determine
|
|
3109
|
+
* which documents require updating in the index. Depending on the change log's
|
|
3110
|
+
* size, it may take longer for Amazon Kendra to use the change log than to
|
|
3111
|
+
* scan all of your documents in Amazon WorkDocs.</p>
|
|
2972
3112
|
*/
|
|
2973
3113
|
UseChangeLog?: boolean;
|
|
2974
3114
|
/**
|
|
2975
3115
|
* <p>A list of regular expression patterns to include certain files
|
|
2976
3116
|
* in your Amazon WorkDocs site repository. Files that match the patterns
|
|
2977
3117
|
* are included in the index. Files that don't match the patterns are
|
|
2978
|
-
* excluded from the index. If a file matches both an inclusion
|
|
2979
|
-
*
|
|
2980
|
-
*
|
|
3118
|
+
* excluded from the index. If a file matches both an inclusion and exclusion
|
|
3119
|
+
* pattern, the exclusion pattern takes precedence and the file isn't included
|
|
3120
|
+
* in the index.</p>
|
|
2981
3121
|
*/
|
|
2982
3122
|
InclusionPatterns?: string[];
|
|
2983
3123
|
/**
|
|
2984
3124
|
* <p>A list of regular expression patterns to exclude certain files
|
|
2985
3125
|
* in your Amazon WorkDocs site repository. Files that match the patterns
|
|
2986
3126
|
* are excluded from the index. Files that don’t match the patterns
|
|
2987
|
-
* are included in the index. If a file matches both an inclusion
|
|
2988
|
-
* pattern
|
|
2989
|
-
*
|
|
3127
|
+
* are included in the index. If a file matches both an inclusion and exclusion
|
|
3128
|
+
* pattern, the exclusion pattern takes precedence and the file isn't included
|
|
3129
|
+
* in the index.</p>
|
|
2990
3130
|
*/
|
|
2991
3131
|
ExclusionPatterns?: string[];
|
|
2992
3132
|
/**
|
|
2993
|
-
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that
|
|
2994
|
-
* Amazon WorkDocs
|
|
2995
|
-
* create
|
|
2996
|
-
* you map to Amazon WorkDocs fields.
|
|
2997
|
-
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping
|
|
2998
|
-
*
|
|
2999
|
-
*
|
|
3133
|
+
* <p>A list of <code>DataSourceToIndexFieldMapping</code> objects that
|
|
3134
|
+
* map Amazon WorkDocs data source attributes or field names to Amazon Kendra
|
|
3135
|
+
* index field names. To create custom fields, use the
|
|
3136
|
+
* <code>UpdateIndex</code> API before you map to Amazon WorkDocs fields.
|
|
3137
|
+
* For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html">Mapping
|
|
3138
|
+
* data source fields</a>. The Amazon WorkDocs data source field names
|
|
3139
|
+
* must exist in your Amazon WorkDocs custom metadata.</p>
|
|
3000
3140
|
*/
|
|
3001
3141
|
FieldMappings?: DataSourceToIndexFieldMapping[];
|
|
3002
3142
|
}
|
|
@@ -3007,47 +3147,47 @@ export declare namespace WorkDocsConfiguration {
|
|
|
3007
3147
|
const filterSensitiveLog: (obj: WorkDocsConfiguration) => any;
|
|
3008
3148
|
}
|
|
3009
3149
|
/**
|
|
3010
|
-
* <p>
|
|
3150
|
+
* <p>Provides the configuration information for an Amazon Kendra data source.</p>
|
|
3011
3151
|
*/
|
|
3012
3152
|
export interface DataSourceConfiguration {
|
|
3013
3153
|
/**
|
|
3014
|
-
* <p>Provides information to
|
|
3015
|
-
*
|
|
3154
|
+
* <p>Provides the configuration information to connect to an Amazon S3
|
|
3155
|
+
* bucket as your data source.</p>
|
|
3016
3156
|
*/
|
|
3017
3157
|
S3Configuration?: S3DataSourceConfiguration;
|
|
3018
3158
|
/**
|
|
3019
|
-
* <p>Provides information
|
|
3020
|
-
*
|
|
3159
|
+
* <p>Provides the configuration information to connect to Microsoft SharePoint
|
|
3160
|
+
* as your data source.</p>
|
|
3021
3161
|
*/
|
|
3022
3162
|
SharePointConfiguration?: SharePointConfiguration;
|
|
3023
3163
|
/**
|
|
3024
|
-
* <p>Provides information
|
|
3025
|
-
*
|
|
3164
|
+
* <p>Provides the configuration information to connect to a database as
|
|
3165
|
+
* your data source.</p>
|
|
3026
3166
|
*/
|
|
3027
3167
|
DatabaseConfiguration?: DatabaseConfiguration;
|
|
3028
3168
|
/**
|
|
3029
|
-
* <p>Provides configuration information
|
|
3030
|
-
*
|
|
3169
|
+
* <p>Provides the configuration information to connect to
|
|
3170
|
+
* Salesforce as your data source.</p>
|
|
3031
3171
|
*/
|
|
3032
3172
|
SalesforceConfiguration?: SalesforceConfiguration;
|
|
3033
3173
|
/**
|
|
3034
|
-
* <p>Provides configuration
|
|
3035
|
-
* OneDrive.</p>
|
|
3174
|
+
* <p>Provides the configuration information to connect to Microsoft
|
|
3175
|
+
* OneDrive as your data source.</p>
|
|
3036
3176
|
*/
|
|
3037
3177
|
OneDriveConfiguration?: OneDriveConfiguration;
|
|
3038
3178
|
/**
|
|
3039
|
-
* <p>Provides configuration
|
|
3040
|
-
*
|
|
3179
|
+
* <p>Provides the configuration information to connect to ServiceNow
|
|
3180
|
+
* as your data source.</p>
|
|
3041
3181
|
*/
|
|
3042
3182
|
ServiceNowConfiguration?: ServiceNowConfiguration;
|
|
3043
3183
|
/**
|
|
3044
|
-
* <p>Provides configuration information
|
|
3045
|
-
* data source.</p>
|
|
3184
|
+
* <p>Provides the configuration information to connect to Confluence
|
|
3185
|
+
* as your data source.</p>
|
|
3046
3186
|
*/
|
|
3047
3187
|
ConfluenceConfiguration?: ConfluenceConfiguration;
|
|
3048
3188
|
/**
|
|
3049
|
-
* <p>Provides configuration
|
|
3050
|
-
* Drive
|
|
3189
|
+
* <p>Provides the configuration information to connect to Google
|
|
3190
|
+
* Drive as your data source.</p>
|
|
3051
3191
|
*/
|
|
3052
3192
|
GoogleDriveConfiguration?: GoogleDriveConfiguration;
|
|
3053
3193
|
/**
|
|
@@ -3065,6 +3205,11 @@ export interface DataSourceConfiguration {
|
|
|
3065
3205
|
* your data source.</p>
|
|
3066
3206
|
*/
|
|
3067
3207
|
FsxConfiguration?: FsxConfiguration;
|
|
3208
|
+
/**
|
|
3209
|
+
* <p>Provides the configuration information to connect to Slack as your
|
|
3210
|
+
* data source.</p>
|
|
3211
|
+
*/
|
|
3212
|
+
SlackConfiguration?: SlackConfiguration;
|
|
3068
3213
|
}
|
|
3069
3214
|
export declare namespace DataSourceConfiguration {
|
|
3070
3215
|
/**
|
|
@@ -3106,6 +3251,7 @@ export declare enum DataSourceType {
|
|
|
3106
3251
|
SALESFORCE = "SALESFORCE",
|
|
3107
3252
|
SERVICENOW = "SERVICENOW",
|
|
3108
3253
|
SHAREPOINT = "SHAREPOINT",
|
|
3254
|
+
SLACK = "SLACK",
|
|
3109
3255
|
WEBCRAWLER = "WEBCRAWLER",
|
|
3110
3256
|
WORKDOCS = "WORKDOCS"
|
|
3111
3257
|
}
|
|
@@ -3125,7 +3271,7 @@ export interface CreateDataSourceRequest {
|
|
|
3125
3271
|
*/
|
|
3126
3272
|
Type: DataSourceType | string | undefined;
|
|
3127
3273
|
/**
|
|
3128
|
-
* <p>
|
|
3274
|
+
* <p>Configuration information that is required to access the data source
|
|
3129
3275
|
* repository.</p>
|
|
3130
3276
|
* <p>You can't specify the <code>Configuration</code> parameter when the
|
|
3131
3277
|
* <code>Type</code> parameter is set to <code>CUSTOM</code>. If you do,
|
|
@@ -3209,7 +3355,7 @@ export declare namespace CreateDataSourceResponse {
|
|
|
3209
3355
|
const filterSensitiveLog: (obj: CreateDataSourceResponse) => any;
|
|
3210
3356
|
}
|
|
3211
3357
|
/**
|
|
3212
|
-
* <p>
|
|
3358
|
+
* <p>Provides the configuration information for your content sources, such as data sources,
|
|
3213
3359
|
* FAQs, and content indexed directly via <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html">BatchPutDocument</a>.</p>
|
|
3214
3360
|
*/
|
|
3215
3361
|
export interface ContentSourceConfiguration {
|
|
@@ -3235,7 +3381,7 @@ export declare namespace ContentSourceConfiguration {
|
|
|
3235
3381
|
const filterSensitiveLog: (obj: ContentSourceConfiguration) => any;
|
|
3236
3382
|
}
|
|
3237
3383
|
/**
|
|
3238
|
-
* <p>
|
|
3384
|
+
* <p>Provides the configuration information for the identifiers of your users.</p>
|
|
3239
3385
|
*/
|
|
3240
3386
|
export interface UserIdentityConfiguration {
|
|
3241
3387
|
/**
|
|
@@ -3256,7 +3402,7 @@ export declare namespace UserIdentityConfiguration {
|
|
|
3256
3402
|
const filterSensitiveLog: (obj: UserIdentityConfiguration) => any;
|
|
3257
3403
|
}
|
|
3258
3404
|
/**
|
|
3259
|
-
* <p>
|
|
3405
|
+
* <p>Provides the configuration information for your Amazon Kendra experience. This includes
|
|
3260
3406
|
* the data source IDs and/or FAQ IDs, and user or group information to grant access
|
|
3261
3407
|
* to your Amazon Kendra experience.</p>
|
|
3262
3408
|
*/
|
|
@@ -3296,7 +3442,7 @@ export interface CreateExperienceRequest {
|
|
|
3296
3442
|
*/
|
|
3297
3443
|
RoleArn?: string;
|
|
3298
3444
|
/**
|
|
3299
|
-
* <p>
|
|
3445
|
+
* <p>Configuration information for your Amazon Kendra experience. This includes
|
|
3300
3446
|
* <code>ContentSourceConfiguration</code>, which specifies the data source IDs
|
|
3301
3447
|
* and/or FAQ IDs, and <code>UserIdentityConfiguration</code>, which specifies the
|
|
3302
3448
|
* user or group information to grant access to your Amazon Kendra experience.</p>
|
|
@@ -3472,7 +3618,7 @@ export declare namespace UserGroupResolutionConfiguration {
|
|
|
3472
3618
|
const filterSensitiveLog: (obj: UserGroupResolutionConfiguration) => any;
|
|
3473
3619
|
}
|
|
3474
3620
|
/**
|
|
3475
|
-
* <p>
|
|
3621
|
+
* <p>Provides the configuration information for the JSON token type.</p>
|
|
3476
3622
|
*/
|
|
3477
3623
|
export interface JsonTokenTypeConfiguration {
|
|
3478
3624
|
/**
|
|
@@ -3495,7 +3641,7 @@ export declare enum KeyLocation {
|
|
|
3495
3641
|
URL = "URL"
|
|
3496
3642
|
}
|
|
3497
3643
|
/**
|
|
3498
|
-
* <p>
|
|
3644
|
+
* <p>Provides the configuration information for the JWT token type.</p>
|
|
3499
3645
|
*/
|
|
3500
3646
|
export interface JwtTokenTypeConfiguration {
|
|
3501
3647
|
/**
|
|
@@ -3534,7 +3680,7 @@ export declare namespace JwtTokenTypeConfiguration {
|
|
|
3534
3680
|
const filterSensitiveLog: (obj: JwtTokenTypeConfiguration) => any;
|
|
3535
3681
|
}
|
|
3536
3682
|
/**
|
|
3537
|
-
* <p>Provides configuration information for a token
|
|
3683
|
+
* <p>Provides the configuration information for a token.</p>
|
|
3538
3684
|
*/
|
|
3539
3685
|
export interface UserTokenConfiguration {
|
|
3540
3686
|
/**
|
|
@@ -3962,8 +4108,7 @@ export interface DescribeDataSourceResponse {
|
|
|
3962
4108
|
*/
|
|
3963
4109
|
Type?: DataSourceType | string;
|
|
3964
4110
|
/**
|
|
3965
|
-
* <p>
|
|
3966
|
-
* the data source is configured. The specific information in the description
|
|
4111
|
+
* <p>Describes how the data source is configured. The specific information in the description
|
|
3967
4112
|
* depends on the data source provider.</p>
|
|
3968
4113
|
*/
|
|
3969
4114
|
Configuration?: DataSourceConfiguration;
|
|
@@ -4046,7 +4191,7 @@ export declare enum EndpointType {
|
|
|
4046
4191
|
HOME = "HOME"
|
|
4047
4192
|
}
|
|
4048
4193
|
/**
|
|
4049
|
-
* <p>Provides the configuration information
|
|
4194
|
+
* <p>Provides the configuration information for the endpoint for your Amazon Kendra
|
|
4050
4195
|
* experience.</p>
|
|
4051
4196
|
*/
|
|
4052
4197
|
export interface ExperienceEndpoint {
|
|
@@ -5990,7 +6135,7 @@ export declare namespace ListIndicesRequest {
|
|
|
5990
6135
|
const filterSensitiveLog: (obj: ListIndicesRequest) => any;
|
|
5991
6136
|
}
|
|
5992
6137
|
/**
|
|
5993
|
-
* <p>A summary of information
|
|
6138
|
+
* <p>A summary of information on the configuration of an index.</p>
|
|
5994
6139
|
*/
|
|
5995
6140
|
export interface IndexConfigurationSummary {
|
|
5996
6141
|
/**
|
|
@@ -6032,7 +6177,7 @@ export declare namespace IndexConfigurationSummary {
|
|
|
6032
6177
|
}
|
|
6033
6178
|
export interface ListIndicesResponse {
|
|
6034
6179
|
/**
|
|
6035
|
-
* <p>An array of summary information
|
|
6180
|
+
* <p>An array of summary information on the configuration of one or more indexes.</p>
|
|
6036
6181
|
*/
|
|
6037
6182
|
IndexConfigurationSummaryItems?: IndexConfigurationSummary[];
|
|
6038
6183
|
/**
|
|
@@ -6493,9 +6638,29 @@ export declare namespace SortingConfiguration {
|
|
|
6493
6638
|
const filterSensitiveLog: (obj: SortingConfiguration) => any;
|
|
6494
6639
|
}
|
|
6495
6640
|
/**
|
|
6496
|
-
* <p>
|
|
6497
|
-
*
|
|
6498
|
-
*
|
|
6641
|
+
* <p>Provides the configuration information for suggested query spell corrections.</p>
|
|
6642
|
+
* <p>Suggested spell corrections are based on words that appear in your indexed documents
|
|
6643
|
+
* and how closely a corrected word matches a misspelled word.</p>
|
|
6644
|
+
* <p>This feature is designed with certain defaults or limits. For information on the
|
|
6645
|
+
* current limits and how to request more support for some limits, see the
|
|
6646
|
+
* <a href="https://docs.aws.amazon.com/kendra/latest/dg/query-spell-check.html">Spell
|
|
6647
|
+
* Checker documentation</a>.</p>
|
|
6648
|
+
*/
|
|
6649
|
+
export interface SpellCorrectionConfiguration {
|
|
6650
|
+
/**
|
|
6651
|
+
* <p>
|
|
6652
|
+
* <code>TRUE</code> to suggest spell corrections for queries.</p>
|
|
6653
|
+
*/
|
|
6654
|
+
IncludeQuerySpellCheckSuggestions: boolean | undefined;
|
|
6655
|
+
}
|
|
6656
|
+
export declare namespace SpellCorrectionConfiguration {
|
|
6657
|
+
/**
|
|
6658
|
+
* @internal
|
|
6659
|
+
*/
|
|
6660
|
+
const filterSensitiveLog: (obj: SpellCorrectionConfiguration) => any;
|
|
6661
|
+
}
|
|
6662
|
+
/**
|
|
6663
|
+
* <p>Data source information for user context filtering.</p>
|
|
6499
6664
|
*/
|
|
6500
6665
|
export interface DataSourceGroup {
|
|
6501
6666
|
/**
|
|
@@ -6706,6 +6871,54 @@ export declare namespace QueryResultItem {
|
|
|
6706
6871
|
*/
|
|
6707
6872
|
const filterSensitiveLog: (obj: QueryResultItem) => any;
|
|
6708
6873
|
}
|
|
6874
|
+
/**
|
|
6875
|
+
* <p>A corrected misspelled word in a query.</p>
|
|
6876
|
+
*/
|
|
6877
|
+
export interface Correction {
|
|
6878
|
+
/**
|
|
6879
|
+
* <p>The zero-based location in the response string or text where
|
|
6880
|
+
* the corrected word starts.</p>
|
|
6881
|
+
*/
|
|
6882
|
+
BeginOffset?: number;
|
|
6883
|
+
/**
|
|
6884
|
+
* <p>The zero-based location in the response string or text where
|
|
6885
|
+
* the corrected word ends.</p>
|
|
6886
|
+
*/
|
|
6887
|
+
EndOffset?: number;
|
|
6888
|
+
/**
|
|
6889
|
+
* <p>The string or text of a misspelled word in a query.</p>
|
|
6890
|
+
*/
|
|
6891
|
+
Term?: string;
|
|
6892
|
+
/**
|
|
6893
|
+
* <p>The string or text of a corrected misspelled word in a query.</p>
|
|
6894
|
+
*/
|
|
6895
|
+
CorrectedTerm?: string;
|
|
6896
|
+
}
|
|
6897
|
+
export declare namespace Correction {
|
|
6898
|
+
/**
|
|
6899
|
+
* @internal
|
|
6900
|
+
*/
|
|
6901
|
+
const filterSensitiveLog: (obj: Correction) => any;
|
|
6902
|
+
}
|
|
6903
|
+
/**
|
|
6904
|
+
* <p>A query with suggested spell corrections. </p>
|
|
6905
|
+
*/
|
|
6906
|
+
export interface SpellCorrectedQuery {
|
|
6907
|
+
/**
|
|
6908
|
+
* <p>The query with the suggested spell corrections.</p>
|
|
6909
|
+
*/
|
|
6910
|
+
SuggestedQueryText?: string;
|
|
6911
|
+
/**
|
|
6912
|
+
* <p>The corrected misspelled word or words in a query.</p>
|
|
6913
|
+
*/
|
|
6914
|
+
Corrections?: Correction[];
|
|
6915
|
+
}
|
|
6916
|
+
export declare namespace SpellCorrectedQuery {
|
|
6917
|
+
/**
|
|
6918
|
+
* @internal
|
|
6919
|
+
*/
|
|
6920
|
+
const filterSensitiveLog: (obj: SpellCorrectedQuery) => any;
|
|
6921
|
+
}
|
|
6709
6922
|
export declare enum WarningCode {
|
|
6710
6923
|
QUERY_LANGUAGE_INVALID_SYNTAX = "QUERY_LANGUAGE_INVALID_SYNTAX"
|
|
6711
6924
|
}
|
|
@@ -6758,6 +6971,10 @@ export interface QueryResult {
|
|
|
6758
6971
|
* with advanced query syntax</a>.</p>
|
|
6759
6972
|
*/
|
|
6760
6973
|
Warnings?: Warning[];
|
|
6974
|
+
/**
|
|
6975
|
+
* <p>A list of information related to suggested spell corrections for a query.</p>
|
|
6976
|
+
*/
|
|
6977
|
+
SpellCorrectedQueries?: SpellCorrectedQuery[];
|
|
6761
6978
|
}
|
|
6762
6979
|
export declare namespace QueryResult {
|
|
6763
6980
|
/**
|
|
@@ -6969,7 +7186,7 @@ export interface UpdateDataSourceRequest {
|
|
|
6969
7186
|
*/
|
|
6970
7187
|
IndexId: string | undefined;
|
|
6971
7188
|
/**
|
|
6972
|
-
* <p>Configuration information for an Amazon Kendra data source.</p>
|
|
7189
|
+
* <p>Configuration information for an Amazon Kendra data source you want to update.</p>
|
|
6973
7190
|
*/
|
|
6974
7191
|
Configuration?: DataSourceConfiguration;
|
|
6975
7192
|
/**
|
|
@@ -7030,8 +7247,7 @@ export interface UpdateExperienceRequest {
|
|
|
7030
7247
|
*/
|
|
7031
7248
|
RoleArn?: string;
|
|
7032
7249
|
/**
|
|
7033
|
-
* <p>
|
|
7034
|
-
* field name that contains the identifiers of your users, such as their emails.</p>
|
|
7250
|
+
* <p>Configuration information for your Amazon Kendra you want to update.</p>
|
|
7035
7251
|
*/
|
|
7036
7252
|
Configuration?: ExperienceConfiguration;
|
|
7037
7253
|
/**
|
|
@@ -7064,7 +7280,7 @@ export interface UpdateIndexRequest {
|
|
|
7064
7280
|
*/
|
|
7065
7281
|
Description?: string;
|
|
7066
7282
|
/**
|
|
7067
|
-
* <p>The document metadata to update
|
|
7283
|
+
* <p>The document metadata you want to update.</p>
|
|
7068
7284
|
*/
|
|
7069
7285
|
DocumentMetadataConfigurationUpdates?: DocumentMetadataConfiguration[];
|
|
7070
7286
|
/**
|
|
@@ -7408,6 +7624,10 @@ export interface QueryRequest {
|
|
|
7408
7624
|
* email address, as the <code>VisitorId</code>.</p>
|
|
7409
7625
|
*/
|
|
7410
7626
|
VisitorId?: string;
|
|
7627
|
+
/**
|
|
7628
|
+
* <p>Enables suggested spell corrections for queries.</p>
|
|
7629
|
+
*/
|
|
7630
|
+
SpellCorrectionConfiguration?: SpellCorrectionConfiguration;
|
|
7411
7631
|
}
|
|
7412
7632
|
export declare namespace QueryRequest {
|
|
7413
7633
|
/**
|