aws-sdk-kendra 1.44.0 → 1.47.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kendra/client.rb +105 -15
- data/lib/aws-sdk-kendra/client_api.rb +56 -0
- data/lib/aws-sdk-kendra/types.rb +779 -312
- data/lib/aws-sdk-kendra.rb +1 -1
- metadata +4 -4
data/lib/aws-sdk-kendra/types.rb
CHANGED
@@ -1238,7 +1238,7 @@ module Aws::Kendra
|
|
1238
1238
|
include Aws::Structure
|
1239
1239
|
end
|
1240
1240
|
|
1241
|
-
#
|
1241
|
+
# Configuration of attachment settings for the Confluence data source.
|
1242
1242
|
# Attachment settings are optional, if you don't specify settings
|
1243
1243
|
# attachments, Amazon Kendra won't index them.
|
1244
1244
|
#
|
@@ -1262,13 +1262,19 @@ module Aws::Kendra
|
|
1262
1262
|
# @return [Boolean]
|
1263
1263
|
#
|
1264
1264
|
# @!attribute [rw] attachment_field_mappings
|
1265
|
-
#
|
1266
|
-
#
|
1267
|
-
#
|
1268
|
-
#
|
1265
|
+
# Maps attributes or field names of Confluence attachments to Amazon
|
1266
|
+
# Kendra index field names. To create custom fields, use the
|
1267
|
+
# `UpdateIndex` API before you map to Confluence fields. For more
|
1268
|
+
# information, see [Mapping data source fields][1]. The Confluence
|
1269
|
+
# data source field names must exist in your Confluence custom
|
1270
|
+
# metadata.
|
1269
1271
|
#
|
1270
1272
|
# If you specify the `AttachentFieldMappings` parameter, you must
|
1271
1273
|
# specify at least one field mapping.
|
1274
|
+
#
|
1275
|
+
#
|
1276
|
+
#
|
1277
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
1272
1278
|
# @return [Array<Types::ConfluenceAttachmentToIndexFieldMapping>]
|
1273
1279
|
#
|
1274
1280
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConfluenceAttachmentConfiguration AWS API Documentation
|
@@ -1280,10 +1286,15 @@ module Aws::Kendra
|
|
1280
1286
|
include Aws::Structure
|
1281
1287
|
end
|
1282
1288
|
|
1283
|
-
#
|
1284
|
-
#
|
1289
|
+
# Maps attributes or field names of Confluence attachments to Amazon
|
1290
|
+
# Kendra index field names. To create custom fields, use the
|
1291
|
+
# `UpdateIndex` API before you map to Confluence fields. For more
|
1292
|
+
# information, see [Mapping data source fields][1]. The Confuence data
|
1293
|
+
# source field names must exist in your Confluence custom metadata.
|
1294
|
+
#
|
1285
1295
|
#
|
1286
|
-
#
|
1296
|
+
#
|
1297
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
1287
1298
|
#
|
1288
1299
|
# @note When making an API call, you may pass ConfluenceAttachmentToIndexFieldMapping
|
1289
1300
|
# data as a hash:
|
@@ -1322,8 +1333,8 @@ module Aws::Kendra
|
|
1322
1333
|
include Aws::Structure
|
1323
1334
|
end
|
1324
1335
|
|
1325
|
-
#
|
1326
|
-
# always indexed unless filtered from the index by the
|
1336
|
+
# Configuration of blog settings for the Confluence data source. Blogs
|
1337
|
+
# are always indexed unless filtered from the index by the
|
1327
1338
|
# `ExclusionPatterns` or `InclusionPatterns` fields in the
|
1328
1339
|
# `ConfluenceConfiguration` object.
|
1329
1340
|
#
|
@@ -1341,12 +1352,18 @@ module Aws::Kendra
|
|
1341
1352
|
# }
|
1342
1353
|
#
|
1343
1354
|
# @!attribute [rw] blog_field_mappings
|
1344
|
-
#
|
1345
|
-
#
|
1346
|
-
#
|
1355
|
+
# Maps attributes or field names of Confluence blogs to Amazon Kendra
|
1356
|
+
# index field names. To create custom fields, use the `UpdateIndex`
|
1357
|
+
# API before you map to Confluence fields. For more information, see
|
1358
|
+
# [Mapping data source fields][1]. The Confluence data source field
|
1359
|
+
# names must exist in your Confluence custom metadata.
|
1347
1360
|
#
|
1348
1361
|
# If you specify the `BlogFieldMappings` parameter, you must specify
|
1349
1362
|
# at least one field mapping.
|
1363
|
+
#
|
1364
|
+
#
|
1365
|
+
#
|
1366
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
1350
1367
|
# @return [Array<Types::ConfluenceBlogToIndexFieldMapping>]
|
1351
1368
|
#
|
1352
1369
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConfluenceBlogConfiguration AWS API Documentation
|
@@ -1357,10 +1374,15 @@ module Aws::Kendra
|
|
1357
1374
|
include Aws::Structure
|
1358
1375
|
end
|
1359
1376
|
|
1360
|
-
#
|
1361
|
-
#
|
1377
|
+
# Maps attributes or field names of Confluence blog to Amazon Kendra
|
1378
|
+
# index field names. To create custom fields, use the `UpdateIndex` API
|
1379
|
+
# before you map to Confluence fields. For more information, see
|
1380
|
+
# [Mapping data source fields][1]. The Confluence data source field
|
1381
|
+
# names must exist in your Confluence custom metadata.
|
1382
|
+
#
|
1383
|
+
#
|
1362
1384
|
#
|
1363
|
-
#
|
1385
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
1364
1386
|
#
|
1365
1387
|
# @note When making an API call, you may pass ConfluenceBlogToIndexFieldMapping
|
1366
1388
|
# data as a hash:
|
@@ -1397,8 +1419,8 @@ module Aws::Kendra
|
|
1397
1419
|
include Aws::Structure
|
1398
1420
|
end
|
1399
1421
|
|
1400
|
-
# Provides configuration information
|
1401
|
-
#
|
1422
|
+
# Provides the configuration information to connect to Confluence as
|
1423
|
+
# your data source.
|
1402
1424
|
#
|
1403
1425
|
# @note When making an API call, you may pass ConfluenceConfiguration
|
1404
1426
|
# data as a hash:
|
@@ -1458,20 +1480,20 @@ module Aws::Kendra
|
|
1458
1480
|
#
|
1459
1481
|
# @!attribute [rw] server_url
|
1460
1482
|
# The URL of your Confluence instance. Use the full URL of the server.
|
1461
|
-
# For example,
|
1462
|
-
# IP address, for example,
|
1483
|
+
# For example, *https://server.example.com:port/*. You can also use an
|
1484
|
+
# IP address, for example, *https://192.168.1.113/*.
|
1463
1485
|
# @return [String]
|
1464
1486
|
#
|
1465
1487
|
# @!attribute [rw] secret_arn
|
1466
1488
|
# The Amazon Resource Name (ARN) of an Secrets Manager secret that
|
1467
|
-
# contains the key
|
1489
|
+
# contains the key-value pairs required to connect to your Confluence
|
1468
1490
|
# server. The secret must contain a JSON structure with the following
|
1469
1491
|
# keys:
|
1470
1492
|
#
|
1471
|
-
# * username
|
1493
|
+
# * username—The user name or email address of a user with
|
1472
1494
|
# administrative privileges for the Confluence server.
|
1473
1495
|
#
|
1474
|
-
# * password
|
1496
|
+
# * password—The password associated with the user logging in to the
|
1475
1497
|
# Confluence server.
|
1476
1498
|
# @return [String]
|
1477
1499
|
#
|
@@ -1481,43 +1503,50 @@ module Aws::Kendra
|
|
1481
1503
|
# @return [String]
|
1482
1504
|
#
|
1483
1505
|
# @!attribute [rw] space_configuration
|
1484
|
-
#
|
1506
|
+
# Configuration information for indexing Confluence spaces.
|
1485
1507
|
# @return [Types::ConfluenceSpaceConfiguration]
|
1486
1508
|
#
|
1487
1509
|
# @!attribute [rw] page_configuration
|
1488
|
-
#
|
1510
|
+
# Configuration information for indexing Confluence pages.
|
1489
1511
|
# @return [Types::ConfluencePageConfiguration]
|
1490
1512
|
#
|
1491
1513
|
# @!attribute [rw] blog_configuration
|
1492
|
-
#
|
1514
|
+
# Configuration information for indexing Confluence blogs.
|
1493
1515
|
# @return [Types::ConfluenceBlogConfiguration]
|
1494
1516
|
#
|
1495
1517
|
# @!attribute [rw] attachment_configuration
|
1496
|
-
#
|
1497
|
-
#
|
1518
|
+
# Configuration information for indexing attachments to Confluence
|
1519
|
+
# blogs and pages.
|
1498
1520
|
# @return [Types::ConfluenceAttachmentConfiguration]
|
1499
1521
|
#
|
1500
1522
|
# @!attribute [rw] vpc_configuration
|
1501
|
-
#
|
1523
|
+
# Configuration information for an Amazon Virtual Private Cloud to
|
1524
|
+
# connect to your Confluence. For more information, see [Configuring a
|
1525
|
+
# VPC][1].
|
1526
|
+
#
|
1527
|
+
#
|
1528
|
+
#
|
1529
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
|
1502
1530
|
# @return [Types::DataSourceVpcConfiguration]
|
1503
1531
|
#
|
1504
1532
|
# @!attribute [rw] inclusion_patterns
|
1505
|
-
# A list of regular expression patterns
|
1506
|
-
#
|
1507
|
-
#
|
1508
|
-
#
|
1509
|
-
#
|
1510
|
-
# pattern
|
1533
|
+
# A list of regular expression patterns to include certain blog posts,
|
1534
|
+
# pages, spaces, or attachments in your Confluence. Content that
|
1535
|
+
# matches the patterns are included in the index. Content that
|
1536
|
+
# doesn't match the patterns is excluded from the index. If content
|
1537
|
+
# matches both an inclusion and exclusion pattern, the exclusion
|
1538
|
+
# pattern takes precedence and the content isn't included in the
|
1511
1539
|
# index.
|
1512
1540
|
# @return [Array<String>]
|
1513
1541
|
#
|
1514
1542
|
# @!attribute [rw] exclusion_patterns
|
1515
|
-
# A list of regular expression patterns
|
1516
|
-
#
|
1517
|
-
#
|
1518
|
-
#
|
1519
|
-
#
|
1520
|
-
#
|
1543
|
+
# >A list of regular expression patterns to exclude certain blog
|
1544
|
+
# posts, pages, spaces, or attachments in your Confluence. Content
|
1545
|
+
# that matches the patterns are excluded from the index. Content that
|
1546
|
+
# doesn't match the patterns is included in the index. If content
|
1547
|
+
# matches both an inclusion and exclusion pattern, the exclusion
|
1548
|
+
# pattern takes precedence and the content isn't included in the
|
1549
|
+
# index.
|
1521
1550
|
# @return [Array<String>]
|
1522
1551
|
#
|
1523
1552
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConfluenceConfiguration AWS API Documentation
|
@@ -1537,7 +1566,7 @@ module Aws::Kendra
|
|
1537
1566
|
include Aws::Structure
|
1538
1567
|
end
|
1539
1568
|
|
1540
|
-
#
|
1569
|
+
# Configuration of the page settings for the Confluence data source.
|
1541
1570
|
#
|
1542
1571
|
# @note When making an API call, you may pass ConfluencePageConfiguration
|
1543
1572
|
# data as a hash:
|
@@ -1553,12 +1582,19 @@ module Aws::Kendra
|
|
1553
1582
|
# }
|
1554
1583
|
#
|
1555
1584
|
# @!attribute [rw] page_field_mappings
|
1556
|
-
#
|
1557
|
-
#
|
1558
|
-
#
|
1585
|
+
# >Maps attributes or field names of Confluence pages to Amazon
|
1586
|
+
# Kendra index field names. To create custom fields, use the
|
1587
|
+
# `UpdateIndex` API before you map to Confluence fields. For more
|
1588
|
+
# information, see [Mapping data source fields][1]. The Confluence
|
1589
|
+
# data source field names must exist in your Confluence custom
|
1590
|
+
# metadata.
|
1559
1591
|
#
|
1560
1592
|
# If you specify the `PageFieldMappings` parameter, you must specify
|
1561
1593
|
# at least one field mapping.
|
1594
|
+
#
|
1595
|
+
#
|
1596
|
+
#
|
1597
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
1562
1598
|
# @return [Array<Types::ConfluencePageToIndexFieldMapping>]
|
1563
1599
|
#
|
1564
1600
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConfluencePageConfiguration AWS API Documentation
|
@@ -1569,10 +1605,15 @@ module Aws::Kendra
|
|
1569
1605
|
include Aws::Structure
|
1570
1606
|
end
|
1571
1607
|
|
1572
|
-
#
|
1573
|
-
#
|
1608
|
+
# >Maps attributes or field names of Confluence pages to Amazon
|
1609
|
+
# Kendra index field names. To create custom fields, use the
|
1610
|
+
# `UpdateIndex` API before you map to Confluence fields. For more
|
1611
|
+
# information, see [Mapping data source fields][1]. The Confluence data
|
1612
|
+
# source field names must exist in your Confluence custom metadata.
|
1613
|
+
#
|
1614
|
+
#
|
1574
1615
|
#
|
1575
|
-
#
|
1616
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
1576
1617
|
#
|
1577
1618
|
# @note When making an API call, you may pass ConfluencePageToIndexFieldMapping
|
1578
1619
|
# data as a hash:
|
@@ -1609,7 +1650,7 @@ module Aws::Kendra
|
|
1609
1650
|
include Aws::Structure
|
1610
1651
|
end
|
1611
1652
|
|
1612
|
-
#
|
1653
|
+
# Configuration information for indexing Confluence spaces.
|
1613
1654
|
#
|
1614
1655
|
# @note When making an API call, you may pass ConfluenceSpaceConfiguration
|
1615
1656
|
# data as a hash:
|
@@ -1661,12 +1702,18 @@ module Aws::Kendra
|
|
1661
1702
|
# @return [Array<String>]
|
1662
1703
|
#
|
1663
1704
|
# @!attribute [rw] space_field_mappings
|
1664
|
-
#
|
1665
|
-
#
|
1666
|
-
#
|
1705
|
+
# Maps attributes or field names of Confluence spaces to Amazon Kendra
|
1706
|
+
# index field names. To create custom fields, use the `UpdateIndex`
|
1707
|
+
# API before you map to Confluence fields. For more information, see
|
1708
|
+
# [Mapping data source fields][1]. The Confluence data source field
|
1709
|
+
# names must exist in your Confluence custom metadata.
|
1667
1710
|
#
|
1668
1711
|
# If you specify the `SpaceFieldMappings` parameter, you must specify
|
1669
1712
|
# at least one field mapping.
|
1713
|
+
#
|
1714
|
+
#
|
1715
|
+
#
|
1716
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
1670
1717
|
# @return [Array<Types::ConfluenceSpaceToIndexFieldMapping>]
|
1671
1718
|
#
|
1672
1719
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConfluenceSpaceConfiguration AWS API Documentation
|
@@ -1681,10 +1728,15 @@ module Aws::Kendra
|
|
1681
1728
|
include Aws::Structure
|
1682
1729
|
end
|
1683
1730
|
|
1684
|
-
#
|
1685
|
-
#
|
1731
|
+
# >Maps attributes or field names of Confluence spaces to Amazon
|
1732
|
+
# Kendra index field names. To create custom fields, use the
|
1733
|
+
# `UpdateIndex` API before you map to Confluence fields. For more
|
1734
|
+
# information, see [Mapping data source fields][1]. The Confluence data
|
1735
|
+
# source field names must exist in your Confluence custom metadata.
|
1736
|
+
#
|
1686
1737
|
#
|
1687
|
-
#
|
1738
|
+
#
|
1739
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
1688
1740
|
#
|
1689
1741
|
# @note When making an API call, you may pass ConfluenceSpaceToIndexFieldMapping
|
1690
1742
|
# data as a hash:
|
@@ -1721,7 +1773,8 @@ module Aws::Kendra
|
|
1721
1773
|
include Aws::Structure
|
1722
1774
|
end
|
1723
1775
|
|
1724
|
-
# Provides the information
|
1776
|
+
# Provides the configuration information that's required to connect to
|
1777
|
+
# a database.
|
1725
1778
|
#
|
1726
1779
|
# @note When making an API call, you may pass ConnectionConfiguration
|
1727
1780
|
# data as a hash:
|
@@ -1776,8 +1829,9 @@ module Aws::Kendra
|
|
1776
1829
|
include Aws::Structure
|
1777
1830
|
end
|
1778
1831
|
|
1779
|
-
#
|
1780
|
-
# sources, FAQs, and content indexed directly via
|
1832
|
+
# Provides the configuration information for your content sources, such
|
1833
|
+
# as data sources, FAQs, and content indexed directly via
|
1834
|
+
# [BatchPutDocument][1].
|
1781
1835
|
#
|
1782
1836
|
#
|
1783
1837
|
#
|
@@ -1817,13 +1871,44 @@ module Aws::Kendra
|
|
1817
1871
|
include Aws::Structure
|
1818
1872
|
end
|
1819
1873
|
|
1874
|
+
# A corrected misspelled word in a query.
|
1875
|
+
#
|
1876
|
+
# @!attribute [rw] begin_offset
|
1877
|
+
# The zero-based location in the response string or text where the
|
1878
|
+
# corrected word starts.
|
1879
|
+
# @return [Integer]
|
1880
|
+
#
|
1881
|
+
# @!attribute [rw] end_offset
|
1882
|
+
# The zero-based location in the response string or text where the
|
1883
|
+
# corrected word ends.
|
1884
|
+
# @return [Integer]
|
1885
|
+
#
|
1886
|
+
# @!attribute [rw] term
|
1887
|
+
# The string or text of a misspelled word in a query.
|
1888
|
+
# @return [String]
|
1889
|
+
#
|
1890
|
+
# @!attribute [rw] corrected_term
|
1891
|
+
# The string or text of a corrected misspelled word in a query.
|
1892
|
+
# @return [String]
|
1893
|
+
#
|
1894
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Correction AWS API Documentation
|
1895
|
+
#
|
1896
|
+
class Correction < Struct.new(
|
1897
|
+
:begin_offset,
|
1898
|
+
:end_offset,
|
1899
|
+
:term,
|
1900
|
+
:corrected_term)
|
1901
|
+
SENSITIVE = []
|
1902
|
+
include Aws::Structure
|
1903
|
+
end
|
1904
|
+
|
1820
1905
|
# @note When making an API call, you may pass CreateDataSourceRequest
|
1821
1906
|
# data as a hash:
|
1822
1907
|
#
|
1823
1908
|
# {
|
1824
1909
|
# name: "DataSourceName", # required
|
1825
1910
|
# index_id: "IndexId", # required
|
1826
|
-
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX
|
1911
|
+
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX, SLACK
|
1827
1912
|
# configuration: {
|
1828
1913
|
# s3_configuration: {
|
1829
1914
|
# bucket_name: "S3BucketName", # required
|
@@ -2153,6 +2238,31 @@ module Aws::Kendra
|
|
2153
2238
|
# },
|
2154
2239
|
# ],
|
2155
2240
|
# },
|
2241
|
+
# slack_configuration: {
|
2242
|
+
# team_id: "TeamId", # required
|
2243
|
+
# secret_arn: "SecretArn", # required
|
2244
|
+
# vpc_configuration: {
|
2245
|
+
# subnet_ids: ["SubnetId"], # required
|
2246
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
2247
|
+
# },
|
2248
|
+
# slack_entity_list: ["PUBLIC_CHANNEL"], # required, accepts PUBLIC_CHANNEL, PRIVATE_CHANNEL, GROUP_MESSAGE, DIRECT_MESSAGE
|
2249
|
+
# use_change_log: false,
|
2250
|
+
# crawl_bot_message: false,
|
2251
|
+
# exclude_archived: false,
|
2252
|
+
# since_crawl_date: "SinceCrawlDate", # required
|
2253
|
+
# look_back_period: 1,
|
2254
|
+
# private_channel_filter: ["String"],
|
2255
|
+
# public_channel_filter: ["String"],
|
2256
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2257
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2258
|
+
# field_mappings: [
|
2259
|
+
# {
|
2260
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2261
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2262
|
+
# index_field_name: "IndexFieldName", # required
|
2263
|
+
# },
|
2264
|
+
# ],
|
2265
|
+
# },
|
2156
2266
|
# },
|
2157
2267
|
# description: "Description",
|
2158
2268
|
# schedule: "ScanSchedule",
|
@@ -2238,8 +2348,8 @@ module Aws::Kendra
|
|
2238
2348
|
# @return [String]
|
2239
2349
|
#
|
2240
2350
|
# @!attribute [rw] configuration
|
2241
|
-
#
|
2242
|
-
#
|
2351
|
+
# Configuration information that is required to access the data source
|
2352
|
+
# repository.
|
2243
2353
|
#
|
2244
2354
|
# You can't specify the `Configuration` parameter when the `Type`
|
2245
2355
|
# parameter is set to `CUSTOM`. If you do, you receive a
|
@@ -2392,11 +2502,11 @@ module Aws::Kendra
|
|
2392
2502
|
# @return [String]
|
2393
2503
|
#
|
2394
2504
|
# @!attribute [rw] configuration
|
2395
|
-
#
|
2396
|
-
#
|
2397
|
-
#
|
2398
|
-
#
|
2399
|
-
#
|
2505
|
+
# Configuration information for your Amazon Kendra experience. This
|
2506
|
+
# includes `ContentSourceConfiguration`, which specifies the data
|
2507
|
+
# source IDs and/or FAQ IDs, and `UserIdentityConfiguration`, which
|
2508
|
+
# specifies the user or group information to grant access to your
|
2509
|
+
# Amazon Kendra experience.
|
2400
2510
|
# @return [Types::ExperienceConfiguration]
|
2401
2511
|
#
|
2402
2512
|
# @!attribute [rw] description
|
@@ -3022,7 +3132,8 @@ module Aws::Kendra
|
|
3022
3132
|
include Aws::Structure
|
3023
3133
|
end
|
3024
3134
|
|
3025
|
-
#
|
3135
|
+
# Provides the configuration information for an Amazon Kendra data
|
3136
|
+
# source.
|
3026
3137
|
#
|
3027
3138
|
# @note When making an API call, you may pass DataSourceConfiguration
|
3028
3139
|
# data as a hash:
|
@@ -3356,46 +3467,71 @@ module Aws::Kendra
|
|
3356
3467
|
# },
|
3357
3468
|
# ],
|
3358
3469
|
# },
|
3470
|
+
# slack_configuration: {
|
3471
|
+
# team_id: "TeamId", # required
|
3472
|
+
# secret_arn: "SecretArn", # required
|
3473
|
+
# vpc_configuration: {
|
3474
|
+
# subnet_ids: ["SubnetId"], # required
|
3475
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
3476
|
+
# },
|
3477
|
+
# slack_entity_list: ["PUBLIC_CHANNEL"], # required, accepts PUBLIC_CHANNEL, PRIVATE_CHANNEL, GROUP_MESSAGE, DIRECT_MESSAGE
|
3478
|
+
# use_change_log: false,
|
3479
|
+
# crawl_bot_message: false,
|
3480
|
+
# exclude_archived: false,
|
3481
|
+
# since_crawl_date: "SinceCrawlDate", # required
|
3482
|
+
# look_back_period: 1,
|
3483
|
+
# private_channel_filter: ["String"],
|
3484
|
+
# public_channel_filter: ["String"],
|
3485
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
3486
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
3487
|
+
# field_mappings: [
|
3488
|
+
# {
|
3489
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
3490
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
3491
|
+
# index_field_name: "IndexFieldName", # required
|
3492
|
+
# },
|
3493
|
+
# ],
|
3494
|
+
# },
|
3359
3495
|
# }
|
3360
3496
|
#
|
3361
3497
|
# @!attribute [rw] s3_configuration
|
3362
|
-
# Provides information to
|
3363
|
-
#
|
3498
|
+
# Provides the configuration information to connect to an Amazon S3
|
3499
|
+
# bucket as your data source.
|
3364
3500
|
# @return [Types::S3DataSourceConfiguration]
|
3365
3501
|
#
|
3366
3502
|
# @!attribute [rw] share_point_configuration
|
3367
|
-
# Provides information
|
3368
|
-
#
|
3503
|
+
# Provides the configuration information to connect to Microsoft
|
3504
|
+
# SharePoint as your data source.
|
3369
3505
|
# @return [Types::SharePointConfiguration]
|
3370
3506
|
#
|
3371
3507
|
# @!attribute [rw] database_configuration
|
3372
|
-
# Provides information
|
3373
|
-
#
|
3508
|
+
# Provides the configuration information to connect to a database as
|
3509
|
+
# your data source.
|
3374
3510
|
# @return [Types::DatabaseConfiguration]
|
3375
3511
|
#
|
3376
3512
|
# @!attribute [rw] salesforce_configuration
|
3377
|
-
# Provides configuration information
|
3378
|
-
#
|
3513
|
+
# Provides the configuration information to connect to Salesforce as
|
3514
|
+
# your data source.
|
3379
3515
|
# @return [Types::SalesforceConfiguration]
|
3380
3516
|
#
|
3381
3517
|
# @!attribute [rw] one_drive_configuration
|
3382
|
-
# Provides configuration
|
3383
|
-
# OneDrive.
|
3518
|
+
# Provides the configuration information to connect to Microsoft
|
3519
|
+
# OneDrive as your data source.
|
3384
3520
|
# @return [Types::OneDriveConfiguration]
|
3385
3521
|
#
|
3386
3522
|
# @!attribute [rw] service_now_configuration
|
3387
|
-
# Provides configuration
|
3388
|
-
#
|
3523
|
+
# Provides the configuration information to connect to ServiceNow as
|
3524
|
+
# your data source.
|
3389
3525
|
# @return [Types::ServiceNowConfiguration]
|
3390
3526
|
#
|
3391
3527
|
# @!attribute [rw] confluence_configuration
|
3392
|
-
# Provides configuration information
|
3393
|
-
# data source.
|
3528
|
+
# Provides the configuration information to connect to Confluence as
|
3529
|
+
# your data source.
|
3394
3530
|
# @return [Types::ConfluenceConfiguration]
|
3395
3531
|
#
|
3396
3532
|
# @!attribute [rw] google_drive_configuration
|
3397
|
-
# Provides configuration
|
3398
|
-
#
|
3533
|
+
# Provides the configuration information to connect to Google Drive as
|
3534
|
+
# your data source.
|
3399
3535
|
# @return [Types::GoogleDriveConfiguration]
|
3400
3536
|
#
|
3401
3537
|
# @!attribute [rw] web_crawler_configuration
|
@@ -3413,6 +3549,11 @@ module Aws::Kendra
|
|
3413
3549
|
# your data source.
|
3414
3550
|
# @return [Types::FsxConfiguration]
|
3415
3551
|
#
|
3552
|
+
# @!attribute [rw] slack_configuration
|
3553
|
+
# Provides the configuration information to connect to Slack as your
|
3554
|
+
# data source.
|
3555
|
+
# @return [Types::SlackConfiguration]
|
3556
|
+
#
|
3416
3557
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceConfiguration AWS API Documentation
|
3417
3558
|
#
|
3418
3559
|
class DataSourceConfiguration < Struct.new(
|
@@ -3426,7 +3567,8 @@ module Aws::Kendra
|
|
3426
3567
|
:google_drive_configuration,
|
3427
3568
|
:web_crawler_configuration,
|
3428
3569
|
:work_docs_configuration,
|
3429
|
-
:fsx_configuration
|
3570
|
+
:fsx_configuration,
|
3571
|
+
:slack_configuration)
|
3430
3572
|
SENSITIVE = []
|
3431
3573
|
include Aws::Structure
|
3432
3574
|
end
|
@@ -3685,7 +3827,7 @@ module Aws::Kendra
|
|
3685
3827
|
include Aws::Structure
|
3686
3828
|
end
|
3687
3829
|
|
3688
|
-
# Provides information
|
3830
|
+
# Provides the configuration information to connect to an Amazon VPC.
|
3689
3831
|
#
|
3690
3832
|
# @note When making an API call, you may pass DataSourceVpcConfiguration
|
3691
3833
|
# data as a hash:
|
@@ -3716,7 +3858,7 @@ module Aws::Kendra
|
|
3716
3858
|
include Aws::Structure
|
3717
3859
|
end
|
3718
3860
|
|
3719
|
-
# Provides the information
|
3861
|
+
# Provides the configuration information to connect to a index.
|
3720
3862
|
#
|
3721
3863
|
# @note When making an API call, you may pass DatabaseConfiguration
|
3722
3864
|
# data as a hash:
|
@@ -3760,11 +3902,11 @@ module Aws::Kendra
|
|
3760
3902
|
# @return [String]
|
3761
3903
|
#
|
3762
3904
|
# @!attribute [rw] connection_configuration
|
3763
|
-
#
|
3905
|
+
# Configuration information that's required to connect to a database.
|
3764
3906
|
# @return [Types::ConnectionConfiguration]
|
3765
3907
|
#
|
3766
3908
|
# @!attribute [rw] vpc_configuration
|
3767
|
-
# Provides information
|
3909
|
+
# Provides the configuration information to connect to an Amazon VPC.
|
3768
3910
|
# @return [Types::DataSourceVpcConfiguration]
|
3769
3911
|
#
|
3770
3912
|
# @!attribute [rw] column_configuration
|
@@ -4048,9 +4190,8 @@ module Aws::Kendra
|
|
4048
4190
|
# @return [String]
|
4049
4191
|
#
|
4050
4192
|
# @!attribute [rw] configuration
|
4051
|
-
#
|
4052
|
-
#
|
4053
|
-
# description depends on the data source provider.
|
4193
|
+
# Describes how the data source is configured. The specific
|
4194
|
+
# information in the description depends on the data source provider.
|
4054
4195
|
# @return [Types::DataSourceConfiguration]
|
4055
4196
|
#
|
4056
4197
|
# @!attribute [rw] created_at
|
@@ -5484,7 +5625,7 @@ module Aws::Kendra
|
|
5484
5625
|
include Aws::Structure
|
5485
5626
|
end
|
5486
5627
|
|
5487
|
-
# Provides the configuration information
|
5628
|
+
# Provides the configuration information for users or groups in your
|
5488
5629
|
# Amazon Web Services SSO identity source to grant access your Amazon
|
5489
5630
|
# Kendra experience.
|
5490
5631
|
#
|
@@ -5548,7 +5689,7 @@ module Aws::Kendra
|
|
5548
5689
|
include Aws::Structure
|
5549
5690
|
end
|
5550
5691
|
|
5551
|
-
# Provides the configuration information
|
5692
|
+
# Provides the configuration information for users or groups in your
|
5552
5693
|
# Amazon Web Services SSO identity source for access to your Amazon
|
5553
5694
|
# Kendra experience. Specific permissions are defined for each user or
|
5554
5695
|
# group once they are granted access to your Amazon Kendra experience.
|
@@ -5587,7 +5728,7 @@ module Aws::Kendra
|
|
5587
5728
|
include Aws::Structure
|
5588
5729
|
end
|
5589
5730
|
|
5590
|
-
#
|
5731
|
+
# Provides the configuration information for your Amazon Kendra
|
5591
5732
|
# experience. This includes the data source IDs and/or FAQ IDs, and user
|
5592
5733
|
# or group information to grant access to your Amazon Kendra experience.
|
5593
5734
|
#
|
@@ -5626,8 +5767,8 @@ module Aws::Kendra
|
|
5626
5767
|
include Aws::Structure
|
5627
5768
|
end
|
5628
5769
|
|
5629
|
-
# Provides the configuration information
|
5630
|
-
# Kendra experience.
|
5770
|
+
# Provides the configuration information for the endpoint for your
|
5771
|
+
# Amazon Kendra experience.
|
5631
5772
|
#
|
5632
5773
|
# @!attribute [rw] endpoint_type
|
5633
5774
|
# The type of endpoint for your Amazon Kendra experience. The type
|
@@ -5912,9 +6053,9 @@ module Aws::Kendra
|
|
5912
6053
|
# @return [String]
|
5913
6054
|
#
|
5914
6055
|
# @!attribute [rw] vpc_configuration
|
5915
|
-
#
|
5916
|
-
#
|
5917
|
-
#
|
6056
|
+
# Configuration information for an Amazon Virtual Private Cloud to
|
6057
|
+
# connect to your Amazon FSx. Your Amazon FSx instance must reside
|
6058
|
+
# inside your VPC.
|
5918
6059
|
# @return [Types::DataSourceVpcConfiguration]
|
5919
6060
|
#
|
5920
6061
|
# @!attribute [rw] secret_arn
|
@@ -5929,36 +6070,35 @@ module Aws::Kendra
|
|
5929
6070
|
# have read and mounting access to the Amazon FSx file system for
|
5930
6071
|
# Windows.
|
5931
6072
|
#
|
5932
|
-
# * password—The password of the
|
5933
|
-
# mounting access Amazon FSx Windows file system.
|
6073
|
+
# * password—The password of the Active Directory user account with
|
6074
|
+
# read and mounting access to the Amazon FSx Windows file system.
|
5934
6075
|
# @return [String]
|
5935
6076
|
#
|
5936
6077
|
# @!attribute [rw] inclusion_patterns
|
5937
6078
|
# A list of regular expression patterns to include certain files in
|
5938
6079
|
# your Amazon FSx file system. Files that match the patterns are
|
5939
6080
|
# included in the index. Files that don't match the patterns are
|
5940
|
-
# excluded from the index. If a file matches both an inclusion
|
5941
|
-
#
|
5942
|
-
#
|
6081
|
+
# excluded from the index. If a file matches both an inclusion and
|
6082
|
+
# exclusion pattern, the exclusion pattern takes precedence and the
|
6083
|
+
# file isn't included in the index.
|
5943
6084
|
# @return [Array<String>]
|
5944
6085
|
#
|
5945
6086
|
# @!attribute [rw] exclusion_patterns
|
5946
6087
|
# A list of regular expression patterns to exclude certain files in
|
5947
6088
|
# your Amazon FSx file system. Files that match the patterns are
|
5948
|
-
# excluded from the index. Files that don
|
5949
|
-
# included in the index. If a file matches both an inclusion
|
5950
|
-
#
|
5951
|
-
#
|
6089
|
+
# excluded from the index. Files that don't match the patterns are
|
6090
|
+
# included in the index. If a file matches both an inclusion and
|
6091
|
+
# exclusion pattern, the exclusion pattern takes precedence and the
|
6092
|
+
# file isn't included in the index.
|
5952
6093
|
# @return [Array<String>]
|
5953
6094
|
#
|
5954
6095
|
# @!attribute [rw] field_mappings
|
5955
6096
|
# A list of `DataSourceToIndexFieldMapping` objects that map Amazon
|
5956
6097
|
# FSx data source attributes or field names to Amazon Kendra index
|
5957
|
-
# field names
|
5958
|
-
#
|
5959
|
-
#
|
5960
|
-
#
|
5961
|
-
# metadata.
|
6098
|
+
# field names. To create custom fields, use the `UpdateIndex` API
|
6099
|
+
# before you map to Amazon FSx fields. For more information, see
|
6100
|
+
# [Mapping data source fields][1]. The Amazon FSx data source field
|
6101
|
+
# names must exist in your Amazon FSx custom metadata.
|
5962
6102
|
#
|
5963
6103
|
#
|
5964
6104
|
#
|
@@ -6141,8 +6281,8 @@ module Aws::Kendra
|
|
6141
6281
|
include Aws::Structure
|
6142
6282
|
end
|
6143
6283
|
|
6144
|
-
# Provides configuration information
|
6145
|
-
#
|
6284
|
+
# Provides the configuration information to connect to Google Drive as
|
6285
|
+
# your data source.
|
6146
6286
|
#
|
6147
6287
|
# @note When making an API call, you may pass GoogleDriveConfiguration
|
6148
6288
|
# data as a hash:
|
@@ -6175,30 +6315,34 @@ module Aws::Kendra
|
|
6175
6315
|
# @return [String]
|
6176
6316
|
#
|
6177
6317
|
# @!attribute [rw] inclusion_patterns
|
6178
|
-
# A list of regular expression patterns
|
6179
|
-
#
|
6180
|
-
#
|
6181
|
-
# the
|
6182
|
-
# inclusion
|
6183
|
-
# index.
|
6318
|
+
# A list of regular expression patterns to include certain items in
|
6319
|
+
# your Google Drive, including shared drives and users' My Drives.
|
6320
|
+
# Items that match the patterns are included in the index. Items that
|
6321
|
+
# don't match the patterns are excluded from the index. If an item
|
6322
|
+
# matches both an inclusion and exclusion pattern, the exclusion
|
6323
|
+
# pattern takes precedence and the item isn't included in the index.
|
6184
6324
|
# @return [Array<String>]
|
6185
6325
|
#
|
6186
6326
|
# @!attribute [rw] exclusion_patterns
|
6187
|
-
# A list of regular expression patterns
|
6188
|
-
# Google Drive
|
6189
|
-
#
|
6190
|
-
# don't match the
|
6191
|
-
# matches both an
|
6192
|
-
#
|
6327
|
+
# A list of regular expression patterns to exclude certain items in
|
6328
|
+
# your Google Drive, including shared drives and users' My Drives.
|
6329
|
+
# Items that match the patterns are excluded from the index. Items
|
6330
|
+
# that don't match the patterns are included in the index. If an item
|
6331
|
+
# matches both an inclusion and exclusion pattern, the exclusion
|
6332
|
+
# pattern takes precedence and the item isn't included in the index.
|
6193
6333
|
# @return [Array<String>]
|
6194
6334
|
#
|
6195
6335
|
# @!attribute [rw] field_mappings
|
6196
|
-
#
|
6197
|
-
# Kendra index field.
|
6336
|
+
# Maps Google Drive data source attributes or field names to Amazon
|
6337
|
+
# Kendra index field names. To create custom fields, use the
|
6338
|
+
# `UpdateIndex` API before you map to Google Drive fields. For more
|
6339
|
+
# information, see [Mapping data source fields][1]. The Google Drive
|
6340
|
+
# data source field names must exist in your Google Drive custom
|
6341
|
+
# metadata.
|
6342
|
+
#
|
6198
6343
|
#
|
6199
|
-
#
|
6200
|
-
#
|
6201
|
-
# create the field using the `UpdateIndex` API.
|
6344
|
+
#
|
6345
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
6202
6346
|
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
6203
6347
|
#
|
6204
6348
|
# @!attribute [rw] exclude_mime_types
|
@@ -6506,7 +6650,7 @@ module Aws::Kendra
|
|
6506
6650
|
include Aws::Structure
|
6507
6651
|
end
|
6508
6652
|
|
6509
|
-
# A summary of information
|
6653
|
+
# A summary of information on the configuration of an index.
|
6510
6654
|
#
|
6511
6655
|
# @!attribute [rw] name
|
6512
6656
|
# The name of the index.
|
@@ -6661,7 +6805,7 @@ module Aws::Kendra
|
|
6661
6805
|
include Aws::Structure
|
6662
6806
|
end
|
6663
6807
|
|
6664
|
-
#
|
6808
|
+
# Provides the configuration information for the JSON token type.
|
6665
6809
|
#
|
6666
6810
|
# @note When making an API call, you may pass JsonTokenTypeConfiguration
|
6667
6811
|
# data as a hash:
|
@@ -6688,7 +6832,7 @@ module Aws::Kendra
|
|
6688
6832
|
include Aws::Structure
|
6689
6833
|
end
|
6690
6834
|
|
6691
|
-
#
|
6835
|
+
# Provides the configuration information for the JWT token type.
|
6692
6836
|
#
|
6693
6837
|
# @note When making an API call, you may pass JwtTokenTypeConfiguration
|
6694
6838
|
# data as a hash:
|
@@ -7198,7 +7342,8 @@ module Aws::Kendra
|
|
7198
7342
|
end
|
7199
7343
|
|
7200
7344
|
# @!attribute [rw] index_configuration_summary_items
|
7201
|
-
# An array of summary information
|
7345
|
+
# An array of summary information on the configuration of one or more
|
7346
|
+
# indexes.
|
7202
7347
|
# @return [Array<Types::IndexConfigurationSummary>]
|
7203
7348
|
#
|
7204
7349
|
# @!attribute [rw] next_token
|
@@ -7423,8 +7568,8 @@ module Aws::Kendra
|
|
7423
7568
|
include Aws::Structure
|
7424
7569
|
end
|
7425
7570
|
|
7426
|
-
# Provides configuration information
|
7427
|
-
#
|
7571
|
+
# Provides the configuration information to connect to OneDrive as your
|
7572
|
+
# data source.
|
7428
7573
|
#
|
7429
7574
|
# @note When making an API call, you may pass OneDriveConfiguration
|
7430
7575
|
# data as a hash:
|
@@ -7467,28 +7612,38 @@ module Aws::Kendra
|
|
7467
7612
|
# @return [Types::OneDriveUsers]
|
7468
7613
|
#
|
7469
7614
|
# @!attribute [rw] inclusion_patterns
|
7470
|
-
# A list of regular expression patterns
|
7471
|
-
#
|
7472
|
-
#
|
7473
|
-
#
|
7474
|
-
#
|
7475
|
-
#
|
7476
|
-
#
|
7615
|
+
# A list of regular expression patterns to include certain documents
|
7616
|
+
# in your OneDrive. Documents that match the patterns are included in
|
7617
|
+
# the index. Documents that don't match the patterns are excluded
|
7618
|
+
# from the index. If a document matches both an inclusion and
|
7619
|
+
# exclusion pattern, the exclusion pattern takes precedence and the
|
7620
|
+
# document isn't included in the index.
|
7621
|
+
#
|
7622
|
+
# The pattern is applied to the file name.
|
7477
7623
|
# @return [Array<String>]
|
7478
7624
|
#
|
7479
7625
|
# @!attribute [rw] exclusion_patterns
|
7480
|
-
#
|
7481
|
-
#
|
7482
|
-
#
|
7483
|
-
# the
|
7484
|
-
#
|
7485
|
-
#
|
7626
|
+
# A list of regular expression patterns to exclude certain documents
|
7627
|
+
# in your OneDrive. Documents that match the patterns are excluded
|
7628
|
+
# from the index. Documents that don't match the patterns are
|
7629
|
+
# included in the index. If a document matches both an inclusion and
|
7630
|
+
# exclusion pattern, the exclusion pattern takes precedence and the
|
7631
|
+
# document isn't included in the index.
|
7632
|
+
#
|
7633
|
+
# The pattern is applied to the file name.
|
7486
7634
|
# @return [Array<String>]
|
7487
7635
|
#
|
7488
7636
|
# @!attribute [rw] field_mappings
|
7489
|
-
# A list of `DataSourceToIndexFieldMapping` objects that map
|
7490
|
-
#
|
7491
|
-
#
|
7637
|
+
# A list of `DataSourceToIndexFieldMapping` objects that map OneDrive
|
7638
|
+
# data source attributes or field names to Amazon Kendra index field
|
7639
|
+
# names. To create custom fields, use the `UpdateIndex` API before you
|
7640
|
+
# map to OneDrive fields. For more information, see [Mapping data
|
7641
|
+
# source fields][1]. The OneDrive data source field names must exist
|
7642
|
+
# in your OneDrive custom metadata.
|
7643
|
+
#
|
7644
|
+
#
|
7645
|
+
#
|
7646
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
7492
7647
|
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
7493
7648
|
#
|
7494
7649
|
# @!attribute [rw] disable_local_groups
|
@@ -7915,6 +8070,9 @@ module Aws::Kendra
|
|
7915
8070
|
# ],
|
7916
8071
|
# },
|
7917
8072
|
# visitor_id: "VisitorId",
|
8073
|
+
# spell_correction_configuration: {
|
8074
|
+
# include_query_spell_check_suggestions: false, # required
|
8075
|
+
# },
|
7918
8076
|
# }
|
7919
8077
|
#
|
7920
8078
|
# @!attribute [rw] index_id
|
@@ -8008,6 +8166,10 @@ module Aws::Kendra
|
|
8008
8166
|
# `VisitorId`.
|
8009
8167
|
# @return [String]
|
8010
8168
|
#
|
8169
|
+
# @!attribute [rw] spell_correction_configuration
|
8170
|
+
# Enables suggested spell corrections for queries.
|
8171
|
+
# @return [Types::SpellCorrectionConfiguration]
|
8172
|
+
#
|
8011
8173
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryRequest AWS API Documentation
|
8012
8174
|
#
|
8013
8175
|
class QueryRequest < Struct.new(
|
@@ -8022,7 +8184,8 @@ module Aws::Kendra
|
|
8022
8184
|
:page_size,
|
8023
8185
|
:sorting_configuration,
|
8024
8186
|
:user_context,
|
8025
|
-
:visitor_id
|
8187
|
+
:visitor_id,
|
8188
|
+
:spell_correction_configuration)
|
8026
8189
|
SENSITIVE = []
|
8027
8190
|
include Aws::Structure
|
8028
8191
|
end
|
@@ -8061,6 +8224,11 @@ module Aws::Kendra
|
|
8061
8224
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax
|
8062
8225
|
# @return [Array<Types::Warning>]
|
8063
8226
|
#
|
8227
|
+
# @!attribute [rw] spell_corrected_queries
|
8228
|
+
# A list of information related to suggested spell corrections for a
|
8229
|
+
# query.
|
8230
|
+
# @return [Array<Types::SpellCorrectedQuery>]
|
8231
|
+
#
|
8064
8232
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryResult AWS API Documentation
|
8065
8233
|
#
|
8066
8234
|
class QueryResult < Struct.new(
|
@@ -8068,7 +8236,8 @@ module Aws::Kendra
|
|
8068
8236
|
:result_items,
|
8069
8237
|
:facet_results,
|
8070
8238
|
:total_number_of_results,
|
8071
|
-
:warnings
|
8239
|
+
:warnings,
|
8240
|
+
:spell_corrected_queries)
|
8072
8241
|
SENSITIVE = []
|
8073
8242
|
include Aws::Structure
|
8074
8243
|
end
|
@@ -8363,8 +8532,8 @@ module Aws::Kendra
|
|
8363
8532
|
include Aws::Structure
|
8364
8533
|
end
|
8365
8534
|
|
8366
|
-
# Provides configuration information
|
8367
|
-
#
|
8535
|
+
# Provides the configuration information to connect to an Amazon S3
|
8536
|
+
# bucket.
|
8368
8537
|
#
|
8369
8538
|
# @note When making an API call, you may pass S3DataSourceConfiguration
|
8370
8539
|
# data as a hash:
|
@@ -8492,8 +8661,8 @@ module Aws::Kendra
|
|
8492
8661
|
include Aws::Structure
|
8493
8662
|
end
|
8494
8663
|
|
8495
|
-
#
|
8496
|
-
# contents of the object comes from the Salesforce FeedItem table.
|
8664
|
+
# The configuration information for syncing a Salesforce chatter feed.
|
8665
|
+
# The contents of the object comes from the Salesforce FeedItem table.
|
8497
8666
|
#
|
8498
8667
|
# @note When making an API call, you may pass SalesforceChatterFeedConfiguration
|
8499
8668
|
# data as a hash:
|
@@ -8546,8 +8715,8 @@ module Aws::Kendra
|
|
8546
8715
|
include Aws::Structure
|
8547
8716
|
end
|
8548
8717
|
|
8549
|
-
# Provides configuration information
|
8550
|
-
# source.
|
8718
|
+
# Provides the configuration information to connect to Salesforce as
|
8719
|
+
# your data source.
|
8551
8720
|
#
|
8552
8721
|
# @note When making an API call, you may pass SalesforceConfiguration
|
8553
8722
|
# data as a hash:
|
@@ -8654,19 +8823,19 @@ module Aws::Kendra
|
|
8654
8823
|
# @return [String]
|
8655
8824
|
#
|
8656
8825
|
# @!attribute [rw] standard_object_configurations
|
8657
|
-
#
|
8826
|
+
# Configuration of the Salesforce standard objects that Amazon Kendra
|
8658
8827
|
# indexes.
|
8659
8828
|
# @return [Array<Types::SalesforceStandardObjectConfiguration>]
|
8660
8829
|
#
|
8661
8830
|
# @!attribute [rw] knowledge_article_configuration
|
8662
|
-
#
|
8663
|
-
#
|
8831
|
+
# Configuration information for the knowledge article types that
|
8832
|
+
# Amazon Kendra indexes. Amazon Kendra indexes standard knowledge
|
8664
8833
|
# articles and the standard fields of knowledge articles, or the
|
8665
8834
|
# custom fields of custom knowledge articles, but not both.
|
8666
8835
|
# @return [Types::SalesforceKnowledgeArticleConfiguration]
|
8667
8836
|
#
|
8668
8837
|
# @!attribute [rw] chatter_feed_configuration
|
8669
|
-
#
|
8838
|
+
# Configuration information for Salesforce chatter feeds.
|
8670
8839
|
# @return [Types::SalesforceChatterFeedConfiguration]
|
8671
8840
|
#
|
8672
8841
|
# @!attribute [rw] crawl_attachments
|
@@ -8675,28 +8844,30 @@ module Aws::Kendra
|
|
8675
8844
|
# @return [Boolean]
|
8676
8845
|
#
|
8677
8846
|
# @!attribute [rw] standard_object_attachment_configuration
|
8678
|
-
#
|
8679
|
-
#
|
8847
|
+
# Configuration information for processing attachments to Salesforce
|
8848
|
+
# standard objects.
|
8680
8849
|
# @return [Types::SalesforceStandardObjectAttachmentConfiguration]
|
8681
8850
|
#
|
8682
8851
|
# @!attribute [rw] include_attachment_file_patterns
|
8683
|
-
# A list of regular expression patterns
|
8684
|
-
#
|
8685
|
-
#
|
8686
|
-
#
|
8687
|
-
#
|
8688
|
-
#
|
8689
|
-
#
|
8852
|
+
# A list of regular expression patterns to include certain documents
|
8853
|
+
# in your Salesforce. Documents that match the patterns are included
|
8854
|
+
# in the index. Documents that don't match the patterns are excluded
|
8855
|
+
# from the index. If a document matches both an inclusion and
|
8856
|
+
# exclusion pattern, the exclusion pattern takes precedence and the
|
8857
|
+
# document isn't included in the index.
|
8858
|
+
#
|
8859
|
+
# The pattern is applied to the name of the attached file.
|
8690
8860
|
# @return [Array<String>]
|
8691
8861
|
#
|
8692
8862
|
# @!attribute [rw] exclude_attachment_file_patterns
|
8693
|
-
# A list of regular expression patterns
|
8694
|
-
#
|
8695
|
-
#
|
8696
|
-
#
|
8697
|
-
#
|
8698
|
-
#
|
8699
|
-
#
|
8863
|
+
# A list of regular expression patterns to exclude certain documents
|
8864
|
+
# in your Salesforce. Documents that match the patterns are excluded
|
8865
|
+
# from the index. Documents that don't match the patterns are
|
8866
|
+
# included in the index. If a document matches both an inclusion and
|
8867
|
+
# exclusion pattern, the exclusion pattern takes precedence and the
|
8868
|
+
# document isn't included in the index.
|
8869
|
+
#
|
8870
|
+
# The pattern is applied to the name of the attached file.
|
8700
8871
|
# @return [Array<String>]
|
8701
8872
|
#
|
8702
8873
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceConfiguration AWS API Documentation
|
@@ -8715,7 +8886,7 @@ module Aws::Kendra
|
|
8715
8886
|
include Aws::Structure
|
8716
8887
|
end
|
8717
8888
|
|
8718
|
-
# Provides configuration information for indexing Salesforce custom
|
8889
|
+
# Provides the configuration information for indexing Salesforce custom
|
8719
8890
|
# articles.
|
8720
8891
|
#
|
8721
8892
|
# @note When making an API call, you may pass SalesforceCustomKnowledgeArticleTypeConfiguration
|
@@ -8749,8 +8920,16 @@ module Aws::Kendra
|
|
8749
8920
|
# @return [String]
|
8750
8921
|
#
|
8751
8922
|
# @!attribute [rw] field_mappings
|
8752
|
-
#
|
8753
|
-
#
|
8923
|
+
# Maps attributes or field names of the custom knowledge article to
|
8924
|
+
# Amazon Kendra index field names. To create custom fields, use the
|
8925
|
+
# `UpdateIndex` API before you map to Salesforce fields. For more
|
8926
|
+
# information, see [Mapping data source fields][1]. The Salesforce
|
8927
|
+
# data source field names must exist in your Salesforce custom
|
8928
|
+
# metadata.
|
8929
|
+
#
|
8930
|
+
#
|
8931
|
+
#
|
8932
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
8754
8933
|
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
8755
8934
|
#
|
8756
8935
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceCustomKnowledgeArticleTypeConfiguration AWS API Documentation
|
@@ -8764,7 +8943,7 @@ module Aws::Kendra
|
|
8764
8943
|
include Aws::Structure
|
8765
8944
|
end
|
8766
8945
|
|
8767
|
-
#
|
8946
|
+
# Provides the configuration information for the knowledge article types
|
8768
8947
|
# that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge
|
8769
8948
|
# articles and the standard fields of knowledge articles, or the custom
|
8770
8949
|
# fields of custom knowledge articles, but not both
|
@@ -8808,13 +8987,12 @@ module Aws::Kendra
|
|
8808
8987
|
# @return [Array<String>]
|
8809
8988
|
#
|
8810
8989
|
# @!attribute [rw] standard_knowledge_article_type_configuration
|
8811
|
-
#
|
8990
|
+
# Configuration information for standard Salesforce knowledge
|
8812
8991
|
# articles.
|
8813
8992
|
# @return [Types::SalesforceStandardKnowledgeArticleTypeConfiguration]
|
8814
8993
|
#
|
8815
8994
|
# @!attribute [rw] custom_knowledge_article_type_configurations
|
8816
|
-
#
|
8817
|
-
# articles.
|
8995
|
+
# Configuration information for custom Salesforce knowledge articles.
|
8818
8996
|
# @return [Array<Types::SalesforceCustomKnowledgeArticleTypeConfiguration>]
|
8819
8997
|
#
|
8820
8998
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceKnowledgeArticleConfiguration AWS API Documentation
|
@@ -8827,8 +9005,8 @@ module Aws::Kendra
|
|
8827
9005
|
include Aws::Structure
|
8828
9006
|
end
|
8829
9007
|
|
8830
|
-
# Provides configuration information for standard Salesforce
|
8831
|
-
# articles.
|
9008
|
+
# Provides the configuration information for standard Salesforce
|
9009
|
+
# knowledge articles.
|
8832
9010
|
#
|
8833
9011
|
# @note When making an API call, you may pass SalesforceStandardKnowledgeArticleTypeConfiguration
|
8834
9012
|
# data as a hash:
|
@@ -8854,9 +9032,16 @@ module Aws::Kendra
|
|
8854
9032
|
# @return [String]
|
8855
9033
|
#
|
8856
9034
|
# @!attribute [rw] field_mappings
|
8857
|
-
#
|
8858
|
-
#
|
8859
|
-
#
|
9035
|
+
# Maps attributes or field names of the knowledge article to Amazon
|
9036
|
+
# Kendra index field names. To create custom fields, use the
|
9037
|
+
# `UpdateIndex` API before you map to Salesforce fields. For more
|
9038
|
+
# information, see [Mapping data source fields][1]. The Salesforce
|
9039
|
+
# data source field names must exist in your Salesforce custom
|
9040
|
+
# metadata.
|
9041
|
+
#
|
9042
|
+
#
|
9043
|
+
#
|
9044
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
8860
9045
|
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
8861
9046
|
#
|
8862
9047
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceStandardKnowledgeArticleTypeConfiguration AWS API Documentation
|
@@ -8869,7 +9054,7 @@ module Aws::Kendra
|
|
8869
9054
|
include Aws::Structure
|
8870
9055
|
end
|
8871
9056
|
|
8872
|
-
# Provides configuration information for processing attachments to
|
9057
|
+
# Provides the configuration information for processing attachments to
|
8873
9058
|
# Salesforce standard objects.
|
8874
9059
|
#
|
8875
9060
|
# @note When making an API call, you may pass SalesforceStandardObjectAttachmentConfiguration
|
@@ -8904,7 +9089,7 @@ module Aws::Kendra
|
|
8904
9089
|
include Aws::Structure
|
8905
9090
|
end
|
8906
9091
|
|
8907
|
-
#
|
9092
|
+
# Provides the configuration information for indexing a single standard
|
8908
9093
|
# object.
|
8909
9094
|
#
|
8910
9095
|
# @note When making an API call, you may pass SalesforceStandardObjectConfiguration
|
@@ -8938,9 +9123,16 @@ module Aws::Kendra
|
|
8938
9123
|
# @return [String]
|
8939
9124
|
#
|
8940
9125
|
# @!attribute [rw] field_mappings
|
8941
|
-
#
|
8942
|
-
# Kendra index
|
8943
|
-
#
|
9126
|
+
# Maps attributes or field names of the standard object to Amazon
|
9127
|
+
# Kendra index field names. To create custom fields, use the
|
9128
|
+
# `UpdateIndex` API before you map to Salesforce fields. For more
|
9129
|
+
# information, see [Mapping data source fields][1]. The Salesforce
|
9130
|
+
# data source field names must exist in your Salesforce custom
|
9131
|
+
# metadata.
|
9132
|
+
#
|
9133
|
+
#
|
9134
|
+
#
|
9135
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
8944
9136
|
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
8945
9137
|
#
|
8946
9138
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceStandardObjectConfiguration AWS API Documentation
|
@@ -9019,7 +9211,7 @@ module Aws::Kendra
|
|
9019
9211
|
include Aws::Structure
|
9020
9212
|
end
|
9021
9213
|
|
9022
|
-
# Provides the configuration information
|
9214
|
+
# Provides the configuration information for the seed or starting point
|
9023
9215
|
# URLs to crawl.
|
9024
9216
|
#
|
9025
9217
|
# *When selecting websites to index, you must adhere to the [Amazon
|
@@ -9096,8 +9288,8 @@ module Aws::Kendra
|
|
9096
9288
|
include Aws::Structure
|
9097
9289
|
end
|
9098
9290
|
|
9099
|
-
# Provides configuration information
|
9100
|
-
# data source.
|
9291
|
+
# Provides the configuration information to connect to ServiceNow as
|
9292
|
+
# your data source.
|
9101
9293
|
#
|
9102
9294
|
# @note When making an API call, you may pass ServiceNowConfiguration
|
9103
9295
|
# data as a hash:
|
@@ -9141,7 +9333,7 @@ module Aws::Kendra
|
|
9141
9333
|
# @!attribute [rw] host_url
|
9142
9334
|
# The ServiceNow instance that the data source connects to. The host
|
9143
9335
|
# endpoint should look like the following:
|
9144
|
-
#
|
9336
|
+
# *\\\{instance\\}.service-now.com.*
|
9145
9337
|
# @return [String]
|
9146
9338
|
#
|
9147
9339
|
# @!attribute [rw] secret_arn
|
@@ -9156,24 +9348,23 @@ module Aws::Kendra
|
|
9156
9348
|
# @return [String]
|
9157
9349
|
#
|
9158
9350
|
# @!attribute [rw] knowledge_article_configuration
|
9159
|
-
#
|
9160
|
-
#
|
9351
|
+
# Configuration information for crawling knowledge articles in the
|
9352
|
+
# ServiceNow site.
|
9161
9353
|
# @return [Types::ServiceNowKnowledgeArticleConfiguration]
|
9162
9354
|
#
|
9163
9355
|
# @!attribute [rw] service_catalog_configuration
|
9164
|
-
#
|
9165
|
-
#
|
9356
|
+
# Configuration information for crawling service catalogs in the
|
9357
|
+
# ServiceNow site.
|
9166
9358
|
# @return [Types::ServiceNowServiceCatalogConfiguration]
|
9167
9359
|
#
|
9168
9360
|
# @!attribute [rw] authentication_type
|
9169
|
-
#
|
9170
|
-
#
|
9171
|
-
#
|
9172
|
-
#
|
9173
|
-
#
|
9174
|
-
#
|
9175
|
-
#
|
9176
|
-
# access to.
|
9361
|
+
# The type of authentication used to connect to the ServiceNow
|
9362
|
+
# instance. If you choose `HTTP_BASIC`, Amazon Kendra is authenticated
|
9363
|
+
# using the user name and password provided in the Secrets Manager
|
9364
|
+
# secret in the `SecretArn` field. When you choose `OAUTH2`, Amazon
|
9365
|
+
# Kendra is authenticated using the OAuth token and secret provided in
|
9366
|
+
# the Secrets Manager secret, and the user name and password are used
|
9367
|
+
# to determine which information Amazon Kendra has access to.
|
9177
9368
|
#
|
9178
9369
|
# When you use `OAUTH2` authentication, you must generate a token and
|
9179
9370
|
# a client secret using the ServiceNow console. For more information,
|
@@ -9197,8 +9388,8 @@ module Aws::Kendra
|
|
9197
9388
|
include Aws::Structure
|
9198
9389
|
end
|
9199
9390
|
|
9200
|
-
# Provides configuration information for crawling knowledge articles
|
9201
|
-
# the ServiceNow site.
|
9391
|
+
# Provides the configuration information for crawling knowledge articles
|
9392
|
+
# in the ServiceNow site.
|
9202
9393
|
#
|
9203
9394
|
# @note When making an API call, you may pass ServiceNowKnowledgeArticleConfiguration
|
9204
9395
|
# data as a hash:
|
@@ -9225,15 +9416,27 @@ module Aws::Kendra
|
|
9225
9416
|
# @return [Boolean]
|
9226
9417
|
#
|
9227
9418
|
# @!attribute [rw] include_attachment_file_patterns
|
9228
|
-
#
|
9229
|
-
#
|
9230
|
-
#
|
9419
|
+
# A list of regular expression patterns to include certain attachments
|
9420
|
+
# of knowledge articles in your ServiceNow. Item that match the
|
9421
|
+
# patterns are included in the index. Items that don't match the
|
9422
|
+
# patterns are excluded from the index. If an item matches both an
|
9423
|
+
# inclusion and exclusion pattern, the exclusion pattern takes
|
9424
|
+
# precedence and the item isn't included in the index.
|
9425
|
+
#
|
9426
|
+
# The regex is applied to the field specified in the
|
9427
|
+
# `PatternTargetField`.
|
9231
9428
|
# @return [Array<String>]
|
9232
9429
|
#
|
9233
9430
|
# @!attribute [rw] exclude_attachment_file_patterns
|
9234
|
-
#
|
9235
|
-
#
|
9236
|
-
#
|
9431
|
+
# A list of regular expression patterns to exclude certain attachments
|
9432
|
+
# of knowledge articles in your ServiceNow. Item that match the
|
9433
|
+
# patterns are excluded from the index. Items that don't match the
|
9434
|
+
# patterns are included in the index. If an item matches both an
|
9435
|
+
# inclusion and exclusion pattern, the exclusion pattern takes
|
9436
|
+
# precedence and the item isn't included in the index.
|
9437
|
+
#
|
9438
|
+
# The regex is applied to the field specified in the
|
9439
|
+
# `PatternTargetField`.
|
9237
9440
|
# @return [Array<String>]
|
9238
9441
|
#
|
9239
9442
|
# @!attribute [rw] document_data_field_name
|
@@ -9247,8 +9450,16 @@ module Aws::Kendra
|
|
9247
9450
|
# @return [String]
|
9248
9451
|
#
|
9249
9452
|
# @!attribute [rw] field_mappings
|
9250
|
-
#
|
9251
|
-
#
|
9453
|
+
# Maps attributes or field names of knoweldge articles to Amazon
|
9454
|
+
# Kendra index field names. To create custom fields, use the
|
9455
|
+
# `UpdateIndex` API before you map to ServiceNow fields. For more
|
9456
|
+
# information, see [Mapping data source fields][1]. The ServiceNow
|
9457
|
+
# data source field names must exist in your ServiceNow custom
|
9458
|
+
# metadata.
|
9459
|
+
#
|
9460
|
+
#
|
9461
|
+
#
|
9462
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
9252
9463
|
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
9253
9464
|
#
|
9254
9465
|
# @!attribute [rw] filter_query
|
@@ -9279,8 +9490,8 @@ module Aws::Kendra
|
|
9279
9490
|
include Aws::Structure
|
9280
9491
|
end
|
9281
9492
|
|
9282
|
-
# Provides configuration information for crawling service catalog
|
9283
|
-
# in the ServiceNow site
|
9493
|
+
# Provides the configuration information for crawling service catalog
|
9494
|
+
# items in the ServiceNow site
|
9284
9495
|
#
|
9285
9496
|
# @note When making an API call, you may pass ServiceNowServiceCatalogConfiguration
|
9286
9497
|
# data as a hash:
|
@@ -9306,21 +9517,23 @@ module Aws::Kendra
|
|
9306
9517
|
# @return [Boolean]
|
9307
9518
|
#
|
9308
9519
|
# @!attribute [rw] include_attachment_file_patterns
|
9309
|
-
# A list of regular expression patterns
|
9310
|
-
#
|
9311
|
-
#
|
9312
|
-
#
|
9313
|
-
#
|
9520
|
+
# A list of regular expression patterns to include certain attachments
|
9521
|
+
# of catalogs in your ServiceNow. Item that match the patterns are
|
9522
|
+
# included in the index. Items that don't match the patterns are
|
9523
|
+
# excluded from the index. If an item matches both an inclusion and
|
9524
|
+
# exclusion pattern, the exclusion pattern takes precedence and the
|
9525
|
+
# item isn't included in the index.
|
9314
9526
|
#
|
9315
9527
|
# The regex is applied to the file name of the attachment.
|
9316
9528
|
# @return [Array<String>]
|
9317
9529
|
#
|
9318
9530
|
# @!attribute [rw] exclude_attachment_file_patterns
|
9319
|
-
# A list of regular expression patterns
|
9320
|
-
#
|
9321
|
-
#
|
9322
|
-
#
|
9323
|
-
#
|
9531
|
+
# A list of regular expression patterns to exclude certain attachments
|
9532
|
+
# of catalogs in your ServiceNow. Item that match the patterns are
|
9533
|
+
# excluded from the index. Items that don't match the patterns are
|
9534
|
+
# included in the index. If an item matches both an inclusion and
|
9535
|
+
# exclusion pattern, the exclusion pattern takes precedence and the
|
9536
|
+
# item isn't included in the index.
|
9324
9537
|
#
|
9325
9538
|
# The regex is applied to the file name of the attachment.
|
9326
9539
|
# @return [Array<String>]
|
@@ -9336,8 +9549,15 @@ module Aws::Kendra
|
|
9336
9549
|
# @return [String]
|
9337
9550
|
#
|
9338
9551
|
# @!attribute [rw] field_mappings
|
9339
|
-
#
|
9340
|
-
#
|
9552
|
+
# Maps attributes or field names of catalogs to Amazon Kendra index
|
9553
|
+
# field names. To create custom fields, use the `UpdateIndex` API
|
9554
|
+
# before you map to ServiceNow fields. For more information, see
|
9555
|
+
# [Mapping data source fields][1]. The ServiceNow data source field
|
9556
|
+
# names must exist in your ServiceNow custom metadata.
|
9557
|
+
#
|
9558
|
+
#
|
9559
|
+
#
|
9560
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
9341
9561
|
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
9342
9562
|
#
|
9343
9563
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServiceNowServiceCatalogConfiguration AWS API Documentation
|
@@ -9364,8 +9584,8 @@ module Aws::Kendra
|
|
9364
9584
|
include Aws::Structure
|
9365
9585
|
end
|
9366
9586
|
|
9367
|
-
# Provides configuration information
|
9368
|
-
# SharePoint data source.
|
9587
|
+
# Provides the configuration information to connect to Microsoft
|
9588
|
+
# SharePoint as your data source.
|
9369
9589
|
#
|
9370
9590
|
# @note When making an API call, you may pass SharePointConfiguration
|
9371
9591
|
# data as a hash:
|
@@ -9428,44 +9648,45 @@ module Aws::Kendra
|
|
9428
9648
|
# @return [Boolean]
|
9429
9649
|
#
|
9430
9650
|
# @!attribute [rw] use_change_log
|
9431
|
-
#
|
9432
|
-
#
|
9433
|
-
#
|
9434
|
-
#
|
9435
|
-
# determine the changed documents using the Amazon Kendra document
|
9436
|
-
# crawler.
|
9651
|
+
# `TRUE` to use the SharePoint change log to determine which documents
|
9652
|
+
# require updating in the index. Depending on the change log's size,
|
9653
|
+
# it may take longer for Amazon Kendra to use the change log than to
|
9654
|
+
# scan all of your documents in SharePoint.
|
9437
9655
|
# @return [Boolean]
|
9438
9656
|
#
|
9439
9657
|
# @!attribute [rw] inclusion_patterns
|
9440
|
-
# A list of regular expression patterns
|
9441
|
-
#
|
9442
|
-
#
|
9443
|
-
#
|
9444
|
-
#
|
9658
|
+
# A list of regular expression patterns to include certain documents
|
9659
|
+
# in your SharePoint. Documents that match the patterns are included
|
9660
|
+
# in the index. Documents that don't match the patterns are excluded
|
9661
|
+
# from the index. If a document matches both an inclusion and
|
9662
|
+
# exclusion pattern, the exclusion pattern takes precedence and the
|
9663
|
+
# document isn't included in the index.
|
9445
9664
|
#
|
9446
9665
|
# The regex is applied to the display URL of the SharePoint document.
|
9447
9666
|
# @return [Array<String>]
|
9448
9667
|
#
|
9449
9668
|
# @!attribute [rw] exclusion_patterns
|
9450
|
-
# A list of regular expression patterns
|
9451
|
-
#
|
9452
|
-
#
|
9453
|
-
#
|
9454
|
-
#
|
9669
|
+
# A list of regular expression patterns to exclude certain documents
|
9670
|
+
# in your SharePoint. Documents that match the patterns are excluded
|
9671
|
+
# from the index. Documents that don't match the patterns are
|
9672
|
+
# included in the index. If a document matches both an inclusion and
|
9673
|
+
# exclusion pattern, the exclusion pattern takes precedence and the
|
9674
|
+
# document isn't included in the index.
|
9455
9675
|
#
|
9456
9676
|
# The regex is applied to the display URL of the SharePoint document.
|
9457
9677
|
# @return [Array<String>]
|
9458
9678
|
#
|
9459
9679
|
# @!attribute [rw] vpc_configuration
|
9460
|
-
# Provides information
|
9680
|
+
# Provides the configuration information to connect to an Amazon VPC.
|
9461
9681
|
# @return [Types::DataSourceVpcConfiguration]
|
9462
9682
|
#
|
9463
9683
|
# @!attribute [rw] field_mappings
|
9464
|
-
# A list of `DataSourceToIndexFieldMapping` objects that map
|
9465
|
-
# SharePoint attributes
|
9466
|
-
#
|
9467
|
-
# before you map SharePoint
|
9468
|
-
# [Mapping
|
9684
|
+
# A list of `DataSourceToIndexFieldMapping` objects that map
|
9685
|
+
# SharePoint data source attributes or field names to Amazon Kendra
|
9686
|
+
# index field names. To create custom fields, use the `UpdateIndex`
|
9687
|
+
# API before you map to SharePoint fields. For more information, see
|
9688
|
+
# [Mapping data source fields][1]. The SharePoint data source field
|
9689
|
+
# names must exist in your SharePoint custom metadata.
|
9469
9690
|
#
|
9470
9691
|
#
|
9471
9692
|
#
|
@@ -9505,7 +9726,7 @@ module Aws::Kendra
|
|
9505
9726
|
include Aws::Structure
|
9506
9727
|
end
|
9507
9728
|
|
9508
|
-
# Provides the configuration information
|
9729
|
+
# Provides the configuration information for the sitemap URLs to crawl.
|
9509
9730
|
#
|
9510
9731
|
# *When selecting websites to index, you must adhere to the [Amazon
|
9511
9732
|
# Acceptable Use Policy][1] and all other Amazon terms. Remember that
|
@@ -9537,6 +9758,180 @@ module Aws::Kendra
|
|
9537
9758
|
include Aws::Structure
|
9538
9759
|
end
|
9539
9760
|
|
9761
|
+
# Provides the configuration information to connect to Slack as your
|
9762
|
+
# data source.
|
9763
|
+
#
|
9764
|
+
# @note When making an API call, you may pass SlackConfiguration
|
9765
|
+
# data as a hash:
|
9766
|
+
#
|
9767
|
+
# {
|
9768
|
+
# team_id: "TeamId", # required
|
9769
|
+
# secret_arn: "SecretArn", # required
|
9770
|
+
# vpc_configuration: {
|
9771
|
+
# subnet_ids: ["SubnetId"], # required
|
9772
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
9773
|
+
# },
|
9774
|
+
# slack_entity_list: ["PUBLIC_CHANNEL"], # required, accepts PUBLIC_CHANNEL, PRIVATE_CHANNEL, GROUP_MESSAGE, DIRECT_MESSAGE
|
9775
|
+
# use_change_log: false,
|
9776
|
+
# crawl_bot_message: false,
|
9777
|
+
# exclude_archived: false,
|
9778
|
+
# since_crawl_date: "SinceCrawlDate", # required
|
9779
|
+
# look_back_period: 1,
|
9780
|
+
# private_channel_filter: ["String"],
|
9781
|
+
# public_channel_filter: ["String"],
|
9782
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
9783
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
9784
|
+
# field_mappings: [
|
9785
|
+
# {
|
9786
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
9787
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
9788
|
+
# index_field_name: "IndexFieldName", # required
|
9789
|
+
# },
|
9790
|
+
# ],
|
9791
|
+
# }
|
9792
|
+
#
|
9793
|
+
# @!attribute [rw] team_id
|
9794
|
+
# The identifier of the team in the Slack workspace. For example,
|
9795
|
+
# *T0123456789*.
|
9796
|
+
#
|
9797
|
+
# You can find your team ID in the URL of the main page of your Slack
|
9798
|
+
# workspace. When you log in to Slack via a browser, you are directed
|
9799
|
+
# to the URL of the main page. For example,
|
9800
|
+
# *https://app.slack.com/client/**T0123456789**/...*.
|
9801
|
+
# @return [String]
|
9802
|
+
#
|
9803
|
+
# @!attribute [rw] secret_arn
|
9804
|
+
# The Amazon Resource Name (ARN) of an Secrets Manager secret that
|
9805
|
+
# contains the key-value pairs required to connect to your Slack
|
9806
|
+
# workspace team. The secret must contain a JSON structure with the
|
9807
|
+
# following keys:
|
9808
|
+
#
|
9809
|
+
# * slackToken—The user or bot token created in Slack. For more
|
9810
|
+
# information on creating a token in Slack, see [Authentication for
|
9811
|
+
# a Slack data source][1].
|
9812
|
+
#
|
9813
|
+
# ^
|
9814
|
+
#
|
9815
|
+
#
|
9816
|
+
#
|
9817
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-slack.html#slack-authentication
|
9818
|
+
# @return [String]
|
9819
|
+
#
|
9820
|
+
# @!attribute [rw] vpc_configuration
|
9821
|
+
# Configuration information for an Amazon Virtual Private Cloud to
|
9822
|
+
# connect to your Slack. For more information, see [Configuring a
|
9823
|
+
# VPC][1].
|
9824
|
+
#
|
9825
|
+
#
|
9826
|
+
#
|
9827
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
|
9828
|
+
# @return [Types::DataSourceVpcConfiguration]
|
9829
|
+
#
|
9830
|
+
# @!attribute [rw] slack_entity_list
|
9831
|
+
# Specify whether to index public channels, private channels, group
|
9832
|
+
# messages, and direct messages. You can specify one or more of these
|
9833
|
+
# options.
|
9834
|
+
# @return [Array<String>]
|
9835
|
+
#
|
9836
|
+
# @!attribute [rw] use_change_log
|
9837
|
+
# `TRUE` to use the Slack change log to determine which documents
|
9838
|
+
# require updating in the index. Depending on the Slack change log's
|
9839
|
+
# size, it may take longer for Amazon Kendra to use the change log
|
9840
|
+
# than to scan all of your documents in Slack.
|
9841
|
+
# @return [Boolean]
|
9842
|
+
#
|
9843
|
+
# @!attribute [rw] crawl_bot_message
|
9844
|
+
# `TRUE` to index bot messages from your Slack workspace team.
|
9845
|
+
# @return [Boolean]
|
9846
|
+
#
|
9847
|
+
# @!attribute [rw] exclude_archived
|
9848
|
+
# `TRUE` to exclude archived messages to index from your Slack
|
9849
|
+
# workspace team.
|
9850
|
+
# @return [Boolean]
|
9851
|
+
#
|
9852
|
+
# @!attribute [rw] since_crawl_date
|
9853
|
+
# The date to start crawling your data from your Slack workspace team.
|
9854
|
+
# The date must follow this format: `yyyy-mm-dd`.
|
9855
|
+
# @return [String]
|
9856
|
+
#
|
9857
|
+
# @!attribute [rw] look_back_period
|
9858
|
+
# The number of hours for change log to look back from when you last
|
9859
|
+
# synchronized your data. You can look back up to 7 days or 168 hours.
|
9860
|
+
#
|
9861
|
+
# Change log updates your index only if new content was added since
|
9862
|
+
# you last synced your data. Updated or deleted content from before
|
9863
|
+
# you last synced does not get updated in your index. To capture
|
9864
|
+
# updated or deleted content before you last synced, set the
|
9865
|
+
# `LookBackPeriod` to the number of hours you want change log to look
|
9866
|
+
# back.
|
9867
|
+
# @return [Integer]
|
9868
|
+
#
|
9869
|
+
# @!attribute [rw] private_channel_filter
|
9870
|
+
# The list of private channel names from your Slack workspace team.
|
9871
|
+
# You use this if you want to index specific private channels, not all
|
9872
|
+
# private channels. You can also use regular expression patterns to
|
9873
|
+
# filter private channels.
|
9874
|
+
# @return [Array<String>]
|
9875
|
+
#
|
9876
|
+
# @!attribute [rw] public_channel_filter
|
9877
|
+
# The list of public channel names to index from your Slack workspace
|
9878
|
+
# team. You use this if you want to index specific public channels,
|
9879
|
+
# not all public channels. You can also use regular expression
|
9880
|
+
# patterns to filter public channels.
|
9881
|
+
# @return [Array<String>]
|
9882
|
+
#
|
9883
|
+
# @!attribute [rw] inclusion_patterns
|
9884
|
+
# A list of regular expression patterns to include certain attached
|
9885
|
+
# files in your Slack workspace team. Files that match the patterns
|
9886
|
+
# are included in the index. Files that don't match the patterns are
|
9887
|
+
# excluded from the index. If a file matches both an inclusion and
|
9888
|
+
# exclusion pattern, the exclusion pattern takes precedence and the
|
9889
|
+
# file isn't included in the index.
|
9890
|
+
# @return [Array<String>]
|
9891
|
+
#
|
9892
|
+
# @!attribute [rw] exclusion_patterns
|
9893
|
+
# A list of regular expression patterns to exclude certain attached
|
9894
|
+
# files in your Slack workspace team. Files that match the patterns
|
9895
|
+
# are excluded from the index. Files that don’t match the patterns are
|
9896
|
+
# included in the index. If a file matches both an inclusion and
|
9897
|
+
# exclusion pattern, the exclusion pattern takes precedence and the
|
9898
|
+
# file isn't included in the index.
|
9899
|
+
# @return [Array<String>]
|
9900
|
+
#
|
9901
|
+
# @!attribute [rw] field_mappings
|
9902
|
+
# A list of `DataSourceToIndexFieldMapping` objects that map Slack
|
9903
|
+
# data source attributes or field names to Amazon Kendra index field
|
9904
|
+
# names. To create custom fields, use the `UpdateIndex` API before you
|
9905
|
+
# map to Slack fields. For more information, see [Mapping data source
|
9906
|
+
# fields][1]. The Slack data source field names must exist in your
|
9907
|
+
# Slack custom metadata.
|
9908
|
+
#
|
9909
|
+
#
|
9910
|
+
#
|
9911
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
9912
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
9913
|
+
#
|
9914
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SlackConfiguration AWS API Documentation
|
9915
|
+
#
|
9916
|
+
class SlackConfiguration < Struct.new(
|
9917
|
+
:team_id,
|
9918
|
+
:secret_arn,
|
9919
|
+
:vpc_configuration,
|
9920
|
+
:slack_entity_list,
|
9921
|
+
:use_change_log,
|
9922
|
+
:crawl_bot_message,
|
9923
|
+
:exclude_archived,
|
9924
|
+
:since_crawl_date,
|
9925
|
+
:look_back_period,
|
9926
|
+
:private_channel_filter,
|
9927
|
+
:public_channel_filter,
|
9928
|
+
:inclusion_patterns,
|
9929
|
+
:exclusion_patterns,
|
9930
|
+
:field_mappings)
|
9931
|
+
SENSITIVE = []
|
9932
|
+
include Aws::Structure
|
9933
|
+
end
|
9934
|
+
|
9540
9935
|
# Specifies the document attribute to use to sort the response to a
|
9541
9936
|
# Amazon Kendra query. You can specify a single attribute for sorting.
|
9542
9937
|
# The attribute must have the `Sortable` flag set to `true`, otherwise
|
@@ -9596,8 +9991,60 @@ module Aws::Kendra
|
|
9596
9991
|
include Aws::Structure
|
9597
9992
|
end
|
9598
9993
|
|
9599
|
-
#
|
9600
|
-
#
|
9994
|
+
# A query with suggested spell corrections.
|
9995
|
+
#
|
9996
|
+
# @!attribute [rw] suggested_query_text
|
9997
|
+
# The query with the suggested spell corrections.
|
9998
|
+
# @return [String]
|
9999
|
+
#
|
10000
|
+
# @!attribute [rw] corrections
|
10001
|
+
# The corrected misspelled word or words in a query.
|
10002
|
+
# @return [Array<Types::Correction>]
|
10003
|
+
#
|
10004
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SpellCorrectedQuery AWS API Documentation
|
10005
|
+
#
|
10006
|
+
class SpellCorrectedQuery < Struct.new(
|
10007
|
+
:suggested_query_text,
|
10008
|
+
:corrections)
|
10009
|
+
SENSITIVE = []
|
10010
|
+
include Aws::Structure
|
10011
|
+
end
|
10012
|
+
|
10013
|
+
# Provides the configuration information for suggested query spell
|
10014
|
+
# corrections.
|
10015
|
+
#
|
10016
|
+
# Suggested spell corrections are based on words that appear in your
|
10017
|
+
# indexed documents and how closely a corrected word matches a
|
10018
|
+
# misspelled word.
|
10019
|
+
#
|
10020
|
+
# This feature is designed with certain defaults or limits. For
|
10021
|
+
# information on the current limits and how to request more support for
|
10022
|
+
# some limits, see the [Spell Checker documentation][1].
|
10023
|
+
#
|
10024
|
+
#
|
10025
|
+
#
|
10026
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/query-spell-check.html
|
10027
|
+
#
|
10028
|
+
# @note When making an API call, you may pass SpellCorrectionConfiguration
|
10029
|
+
# data as a hash:
|
10030
|
+
#
|
10031
|
+
# {
|
10032
|
+
# include_query_spell_check_suggestions: false, # required
|
10033
|
+
# }
|
10034
|
+
#
|
10035
|
+
# @!attribute [rw] include_query_spell_check_suggestions
|
10036
|
+
# `TRUE` to suggest spell corrections for queries.
|
10037
|
+
# @return [Boolean]
|
10038
|
+
#
|
10039
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SpellCorrectionConfiguration AWS API Documentation
|
10040
|
+
#
|
10041
|
+
class SpellCorrectionConfiguration < Struct.new(
|
10042
|
+
:include_query_spell_check_suggestions)
|
10043
|
+
SENSITIVE = []
|
10044
|
+
include Aws::Structure
|
10045
|
+
end
|
10046
|
+
|
10047
|
+
# Provides the configuration information to use a SQL database.
|
9601
10048
|
#
|
9602
10049
|
# @note When making an API call, you may pass SqlConfiguration
|
9603
10050
|
# data as a hash:
|
@@ -10405,6 +10852,31 @@ module Aws::Kendra
|
|
10405
10852
|
# },
|
10406
10853
|
# ],
|
10407
10854
|
# },
|
10855
|
+
# slack_configuration: {
|
10856
|
+
# team_id: "TeamId", # required
|
10857
|
+
# secret_arn: "SecretArn", # required
|
10858
|
+
# vpc_configuration: {
|
10859
|
+
# subnet_ids: ["SubnetId"], # required
|
10860
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
10861
|
+
# },
|
10862
|
+
# slack_entity_list: ["PUBLIC_CHANNEL"], # required, accepts PUBLIC_CHANNEL, PRIVATE_CHANNEL, GROUP_MESSAGE, DIRECT_MESSAGE
|
10863
|
+
# use_change_log: false,
|
10864
|
+
# crawl_bot_message: false,
|
10865
|
+
# exclude_archived: false,
|
10866
|
+
# since_crawl_date: "SinceCrawlDate", # required
|
10867
|
+
# look_back_period: 1,
|
10868
|
+
# private_channel_filter: ["String"],
|
10869
|
+
# public_channel_filter: ["String"],
|
10870
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
10871
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
10872
|
+
# field_mappings: [
|
10873
|
+
# {
|
10874
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
10875
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
10876
|
+
# index_field_name: "IndexFieldName", # required
|
10877
|
+
# },
|
10878
|
+
# ],
|
10879
|
+
# },
|
10408
10880
|
# },
|
10409
10881
|
# description: "Description",
|
10410
10882
|
# schedule: "ScanSchedule",
|
@@ -10483,7 +10955,8 @@ module Aws::Kendra
|
|
10483
10955
|
# @return [String]
|
10484
10956
|
#
|
10485
10957
|
# @!attribute [rw] configuration
|
10486
|
-
# Configuration information for an Amazon Kendra data source
|
10958
|
+
# Configuration information for an Amazon Kendra data source you want
|
10959
|
+
# to update.
|
10487
10960
|
# @return [Types::DataSourceConfiguration]
|
10488
10961
|
#
|
10489
10962
|
# @!attribute [rw] description
|
@@ -10587,9 +11060,7 @@ module Aws::Kendra
|
|
10587
11060
|
# @return [String]
|
10588
11061
|
#
|
10589
11062
|
# @!attribute [rw] configuration
|
10590
|
-
#
|
10591
|
-
# Amazon Web Services SSO field name that contains the identifiers of
|
10592
|
-
# your users, such as their emails.
|
11063
|
+
# Configuration information for your Amazon Kendra you want to update.
|
10593
11064
|
# @return [Types::ExperienceConfiguration]
|
10594
11065
|
#
|
10595
11066
|
# @!attribute [rw] description
|
@@ -10683,7 +11154,7 @@ module Aws::Kendra
|
|
10683
11154
|
# @return [String]
|
10684
11155
|
#
|
10685
11156
|
# @!attribute [rw] document_metadata_configuration_updates
|
10686
|
-
# The document metadata to update.
|
11157
|
+
# The document metadata you want to update.
|
10687
11158
|
# @return [Array<Types::DocumentMetadataConfiguration>]
|
10688
11159
|
#
|
10689
11160
|
# @!attribute [rw] capacity_units
|
@@ -10964,8 +11435,8 @@ module Aws::Kendra
|
|
10964
11435
|
# }
|
10965
11436
|
#
|
10966
11437
|
# @!attribute [rw] seed_url_configuration
|
10967
|
-
#
|
10968
|
-
#
|
11438
|
+
# Configuration of the seed or starting point URLs of the websites you
|
11439
|
+
# want to crawl.
|
10969
11440
|
#
|
10970
11441
|
# You can choose to crawl only the website host names, or the website
|
10971
11442
|
# host names with subdomains, or the website host names with
|
@@ -10975,8 +11446,7 @@ module Aws::Kendra
|
|
10975
11446
|
# @return [Types::SeedUrlConfiguration]
|
10976
11447
|
#
|
10977
11448
|
# @!attribute [rw] site_maps_configuration
|
10978
|
-
#
|
10979
|
-
# want to crawl.
|
11449
|
+
# Configuration of the sitemap URLs of the websites you want to crawl.
|
10980
11450
|
#
|
10981
11451
|
# Only URLs belonging to the same website host names are crawled. You
|
10982
11452
|
# can list up to three sitemap URLs.
|
@@ -11101,7 +11571,8 @@ module Aws::Kendra
|
|
11101
11571
|
include Aws::Structure
|
11102
11572
|
end
|
11103
11573
|
|
11104
|
-
#
|
11574
|
+
# Provides the configuration information for the identifiers of your
|
11575
|
+
# users.
|
11105
11576
|
#
|
11106
11577
|
# @note When making an API call, you may pass UserIdentityConfiguration
|
11107
11578
|
# data as a hash:
|
@@ -11134,7 +11605,7 @@ module Aws::Kendra
|
|
11134
11605
|
include Aws::Structure
|
11135
11606
|
end
|
11136
11607
|
|
11137
|
-
# Provides configuration information for a token
|
11608
|
+
# Provides the configuration information for a token.
|
11138
11609
|
#
|
11139
11610
|
# @note When making an API call, you may pass UserTokenConfiguration
|
11140
11611
|
# data as a hash:
|
@@ -11303,24 +11774,26 @@ module Aws::Kendra
|
|
11303
11774
|
# @return [Integer]
|
11304
11775
|
#
|
11305
11776
|
# @!attribute [rw] url_inclusion_patterns
|
11306
|
-
#
|
11307
|
-
#
|
11308
|
-
#
|
11309
|
-
#
|
11310
|
-
# precedence
|
11777
|
+
# A list of regular expression patterns to include certain URLs to
|
11778
|
+
# crawl. URLs that match the patterns are included in the index. URLs
|
11779
|
+
# that don't match the patterns are excluded from the index. If a URL
|
11780
|
+
# matches both an inclusion and exclusion pattern, the exclusion
|
11781
|
+
# pattern takes precedence and the URL file isn't included in the
|
11782
|
+
# index.
|
11311
11783
|
# @return [Array<String>]
|
11312
11784
|
#
|
11313
11785
|
# @!attribute [rw] url_exclusion_patterns
|
11314
|
-
#
|
11315
|
-
#
|
11316
|
-
#
|
11317
|
-
#
|
11318
|
-
# precedence
|
11786
|
+
# A list of regular expression patterns to exclude certain URLs to
|
11787
|
+
# crawl. URLs that match the patterns are excluded from the index.
|
11788
|
+
# URLs that don't match the patterns are included in the index. If a
|
11789
|
+
# URL matches both an inclusion and exclusion pattern, the exclusion
|
11790
|
+
# pattern takes precedence and the URL file isn't included in the
|
11791
|
+
# index.
|
11319
11792
|
# @return [Array<String>]
|
11320
11793
|
#
|
11321
11794
|
# @!attribute [rw] proxy_configuration
|
11322
|
-
#
|
11323
|
-
#
|
11795
|
+
# Configuration information required to connect to your internal
|
11796
|
+
# websites via a web proxy.
|
11324
11797
|
#
|
11325
11798
|
# You must provide the website host name and port number. For example,
|
11326
11799
|
# the host name of https://a.example.com/page1.html is
|
@@ -11336,8 +11809,8 @@ module Aws::Kendra
|
|
11336
11809
|
# @return [Types::ProxyConfiguration]
|
11337
11810
|
#
|
11338
11811
|
# @!attribute [rw] authentication_configuration
|
11339
|
-
#
|
11340
|
-
#
|
11812
|
+
# Configuration information required to connect to websites using
|
11813
|
+
# authentication.
|
11341
11814
|
#
|
11342
11815
|
# You can connect to websites using basic authentication of user name
|
11343
11816
|
# and password.
|
@@ -11418,43 +11891,37 @@ module Aws::Kendra
|
|
11418
11891
|
# @return [Boolean]
|
11419
11892
|
#
|
11420
11893
|
# @!attribute [rw] use_change_log
|
11421
|
-
# `TRUE` to use the change
|
11422
|
-
#
|
11423
|
-
#
|
11424
|
-
#
|
11425
|
-
# for the first time, all documents are scanned. After your first
|
11426
|
-
# sync, you can use the change logs to update your documents in your
|
11427
|
-
# index for future syncs.
|
11428
|
-
#
|
11429
|
-
# The default is set to `FALSE`.
|
11894
|
+
# `TRUE` to use the Amazon WorkDocs change log to determine which
|
11895
|
+
# documents require updating in the index. Depending on the change
|
11896
|
+
# log's size, it may take longer for Amazon Kendra to use the change
|
11897
|
+
# log than to scan all of your documents in Amazon WorkDocs.
|
11430
11898
|
# @return [Boolean]
|
11431
11899
|
#
|
11432
11900
|
# @!attribute [rw] inclusion_patterns
|
11433
11901
|
# A list of regular expression patterns to include certain files in
|
11434
11902
|
# your Amazon WorkDocs site repository. Files that match the patterns
|
11435
11903
|
# are included in the index. Files that don't match the patterns are
|
11436
|
-
# excluded from the index. If a file matches both an inclusion
|
11437
|
-
#
|
11438
|
-
#
|
11904
|
+
# excluded from the index. If a file matches both an inclusion and
|
11905
|
+
# exclusion pattern, the exclusion pattern takes precedence and the
|
11906
|
+
# file isn't included in the index.
|
11439
11907
|
# @return [Array<String>]
|
11440
11908
|
#
|
11441
11909
|
# @!attribute [rw] exclusion_patterns
|
11442
11910
|
# A list of regular expression patterns to exclude certain files in
|
11443
11911
|
# your Amazon WorkDocs site repository. Files that match the patterns
|
11444
11912
|
# are excluded from the index. Files that don’t match the patterns are
|
11445
|
-
# included in the index. If a file matches both an inclusion
|
11446
|
-
#
|
11447
|
-
#
|
11913
|
+
# included in the index. If a file matches both an inclusion and
|
11914
|
+
# exclusion pattern, the exclusion pattern takes precedence and the
|
11915
|
+
# file isn't included in the index.
|
11448
11916
|
# @return [Array<String>]
|
11449
11917
|
#
|
11450
11918
|
# @!attribute [rw] field_mappings
|
11451
11919
|
# A list of `DataSourceToIndexFieldMapping` objects that map Amazon
|
11452
|
-
# WorkDocs
|
11453
|
-
#
|
11454
|
-
#
|
11455
|
-
#
|
11456
|
-
#
|
11457
|
-
# WorkDocs custom metadata.
|
11920
|
+
# WorkDocs data source attributes or field names to Amazon Kendra
|
11921
|
+
# index field names. To create custom fields, use the `UpdateIndex`
|
11922
|
+
# API before you map to Amazon WorkDocs fields. For more information,
|
11923
|
+
# see [Mapping data source fields][1]. The Amazon WorkDocs data source
|
11924
|
+
# field names must exist in your Amazon WorkDocs custom metadata.
|
11458
11925
|
#
|
11459
11926
|
#
|
11460
11927
|
#
|