aws-sdk-kendra 1.45.0 → 1.48.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kendra/client.rb +230 -27
- data/lib/aws-sdk-kendra/client_api.rb +74 -0
- data/lib/aws-sdk-kendra/types.rb +1142 -334
- data/lib/aws-sdk-kendra.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-kendra/types.rb
CHANGED
|
@@ -1075,8 +1075,212 @@ module Aws::Kendra
|
|
|
1075
1075
|
include Aws::Structure
|
|
1076
1076
|
end
|
|
1077
1077
|
|
|
1078
|
-
#
|
|
1079
|
-
#
|
|
1078
|
+
# Provides the configuration information to connect to Box as your data
|
|
1079
|
+
# source.
|
|
1080
|
+
#
|
|
1081
|
+
# @note When making an API call, you may pass BoxConfiguration
|
|
1082
|
+
# data as a hash:
|
|
1083
|
+
#
|
|
1084
|
+
# {
|
|
1085
|
+
# enterprise_id: "EnterpriseId", # required
|
|
1086
|
+
# secret_arn: "SecretArn", # required
|
|
1087
|
+
# use_change_log: false,
|
|
1088
|
+
# crawl_comments: false,
|
|
1089
|
+
# crawl_tasks: false,
|
|
1090
|
+
# crawl_web_links: false,
|
|
1091
|
+
# file_field_mappings: [
|
|
1092
|
+
# {
|
|
1093
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
|
1094
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
|
1095
|
+
# index_field_name: "IndexFieldName", # required
|
|
1096
|
+
# },
|
|
1097
|
+
# ],
|
|
1098
|
+
# task_field_mappings: [
|
|
1099
|
+
# {
|
|
1100
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
|
1101
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
|
1102
|
+
# index_field_name: "IndexFieldName", # required
|
|
1103
|
+
# },
|
|
1104
|
+
# ],
|
|
1105
|
+
# comment_field_mappings: [
|
|
1106
|
+
# {
|
|
1107
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
|
1108
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
|
1109
|
+
# index_field_name: "IndexFieldName", # required
|
|
1110
|
+
# },
|
|
1111
|
+
# ],
|
|
1112
|
+
# web_link_field_mappings: [
|
|
1113
|
+
# {
|
|
1114
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
|
1115
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
|
1116
|
+
# index_field_name: "IndexFieldName", # required
|
|
1117
|
+
# },
|
|
1118
|
+
# ],
|
|
1119
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
|
1120
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
|
1121
|
+
# vpc_configuration: {
|
|
1122
|
+
# subnet_ids: ["SubnetId"], # required
|
|
1123
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
|
1124
|
+
# },
|
|
1125
|
+
# }
|
|
1126
|
+
#
|
|
1127
|
+
# @!attribute [rw] enterprise_id
|
|
1128
|
+
# The identifier of the Box Enterprise platform. You can find the
|
|
1129
|
+
# enterprise ID in the Box Developer Console settings or when you
|
|
1130
|
+
# create an app in Box and download your authentication credentials.
|
|
1131
|
+
# For example, *801234567*.
|
|
1132
|
+
# @return [String]
|
|
1133
|
+
#
|
|
1134
|
+
# @!attribute [rw] secret_arn
|
|
1135
|
+
# The Amazon Resource Name (ARN) of an Secrets Manager secret that
|
|
1136
|
+
# contains the key-value pairs required to connect to your Box
|
|
1137
|
+
# platform. The secret must contain a JSON structure with the
|
|
1138
|
+
# following keys:
|
|
1139
|
+
#
|
|
1140
|
+
# * clientID—The identifier of the client OAuth 2.0 authentication
|
|
1141
|
+
# application created in Box.
|
|
1142
|
+
#
|
|
1143
|
+
# * clientSecret—A set of characters known only to the OAuth 2.0
|
|
1144
|
+
# authentication application created in Box.
|
|
1145
|
+
#
|
|
1146
|
+
# * publicKeyId—The identifier of the public key contained within an
|
|
1147
|
+
# identity certificate.
|
|
1148
|
+
#
|
|
1149
|
+
# * privateKey—A set of characters that make up an encryption key.
|
|
1150
|
+
#
|
|
1151
|
+
# * passphrase—A set of characters that act like a password.
|
|
1152
|
+
#
|
|
1153
|
+
# You create an application in Box to generate the keys or credentials
|
|
1154
|
+
# required for the secret. For more information, see [Authentication
|
|
1155
|
+
# for a Box data source][1].
|
|
1156
|
+
#
|
|
1157
|
+
#
|
|
1158
|
+
#
|
|
1159
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-box.html#box-authentication
|
|
1160
|
+
# @return [String]
|
|
1161
|
+
#
|
|
1162
|
+
# @!attribute [rw] use_change_log
|
|
1163
|
+
# `TRUE` to use the Slack change log to determine which documents
|
|
1164
|
+
# require updating in the index. Depending on the data source change
|
|
1165
|
+
# log's size, it may take longer for Amazon Kendra to use the change
|
|
1166
|
+
# log than to scan all of your documents.
|
|
1167
|
+
# @return [Boolean]
|
|
1168
|
+
#
|
|
1169
|
+
# @!attribute [rw] crawl_comments
|
|
1170
|
+
# `TRUE` to index comments.
|
|
1171
|
+
# @return [Boolean]
|
|
1172
|
+
#
|
|
1173
|
+
# @!attribute [rw] crawl_tasks
|
|
1174
|
+
# `TRUE` to index the contents of tasks.
|
|
1175
|
+
# @return [Boolean]
|
|
1176
|
+
#
|
|
1177
|
+
# @!attribute [rw] crawl_web_links
|
|
1178
|
+
# `TRUE` to index web links.
|
|
1179
|
+
# @return [Boolean]
|
|
1180
|
+
#
|
|
1181
|
+
# @!attribute [rw] file_field_mappings
|
|
1182
|
+
# A list of `DataSourceToIndexFieldMapping` objects that map
|
|
1183
|
+
# attributes or field names of Box files to Amazon Kendra index field
|
|
1184
|
+
# names. To create custom fields, use the `UpdateIndex` API before you
|
|
1185
|
+
# map to Box fields. For more information, see [Mapping data source
|
|
1186
|
+
# fields][1]. The Box field names must exist in your Box custom
|
|
1187
|
+
# metadata.
|
|
1188
|
+
#
|
|
1189
|
+
#
|
|
1190
|
+
#
|
|
1191
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
|
1192
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
|
1193
|
+
#
|
|
1194
|
+
# @!attribute [rw] task_field_mappings
|
|
1195
|
+
# A list of `DataSourceToIndexFieldMapping` objects that map
|
|
1196
|
+
# attributes or field names of Box tasks to Amazon Kendra index field
|
|
1197
|
+
# names. To create custom fields, use the `UpdateIndex` API before you
|
|
1198
|
+
# map to Box fields. For more information, see [Mapping data source
|
|
1199
|
+
# fields][1]. The Box field names must exist in your Box custom
|
|
1200
|
+
# metadata.
|
|
1201
|
+
#
|
|
1202
|
+
#
|
|
1203
|
+
#
|
|
1204
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
|
1205
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
|
1206
|
+
#
|
|
1207
|
+
# @!attribute [rw] comment_field_mappings
|
|
1208
|
+
# A list of `DataSourceToIndexFieldMapping` objects that map
|
|
1209
|
+
# attributes or field names of Box comments to Amazon Kendra index
|
|
1210
|
+
# field names. To create custom fields, use the `UpdateIndex` API
|
|
1211
|
+
# before you map to Box fields. For more information, see [Mapping
|
|
1212
|
+
# data source fields][1]. The Box field names must exist in your Box
|
|
1213
|
+
# custom metadata.
|
|
1214
|
+
#
|
|
1215
|
+
#
|
|
1216
|
+
#
|
|
1217
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
|
1218
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
|
1219
|
+
#
|
|
1220
|
+
# @!attribute [rw] web_link_field_mappings
|
|
1221
|
+
# A list of `DataSourceToIndexFieldMapping` objects that map
|
|
1222
|
+
# attributes or field names of Box web links to Amazon Kendra index
|
|
1223
|
+
# field names. To create custom fields, use the `UpdateIndex` API
|
|
1224
|
+
# before you map to Box fields. For more information, see [Mapping
|
|
1225
|
+
# data source fields][1]. The Box field names must exist in your Box
|
|
1226
|
+
# custom metadata.
|
|
1227
|
+
#
|
|
1228
|
+
#
|
|
1229
|
+
#
|
|
1230
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
|
1231
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
|
1232
|
+
#
|
|
1233
|
+
# @!attribute [rw] inclusion_patterns
|
|
1234
|
+
# A list of regular expression patterns to include certain files and
|
|
1235
|
+
# folders in your Box platform. Files and folders that match the
|
|
1236
|
+
# patterns are included in the index. Files and folders that don't
|
|
1237
|
+
# match the patterns are excluded from the index. If a file or folder
|
|
1238
|
+
# matches both an inclusion and exclusion pattern, the exclusion
|
|
1239
|
+
# pattern takes precedence and the file or folder isn't included in
|
|
1240
|
+
# the index.
|
|
1241
|
+
# @return [Array<String>]
|
|
1242
|
+
#
|
|
1243
|
+
# @!attribute [rw] exclusion_patterns
|
|
1244
|
+
# A list of regular expression patterns to exclude certain files and
|
|
1245
|
+
# folders from your Box platform. Files and folders that match the
|
|
1246
|
+
# patterns are excluded from the index.Files and folders that don't
|
|
1247
|
+
# match the patterns are included in the index. If a file or folder
|
|
1248
|
+
# matches both an inclusion and exclusion pattern, the exclusion
|
|
1249
|
+
# pattern takes precedence and the file or folder isn't included in
|
|
1250
|
+
# the index.
|
|
1251
|
+
# @return [Array<String>]
|
|
1252
|
+
#
|
|
1253
|
+
# @!attribute [rw] vpc_configuration
|
|
1254
|
+
# Configuration information for an Amazon VPC to connect to your Box.
|
|
1255
|
+
# For more information, see [Configuring a VPC][1].
|
|
1256
|
+
#
|
|
1257
|
+
#
|
|
1258
|
+
#
|
|
1259
|
+
# [1]: https://docs.aws.amazon.com/endra/latest/dg/vpc-configuration.html
|
|
1260
|
+
# @return [Types::DataSourceVpcConfiguration]
|
|
1261
|
+
#
|
|
1262
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/BoxConfiguration AWS API Documentation
|
|
1263
|
+
#
|
|
1264
|
+
class BoxConfiguration < Struct.new(
|
|
1265
|
+
:enterprise_id,
|
|
1266
|
+
:secret_arn,
|
|
1267
|
+
:use_change_log,
|
|
1268
|
+
:crawl_comments,
|
|
1269
|
+
:crawl_tasks,
|
|
1270
|
+
:crawl_web_links,
|
|
1271
|
+
:file_field_mappings,
|
|
1272
|
+
:task_field_mappings,
|
|
1273
|
+
:comment_field_mappings,
|
|
1274
|
+
:web_link_field_mappings,
|
|
1275
|
+
:inclusion_patterns,
|
|
1276
|
+
:exclusion_patterns,
|
|
1277
|
+
:vpc_configuration)
|
|
1278
|
+
SENSITIVE = []
|
|
1279
|
+
include Aws::Structure
|
|
1280
|
+
end
|
|
1281
|
+
|
|
1282
|
+
# Specifies additional capacity units configured for your Enterprise
|
|
1283
|
+
# Edition index. You can add and remove capacity units to fit your usage
|
|
1080
1284
|
# requirements.
|
|
1081
1285
|
#
|
|
1082
1286
|
# @note When making an API call, you may pass CapacityUnitsConfiguration
|
|
@@ -1238,7 +1442,7 @@ module Aws::Kendra
|
|
|
1238
1442
|
include Aws::Structure
|
|
1239
1443
|
end
|
|
1240
1444
|
|
|
1241
|
-
#
|
|
1445
|
+
# Configuration of attachment settings for the Confluence data source.
|
|
1242
1446
|
# Attachment settings are optional, if you don't specify settings
|
|
1243
1447
|
# attachments, Amazon Kendra won't index them.
|
|
1244
1448
|
#
|
|
@@ -1262,13 +1466,19 @@ module Aws::Kendra
|
|
|
1262
1466
|
# @return [Boolean]
|
|
1263
1467
|
#
|
|
1264
1468
|
# @!attribute [rw] attachment_field_mappings
|
|
1265
|
-
#
|
|
1266
|
-
#
|
|
1267
|
-
#
|
|
1268
|
-
#
|
|
1469
|
+
# Maps attributes or field names of Confluence attachments to Amazon
|
|
1470
|
+
# Kendra index field names. To create custom fields, use the
|
|
1471
|
+
# `UpdateIndex` API before you map to Confluence fields. For more
|
|
1472
|
+
# information, see [Mapping data source fields][1]. The Confluence
|
|
1473
|
+
# data source field names must exist in your Confluence custom
|
|
1474
|
+
# metadata.
|
|
1269
1475
|
#
|
|
1270
1476
|
# If you specify the `AttachentFieldMappings` parameter, you must
|
|
1271
1477
|
# specify at least one field mapping.
|
|
1478
|
+
#
|
|
1479
|
+
#
|
|
1480
|
+
#
|
|
1481
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
|
1272
1482
|
# @return [Array<Types::ConfluenceAttachmentToIndexFieldMapping>]
|
|
1273
1483
|
#
|
|
1274
1484
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConfluenceAttachmentConfiguration AWS API Documentation
|
|
@@ -1280,10 +1490,15 @@ module Aws::Kendra
|
|
|
1280
1490
|
include Aws::Structure
|
|
1281
1491
|
end
|
|
1282
1492
|
|
|
1283
|
-
#
|
|
1284
|
-
#
|
|
1493
|
+
# Maps attributes or field names of Confluence attachments to Amazon
|
|
1494
|
+
# Kendra index field names. To create custom fields, use the
|
|
1495
|
+
# `UpdateIndex` API before you map to Confluence fields. For more
|
|
1496
|
+
# information, see [Mapping data source fields][1]. The Confuence data
|
|
1497
|
+
# source field names must exist in your Confluence custom metadata.
|
|
1498
|
+
#
|
|
1499
|
+
#
|
|
1285
1500
|
#
|
|
1286
|
-
#
|
|
1501
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
|
1287
1502
|
#
|
|
1288
1503
|
# @note When making an API call, you may pass ConfluenceAttachmentToIndexFieldMapping
|
|
1289
1504
|
# data as a hash:
|
|
@@ -1322,8 +1537,8 @@ module Aws::Kendra
|
|
|
1322
1537
|
include Aws::Structure
|
|
1323
1538
|
end
|
|
1324
1539
|
|
|
1325
|
-
#
|
|
1326
|
-
# always indexed unless filtered from the index by the
|
|
1540
|
+
# Configuration of blog settings for the Confluence data source. Blogs
|
|
1541
|
+
# are always indexed unless filtered from the index by the
|
|
1327
1542
|
# `ExclusionPatterns` or `InclusionPatterns` fields in the
|
|
1328
1543
|
# `ConfluenceConfiguration` object.
|
|
1329
1544
|
#
|
|
@@ -1341,12 +1556,18 @@ module Aws::Kendra
|
|
|
1341
1556
|
# }
|
|
1342
1557
|
#
|
|
1343
1558
|
# @!attribute [rw] blog_field_mappings
|
|
1344
|
-
#
|
|
1345
|
-
#
|
|
1346
|
-
#
|
|
1559
|
+
# Maps attributes or field names of Confluence blogs to Amazon Kendra
|
|
1560
|
+
# index field names. To create custom fields, use the `UpdateIndex`
|
|
1561
|
+
# API before you map to Confluence fields. For more information, see
|
|
1562
|
+
# [Mapping data source fields][1]. The Confluence data source field
|
|
1563
|
+
# names must exist in your Confluence custom metadata.
|
|
1347
1564
|
#
|
|
1348
1565
|
# If you specify the `BlogFieldMappings` parameter, you must specify
|
|
1349
1566
|
# at least one field mapping.
|
|
1567
|
+
#
|
|
1568
|
+
#
|
|
1569
|
+
#
|
|
1570
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
|
1350
1571
|
# @return [Array<Types::ConfluenceBlogToIndexFieldMapping>]
|
|
1351
1572
|
#
|
|
1352
1573
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConfluenceBlogConfiguration AWS API Documentation
|
|
@@ -1357,10 +1578,15 @@ module Aws::Kendra
|
|
|
1357
1578
|
include Aws::Structure
|
|
1358
1579
|
end
|
|
1359
1580
|
|
|
1360
|
-
#
|
|
1361
|
-
#
|
|
1581
|
+
# Maps attributes or field names of Confluence blog to Amazon Kendra
|
|
1582
|
+
# index field names. To create custom fields, use the `UpdateIndex` API
|
|
1583
|
+
# before you map to Confluence fields. For more information, see
|
|
1584
|
+
# [Mapping data source fields][1]. The Confluence data source field
|
|
1585
|
+
# names must exist in your Confluence custom metadata.
|
|
1362
1586
|
#
|
|
1363
|
-
#
|
|
1587
|
+
#
|
|
1588
|
+
#
|
|
1589
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
|
1364
1590
|
#
|
|
1365
1591
|
# @note When making an API call, you may pass ConfluenceBlogToIndexFieldMapping
|
|
1366
1592
|
# data as a hash:
|
|
@@ -1397,8 +1623,8 @@ module Aws::Kendra
|
|
|
1397
1623
|
include Aws::Structure
|
|
1398
1624
|
end
|
|
1399
1625
|
|
|
1400
|
-
# Provides configuration information
|
|
1401
|
-
#
|
|
1626
|
+
# Provides the configuration information to connect to Confluence as
|
|
1627
|
+
# your data source.
|
|
1402
1628
|
#
|
|
1403
1629
|
# @note When making an API call, you may pass ConfluenceConfiguration
|
|
1404
1630
|
# data as a hash:
|
|
@@ -1458,20 +1684,20 @@ module Aws::Kendra
|
|
|
1458
1684
|
#
|
|
1459
1685
|
# @!attribute [rw] server_url
|
|
1460
1686
|
# The URL of your Confluence instance. Use the full URL of the server.
|
|
1461
|
-
# For example,
|
|
1462
|
-
# IP address, for example,
|
|
1687
|
+
# For example, *https://server.example.com:port/*. You can also use an
|
|
1688
|
+
# IP address, for example, *https://192.168.1.113/*.
|
|
1463
1689
|
# @return [String]
|
|
1464
1690
|
#
|
|
1465
1691
|
# @!attribute [rw] secret_arn
|
|
1466
1692
|
# The Amazon Resource Name (ARN) of an Secrets Manager secret that
|
|
1467
|
-
# contains the key
|
|
1693
|
+
# contains the key-value pairs required to connect to your Confluence
|
|
1468
1694
|
# server. The secret must contain a JSON structure with the following
|
|
1469
1695
|
# keys:
|
|
1470
1696
|
#
|
|
1471
|
-
# * username
|
|
1697
|
+
# * username—The user name or email address of a user with
|
|
1472
1698
|
# administrative privileges for the Confluence server.
|
|
1473
1699
|
#
|
|
1474
|
-
# * password
|
|
1700
|
+
# * password—The password associated with the user logging in to the
|
|
1475
1701
|
# Confluence server.
|
|
1476
1702
|
# @return [String]
|
|
1477
1703
|
#
|
|
@@ -1481,43 +1707,50 @@ module Aws::Kendra
|
|
|
1481
1707
|
# @return [String]
|
|
1482
1708
|
#
|
|
1483
1709
|
# @!attribute [rw] space_configuration
|
|
1484
|
-
#
|
|
1710
|
+
# Configuration information for indexing Confluence spaces.
|
|
1485
1711
|
# @return [Types::ConfluenceSpaceConfiguration]
|
|
1486
1712
|
#
|
|
1487
1713
|
# @!attribute [rw] page_configuration
|
|
1488
|
-
#
|
|
1714
|
+
# Configuration information for indexing Confluence pages.
|
|
1489
1715
|
# @return [Types::ConfluencePageConfiguration]
|
|
1490
1716
|
#
|
|
1491
1717
|
# @!attribute [rw] blog_configuration
|
|
1492
|
-
#
|
|
1718
|
+
# Configuration information for indexing Confluence blogs.
|
|
1493
1719
|
# @return [Types::ConfluenceBlogConfiguration]
|
|
1494
1720
|
#
|
|
1495
1721
|
# @!attribute [rw] attachment_configuration
|
|
1496
|
-
#
|
|
1497
|
-
#
|
|
1722
|
+
# Configuration information for indexing attachments to Confluence
|
|
1723
|
+
# blogs and pages.
|
|
1498
1724
|
# @return [Types::ConfluenceAttachmentConfiguration]
|
|
1499
1725
|
#
|
|
1500
1726
|
# @!attribute [rw] vpc_configuration
|
|
1501
|
-
#
|
|
1727
|
+
# Configuration information for an Amazon Virtual Private Cloud to
|
|
1728
|
+
# connect to your Confluence. For more information, see [Configuring a
|
|
1729
|
+
# VPC][1].
|
|
1730
|
+
#
|
|
1731
|
+
#
|
|
1732
|
+
#
|
|
1733
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
|
|
1502
1734
|
# @return [Types::DataSourceVpcConfiguration]
|
|
1503
1735
|
#
|
|
1504
1736
|
# @!attribute [rw] inclusion_patterns
|
|
1505
|
-
# A list of regular expression patterns
|
|
1506
|
-
#
|
|
1507
|
-
#
|
|
1508
|
-
#
|
|
1509
|
-
#
|
|
1510
|
-
# pattern
|
|
1737
|
+
# A list of regular expression patterns to include certain blog posts,
|
|
1738
|
+
# pages, spaces, or attachments in your Confluence. Content that
|
|
1739
|
+
# matches the patterns are included in the index. Content that
|
|
1740
|
+
# doesn't match the patterns is excluded from the index. If content
|
|
1741
|
+
# matches both an inclusion and exclusion pattern, the exclusion
|
|
1742
|
+
# pattern takes precedence and the content isn't included in the
|
|
1511
1743
|
# index.
|
|
1512
1744
|
# @return [Array<String>]
|
|
1513
1745
|
#
|
|
1514
1746
|
# @!attribute [rw] exclusion_patterns
|
|
1515
|
-
# A list of regular expression patterns
|
|
1516
|
-
#
|
|
1517
|
-
#
|
|
1518
|
-
#
|
|
1519
|
-
#
|
|
1520
|
-
#
|
|
1747
|
+
# >A list of regular expression patterns to exclude certain blog
|
|
1748
|
+
# posts, pages, spaces, or attachments in your Confluence. Content
|
|
1749
|
+
# that matches the patterns are excluded from the index. Content that
|
|
1750
|
+
# doesn't match the patterns is included in the index. If content
|
|
1751
|
+
# matches both an inclusion and exclusion pattern, the exclusion
|
|
1752
|
+
# pattern takes precedence and the content isn't included in the
|
|
1753
|
+
# index.
|
|
1521
1754
|
# @return [Array<String>]
|
|
1522
1755
|
#
|
|
1523
1756
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConfluenceConfiguration AWS API Documentation
|
|
@@ -1537,7 +1770,7 @@ module Aws::Kendra
|
|
|
1537
1770
|
include Aws::Structure
|
|
1538
1771
|
end
|
|
1539
1772
|
|
|
1540
|
-
#
|
|
1773
|
+
# Configuration of the page settings for the Confluence data source.
|
|
1541
1774
|
#
|
|
1542
1775
|
# @note When making an API call, you may pass ConfluencePageConfiguration
|
|
1543
1776
|
# data as a hash:
|
|
@@ -1553,12 +1786,19 @@ module Aws::Kendra
|
|
|
1553
1786
|
# }
|
|
1554
1787
|
#
|
|
1555
1788
|
# @!attribute [rw] page_field_mappings
|
|
1556
|
-
#
|
|
1557
|
-
#
|
|
1558
|
-
#
|
|
1789
|
+
# >Maps attributes or field names of Confluence pages to Amazon
|
|
1790
|
+
# Kendra index field names. To create custom fields, use the
|
|
1791
|
+
# `UpdateIndex` API before you map to Confluence fields. For more
|
|
1792
|
+
# information, see [Mapping data source fields][1]. The Confluence
|
|
1793
|
+
# data source field names must exist in your Confluence custom
|
|
1794
|
+
# metadata.
|
|
1559
1795
|
#
|
|
1560
1796
|
# If you specify the `PageFieldMappings` parameter, you must specify
|
|
1561
1797
|
# at least one field mapping.
|
|
1798
|
+
#
|
|
1799
|
+
#
|
|
1800
|
+
#
|
|
1801
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
|
1562
1802
|
# @return [Array<Types::ConfluencePageToIndexFieldMapping>]
|
|
1563
1803
|
#
|
|
1564
1804
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConfluencePageConfiguration AWS API Documentation
|
|
@@ -1569,10 +1809,15 @@ module Aws::Kendra
|
|
|
1569
1809
|
include Aws::Structure
|
|
1570
1810
|
end
|
|
1571
1811
|
|
|
1572
|
-
#
|
|
1573
|
-
#
|
|
1812
|
+
# >Maps attributes or field names of Confluence pages to Amazon
|
|
1813
|
+
# Kendra index field names. To create custom fields, use the
|
|
1814
|
+
# `UpdateIndex` API before you map to Confluence fields. For more
|
|
1815
|
+
# information, see [Mapping data source fields][1]. The Confluence data
|
|
1816
|
+
# source field names must exist in your Confluence custom metadata.
|
|
1817
|
+
#
|
|
1574
1818
|
#
|
|
1575
|
-
#
|
|
1819
|
+
#
|
|
1820
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
|
1576
1821
|
#
|
|
1577
1822
|
# @note When making an API call, you may pass ConfluencePageToIndexFieldMapping
|
|
1578
1823
|
# data as a hash:
|
|
@@ -1609,7 +1854,7 @@ module Aws::Kendra
|
|
|
1609
1854
|
include Aws::Structure
|
|
1610
1855
|
end
|
|
1611
1856
|
|
|
1612
|
-
#
|
|
1857
|
+
# Configuration information for indexing Confluence spaces.
|
|
1613
1858
|
#
|
|
1614
1859
|
# @note When making an API call, you may pass ConfluenceSpaceConfiguration
|
|
1615
1860
|
# data as a hash:
|
|
@@ -1661,12 +1906,18 @@ module Aws::Kendra
|
|
|
1661
1906
|
# @return [Array<String>]
|
|
1662
1907
|
#
|
|
1663
1908
|
# @!attribute [rw] space_field_mappings
|
|
1664
|
-
#
|
|
1665
|
-
#
|
|
1666
|
-
#
|
|
1909
|
+
# Maps attributes or field names of Confluence spaces to Amazon Kendra
|
|
1910
|
+
# index field names. To create custom fields, use the `UpdateIndex`
|
|
1911
|
+
# API before you map to Confluence fields. For more information, see
|
|
1912
|
+
# [Mapping data source fields][1]. The Confluence data source field
|
|
1913
|
+
# names must exist in your Confluence custom metadata.
|
|
1667
1914
|
#
|
|
1668
1915
|
# If you specify the `SpaceFieldMappings` parameter, you must specify
|
|
1669
1916
|
# at least one field mapping.
|
|
1917
|
+
#
|
|
1918
|
+
#
|
|
1919
|
+
#
|
|
1920
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
|
1670
1921
|
# @return [Array<Types::ConfluenceSpaceToIndexFieldMapping>]
|
|
1671
1922
|
#
|
|
1672
1923
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConfluenceSpaceConfiguration AWS API Documentation
|
|
@@ -1681,10 +1932,15 @@ module Aws::Kendra
|
|
|
1681
1932
|
include Aws::Structure
|
|
1682
1933
|
end
|
|
1683
1934
|
|
|
1684
|
-
#
|
|
1685
|
-
#
|
|
1935
|
+
# >Maps attributes or field names of Confluence spaces to Amazon
|
|
1936
|
+
# Kendra index field names. To create custom fields, use the
|
|
1937
|
+
# `UpdateIndex` API before you map to Confluence fields. For more
|
|
1938
|
+
# information, see [Mapping data source fields][1]. The Confluence data
|
|
1939
|
+
# source field names must exist in your Confluence custom metadata.
|
|
1940
|
+
#
|
|
1686
1941
|
#
|
|
1687
|
-
#
|
|
1942
|
+
#
|
|
1943
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
|
1688
1944
|
#
|
|
1689
1945
|
# @note When making an API call, you may pass ConfluenceSpaceToIndexFieldMapping
|
|
1690
1946
|
# data as a hash:
|
|
@@ -1721,7 +1977,8 @@ module Aws::Kendra
|
|
|
1721
1977
|
include Aws::Structure
|
|
1722
1978
|
end
|
|
1723
1979
|
|
|
1724
|
-
# Provides the information
|
|
1980
|
+
# Provides the configuration information that's required to connect to
|
|
1981
|
+
# a database.
|
|
1725
1982
|
#
|
|
1726
1983
|
# @note When making an API call, you may pass ConnectionConfiguration
|
|
1727
1984
|
# data as a hash:
|
|
@@ -1776,8 +2033,9 @@ module Aws::Kendra
|
|
|
1776
2033
|
include Aws::Structure
|
|
1777
2034
|
end
|
|
1778
2035
|
|
|
1779
|
-
#
|
|
1780
|
-
# sources, FAQs, and content indexed directly via
|
|
2036
|
+
# Provides the configuration information for your content sources, such
|
|
2037
|
+
# as data sources, FAQs, and content indexed directly via
|
|
2038
|
+
# [BatchPutDocument][1].
|
|
1781
2039
|
#
|
|
1782
2040
|
#
|
|
1783
2041
|
#
|
|
@@ -1817,13 +2075,44 @@ module Aws::Kendra
|
|
|
1817
2075
|
include Aws::Structure
|
|
1818
2076
|
end
|
|
1819
2077
|
|
|
2078
|
+
# A corrected misspelled word in a query.
|
|
2079
|
+
#
|
|
2080
|
+
# @!attribute [rw] begin_offset
|
|
2081
|
+
# The zero-based location in the response string or text where the
|
|
2082
|
+
# corrected word starts.
|
|
2083
|
+
# @return [Integer]
|
|
2084
|
+
#
|
|
2085
|
+
# @!attribute [rw] end_offset
|
|
2086
|
+
# The zero-based location in the response string or text where the
|
|
2087
|
+
# corrected word ends.
|
|
2088
|
+
# @return [Integer]
|
|
2089
|
+
#
|
|
2090
|
+
# @!attribute [rw] term
|
|
2091
|
+
# The string or text of a misspelled word in a query.
|
|
2092
|
+
# @return [String]
|
|
2093
|
+
#
|
|
2094
|
+
# @!attribute [rw] corrected_term
|
|
2095
|
+
# The string or text of a corrected misspelled word in a query.
|
|
2096
|
+
# @return [String]
|
|
2097
|
+
#
|
|
2098
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Correction AWS API Documentation
|
|
2099
|
+
#
|
|
2100
|
+
class Correction < Struct.new(
|
|
2101
|
+
:begin_offset,
|
|
2102
|
+
:end_offset,
|
|
2103
|
+
:term,
|
|
2104
|
+
:corrected_term)
|
|
2105
|
+
SENSITIVE = []
|
|
2106
|
+
include Aws::Structure
|
|
2107
|
+
end
|
|
2108
|
+
|
|
1820
2109
|
# @note When making an API call, you may pass CreateDataSourceRequest
|
|
1821
2110
|
# data as a hash:
|
|
1822
2111
|
#
|
|
1823
2112
|
# {
|
|
1824
2113
|
# name: "DataSourceName", # required
|
|
1825
2114
|
# index_id: "IndexId", # required
|
|
1826
|
-
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX
|
|
2115
|
+
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX, SLACK, BOX
|
|
1827
2116
|
# configuration: {
|
|
1828
2117
|
# s3_configuration: {
|
|
1829
2118
|
# bucket_name: "S3BucketName", # required
|
|
@@ -2153,6 +2442,73 @@ module Aws::Kendra
|
|
|
2153
2442
|
# },
|
|
2154
2443
|
# ],
|
|
2155
2444
|
# },
|
|
2445
|
+
# slack_configuration: {
|
|
2446
|
+
# team_id: "TeamId", # required
|
|
2447
|
+
# secret_arn: "SecretArn", # required
|
|
2448
|
+
# vpc_configuration: {
|
|
2449
|
+
# subnet_ids: ["SubnetId"], # required
|
|
2450
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
|
2451
|
+
# },
|
|
2452
|
+
# slack_entity_list: ["PUBLIC_CHANNEL"], # required, accepts PUBLIC_CHANNEL, PRIVATE_CHANNEL, GROUP_MESSAGE, DIRECT_MESSAGE
|
|
2453
|
+
# use_change_log: false,
|
|
2454
|
+
# crawl_bot_message: false,
|
|
2455
|
+
# exclude_archived: false,
|
|
2456
|
+
# since_crawl_date: "SinceCrawlDate", # required
|
|
2457
|
+
# look_back_period: 1,
|
|
2458
|
+
# private_channel_filter: ["String"],
|
|
2459
|
+
# public_channel_filter: ["String"],
|
|
2460
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
|
2461
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
|
2462
|
+
# field_mappings: [
|
|
2463
|
+
# {
|
|
2464
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
|
2465
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
|
2466
|
+
# index_field_name: "IndexFieldName", # required
|
|
2467
|
+
# },
|
|
2468
|
+
# ],
|
|
2469
|
+
# },
|
|
2470
|
+
# box_configuration: {
|
|
2471
|
+
# enterprise_id: "EnterpriseId", # required
|
|
2472
|
+
# secret_arn: "SecretArn", # required
|
|
2473
|
+
# use_change_log: false,
|
|
2474
|
+
# crawl_comments: false,
|
|
2475
|
+
# crawl_tasks: false,
|
|
2476
|
+
# crawl_web_links: false,
|
|
2477
|
+
# file_field_mappings: [
|
|
2478
|
+
# {
|
|
2479
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
|
2480
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
|
2481
|
+
# index_field_name: "IndexFieldName", # required
|
|
2482
|
+
# },
|
|
2483
|
+
# ],
|
|
2484
|
+
# task_field_mappings: [
|
|
2485
|
+
# {
|
|
2486
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
|
2487
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
|
2488
|
+
# index_field_name: "IndexFieldName", # required
|
|
2489
|
+
# },
|
|
2490
|
+
# ],
|
|
2491
|
+
# comment_field_mappings: [
|
|
2492
|
+
# {
|
|
2493
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
|
2494
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
|
2495
|
+
# index_field_name: "IndexFieldName", # required
|
|
2496
|
+
# },
|
|
2497
|
+
# ],
|
|
2498
|
+
# web_link_field_mappings: [
|
|
2499
|
+
# {
|
|
2500
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
|
2501
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
|
2502
|
+
# index_field_name: "IndexFieldName", # required
|
|
2503
|
+
# },
|
|
2504
|
+
# ],
|
|
2505
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
|
2506
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
|
2507
|
+
# vpc_configuration: {
|
|
2508
|
+
# subnet_ids: ["SubnetId"], # required
|
|
2509
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
|
2510
|
+
# },
|
|
2511
|
+
# },
|
|
2156
2512
|
# },
|
|
2157
2513
|
# description: "Description",
|
|
2158
2514
|
# schedule: "ScanSchedule",
|
|
@@ -2238,8 +2594,8 @@ module Aws::Kendra
|
|
|
2238
2594
|
# @return [String]
|
|
2239
2595
|
#
|
|
2240
2596
|
# @!attribute [rw] configuration
|
|
2241
|
-
#
|
|
2242
|
-
#
|
|
2597
|
+
# Configuration information that is required to access the data source
|
|
2598
|
+
# repository.
|
|
2243
2599
|
#
|
|
2244
2600
|
# You can't specify the `Configuration` parameter when the `Type`
|
|
2245
2601
|
# parameter is set to `CUSTOM`. If you do, you receive a
|
|
@@ -2392,11 +2748,11 @@ module Aws::Kendra
|
|
|
2392
2748
|
# @return [String]
|
|
2393
2749
|
#
|
|
2394
2750
|
# @!attribute [rw] configuration
|
|
2395
|
-
#
|
|
2396
|
-
#
|
|
2397
|
-
#
|
|
2398
|
-
#
|
|
2399
|
-
#
|
|
2751
|
+
# Configuration information for your Amazon Kendra experience. This
|
|
2752
|
+
# includes `ContentSourceConfiguration`, which specifies the data
|
|
2753
|
+
# source IDs and/or FAQ IDs, and `UserIdentityConfiguration`, which
|
|
2754
|
+
# specifies the user or group information to grant access to your
|
|
2755
|
+
# Amazon Kendra experience.
|
|
2400
2756
|
# @return [Types::ExperienceConfiguration]
|
|
2401
2757
|
#
|
|
2402
2758
|
# @!attribute [rw] description
|
|
@@ -2620,14 +2976,14 @@ module Aws::Kendra
|
|
|
2620
2976
|
# @return [String]
|
|
2621
2977
|
#
|
|
2622
2978
|
# @!attribute [rw] role_arn
|
|
2623
|
-
# An Identity and Access Management(IAM) role that gives Amazon
|
|
2624
|
-
# permissions to access your Amazon CloudWatch logs and
|
|
2625
|
-
# is also the role
|
|
2626
|
-
# index documents from an Amazon S3 bucket.
|
|
2979
|
+
# An Identity and Access Management (IAM) role that gives Amazon
|
|
2980
|
+
# Kendra permissions to access your Amazon CloudWatch logs and
|
|
2981
|
+
# metrics. This is also the role you use when you call the
|
|
2982
|
+
# `BatchPutDocument` API to index documents from an Amazon S3 bucket.
|
|
2627
2983
|
# @return [String]
|
|
2628
2984
|
#
|
|
2629
2985
|
# @!attribute [rw] server_side_encryption_configuration
|
|
2630
|
-
# The identifier of the
|
|
2986
|
+
# The identifier of the KMS customer managed key (CMK) that's used to
|
|
2631
2987
|
# encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't
|
|
2632
2988
|
# support asymmetric CMKs.
|
|
2633
2989
|
# @return [Types::ServerSideEncryptionConfiguration]
|
|
@@ -3022,7 +3378,8 @@ module Aws::Kendra
|
|
|
3022
3378
|
include Aws::Structure
|
|
3023
3379
|
end
|
|
3024
3380
|
|
|
3025
|
-
#
|
|
3381
|
+
# Provides the configuration information for an Amazon Kendra data
|
|
3382
|
+
# source.
|
|
3026
3383
|
#
|
|
3027
3384
|
# @note When making an API call, you may pass DataSourceConfiguration
|
|
3028
3385
|
# data as a hash:
|
|
@@ -3356,46 +3713,113 @@ module Aws::Kendra
|
|
|
3356
3713
|
# },
|
|
3357
3714
|
# ],
|
|
3358
3715
|
# },
|
|
3716
|
+
# slack_configuration: {
|
|
3717
|
+
# team_id: "TeamId", # required
|
|
3718
|
+
# secret_arn: "SecretArn", # required
|
|
3719
|
+
# vpc_configuration: {
|
|
3720
|
+
# subnet_ids: ["SubnetId"], # required
|
|
3721
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
|
3722
|
+
# },
|
|
3723
|
+
# slack_entity_list: ["PUBLIC_CHANNEL"], # required, accepts PUBLIC_CHANNEL, PRIVATE_CHANNEL, GROUP_MESSAGE, DIRECT_MESSAGE
|
|
3724
|
+
# use_change_log: false,
|
|
3725
|
+
# crawl_bot_message: false,
|
|
3726
|
+
# exclude_archived: false,
|
|
3727
|
+
# since_crawl_date: "SinceCrawlDate", # required
|
|
3728
|
+
# look_back_period: 1,
|
|
3729
|
+
# private_channel_filter: ["String"],
|
|
3730
|
+
# public_channel_filter: ["String"],
|
|
3731
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
|
3732
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
|
3733
|
+
# field_mappings: [
|
|
3734
|
+
# {
|
|
3735
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
|
3736
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
|
3737
|
+
# index_field_name: "IndexFieldName", # required
|
|
3738
|
+
# },
|
|
3739
|
+
# ],
|
|
3740
|
+
# },
|
|
3741
|
+
# box_configuration: {
|
|
3742
|
+
# enterprise_id: "EnterpriseId", # required
|
|
3743
|
+
# secret_arn: "SecretArn", # required
|
|
3744
|
+
# use_change_log: false,
|
|
3745
|
+
# crawl_comments: false,
|
|
3746
|
+
# crawl_tasks: false,
|
|
3747
|
+
# crawl_web_links: false,
|
|
3748
|
+
# file_field_mappings: [
|
|
3749
|
+
# {
|
|
3750
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
|
3751
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
|
3752
|
+
# index_field_name: "IndexFieldName", # required
|
|
3753
|
+
# },
|
|
3754
|
+
# ],
|
|
3755
|
+
# task_field_mappings: [
|
|
3756
|
+
# {
|
|
3757
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
|
3758
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
|
3759
|
+
# index_field_name: "IndexFieldName", # required
|
|
3760
|
+
# },
|
|
3761
|
+
# ],
|
|
3762
|
+
# comment_field_mappings: [
|
|
3763
|
+
# {
|
|
3764
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
|
3765
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
|
3766
|
+
# index_field_name: "IndexFieldName", # required
|
|
3767
|
+
# },
|
|
3768
|
+
# ],
|
|
3769
|
+
# web_link_field_mappings: [
|
|
3770
|
+
# {
|
|
3771
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
|
3772
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
|
3773
|
+
# index_field_name: "IndexFieldName", # required
|
|
3774
|
+
# },
|
|
3775
|
+
# ],
|
|
3776
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
|
3777
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
|
3778
|
+
# vpc_configuration: {
|
|
3779
|
+
# subnet_ids: ["SubnetId"], # required
|
|
3780
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
|
3781
|
+
# },
|
|
3782
|
+
# },
|
|
3359
3783
|
# }
|
|
3360
3784
|
#
|
|
3361
3785
|
# @!attribute [rw] s3_configuration
|
|
3362
|
-
# Provides information to
|
|
3363
|
-
#
|
|
3786
|
+
# Provides the configuration information to connect to an Amazon S3
|
|
3787
|
+
# bucket as your data source.
|
|
3364
3788
|
# @return [Types::S3DataSourceConfiguration]
|
|
3365
3789
|
#
|
|
3366
3790
|
# @!attribute [rw] share_point_configuration
|
|
3367
|
-
# Provides information
|
|
3368
|
-
#
|
|
3791
|
+
# Provides the configuration information to connect to Microsoft
|
|
3792
|
+
# SharePoint as your data source.
|
|
3369
3793
|
# @return [Types::SharePointConfiguration]
|
|
3370
3794
|
#
|
|
3371
3795
|
# @!attribute [rw] database_configuration
|
|
3372
|
-
# Provides information
|
|
3373
|
-
#
|
|
3796
|
+
# Provides the configuration information to connect to a database as
|
|
3797
|
+
# your data source.
|
|
3374
3798
|
# @return [Types::DatabaseConfiguration]
|
|
3375
3799
|
#
|
|
3376
3800
|
# @!attribute [rw] salesforce_configuration
|
|
3377
|
-
# Provides configuration information
|
|
3378
|
-
#
|
|
3801
|
+
# Provides the configuration information to connect to Salesforce as
|
|
3802
|
+
# your data source.
|
|
3379
3803
|
# @return [Types::SalesforceConfiguration]
|
|
3380
3804
|
#
|
|
3381
3805
|
# @!attribute [rw] one_drive_configuration
|
|
3382
|
-
# Provides configuration
|
|
3383
|
-
# OneDrive.
|
|
3806
|
+
# Provides the configuration information to connect to Microsoft
|
|
3807
|
+
# OneDrive as your data source.
|
|
3384
3808
|
# @return [Types::OneDriveConfiguration]
|
|
3385
3809
|
#
|
|
3386
3810
|
# @!attribute [rw] service_now_configuration
|
|
3387
|
-
# Provides configuration
|
|
3388
|
-
#
|
|
3811
|
+
# Provides the configuration information to connect to ServiceNow as
|
|
3812
|
+
# your data source.
|
|
3389
3813
|
# @return [Types::ServiceNowConfiguration]
|
|
3390
3814
|
#
|
|
3391
3815
|
# @!attribute [rw] confluence_configuration
|
|
3392
|
-
# Provides configuration information
|
|
3393
|
-
# data source.
|
|
3816
|
+
# Provides the configuration information to connect to Confluence as
|
|
3817
|
+
# your data source.
|
|
3394
3818
|
# @return [Types::ConfluenceConfiguration]
|
|
3395
3819
|
#
|
|
3396
3820
|
# @!attribute [rw] google_drive_configuration
|
|
3397
|
-
# Provides configuration
|
|
3398
|
-
#
|
|
3821
|
+
# Provides the configuration information to connect to Google Drive as
|
|
3822
|
+
# your data source.
|
|
3399
3823
|
# @return [Types::GoogleDriveConfiguration]
|
|
3400
3824
|
#
|
|
3401
3825
|
# @!attribute [rw] web_crawler_configuration
|
|
@@ -3413,6 +3837,16 @@ module Aws::Kendra
|
|
|
3413
3837
|
# your data source.
|
|
3414
3838
|
# @return [Types::FsxConfiguration]
|
|
3415
3839
|
#
|
|
3840
|
+
# @!attribute [rw] slack_configuration
|
|
3841
|
+
# Provides the configuration information to connect to Slack as your
|
|
3842
|
+
# data source.
|
|
3843
|
+
# @return [Types::SlackConfiguration]
|
|
3844
|
+
#
|
|
3845
|
+
# @!attribute [rw] box_configuration
|
|
3846
|
+
# Provides the configuration information to connect to Box as your
|
|
3847
|
+
# data source.
|
|
3848
|
+
# @return [Types::BoxConfiguration]
|
|
3849
|
+
#
|
|
3416
3850
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceConfiguration AWS API Documentation
|
|
3417
3851
|
#
|
|
3418
3852
|
class DataSourceConfiguration < Struct.new(
|
|
@@ -3426,7 +3860,9 @@ module Aws::Kendra
|
|
|
3426
3860
|
:google_drive_configuration,
|
|
3427
3861
|
:web_crawler_configuration,
|
|
3428
3862
|
:work_docs_configuration,
|
|
3429
|
-
:fsx_configuration
|
|
3863
|
+
:fsx_configuration,
|
|
3864
|
+
:slack_configuration,
|
|
3865
|
+
:box_configuration)
|
|
3430
3866
|
SENSITIVE = []
|
|
3431
3867
|
include Aws::Structure
|
|
3432
3868
|
end
|
|
@@ -3685,7 +4121,7 @@ module Aws::Kendra
|
|
|
3685
4121
|
include Aws::Structure
|
|
3686
4122
|
end
|
|
3687
4123
|
|
|
3688
|
-
# Provides information
|
|
4124
|
+
# Provides the configuration information to connect to an Amazon VPC.
|
|
3689
4125
|
#
|
|
3690
4126
|
# @note When making an API call, you may pass DataSourceVpcConfiguration
|
|
3691
4127
|
# data as a hash:
|
|
@@ -3716,7 +4152,7 @@ module Aws::Kendra
|
|
|
3716
4152
|
include Aws::Structure
|
|
3717
4153
|
end
|
|
3718
4154
|
|
|
3719
|
-
# Provides the information
|
|
4155
|
+
# Provides the configuration information to connect to a index.
|
|
3720
4156
|
#
|
|
3721
4157
|
# @note When making an API call, you may pass DatabaseConfiguration
|
|
3722
4158
|
# data as a hash:
|
|
@@ -3760,11 +4196,11 @@ module Aws::Kendra
|
|
|
3760
4196
|
# @return [String]
|
|
3761
4197
|
#
|
|
3762
4198
|
# @!attribute [rw] connection_configuration
|
|
3763
|
-
#
|
|
4199
|
+
# Configuration information that's required to connect to a database.
|
|
3764
4200
|
# @return [Types::ConnectionConfiguration]
|
|
3765
4201
|
#
|
|
3766
4202
|
# @!attribute [rw] vpc_configuration
|
|
3767
|
-
# Provides information
|
|
4203
|
+
# Provides the configuration information to connect to an Amazon VPC.
|
|
3768
4204
|
# @return [Types::DataSourceVpcConfiguration]
|
|
3769
4205
|
#
|
|
3770
4206
|
# @!attribute [rw] column_configuration
|
|
@@ -4048,9 +4484,8 @@ module Aws::Kendra
|
|
|
4048
4484
|
# @return [String]
|
|
4049
4485
|
#
|
|
4050
4486
|
# @!attribute [rw] configuration
|
|
4051
|
-
#
|
|
4052
|
-
#
|
|
4053
|
-
# description depends on the data source provider.
|
|
4487
|
+
# Describes how the data source is configured. The specific
|
|
4488
|
+
# information in the description depends on the data source provider.
|
|
4054
4489
|
# @return [Types::DataSourceConfiguration]
|
|
4055
4490
|
#
|
|
4056
4491
|
# @!attribute [rw] created_at
|
|
@@ -4344,7 +4779,7 @@ module Aws::Kendra
|
|
|
4344
4779
|
# }
|
|
4345
4780
|
#
|
|
4346
4781
|
# @!attribute [rw] id
|
|
4347
|
-
# The
|
|
4782
|
+
# The identifier of the index to describe.
|
|
4348
4783
|
# @return [String]
|
|
4349
4784
|
#
|
|
4350
4785
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndexRequest AWS API Documentation
|
|
@@ -4360,7 +4795,7 @@ module Aws::Kendra
|
|
|
4360
4795
|
# @return [String]
|
|
4361
4796
|
#
|
|
4362
4797
|
# @!attribute [rw] id
|
|
4363
|
-
# The
|
|
4798
|
+
# The identifier of the index.
|
|
4364
4799
|
# @return [String]
|
|
4365
4800
|
#
|
|
4366
4801
|
# @!attribute [rw] edition
|
|
@@ -4374,8 +4809,8 @@ module Aws::Kendra
|
|
|
4374
4809
|
# @return [String]
|
|
4375
4810
|
#
|
|
4376
4811
|
# @!attribute [rw] server_side_encryption_configuration
|
|
4377
|
-
# The identifier of the KMScustomer master key (CMK) used to
|
|
4378
|
-
# your data. Amazon Kendra doesn't support asymmetric CMKs.
|
|
4812
|
+
# The identifier of the KMScustomer master key (CMK) that is used to
|
|
4813
|
+
# encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.
|
|
4379
4814
|
# @return [Types::ServerSideEncryptionConfiguration]
|
|
4380
4815
|
#
|
|
4381
4816
|
# @!attribute [rw] status
|
|
@@ -4385,7 +4820,7 @@ module Aws::Kendra
|
|
|
4385
4820
|
# @return [String]
|
|
4386
4821
|
#
|
|
4387
4822
|
# @!attribute [rw] description
|
|
4388
|
-
# The description
|
|
4823
|
+
# The description for the index.
|
|
4389
4824
|
# @return [String]
|
|
4390
4825
|
#
|
|
4391
4826
|
# @!attribute [rw] created_at
|
|
@@ -4407,16 +4842,21 @@ module Aws::Kendra
|
|
|
4407
4842
|
# @return [Types::IndexStatistics]
|
|
4408
4843
|
#
|
|
4409
4844
|
# @!attribute [rw] error_message
|
|
4410
|
-
# When
|
|
4845
|
+
# When the `Status` field value is `FAILED`, the `ErrorMessage` field
|
|
4411
4846
|
# contains a message that explains why.
|
|
4412
4847
|
# @return [String]
|
|
4413
4848
|
#
|
|
4414
4849
|
# @!attribute [rw] capacity_units
|
|
4415
|
-
# For Enterprise
|
|
4850
|
+
# For Enterprise Edition indexes, you can choose to use additional
|
|
4416
4851
|
# capacity to meet the needs of your application. This contains the
|
|
4417
|
-
# capacity units used for the index. A
|
|
4418
|
-
#
|
|
4419
|
-
# capacity
|
|
4852
|
+
# capacity units used for the index. A query or document storage
|
|
4853
|
+
# capacity of zero indicates that the index is using the default
|
|
4854
|
+
# capacity. For more information on the default capacity for an index
|
|
4855
|
+
# and adjusting this, see [Adjusting capacity][1].
|
|
4856
|
+
#
|
|
4857
|
+
#
|
|
4858
|
+
#
|
|
4859
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/adjusting-capacity.html
|
|
4420
4860
|
# @return [Types::CapacityUnitsConfiguration]
|
|
4421
4861
|
#
|
|
4422
4862
|
# @!attribute [rw] user_token_configurations
|
|
@@ -5484,7 +5924,7 @@ module Aws::Kendra
|
|
|
5484
5924
|
include Aws::Structure
|
|
5485
5925
|
end
|
|
5486
5926
|
|
|
5487
|
-
# Provides the configuration information
|
|
5927
|
+
# Provides the configuration information for users or groups in your
|
|
5488
5928
|
# Amazon Web Services SSO identity source to grant access your Amazon
|
|
5489
5929
|
# Kendra experience.
|
|
5490
5930
|
#
|
|
@@ -5548,7 +5988,7 @@ module Aws::Kendra
|
|
|
5548
5988
|
include Aws::Structure
|
|
5549
5989
|
end
|
|
5550
5990
|
|
|
5551
|
-
# Provides the configuration information
|
|
5991
|
+
# Provides the configuration information for users or groups in your
|
|
5552
5992
|
# Amazon Web Services SSO identity source for access to your Amazon
|
|
5553
5993
|
# Kendra experience. Specific permissions are defined for each user or
|
|
5554
5994
|
# group once they are granted access to your Amazon Kendra experience.
|
|
@@ -5587,7 +6027,7 @@ module Aws::Kendra
|
|
|
5587
6027
|
include Aws::Structure
|
|
5588
6028
|
end
|
|
5589
6029
|
|
|
5590
|
-
#
|
|
6030
|
+
# Provides the configuration information for your Amazon Kendra
|
|
5591
6031
|
# experience. This includes the data source IDs and/or FAQ IDs, and user
|
|
5592
6032
|
# or group information to grant access to your Amazon Kendra experience.
|
|
5593
6033
|
#
|
|
@@ -5626,8 +6066,8 @@ module Aws::Kendra
|
|
|
5626
6066
|
include Aws::Structure
|
|
5627
6067
|
end
|
|
5628
6068
|
|
|
5629
|
-
# Provides the configuration information
|
|
5630
|
-
# Kendra experience.
|
|
6069
|
+
# Provides the configuration information for the endpoint for your
|
|
6070
|
+
# Amazon Kendra experience.
|
|
5631
6071
|
#
|
|
5632
6072
|
# @!attribute [rw] endpoint_type
|
|
5633
6073
|
# The type of endpoint for your Amazon Kendra experience. The type
|
|
@@ -5912,9 +6352,9 @@ module Aws::Kendra
|
|
|
5912
6352
|
# @return [String]
|
|
5913
6353
|
#
|
|
5914
6354
|
# @!attribute [rw] vpc_configuration
|
|
5915
|
-
#
|
|
5916
|
-
#
|
|
5917
|
-
#
|
|
6355
|
+
# Configuration information for an Amazon Virtual Private Cloud to
|
|
6356
|
+
# connect to your Amazon FSx. Your Amazon FSx instance must reside
|
|
6357
|
+
# inside your VPC.
|
|
5918
6358
|
# @return [Types::DataSourceVpcConfiguration]
|
|
5919
6359
|
#
|
|
5920
6360
|
# @!attribute [rw] secret_arn
|
|
@@ -5929,36 +6369,35 @@ module Aws::Kendra
|
|
|
5929
6369
|
# have read and mounting access to the Amazon FSx file system for
|
|
5930
6370
|
# Windows.
|
|
5931
6371
|
#
|
|
5932
|
-
# * password—The password of the
|
|
5933
|
-
# mounting access Amazon FSx Windows file system.
|
|
6372
|
+
# * password—The password of the Active Directory user account with
|
|
6373
|
+
# read and mounting access to the Amazon FSx Windows file system.
|
|
5934
6374
|
# @return [String]
|
|
5935
6375
|
#
|
|
5936
6376
|
# @!attribute [rw] inclusion_patterns
|
|
5937
6377
|
# A list of regular expression patterns to include certain files in
|
|
5938
6378
|
# your Amazon FSx file system. Files that match the patterns are
|
|
5939
6379
|
# 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
|
-
#
|
|
6380
|
+
# excluded from the index. If a file matches both an inclusion and
|
|
6381
|
+
# exclusion pattern, the exclusion pattern takes precedence and the
|
|
6382
|
+
# file isn't included in the index.
|
|
5943
6383
|
# @return [Array<String>]
|
|
5944
6384
|
#
|
|
5945
6385
|
# @!attribute [rw] exclusion_patterns
|
|
5946
6386
|
# A list of regular expression patterns to exclude certain files in
|
|
5947
6387
|
# 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
|
-
#
|
|
6388
|
+
# excluded from the index. Files that don't match the patterns are
|
|
6389
|
+
# included in the index. If a file matches both an inclusion and
|
|
6390
|
+
# exclusion pattern, the exclusion pattern takes precedence and the
|
|
6391
|
+
# file isn't included in the index.
|
|
5952
6392
|
# @return [Array<String>]
|
|
5953
6393
|
#
|
|
5954
6394
|
# @!attribute [rw] field_mappings
|
|
5955
6395
|
# A list of `DataSourceToIndexFieldMapping` objects that map Amazon
|
|
5956
6396
|
# FSx data source attributes or field names to Amazon Kendra index
|
|
5957
|
-
# field names
|
|
5958
|
-
#
|
|
5959
|
-
#
|
|
5960
|
-
#
|
|
5961
|
-
# metadata.
|
|
6397
|
+
# field names. To create custom fields, use the `UpdateIndex` API
|
|
6398
|
+
# before you map to Amazon FSx fields. For more information, see
|
|
6399
|
+
# [Mapping data source fields][1]. The Amazon FSx data source field
|
|
6400
|
+
# names must exist in your Amazon FSx custom metadata.
|
|
5962
6401
|
#
|
|
5963
6402
|
#
|
|
5964
6403
|
#
|
|
@@ -6141,8 +6580,8 @@ module Aws::Kendra
|
|
|
6141
6580
|
include Aws::Structure
|
|
6142
6581
|
end
|
|
6143
6582
|
|
|
6144
|
-
# Provides configuration information
|
|
6145
|
-
#
|
|
6583
|
+
# Provides the configuration information to connect to Google Drive as
|
|
6584
|
+
# your data source.
|
|
6146
6585
|
#
|
|
6147
6586
|
# @note When making an API call, you may pass GoogleDriveConfiguration
|
|
6148
6587
|
# data as a hash:
|
|
@@ -6175,30 +6614,34 @@ module Aws::Kendra
|
|
|
6175
6614
|
# @return [String]
|
|
6176
6615
|
#
|
|
6177
6616
|
# @!attribute [rw] inclusion_patterns
|
|
6178
|
-
# A list of regular expression patterns
|
|
6179
|
-
#
|
|
6180
|
-
#
|
|
6181
|
-
# the
|
|
6182
|
-
# inclusion
|
|
6183
|
-
# index.
|
|
6617
|
+
# A list of regular expression patterns to include certain items in
|
|
6618
|
+
# your Google Drive, including shared drives and users' My Drives.
|
|
6619
|
+
# Items that match the patterns are included in the index. Items that
|
|
6620
|
+
# don't match the patterns are excluded from the index. If an item
|
|
6621
|
+
# matches both an inclusion and exclusion pattern, the exclusion
|
|
6622
|
+
# pattern takes precedence and the item isn't included in the index.
|
|
6184
6623
|
# @return [Array<String>]
|
|
6185
6624
|
#
|
|
6186
6625
|
# @!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
|
-
#
|
|
6626
|
+
# A list of regular expression patterns to exclude certain items in
|
|
6627
|
+
# your Google Drive, including shared drives and users' My Drives.
|
|
6628
|
+
# Items that match the patterns are excluded from the index. Items
|
|
6629
|
+
# that don't match the patterns are included in the index. If an item
|
|
6630
|
+
# matches both an inclusion and exclusion pattern, the exclusion
|
|
6631
|
+
# pattern takes precedence and the item isn't included in the index.
|
|
6193
6632
|
# @return [Array<String>]
|
|
6194
6633
|
#
|
|
6195
6634
|
# @!attribute [rw] field_mappings
|
|
6196
|
-
#
|
|
6197
|
-
# Kendra index field.
|
|
6635
|
+
# Maps Google Drive data source attributes or field names to Amazon
|
|
6636
|
+
# Kendra index field names. To create custom fields, use the
|
|
6637
|
+
# `UpdateIndex` API before you map to Google Drive fields. For more
|
|
6638
|
+
# information, see [Mapping data source fields][1]. The Google Drive
|
|
6639
|
+
# data source field names must exist in your Google Drive custom
|
|
6640
|
+
# metadata.
|
|
6198
6641
|
#
|
|
6199
|
-
#
|
|
6200
|
-
#
|
|
6201
|
-
#
|
|
6642
|
+
#
|
|
6643
|
+
#
|
|
6644
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
|
6202
6645
|
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
|
6203
6646
|
#
|
|
6204
6647
|
# @!attribute [rw] exclude_mime_types
|
|
@@ -6506,10 +6949,10 @@ module Aws::Kendra
|
|
|
6506
6949
|
include Aws::Structure
|
|
6507
6950
|
end
|
|
6508
6951
|
|
|
6509
|
-
# A summary of information
|
|
6952
|
+
# A summary of information on the configuration of an index.
|
|
6510
6953
|
#
|
|
6511
6954
|
# @!attribute [rw] name
|
|
6512
|
-
# The
|
|
6955
|
+
# The identifier of the index.
|
|
6513
6956
|
# @return [String]
|
|
6514
6957
|
#
|
|
6515
6958
|
# @!attribute [rw] id
|
|
@@ -6661,7 +7104,7 @@ module Aws::Kendra
|
|
|
6661
7104
|
include Aws::Structure
|
|
6662
7105
|
end
|
|
6663
7106
|
|
|
6664
|
-
#
|
|
7107
|
+
# Provides the configuration information for the JSON token type.
|
|
6665
7108
|
#
|
|
6666
7109
|
# @note When making an API call, you may pass JsonTokenTypeConfiguration
|
|
6667
7110
|
# data as a hash:
|
|
@@ -6688,7 +7131,7 @@ module Aws::Kendra
|
|
|
6688
7131
|
include Aws::Structure
|
|
6689
7132
|
end
|
|
6690
7133
|
|
|
6691
|
-
#
|
|
7134
|
+
# Provides the configuration information for the JWT token type.
|
|
6692
7135
|
#
|
|
6693
7136
|
# @note When making an API call, you may pass JwtTokenTypeConfiguration
|
|
6694
7137
|
# data as a hash:
|
|
@@ -7198,7 +7641,8 @@ module Aws::Kendra
|
|
|
7198
7641
|
end
|
|
7199
7642
|
|
|
7200
7643
|
# @!attribute [rw] index_configuration_summary_items
|
|
7201
|
-
# An array of summary information
|
|
7644
|
+
# An array of summary information on the configuration of one or more
|
|
7645
|
+
# indexes.
|
|
7202
7646
|
# @return [Array<Types::IndexConfigurationSummary>]
|
|
7203
7647
|
#
|
|
7204
7648
|
# @!attribute [rw] next_token
|
|
@@ -7423,8 +7867,8 @@ module Aws::Kendra
|
|
|
7423
7867
|
include Aws::Structure
|
|
7424
7868
|
end
|
|
7425
7869
|
|
|
7426
|
-
# Provides configuration information
|
|
7427
|
-
#
|
|
7870
|
+
# Provides the configuration information to connect to OneDrive as your
|
|
7871
|
+
# data source.
|
|
7428
7872
|
#
|
|
7429
7873
|
# @note When making an API call, you may pass OneDriveConfiguration
|
|
7430
7874
|
# data as a hash:
|
|
@@ -7467,28 +7911,38 @@ module Aws::Kendra
|
|
|
7467
7911
|
# @return [Types::OneDriveUsers]
|
|
7468
7912
|
#
|
|
7469
7913
|
# @!attribute [rw] inclusion_patterns
|
|
7470
|
-
# A list of regular expression patterns
|
|
7471
|
-
#
|
|
7472
|
-
#
|
|
7473
|
-
#
|
|
7474
|
-
#
|
|
7475
|
-
#
|
|
7476
|
-
#
|
|
7914
|
+
# A list of regular expression patterns to include certain documents
|
|
7915
|
+
# in your OneDrive. Documents that match the patterns are included in
|
|
7916
|
+
# the index. Documents that don't match the patterns are excluded
|
|
7917
|
+
# from the index. If a document matches both an inclusion and
|
|
7918
|
+
# exclusion pattern, the exclusion pattern takes precedence and the
|
|
7919
|
+
# document isn't included in the index.
|
|
7920
|
+
#
|
|
7921
|
+
# The pattern is applied to the file name.
|
|
7477
7922
|
# @return [Array<String>]
|
|
7478
7923
|
#
|
|
7479
7924
|
# @!attribute [rw] exclusion_patterns
|
|
7480
|
-
#
|
|
7481
|
-
#
|
|
7482
|
-
#
|
|
7483
|
-
# the
|
|
7484
|
-
#
|
|
7485
|
-
#
|
|
7925
|
+
# A list of regular expression patterns to exclude certain documents
|
|
7926
|
+
# in your OneDrive. Documents that match the patterns are excluded
|
|
7927
|
+
# from the index. Documents that don't match the patterns are
|
|
7928
|
+
# included in the index. If a document matches both an inclusion and
|
|
7929
|
+
# exclusion pattern, the exclusion pattern takes precedence and the
|
|
7930
|
+
# document isn't included in the index.
|
|
7931
|
+
#
|
|
7932
|
+
# The pattern is applied to the file name.
|
|
7486
7933
|
# @return [Array<String>]
|
|
7487
7934
|
#
|
|
7488
7935
|
# @!attribute [rw] field_mappings
|
|
7489
|
-
# A list of `DataSourceToIndexFieldMapping` objects that map
|
|
7490
|
-
#
|
|
7491
|
-
#
|
|
7936
|
+
# A list of `DataSourceToIndexFieldMapping` objects that map OneDrive
|
|
7937
|
+
# data source attributes or field names to Amazon Kendra index field
|
|
7938
|
+
# names. To create custom fields, use the `UpdateIndex` API before you
|
|
7939
|
+
# map to OneDrive fields. For more information, see [Mapping data
|
|
7940
|
+
# source fields][1]. The OneDrive data source field names must exist
|
|
7941
|
+
# in your OneDrive custom metadata.
|
|
7942
|
+
#
|
|
7943
|
+
#
|
|
7944
|
+
#
|
|
7945
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
|
7492
7946
|
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
|
7493
7947
|
#
|
|
7494
7948
|
# @!attribute [rw] disable_local_groups
|
|
@@ -7915,6 +8369,9 @@ module Aws::Kendra
|
|
|
7915
8369
|
# ],
|
|
7916
8370
|
# },
|
|
7917
8371
|
# visitor_id: "VisitorId",
|
|
8372
|
+
# spell_correction_configuration: {
|
|
8373
|
+
# include_query_spell_check_suggestions: false, # required
|
|
8374
|
+
# },
|
|
7918
8375
|
# }
|
|
7919
8376
|
#
|
|
7920
8377
|
# @!attribute [rw] index_id
|
|
@@ -8008,6 +8465,10 @@ module Aws::Kendra
|
|
|
8008
8465
|
# `VisitorId`.
|
|
8009
8466
|
# @return [String]
|
|
8010
8467
|
#
|
|
8468
|
+
# @!attribute [rw] spell_correction_configuration
|
|
8469
|
+
# Enables suggested spell corrections for queries.
|
|
8470
|
+
# @return [Types::SpellCorrectionConfiguration]
|
|
8471
|
+
#
|
|
8011
8472
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryRequest AWS API Documentation
|
|
8012
8473
|
#
|
|
8013
8474
|
class QueryRequest < Struct.new(
|
|
@@ -8022,7 +8483,8 @@ module Aws::Kendra
|
|
|
8022
8483
|
:page_size,
|
|
8023
8484
|
:sorting_configuration,
|
|
8024
8485
|
:user_context,
|
|
8025
|
-
:visitor_id
|
|
8486
|
+
:visitor_id,
|
|
8487
|
+
:spell_correction_configuration)
|
|
8026
8488
|
SENSITIVE = []
|
|
8027
8489
|
include Aws::Structure
|
|
8028
8490
|
end
|
|
@@ -8061,6 +8523,11 @@ module Aws::Kendra
|
|
|
8061
8523
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax
|
|
8062
8524
|
# @return [Array<Types::Warning>]
|
|
8063
8525
|
#
|
|
8526
|
+
# @!attribute [rw] spell_corrected_queries
|
|
8527
|
+
# A list of information related to suggested spell corrections for a
|
|
8528
|
+
# query.
|
|
8529
|
+
# @return [Array<Types::SpellCorrectedQuery>]
|
|
8530
|
+
#
|
|
8064
8531
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryResult AWS API Documentation
|
|
8065
8532
|
#
|
|
8066
8533
|
class QueryResult < Struct.new(
|
|
@@ -8068,7 +8535,8 @@ module Aws::Kendra
|
|
|
8068
8535
|
:result_items,
|
|
8069
8536
|
:facet_results,
|
|
8070
8537
|
:total_number_of_results,
|
|
8071
|
-
:warnings
|
|
8538
|
+
:warnings,
|
|
8539
|
+
:spell_corrected_queries)
|
|
8072
8540
|
SENSITIVE = []
|
|
8073
8541
|
include Aws::Structure
|
|
8074
8542
|
end
|
|
@@ -8363,8 +8831,8 @@ module Aws::Kendra
|
|
|
8363
8831
|
include Aws::Structure
|
|
8364
8832
|
end
|
|
8365
8833
|
|
|
8366
|
-
# Provides configuration information
|
|
8367
|
-
#
|
|
8834
|
+
# Provides the configuration information to connect to an Amazon S3
|
|
8835
|
+
# bucket.
|
|
8368
8836
|
#
|
|
8369
8837
|
# @note When making an API call, you may pass S3DataSourceConfiguration
|
|
8370
8838
|
# data as a hash:
|
|
@@ -8492,8 +8960,8 @@ module Aws::Kendra
|
|
|
8492
8960
|
include Aws::Structure
|
|
8493
8961
|
end
|
|
8494
8962
|
|
|
8495
|
-
#
|
|
8496
|
-
# contents of the object comes from the Salesforce FeedItem table.
|
|
8963
|
+
# The configuration information for syncing a Salesforce chatter feed.
|
|
8964
|
+
# The contents of the object comes from the Salesforce FeedItem table.
|
|
8497
8965
|
#
|
|
8498
8966
|
# @note When making an API call, you may pass SalesforceChatterFeedConfiguration
|
|
8499
8967
|
# data as a hash:
|
|
@@ -8546,8 +9014,8 @@ module Aws::Kendra
|
|
|
8546
9014
|
include Aws::Structure
|
|
8547
9015
|
end
|
|
8548
9016
|
|
|
8549
|
-
# Provides configuration information
|
|
8550
|
-
# source.
|
|
9017
|
+
# Provides the configuration information to connect to Salesforce as
|
|
9018
|
+
# your data source.
|
|
8551
9019
|
#
|
|
8552
9020
|
# @note When making an API call, you may pass SalesforceConfiguration
|
|
8553
9021
|
# data as a hash:
|
|
@@ -8654,19 +9122,19 @@ module Aws::Kendra
|
|
|
8654
9122
|
# @return [String]
|
|
8655
9123
|
#
|
|
8656
9124
|
# @!attribute [rw] standard_object_configurations
|
|
8657
|
-
#
|
|
9125
|
+
# Configuration of the Salesforce standard objects that Amazon Kendra
|
|
8658
9126
|
# indexes.
|
|
8659
9127
|
# @return [Array<Types::SalesforceStandardObjectConfiguration>]
|
|
8660
9128
|
#
|
|
8661
9129
|
# @!attribute [rw] knowledge_article_configuration
|
|
8662
|
-
#
|
|
8663
|
-
#
|
|
9130
|
+
# Configuration information for the knowledge article types that
|
|
9131
|
+
# Amazon Kendra indexes. Amazon Kendra indexes standard knowledge
|
|
8664
9132
|
# articles and the standard fields of knowledge articles, or the
|
|
8665
9133
|
# custom fields of custom knowledge articles, but not both.
|
|
8666
9134
|
# @return [Types::SalesforceKnowledgeArticleConfiguration]
|
|
8667
9135
|
#
|
|
8668
9136
|
# @!attribute [rw] chatter_feed_configuration
|
|
8669
|
-
#
|
|
9137
|
+
# Configuration information for Salesforce chatter feeds.
|
|
8670
9138
|
# @return [Types::SalesforceChatterFeedConfiguration]
|
|
8671
9139
|
#
|
|
8672
9140
|
# @!attribute [rw] crawl_attachments
|
|
@@ -8675,28 +9143,30 @@ module Aws::Kendra
|
|
|
8675
9143
|
# @return [Boolean]
|
|
8676
9144
|
#
|
|
8677
9145
|
# @!attribute [rw] standard_object_attachment_configuration
|
|
8678
|
-
#
|
|
8679
|
-
#
|
|
9146
|
+
# Configuration information for processing attachments to Salesforce
|
|
9147
|
+
# standard objects.
|
|
8680
9148
|
# @return [Types::SalesforceStandardObjectAttachmentConfiguration]
|
|
8681
9149
|
#
|
|
8682
9150
|
# @!attribute [rw] include_attachment_file_patterns
|
|
8683
|
-
# A list of regular expression patterns
|
|
8684
|
-
#
|
|
8685
|
-
#
|
|
8686
|
-
#
|
|
8687
|
-
#
|
|
8688
|
-
#
|
|
8689
|
-
#
|
|
9151
|
+
# A list of regular expression patterns to include certain documents
|
|
9152
|
+
# in your Salesforce. Documents that match the patterns are included
|
|
9153
|
+
# in the index. Documents that don't match the patterns are excluded
|
|
9154
|
+
# from the index. If a document matches both an inclusion and
|
|
9155
|
+
# exclusion pattern, the exclusion pattern takes precedence and the
|
|
9156
|
+
# document isn't included in the index.
|
|
9157
|
+
#
|
|
9158
|
+
# The pattern is applied to the name of the attached file.
|
|
8690
9159
|
# @return [Array<String>]
|
|
8691
9160
|
#
|
|
8692
9161
|
# @!attribute [rw] exclude_attachment_file_patterns
|
|
8693
|
-
# A list of regular expression patterns
|
|
8694
|
-
#
|
|
8695
|
-
#
|
|
8696
|
-
#
|
|
8697
|
-
#
|
|
8698
|
-
#
|
|
8699
|
-
#
|
|
9162
|
+
# A list of regular expression patterns to exclude certain documents
|
|
9163
|
+
# in your Salesforce. Documents that match the patterns are excluded
|
|
9164
|
+
# from the index. Documents that don't match the patterns are
|
|
9165
|
+
# included in the index. If a document matches both an inclusion and
|
|
9166
|
+
# exclusion pattern, the exclusion pattern takes precedence and the
|
|
9167
|
+
# document isn't included in the index.
|
|
9168
|
+
#
|
|
9169
|
+
# The pattern is applied to the name of the attached file.
|
|
8700
9170
|
# @return [Array<String>]
|
|
8701
9171
|
#
|
|
8702
9172
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceConfiguration AWS API Documentation
|
|
@@ -8715,7 +9185,7 @@ module Aws::Kendra
|
|
|
8715
9185
|
include Aws::Structure
|
|
8716
9186
|
end
|
|
8717
9187
|
|
|
8718
|
-
# Provides configuration information for indexing Salesforce custom
|
|
9188
|
+
# Provides the configuration information for indexing Salesforce custom
|
|
8719
9189
|
# articles.
|
|
8720
9190
|
#
|
|
8721
9191
|
# @note When making an API call, you may pass SalesforceCustomKnowledgeArticleTypeConfiguration
|
|
@@ -8749,8 +9219,16 @@ module Aws::Kendra
|
|
|
8749
9219
|
# @return [String]
|
|
8750
9220
|
#
|
|
8751
9221
|
# @!attribute [rw] field_mappings
|
|
8752
|
-
#
|
|
8753
|
-
#
|
|
9222
|
+
# Maps attributes or field names of the custom knowledge article to
|
|
9223
|
+
# Amazon Kendra index field names. To create custom fields, use the
|
|
9224
|
+
# `UpdateIndex` API before you map to Salesforce fields. For more
|
|
9225
|
+
# information, see [Mapping data source fields][1]. The Salesforce
|
|
9226
|
+
# data source field names must exist in your Salesforce custom
|
|
9227
|
+
# metadata.
|
|
9228
|
+
#
|
|
9229
|
+
#
|
|
9230
|
+
#
|
|
9231
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
|
8754
9232
|
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
|
8755
9233
|
#
|
|
8756
9234
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceCustomKnowledgeArticleTypeConfiguration AWS API Documentation
|
|
@@ -8764,7 +9242,7 @@ module Aws::Kendra
|
|
|
8764
9242
|
include Aws::Structure
|
|
8765
9243
|
end
|
|
8766
9244
|
|
|
8767
|
-
#
|
|
9245
|
+
# Provides the configuration information for the knowledge article types
|
|
8768
9246
|
# that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge
|
|
8769
9247
|
# articles and the standard fields of knowledge articles, or the custom
|
|
8770
9248
|
# fields of custom knowledge articles, but not both
|
|
@@ -8808,13 +9286,12 @@ module Aws::Kendra
|
|
|
8808
9286
|
# @return [Array<String>]
|
|
8809
9287
|
#
|
|
8810
9288
|
# @!attribute [rw] standard_knowledge_article_type_configuration
|
|
8811
|
-
#
|
|
9289
|
+
# Configuration information for standard Salesforce knowledge
|
|
8812
9290
|
# articles.
|
|
8813
9291
|
# @return [Types::SalesforceStandardKnowledgeArticleTypeConfiguration]
|
|
8814
9292
|
#
|
|
8815
9293
|
# @!attribute [rw] custom_knowledge_article_type_configurations
|
|
8816
|
-
#
|
|
8817
|
-
# articles.
|
|
9294
|
+
# Configuration information for custom Salesforce knowledge articles.
|
|
8818
9295
|
# @return [Array<Types::SalesforceCustomKnowledgeArticleTypeConfiguration>]
|
|
8819
9296
|
#
|
|
8820
9297
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceKnowledgeArticleConfiguration AWS API Documentation
|
|
@@ -8827,8 +9304,8 @@ module Aws::Kendra
|
|
|
8827
9304
|
include Aws::Structure
|
|
8828
9305
|
end
|
|
8829
9306
|
|
|
8830
|
-
# Provides configuration information for standard Salesforce
|
|
8831
|
-
# articles.
|
|
9307
|
+
# Provides the configuration information for standard Salesforce
|
|
9308
|
+
# knowledge articles.
|
|
8832
9309
|
#
|
|
8833
9310
|
# @note When making an API call, you may pass SalesforceStandardKnowledgeArticleTypeConfiguration
|
|
8834
9311
|
# data as a hash:
|
|
@@ -8854,9 +9331,16 @@ module Aws::Kendra
|
|
|
8854
9331
|
# @return [String]
|
|
8855
9332
|
#
|
|
8856
9333
|
# @!attribute [rw] field_mappings
|
|
8857
|
-
#
|
|
8858
|
-
#
|
|
8859
|
-
#
|
|
9334
|
+
# Maps attributes or field names of the knowledge article to Amazon
|
|
9335
|
+
# Kendra index field names. To create custom fields, use the
|
|
9336
|
+
# `UpdateIndex` API before you map to Salesforce fields. For more
|
|
9337
|
+
# information, see [Mapping data source fields][1]. The Salesforce
|
|
9338
|
+
# data source field names must exist in your Salesforce custom
|
|
9339
|
+
# metadata.
|
|
9340
|
+
#
|
|
9341
|
+
#
|
|
9342
|
+
#
|
|
9343
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
|
8860
9344
|
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
|
8861
9345
|
#
|
|
8862
9346
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceStandardKnowledgeArticleTypeConfiguration AWS API Documentation
|
|
@@ -8869,7 +9353,7 @@ module Aws::Kendra
|
|
|
8869
9353
|
include Aws::Structure
|
|
8870
9354
|
end
|
|
8871
9355
|
|
|
8872
|
-
# Provides configuration information for processing attachments to
|
|
9356
|
+
# Provides the configuration information for processing attachments to
|
|
8873
9357
|
# Salesforce standard objects.
|
|
8874
9358
|
#
|
|
8875
9359
|
# @note When making an API call, you may pass SalesforceStandardObjectAttachmentConfiguration
|
|
@@ -8904,7 +9388,7 @@ module Aws::Kendra
|
|
|
8904
9388
|
include Aws::Structure
|
|
8905
9389
|
end
|
|
8906
9390
|
|
|
8907
|
-
#
|
|
9391
|
+
# Provides the configuration information for indexing a single standard
|
|
8908
9392
|
# object.
|
|
8909
9393
|
#
|
|
8910
9394
|
# @note When making an API call, you may pass SalesforceStandardObjectConfiguration
|
|
@@ -8938,9 +9422,16 @@ module Aws::Kendra
|
|
|
8938
9422
|
# @return [String]
|
|
8939
9423
|
#
|
|
8940
9424
|
# @!attribute [rw] field_mappings
|
|
8941
|
-
#
|
|
8942
|
-
# Kendra index
|
|
8943
|
-
#
|
|
9425
|
+
# Maps attributes or field names of the standard object to Amazon
|
|
9426
|
+
# Kendra index field names. To create custom fields, use the
|
|
9427
|
+
# `UpdateIndex` API before you map to Salesforce fields. For more
|
|
9428
|
+
# information, see [Mapping data source fields][1]. The Salesforce
|
|
9429
|
+
# data source field names must exist in your Salesforce custom
|
|
9430
|
+
# metadata.
|
|
9431
|
+
#
|
|
9432
|
+
#
|
|
9433
|
+
#
|
|
9434
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
|
8944
9435
|
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
|
8945
9436
|
#
|
|
8946
9437
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceStandardObjectConfiguration AWS API Documentation
|
|
@@ -9019,7 +9510,7 @@ module Aws::Kendra
|
|
|
9019
9510
|
include Aws::Structure
|
|
9020
9511
|
end
|
|
9021
9512
|
|
|
9022
|
-
# Provides the configuration information
|
|
9513
|
+
# Provides the configuration information for the seed or starting point
|
|
9023
9514
|
# URLs to crawl.
|
|
9024
9515
|
#
|
|
9025
9516
|
# *When selecting websites to index, you must adhere to the [Amazon
|
|
@@ -9096,8 +9587,8 @@ module Aws::Kendra
|
|
|
9096
9587
|
include Aws::Structure
|
|
9097
9588
|
end
|
|
9098
9589
|
|
|
9099
|
-
# Provides configuration information
|
|
9100
|
-
# data source.
|
|
9590
|
+
# Provides the configuration information to connect to ServiceNow as
|
|
9591
|
+
# your data source.
|
|
9101
9592
|
#
|
|
9102
9593
|
# @note When making an API call, you may pass ServiceNowConfiguration
|
|
9103
9594
|
# data as a hash:
|
|
@@ -9141,7 +9632,7 @@ module Aws::Kendra
|
|
|
9141
9632
|
# @!attribute [rw] host_url
|
|
9142
9633
|
# The ServiceNow instance that the data source connects to. The host
|
|
9143
9634
|
# endpoint should look like the following:
|
|
9144
|
-
#
|
|
9635
|
+
# *\\\{instance\\}.service-now.com.*
|
|
9145
9636
|
# @return [String]
|
|
9146
9637
|
#
|
|
9147
9638
|
# @!attribute [rw] secret_arn
|
|
@@ -9156,24 +9647,23 @@ module Aws::Kendra
|
|
|
9156
9647
|
# @return [String]
|
|
9157
9648
|
#
|
|
9158
9649
|
# @!attribute [rw] knowledge_article_configuration
|
|
9159
|
-
#
|
|
9160
|
-
#
|
|
9650
|
+
# Configuration information for crawling knowledge articles in the
|
|
9651
|
+
# ServiceNow site.
|
|
9161
9652
|
# @return [Types::ServiceNowKnowledgeArticleConfiguration]
|
|
9162
9653
|
#
|
|
9163
9654
|
# @!attribute [rw] service_catalog_configuration
|
|
9164
|
-
#
|
|
9165
|
-
#
|
|
9655
|
+
# Configuration information for crawling service catalogs in the
|
|
9656
|
+
# ServiceNow site.
|
|
9166
9657
|
# @return [Types::ServiceNowServiceCatalogConfiguration]
|
|
9167
9658
|
#
|
|
9168
9659
|
# @!attribute [rw] authentication_type
|
|
9169
|
-
#
|
|
9170
|
-
#
|
|
9171
|
-
#
|
|
9172
|
-
#
|
|
9173
|
-
#
|
|
9174
|
-
#
|
|
9175
|
-
#
|
|
9176
|
-
# access to.
|
|
9660
|
+
# The type of authentication used to connect to the ServiceNow
|
|
9661
|
+
# instance. If you choose `HTTP_BASIC`, Amazon Kendra is authenticated
|
|
9662
|
+
# using the user name and password provided in the Secrets Manager
|
|
9663
|
+
# secret in the `SecretArn` field. When you choose `OAUTH2`, Amazon
|
|
9664
|
+
# Kendra is authenticated using the OAuth token and secret provided in
|
|
9665
|
+
# the Secrets Manager secret, and the user name and password are used
|
|
9666
|
+
# to determine which information Amazon Kendra has access to.
|
|
9177
9667
|
#
|
|
9178
9668
|
# When you use `OAUTH2` authentication, you must generate a token and
|
|
9179
9669
|
# a client secret using the ServiceNow console. For more information,
|
|
@@ -9197,8 +9687,8 @@ module Aws::Kendra
|
|
|
9197
9687
|
include Aws::Structure
|
|
9198
9688
|
end
|
|
9199
9689
|
|
|
9200
|
-
# Provides configuration information for crawling knowledge articles
|
|
9201
|
-
# the ServiceNow site.
|
|
9690
|
+
# Provides the configuration information for crawling knowledge articles
|
|
9691
|
+
# in the ServiceNow site.
|
|
9202
9692
|
#
|
|
9203
9693
|
# @note When making an API call, you may pass ServiceNowKnowledgeArticleConfiguration
|
|
9204
9694
|
# data as a hash:
|
|
@@ -9225,15 +9715,27 @@ module Aws::Kendra
|
|
|
9225
9715
|
# @return [Boolean]
|
|
9226
9716
|
#
|
|
9227
9717
|
# @!attribute [rw] include_attachment_file_patterns
|
|
9228
|
-
#
|
|
9229
|
-
#
|
|
9230
|
-
#
|
|
9718
|
+
# A list of regular expression patterns to include certain attachments
|
|
9719
|
+
# of knowledge articles in your ServiceNow. Item that match the
|
|
9720
|
+
# patterns are included in the index. Items that don't match the
|
|
9721
|
+
# patterns are excluded from the index. If an item matches both an
|
|
9722
|
+
# inclusion and exclusion pattern, the exclusion pattern takes
|
|
9723
|
+
# precedence and the item isn't included in the index.
|
|
9724
|
+
#
|
|
9725
|
+
# The regex is applied to the field specified in the
|
|
9726
|
+
# `PatternTargetField`.
|
|
9231
9727
|
# @return [Array<String>]
|
|
9232
9728
|
#
|
|
9233
9729
|
# @!attribute [rw] exclude_attachment_file_patterns
|
|
9234
|
-
#
|
|
9235
|
-
#
|
|
9236
|
-
#
|
|
9730
|
+
# A list of regular expression patterns to exclude certain attachments
|
|
9731
|
+
# of knowledge articles in your ServiceNow. Item that match the
|
|
9732
|
+
# patterns are excluded from the index. Items that don't match the
|
|
9733
|
+
# patterns are included in the index. If an item matches both an
|
|
9734
|
+
# inclusion and exclusion pattern, the exclusion pattern takes
|
|
9735
|
+
# precedence and the item isn't included in the index.
|
|
9736
|
+
#
|
|
9737
|
+
# The regex is applied to the field specified in the
|
|
9738
|
+
# `PatternTargetField`.
|
|
9237
9739
|
# @return [Array<String>]
|
|
9238
9740
|
#
|
|
9239
9741
|
# @!attribute [rw] document_data_field_name
|
|
@@ -9247,8 +9749,16 @@ module Aws::Kendra
|
|
|
9247
9749
|
# @return [String]
|
|
9248
9750
|
#
|
|
9249
9751
|
# @!attribute [rw] field_mappings
|
|
9250
|
-
#
|
|
9251
|
-
#
|
|
9752
|
+
# Maps attributes or field names of knoweldge articles to Amazon
|
|
9753
|
+
# Kendra index field names. To create custom fields, use the
|
|
9754
|
+
# `UpdateIndex` API before you map to ServiceNow fields. For more
|
|
9755
|
+
# information, see [Mapping data source fields][1]. The ServiceNow
|
|
9756
|
+
# data source field names must exist in your ServiceNow custom
|
|
9757
|
+
# metadata.
|
|
9758
|
+
#
|
|
9759
|
+
#
|
|
9760
|
+
#
|
|
9761
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
|
9252
9762
|
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
|
9253
9763
|
#
|
|
9254
9764
|
# @!attribute [rw] filter_query
|
|
@@ -9279,8 +9789,8 @@ module Aws::Kendra
|
|
|
9279
9789
|
include Aws::Structure
|
|
9280
9790
|
end
|
|
9281
9791
|
|
|
9282
|
-
# Provides configuration information for crawling service catalog
|
|
9283
|
-
# in the ServiceNow site
|
|
9792
|
+
# Provides the configuration information for crawling service catalog
|
|
9793
|
+
# items in the ServiceNow site
|
|
9284
9794
|
#
|
|
9285
9795
|
# @note When making an API call, you may pass ServiceNowServiceCatalogConfiguration
|
|
9286
9796
|
# data as a hash:
|
|
@@ -9306,21 +9816,23 @@ module Aws::Kendra
|
|
|
9306
9816
|
# @return [Boolean]
|
|
9307
9817
|
#
|
|
9308
9818
|
# @!attribute [rw] include_attachment_file_patterns
|
|
9309
|
-
# A list of regular expression patterns
|
|
9310
|
-
#
|
|
9311
|
-
#
|
|
9312
|
-
#
|
|
9313
|
-
#
|
|
9819
|
+
# A list of regular expression patterns to include certain attachments
|
|
9820
|
+
# of catalogs in your ServiceNow. Item that match the patterns are
|
|
9821
|
+
# included in the index. Items that don't match the patterns are
|
|
9822
|
+
# excluded from the index. If an item matches both an inclusion and
|
|
9823
|
+
# exclusion pattern, the exclusion pattern takes precedence and the
|
|
9824
|
+
# item isn't included in the index.
|
|
9314
9825
|
#
|
|
9315
9826
|
# The regex is applied to the file name of the attachment.
|
|
9316
9827
|
# @return [Array<String>]
|
|
9317
9828
|
#
|
|
9318
9829
|
# @!attribute [rw] exclude_attachment_file_patterns
|
|
9319
|
-
# A list of regular expression patterns
|
|
9320
|
-
#
|
|
9321
|
-
#
|
|
9322
|
-
#
|
|
9323
|
-
#
|
|
9830
|
+
# A list of regular expression patterns to exclude certain attachments
|
|
9831
|
+
# of catalogs in your ServiceNow. Item that match the patterns are
|
|
9832
|
+
# excluded from the index. Items that don't match the patterns are
|
|
9833
|
+
# included in the index. If an item matches both an inclusion and
|
|
9834
|
+
# exclusion pattern, the exclusion pattern takes precedence and the
|
|
9835
|
+
# item isn't included in the index.
|
|
9324
9836
|
#
|
|
9325
9837
|
# The regex is applied to the file name of the attachment.
|
|
9326
9838
|
# @return [Array<String>]
|
|
@@ -9336,8 +9848,15 @@ module Aws::Kendra
|
|
|
9336
9848
|
# @return [String]
|
|
9337
9849
|
#
|
|
9338
9850
|
# @!attribute [rw] field_mappings
|
|
9339
|
-
#
|
|
9340
|
-
#
|
|
9851
|
+
# Maps attributes or field names of catalogs to Amazon Kendra index
|
|
9852
|
+
# field names. To create custom fields, use the `UpdateIndex` API
|
|
9853
|
+
# before you map to ServiceNow fields. For more information, see
|
|
9854
|
+
# [Mapping data source fields][1]. The ServiceNow data source field
|
|
9855
|
+
# names must exist in your ServiceNow custom metadata.
|
|
9856
|
+
#
|
|
9857
|
+
#
|
|
9858
|
+
#
|
|
9859
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
|
9341
9860
|
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
|
9342
9861
|
#
|
|
9343
9862
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ServiceNowServiceCatalogConfiguration AWS API Documentation
|
|
@@ -9364,8 +9883,8 @@ module Aws::Kendra
|
|
|
9364
9883
|
include Aws::Structure
|
|
9365
9884
|
end
|
|
9366
9885
|
|
|
9367
|
-
# Provides configuration information
|
|
9368
|
-
# SharePoint data source.
|
|
9886
|
+
# Provides the configuration information to connect to Microsoft
|
|
9887
|
+
# SharePoint as your data source.
|
|
9369
9888
|
#
|
|
9370
9889
|
# @note When making an API call, you may pass SharePointConfiguration
|
|
9371
9890
|
# data as a hash:
|
|
@@ -9428,44 +9947,45 @@ module Aws::Kendra
|
|
|
9428
9947
|
# @return [Boolean]
|
|
9429
9948
|
#
|
|
9430
9949
|
# @!attribute [rw] use_change_log
|
|
9431
|
-
#
|
|
9432
|
-
#
|
|
9433
|
-
#
|
|
9434
|
-
#
|
|
9435
|
-
# determine the changed documents using the Amazon Kendra document
|
|
9436
|
-
# crawler.
|
|
9950
|
+
# `TRUE` to use the SharePoint change log to determine which documents
|
|
9951
|
+
# require updating in the index. Depending on the change log's size,
|
|
9952
|
+
# it may take longer for Amazon Kendra to use the change log than to
|
|
9953
|
+
# scan all of your documents in SharePoint.
|
|
9437
9954
|
# @return [Boolean]
|
|
9438
9955
|
#
|
|
9439
9956
|
# @!attribute [rw] inclusion_patterns
|
|
9440
|
-
# A list of regular expression patterns
|
|
9441
|
-
#
|
|
9442
|
-
#
|
|
9443
|
-
#
|
|
9444
|
-
#
|
|
9957
|
+
# A list of regular expression patterns to include certain documents
|
|
9958
|
+
# in your SharePoint. Documents that match the patterns are included
|
|
9959
|
+
# in the index. Documents that don't match the patterns are excluded
|
|
9960
|
+
# from the index. If a document matches both an inclusion and
|
|
9961
|
+
# exclusion pattern, the exclusion pattern takes precedence and the
|
|
9962
|
+
# document isn't included in the index.
|
|
9445
9963
|
#
|
|
9446
9964
|
# The regex is applied to the display URL of the SharePoint document.
|
|
9447
9965
|
# @return [Array<String>]
|
|
9448
9966
|
#
|
|
9449
9967
|
# @!attribute [rw] exclusion_patterns
|
|
9450
|
-
# A list of regular expression patterns
|
|
9451
|
-
#
|
|
9452
|
-
#
|
|
9453
|
-
#
|
|
9454
|
-
#
|
|
9968
|
+
# A list of regular expression patterns to exclude certain documents
|
|
9969
|
+
# in your SharePoint. Documents that match the patterns are excluded
|
|
9970
|
+
# from the index. Documents that don't match the patterns are
|
|
9971
|
+
# included in the index. If a document matches both an inclusion and
|
|
9972
|
+
# exclusion pattern, the exclusion pattern takes precedence and the
|
|
9973
|
+
# document isn't included in the index.
|
|
9455
9974
|
#
|
|
9456
9975
|
# The regex is applied to the display URL of the SharePoint document.
|
|
9457
9976
|
# @return [Array<String>]
|
|
9458
9977
|
#
|
|
9459
9978
|
# @!attribute [rw] vpc_configuration
|
|
9460
|
-
# Provides information
|
|
9979
|
+
# Provides the configuration information to connect to an Amazon VPC.
|
|
9461
9980
|
# @return [Types::DataSourceVpcConfiguration]
|
|
9462
9981
|
#
|
|
9463
9982
|
# @!attribute [rw] field_mappings
|
|
9464
|
-
# A list of `DataSourceToIndexFieldMapping` objects that map
|
|
9465
|
-
# SharePoint attributes
|
|
9466
|
-
#
|
|
9467
|
-
# before you map SharePoint
|
|
9468
|
-
# [Mapping
|
|
9983
|
+
# A list of `DataSourceToIndexFieldMapping` objects that map
|
|
9984
|
+
# SharePoint data source attributes or field names to Amazon Kendra
|
|
9985
|
+
# index field names. To create custom fields, use the `UpdateIndex`
|
|
9986
|
+
# API before you map to SharePoint fields. For more information, see
|
|
9987
|
+
# [Mapping data source fields][1]. The SharePoint data source field
|
|
9988
|
+
# names must exist in your SharePoint custom metadata.
|
|
9469
9989
|
#
|
|
9470
9990
|
#
|
|
9471
9991
|
#
|
|
@@ -9505,7 +10025,7 @@ module Aws::Kendra
|
|
|
9505
10025
|
include Aws::Structure
|
|
9506
10026
|
end
|
|
9507
10027
|
|
|
9508
|
-
# Provides the configuration information
|
|
10028
|
+
# Provides the configuration information for the sitemap URLs to crawl.
|
|
9509
10029
|
#
|
|
9510
10030
|
# *When selecting websites to index, you must adhere to the [Amazon
|
|
9511
10031
|
# Acceptable Use Policy][1] and all other Amazon terms. Remember that
|
|
@@ -9537,6 +10057,180 @@ module Aws::Kendra
|
|
|
9537
10057
|
include Aws::Structure
|
|
9538
10058
|
end
|
|
9539
10059
|
|
|
10060
|
+
# Provides the configuration information to connect to Slack as your
|
|
10061
|
+
# data source.
|
|
10062
|
+
#
|
|
10063
|
+
# @note When making an API call, you may pass SlackConfiguration
|
|
10064
|
+
# data as a hash:
|
|
10065
|
+
#
|
|
10066
|
+
# {
|
|
10067
|
+
# team_id: "TeamId", # required
|
|
10068
|
+
# secret_arn: "SecretArn", # required
|
|
10069
|
+
# vpc_configuration: {
|
|
10070
|
+
# subnet_ids: ["SubnetId"], # required
|
|
10071
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
|
10072
|
+
# },
|
|
10073
|
+
# slack_entity_list: ["PUBLIC_CHANNEL"], # required, accepts PUBLIC_CHANNEL, PRIVATE_CHANNEL, GROUP_MESSAGE, DIRECT_MESSAGE
|
|
10074
|
+
# use_change_log: false,
|
|
10075
|
+
# crawl_bot_message: false,
|
|
10076
|
+
# exclude_archived: false,
|
|
10077
|
+
# since_crawl_date: "SinceCrawlDate", # required
|
|
10078
|
+
# look_back_period: 1,
|
|
10079
|
+
# private_channel_filter: ["String"],
|
|
10080
|
+
# public_channel_filter: ["String"],
|
|
10081
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
|
10082
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
|
10083
|
+
# field_mappings: [
|
|
10084
|
+
# {
|
|
10085
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
|
10086
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
|
10087
|
+
# index_field_name: "IndexFieldName", # required
|
|
10088
|
+
# },
|
|
10089
|
+
# ],
|
|
10090
|
+
# }
|
|
10091
|
+
#
|
|
10092
|
+
# @!attribute [rw] team_id
|
|
10093
|
+
# The identifier of the team in the Slack workspace. For example,
|
|
10094
|
+
# *T0123456789*.
|
|
10095
|
+
#
|
|
10096
|
+
# You can find your team ID in the URL of the main page of your Slack
|
|
10097
|
+
# workspace. When you log in to Slack via a browser, you are directed
|
|
10098
|
+
# to the URL of the main page. For example,
|
|
10099
|
+
# *https://app.slack.com/client/**T0123456789**/...*.
|
|
10100
|
+
# @return [String]
|
|
10101
|
+
#
|
|
10102
|
+
# @!attribute [rw] secret_arn
|
|
10103
|
+
# The Amazon Resource Name (ARN) of an Secrets Manager secret that
|
|
10104
|
+
# contains the key-value pairs required to connect to your Slack
|
|
10105
|
+
# workspace team. The secret must contain a JSON structure with the
|
|
10106
|
+
# following keys:
|
|
10107
|
+
#
|
|
10108
|
+
# * slackToken—The user or bot token created in Slack. For more
|
|
10109
|
+
# information on creating a token in Slack, see [Authentication for
|
|
10110
|
+
# a Slack data source][1].
|
|
10111
|
+
#
|
|
10112
|
+
# ^
|
|
10113
|
+
#
|
|
10114
|
+
#
|
|
10115
|
+
#
|
|
10116
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-slack.html#slack-authentication
|
|
10117
|
+
# @return [String]
|
|
10118
|
+
#
|
|
10119
|
+
# @!attribute [rw] vpc_configuration
|
|
10120
|
+
# Configuration information for an Amazon Virtual Private Cloud to
|
|
10121
|
+
# connect to your Slack. For more information, see [Configuring a
|
|
10122
|
+
# VPC][1].
|
|
10123
|
+
#
|
|
10124
|
+
#
|
|
10125
|
+
#
|
|
10126
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
|
|
10127
|
+
# @return [Types::DataSourceVpcConfiguration]
|
|
10128
|
+
#
|
|
10129
|
+
# @!attribute [rw] slack_entity_list
|
|
10130
|
+
# Specify whether to index public channels, private channels, group
|
|
10131
|
+
# messages, and direct messages. You can specify one or more of these
|
|
10132
|
+
# options.
|
|
10133
|
+
# @return [Array<String>]
|
|
10134
|
+
#
|
|
10135
|
+
# @!attribute [rw] use_change_log
|
|
10136
|
+
# `TRUE` to use the Slack change log to determine which documents
|
|
10137
|
+
# require updating in the index. Depending on the Slack change log's
|
|
10138
|
+
# size, it may take longer for Amazon Kendra to use the change log
|
|
10139
|
+
# than to scan all of your documents in Slack.
|
|
10140
|
+
# @return [Boolean]
|
|
10141
|
+
#
|
|
10142
|
+
# @!attribute [rw] crawl_bot_message
|
|
10143
|
+
# `TRUE` to index bot messages from your Slack workspace team.
|
|
10144
|
+
# @return [Boolean]
|
|
10145
|
+
#
|
|
10146
|
+
# @!attribute [rw] exclude_archived
|
|
10147
|
+
# `TRUE` to exclude archived messages to index from your Slack
|
|
10148
|
+
# workspace team.
|
|
10149
|
+
# @return [Boolean]
|
|
10150
|
+
#
|
|
10151
|
+
# @!attribute [rw] since_crawl_date
|
|
10152
|
+
# The date to start crawling your data from your Slack workspace team.
|
|
10153
|
+
# The date must follow this format: `yyyy-mm-dd`.
|
|
10154
|
+
# @return [String]
|
|
10155
|
+
#
|
|
10156
|
+
# @!attribute [rw] look_back_period
|
|
10157
|
+
# The number of hours for change log to look back from when you last
|
|
10158
|
+
# synchronized your data. You can look back up to 7 days or 168 hours.
|
|
10159
|
+
#
|
|
10160
|
+
# Change log updates your index only if new content was added since
|
|
10161
|
+
# you last synced your data. Updated or deleted content from before
|
|
10162
|
+
# you last synced does not get updated in your index. To capture
|
|
10163
|
+
# updated or deleted content before you last synced, set the
|
|
10164
|
+
# `LookBackPeriod` to the number of hours you want change log to look
|
|
10165
|
+
# back.
|
|
10166
|
+
# @return [Integer]
|
|
10167
|
+
#
|
|
10168
|
+
# @!attribute [rw] private_channel_filter
|
|
10169
|
+
# The list of private channel names from your Slack workspace team.
|
|
10170
|
+
# You use this if you want to index specific private channels, not all
|
|
10171
|
+
# private channels. You can also use regular expression patterns to
|
|
10172
|
+
# filter private channels.
|
|
10173
|
+
# @return [Array<String>]
|
|
10174
|
+
#
|
|
10175
|
+
# @!attribute [rw] public_channel_filter
|
|
10176
|
+
# The list of public channel names to index from your Slack workspace
|
|
10177
|
+
# team. You use this if you want to index specific public channels,
|
|
10178
|
+
# not all public channels. You can also use regular expression
|
|
10179
|
+
# patterns to filter public channels.
|
|
10180
|
+
# @return [Array<String>]
|
|
10181
|
+
#
|
|
10182
|
+
# @!attribute [rw] inclusion_patterns
|
|
10183
|
+
# A list of regular expression patterns to include certain attached
|
|
10184
|
+
# files in your Slack workspace team. Files that match the patterns
|
|
10185
|
+
# are included in the index. Files that don't match the patterns are
|
|
10186
|
+
# excluded from the index. If a file matches both an inclusion and
|
|
10187
|
+
# exclusion pattern, the exclusion pattern takes precedence and the
|
|
10188
|
+
# file isn't included in the index.
|
|
10189
|
+
# @return [Array<String>]
|
|
10190
|
+
#
|
|
10191
|
+
# @!attribute [rw] exclusion_patterns
|
|
10192
|
+
# A list of regular expression patterns to exclude certain attached
|
|
10193
|
+
# files in your Slack workspace team. Files that match the patterns
|
|
10194
|
+
# are excluded from the index. Files that don’t match the patterns are
|
|
10195
|
+
# included in the index. If a file matches both an inclusion and
|
|
10196
|
+
# exclusion pattern, the exclusion pattern takes precedence and the
|
|
10197
|
+
# file isn't included in the index.
|
|
10198
|
+
# @return [Array<String>]
|
|
10199
|
+
#
|
|
10200
|
+
# @!attribute [rw] field_mappings
|
|
10201
|
+
# A list of `DataSourceToIndexFieldMapping` objects that map Slack
|
|
10202
|
+
# data source attributes or field names to Amazon Kendra index field
|
|
10203
|
+
# names. To create custom fields, use the `UpdateIndex` API before you
|
|
10204
|
+
# map to Slack fields. For more information, see [Mapping data source
|
|
10205
|
+
# fields][1]. The Slack data source field names must exist in your
|
|
10206
|
+
# Slack custom metadata.
|
|
10207
|
+
#
|
|
10208
|
+
#
|
|
10209
|
+
#
|
|
10210
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
|
10211
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
|
10212
|
+
#
|
|
10213
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SlackConfiguration AWS API Documentation
|
|
10214
|
+
#
|
|
10215
|
+
class SlackConfiguration < Struct.new(
|
|
10216
|
+
:team_id,
|
|
10217
|
+
:secret_arn,
|
|
10218
|
+
:vpc_configuration,
|
|
10219
|
+
:slack_entity_list,
|
|
10220
|
+
:use_change_log,
|
|
10221
|
+
:crawl_bot_message,
|
|
10222
|
+
:exclude_archived,
|
|
10223
|
+
:since_crawl_date,
|
|
10224
|
+
:look_back_period,
|
|
10225
|
+
:private_channel_filter,
|
|
10226
|
+
:public_channel_filter,
|
|
10227
|
+
:inclusion_patterns,
|
|
10228
|
+
:exclusion_patterns,
|
|
10229
|
+
:field_mappings)
|
|
10230
|
+
SENSITIVE = []
|
|
10231
|
+
include Aws::Structure
|
|
10232
|
+
end
|
|
10233
|
+
|
|
9540
10234
|
# Specifies the document attribute to use to sort the response to a
|
|
9541
10235
|
# Amazon Kendra query. You can specify a single attribute for sorting.
|
|
9542
10236
|
# The attribute must have the `Sortable` flag set to `true`, otherwise
|
|
@@ -9596,8 +10290,60 @@ module Aws::Kendra
|
|
|
9596
10290
|
include Aws::Structure
|
|
9597
10291
|
end
|
|
9598
10292
|
|
|
9599
|
-
#
|
|
9600
|
-
#
|
|
10293
|
+
# A query with suggested spell corrections.
|
|
10294
|
+
#
|
|
10295
|
+
# @!attribute [rw] suggested_query_text
|
|
10296
|
+
# The query with the suggested spell corrections.
|
|
10297
|
+
# @return [String]
|
|
10298
|
+
#
|
|
10299
|
+
# @!attribute [rw] corrections
|
|
10300
|
+
# The corrected misspelled word or words in a query.
|
|
10301
|
+
# @return [Array<Types::Correction>]
|
|
10302
|
+
#
|
|
10303
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SpellCorrectedQuery AWS API Documentation
|
|
10304
|
+
#
|
|
10305
|
+
class SpellCorrectedQuery < Struct.new(
|
|
10306
|
+
:suggested_query_text,
|
|
10307
|
+
:corrections)
|
|
10308
|
+
SENSITIVE = []
|
|
10309
|
+
include Aws::Structure
|
|
10310
|
+
end
|
|
10311
|
+
|
|
10312
|
+
# Provides the configuration information for suggested query spell
|
|
10313
|
+
# corrections.
|
|
10314
|
+
#
|
|
10315
|
+
# Suggested spell corrections are based on words that appear in your
|
|
10316
|
+
# indexed documents and how closely a corrected word matches a
|
|
10317
|
+
# misspelled word.
|
|
10318
|
+
#
|
|
10319
|
+
# This feature is designed with certain defaults or limits. For
|
|
10320
|
+
# information on the current limits and how to request more support for
|
|
10321
|
+
# some limits, see the [Spell Checker documentation][1].
|
|
10322
|
+
#
|
|
10323
|
+
#
|
|
10324
|
+
#
|
|
10325
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/query-spell-check.html
|
|
10326
|
+
#
|
|
10327
|
+
# @note When making an API call, you may pass SpellCorrectionConfiguration
|
|
10328
|
+
# data as a hash:
|
|
10329
|
+
#
|
|
10330
|
+
# {
|
|
10331
|
+
# include_query_spell_check_suggestions: false, # required
|
|
10332
|
+
# }
|
|
10333
|
+
#
|
|
10334
|
+
# @!attribute [rw] include_query_spell_check_suggestions
|
|
10335
|
+
# `TRUE` to suggest spell corrections for queries.
|
|
10336
|
+
# @return [Boolean]
|
|
10337
|
+
#
|
|
10338
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SpellCorrectionConfiguration AWS API Documentation
|
|
10339
|
+
#
|
|
10340
|
+
class SpellCorrectionConfiguration < Struct.new(
|
|
10341
|
+
:include_query_spell_check_suggestions)
|
|
10342
|
+
SENSITIVE = []
|
|
10343
|
+
include Aws::Structure
|
|
10344
|
+
end
|
|
10345
|
+
|
|
10346
|
+
# Provides the configuration information to use a SQL database.
|
|
9601
10347
|
#
|
|
9602
10348
|
# @note When making an API call, you may pass SqlConfiguration
|
|
9603
10349
|
# data as a hash:
|
|
@@ -10405,6 +11151,73 @@ module Aws::Kendra
|
|
|
10405
11151
|
# },
|
|
10406
11152
|
# ],
|
|
10407
11153
|
# },
|
|
11154
|
+
# slack_configuration: {
|
|
11155
|
+
# team_id: "TeamId", # required
|
|
11156
|
+
# secret_arn: "SecretArn", # required
|
|
11157
|
+
# vpc_configuration: {
|
|
11158
|
+
# subnet_ids: ["SubnetId"], # required
|
|
11159
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
|
11160
|
+
# },
|
|
11161
|
+
# slack_entity_list: ["PUBLIC_CHANNEL"], # required, accepts PUBLIC_CHANNEL, PRIVATE_CHANNEL, GROUP_MESSAGE, DIRECT_MESSAGE
|
|
11162
|
+
# use_change_log: false,
|
|
11163
|
+
# crawl_bot_message: false,
|
|
11164
|
+
# exclude_archived: false,
|
|
11165
|
+
# since_crawl_date: "SinceCrawlDate", # required
|
|
11166
|
+
# look_back_period: 1,
|
|
11167
|
+
# private_channel_filter: ["String"],
|
|
11168
|
+
# public_channel_filter: ["String"],
|
|
11169
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
|
11170
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
|
11171
|
+
# field_mappings: [
|
|
11172
|
+
# {
|
|
11173
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
|
11174
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
|
11175
|
+
# index_field_name: "IndexFieldName", # required
|
|
11176
|
+
# },
|
|
11177
|
+
# ],
|
|
11178
|
+
# },
|
|
11179
|
+
# box_configuration: {
|
|
11180
|
+
# enterprise_id: "EnterpriseId", # required
|
|
11181
|
+
# secret_arn: "SecretArn", # required
|
|
11182
|
+
# use_change_log: false,
|
|
11183
|
+
# crawl_comments: false,
|
|
11184
|
+
# crawl_tasks: false,
|
|
11185
|
+
# crawl_web_links: false,
|
|
11186
|
+
# file_field_mappings: [
|
|
11187
|
+
# {
|
|
11188
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
|
11189
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
|
11190
|
+
# index_field_name: "IndexFieldName", # required
|
|
11191
|
+
# },
|
|
11192
|
+
# ],
|
|
11193
|
+
# task_field_mappings: [
|
|
11194
|
+
# {
|
|
11195
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
|
11196
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
|
11197
|
+
# index_field_name: "IndexFieldName", # required
|
|
11198
|
+
# },
|
|
11199
|
+
# ],
|
|
11200
|
+
# comment_field_mappings: [
|
|
11201
|
+
# {
|
|
11202
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
|
11203
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
|
11204
|
+
# index_field_name: "IndexFieldName", # required
|
|
11205
|
+
# },
|
|
11206
|
+
# ],
|
|
11207
|
+
# web_link_field_mappings: [
|
|
11208
|
+
# {
|
|
11209
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
|
11210
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
|
11211
|
+
# index_field_name: "IndexFieldName", # required
|
|
11212
|
+
# },
|
|
11213
|
+
# ],
|
|
11214
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
|
11215
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
|
11216
|
+
# vpc_configuration: {
|
|
11217
|
+
# subnet_ids: ["SubnetId"], # required
|
|
11218
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
|
11219
|
+
# },
|
|
11220
|
+
# },
|
|
10408
11221
|
# },
|
|
10409
11222
|
# description: "Description",
|
|
10410
11223
|
# schedule: "ScanSchedule",
|
|
@@ -10483,7 +11296,8 @@ module Aws::Kendra
|
|
|
10483
11296
|
# @return [String]
|
|
10484
11297
|
#
|
|
10485
11298
|
# @!attribute [rw] configuration
|
|
10486
|
-
# Configuration information for an Amazon Kendra data source
|
|
11299
|
+
# Configuration information for an Amazon Kendra data source you want
|
|
11300
|
+
# to update.
|
|
10487
11301
|
# @return [Types::DataSourceConfiguration]
|
|
10488
11302
|
#
|
|
10489
11303
|
# @!attribute [rw] description
|
|
@@ -10587,9 +11401,7 @@ module Aws::Kendra
|
|
|
10587
11401
|
# @return [String]
|
|
10588
11402
|
#
|
|
10589
11403
|
# @!attribute [rw] configuration
|
|
10590
|
-
#
|
|
10591
|
-
# Amazon Web Services SSO field name that contains the identifiers of
|
|
10592
|
-
# your users, such as their emails.
|
|
11404
|
+
# Configuration information for your Amazon Kendra you want to update.
|
|
10593
11405
|
# @return [Types::ExperienceConfiguration]
|
|
10594
11406
|
#
|
|
10595
11407
|
# @!attribute [rw] description
|
|
@@ -10683,16 +11495,16 @@ module Aws::Kendra
|
|
|
10683
11495
|
# @return [String]
|
|
10684
11496
|
#
|
|
10685
11497
|
# @!attribute [rw] document_metadata_configuration_updates
|
|
10686
|
-
# The document metadata to update.
|
|
11498
|
+
# The document metadata you want to update.
|
|
10687
11499
|
# @return [Array<Types::DocumentMetadataConfiguration>]
|
|
10688
11500
|
#
|
|
10689
11501
|
# @!attribute [rw] capacity_units
|
|
10690
|
-
# Sets the number of additional storage and query capacity
|
|
10691
|
-
# should be used by the index. You can change the capacity
|
|
10692
|
-
# index up to 5 times per day.
|
|
11502
|
+
# Sets the number of additional document storage and query capacity
|
|
11503
|
+
# units that should be used by the index. You can change the capacity
|
|
11504
|
+
# of the index up to 5 times per day, or make 5 API calls.
|
|
10693
11505
|
#
|
|
10694
11506
|
# If you are using extra storage units, you can't reduce the storage
|
|
10695
|
-
# capacity below
|
|
11507
|
+
# capacity below what is required to meet the storage needs for your
|
|
10696
11508
|
# index.
|
|
10697
11509
|
# @return [Types::CapacityUnitsConfiguration]
|
|
10698
11510
|
#
|
|
@@ -10964,8 +11776,8 @@ module Aws::Kendra
|
|
|
10964
11776
|
# }
|
|
10965
11777
|
#
|
|
10966
11778
|
# @!attribute [rw] seed_url_configuration
|
|
10967
|
-
#
|
|
10968
|
-
#
|
|
11779
|
+
# Configuration of the seed or starting point URLs of the websites you
|
|
11780
|
+
# want to crawl.
|
|
10969
11781
|
#
|
|
10970
11782
|
# You can choose to crawl only the website host names, or the website
|
|
10971
11783
|
# host names with subdomains, or the website host names with
|
|
@@ -10975,8 +11787,7 @@ module Aws::Kendra
|
|
|
10975
11787
|
# @return [Types::SeedUrlConfiguration]
|
|
10976
11788
|
#
|
|
10977
11789
|
# @!attribute [rw] site_maps_configuration
|
|
10978
|
-
#
|
|
10979
|
-
# want to crawl.
|
|
11790
|
+
# Configuration of the sitemap URLs of the websites you want to crawl.
|
|
10980
11791
|
#
|
|
10981
11792
|
# Only URLs belonging to the same website host names are crawled. You
|
|
10982
11793
|
# can list up to three sitemap URLs.
|
|
@@ -11101,7 +11912,8 @@ module Aws::Kendra
|
|
|
11101
11912
|
include Aws::Structure
|
|
11102
11913
|
end
|
|
11103
11914
|
|
|
11104
|
-
#
|
|
11915
|
+
# Provides the configuration information for the identifiers of your
|
|
11916
|
+
# users.
|
|
11105
11917
|
#
|
|
11106
11918
|
# @note When making an API call, you may pass UserIdentityConfiguration
|
|
11107
11919
|
# data as a hash:
|
|
@@ -11134,7 +11946,7 @@ module Aws::Kendra
|
|
|
11134
11946
|
include Aws::Structure
|
|
11135
11947
|
end
|
|
11136
11948
|
|
|
11137
|
-
# Provides configuration information for a token
|
|
11949
|
+
# Provides the configuration information for a token.
|
|
11138
11950
|
#
|
|
11139
11951
|
# @note When making an API call, you may pass UserTokenConfiguration
|
|
11140
11952
|
# data as a hash:
|
|
@@ -11303,24 +12115,26 @@ module Aws::Kendra
|
|
|
11303
12115
|
# @return [Integer]
|
|
11304
12116
|
#
|
|
11305
12117
|
# @!attribute [rw] url_inclusion_patterns
|
|
11306
|
-
#
|
|
11307
|
-
#
|
|
11308
|
-
#
|
|
11309
|
-
#
|
|
11310
|
-
# precedence
|
|
12118
|
+
# A list of regular expression patterns to include certain URLs to
|
|
12119
|
+
# crawl. URLs that match the patterns are included in the index. URLs
|
|
12120
|
+
# that don't match the patterns are excluded from the index. If a URL
|
|
12121
|
+
# matches both an inclusion and exclusion pattern, the exclusion
|
|
12122
|
+
# pattern takes precedence and the URL file isn't included in the
|
|
12123
|
+
# index.
|
|
11311
12124
|
# @return [Array<String>]
|
|
11312
12125
|
#
|
|
11313
12126
|
# @!attribute [rw] url_exclusion_patterns
|
|
11314
|
-
#
|
|
11315
|
-
#
|
|
11316
|
-
#
|
|
11317
|
-
#
|
|
11318
|
-
# precedence
|
|
12127
|
+
# A list of regular expression patterns to exclude certain URLs to
|
|
12128
|
+
# crawl. URLs that match the patterns are excluded from the index.
|
|
12129
|
+
# URLs that don't match the patterns are included in the index. If a
|
|
12130
|
+
# URL matches both an inclusion and exclusion pattern, the exclusion
|
|
12131
|
+
# pattern takes precedence and the URL file isn't included in the
|
|
12132
|
+
# index.
|
|
11319
12133
|
# @return [Array<String>]
|
|
11320
12134
|
#
|
|
11321
12135
|
# @!attribute [rw] proxy_configuration
|
|
11322
|
-
#
|
|
11323
|
-
#
|
|
12136
|
+
# Configuration information required to connect to your internal
|
|
12137
|
+
# websites via a web proxy.
|
|
11324
12138
|
#
|
|
11325
12139
|
# You must provide the website host name and port number. For example,
|
|
11326
12140
|
# the host name of https://a.example.com/page1.html is
|
|
@@ -11336,8 +12150,8 @@ module Aws::Kendra
|
|
|
11336
12150
|
# @return [Types::ProxyConfiguration]
|
|
11337
12151
|
#
|
|
11338
12152
|
# @!attribute [rw] authentication_configuration
|
|
11339
|
-
#
|
|
11340
|
-
#
|
|
12153
|
+
# Configuration information required to connect to websites using
|
|
12154
|
+
# authentication.
|
|
11341
12155
|
#
|
|
11342
12156
|
# You can connect to websites using basic authentication of user name
|
|
11343
12157
|
# and password.
|
|
@@ -11418,43 +12232,37 @@ module Aws::Kendra
|
|
|
11418
12232
|
# @return [Boolean]
|
|
11419
12233
|
#
|
|
11420
12234
|
# @!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`.
|
|
12235
|
+
# `TRUE` to use the Amazon WorkDocs change log to determine which
|
|
12236
|
+
# documents require updating in the index. Depending on the change
|
|
12237
|
+
# log's size, it may take longer for Amazon Kendra to use the change
|
|
12238
|
+
# log than to scan all of your documents in Amazon WorkDocs.
|
|
11430
12239
|
# @return [Boolean]
|
|
11431
12240
|
#
|
|
11432
12241
|
# @!attribute [rw] inclusion_patterns
|
|
11433
12242
|
# A list of regular expression patterns to include certain files in
|
|
11434
12243
|
# your Amazon WorkDocs site repository. Files that match the patterns
|
|
11435
12244
|
# 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
|
-
#
|
|
12245
|
+
# excluded from the index. If a file matches both an inclusion and
|
|
12246
|
+
# exclusion pattern, the exclusion pattern takes precedence and the
|
|
12247
|
+
# file isn't included in the index.
|
|
11439
12248
|
# @return [Array<String>]
|
|
11440
12249
|
#
|
|
11441
12250
|
# @!attribute [rw] exclusion_patterns
|
|
11442
12251
|
# A list of regular expression patterns to exclude certain files in
|
|
11443
12252
|
# your Amazon WorkDocs site repository. Files that match the patterns
|
|
11444
12253
|
# 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
|
-
#
|
|
12254
|
+
# included in the index. If a file matches both an inclusion and
|
|
12255
|
+
# exclusion pattern, the exclusion pattern takes precedence and the
|
|
12256
|
+
# file isn't included in the index.
|
|
11448
12257
|
# @return [Array<String>]
|
|
11449
12258
|
#
|
|
11450
12259
|
# @!attribute [rw] field_mappings
|
|
11451
12260
|
# A list of `DataSourceToIndexFieldMapping` objects that map Amazon
|
|
11452
|
-
# WorkDocs
|
|
11453
|
-
#
|
|
11454
|
-
#
|
|
11455
|
-
#
|
|
11456
|
-
#
|
|
11457
|
-
# WorkDocs custom metadata.
|
|
12261
|
+
# WorkDocs data source attributes or field names to Amazon Kendra
|
|
12262
|
+
# index field names. To create custom fields, use the `UpdateIndex`
|
|
12263
|
+
# API before you map to Amazon WorkDocs fields. For more information,
|
|
12264
|
+
# see [Mapping data source fields][1]. The Amazon WorkDocs data source
|
|
12265
|
+
# field names must exist in your Amazon WorkDocs custom metadata.
|
|
11458
12266
|
#
|
|
11459
12267
|
#
|
|
11460
12268
|
#
|