aws-sdk-kendra 1.43.0 → 1.46.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 +138 -82
- data/lib/aws-sdk-kendra/client_api.rb +38 -0
- data/lib/aws-sdk-kendra/types.rb +451 -196
- data/lib/aws-sdk-kendra.rb +1 -1
- metadata +4 -4
data/lib/aws-sdk-kendra/types.rb
CHANGED
@@ -62,7 +62,7 @@ module Aws::Kendra
|
|
62
62
|
# A list of groups, separated by semi-colons, that filters a query
|
63
63
|
# response based on user context. The document is only returned to
|
64
64
|
# users that are in one of the groups specified in the `UserContext`
|
65
|
-
# field of the `Query`
|
65
|
+
# field of the `Query` API.
|
66
66
|
# @return [String]
|
67
67
|
#
|
68
68
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AclConfiguration AWS API Documentation
|
@@ -736,7 +736,7 @@ module Aws::Kendra
|
|
736
736
|
end
|
737
737
|
|
738
738
|
# Provides information about documents that could not be removed from an
|
739
|
-
# index by the `BatchDeleteDocument`
|
739
|
+
# index by the `BatchDeleteDocument` API.
|
740
740
|
#
|
741
741
|
# @!attribute [rw] id
|
742
742
|
# The identifier of the document that couldn't be removed from the
|
@@ -788,7 +788,7 @@ module Aws::Kendra
|
|
788
788
|
#
|
789
789
|
# @!attribute [rw] index_id
|
790
790
|
# The identifier of the index to add documents to. The index ID is
|
791
|
-
# returned by the [
|
791
|
+
# returned by the [CreateIndex ][1] API.
|
792
792
|
#
|
793
793
|
#
|
794
794
|
#
|
@@ -969,13 +969,13 @@ module Aws::Kendra
|
|
969
969
|
#
|
970
970
|
# @!attribute [rw] index_id
|
971
971
|
# The identifier of the index to add the documents to. You need to
|
972
|
-
# create the index first using the `CreateIndex`
|
972
|
+
# create the index first using the `CreateIndex` API.
|
973
973
|
# @return [String]
|
974
974
|
#
|
975
975
|
# @!attribute [rw] role_arn
|
976
976
|
# The Amazon Resource Name (ARN) of a role that is allowed to run the
|
977
|
-
# `BatchPutDocument`
|
978
|
-
#
|
977
|
+
# `BatchPutDocument` API. For more information, see [IAM Roles for
|
978
|
+
# Amazon Kendra][1].
|
979
979
|
#
|
980
980
|
#
|
981
981
|
#
|
@@ -985,13 +985,6 @@ module Aws::Kendra
|
|
985
985
|
# @!attribute [rw] documents
|
986
986
|
# One or more documents to add to the index.
|
987
987
|
#
|
988
|
-
# Documents can include custom attributes. For example,
|
989
|
-
# 'DataSourceId' and 'DataSourceSyncJobId' are custom attributes
|
990
|
-
# that provide information on the synchronization of documents running
|
991
|
-
# on a data source. Note, 'DataSourceSyncJobId' could be an optional
|
992
|
-
# custom attribute as Amazon Kendra will use the ID of a running sync
|
993
|
-
# job.
|
994
|
-
#
|
995
988
|
# Documents have the following file size limits.
|
996
989
|
#
|
997
990
|
# * 5 MB total size for inline documents
|
@@ -1011,7 +1004,7 @@ module Aws::Kendra
|
|
1011
1004
|
# @!attribute [rw] custom_document_enrichment_configuration
|
1012
1005
|
# Configuration information for altering your document metadata and
|
1013
1006
|
# content during the document ingestion process when you use the
|
1014
|
-
# `BatchPutDocument`
|
1007
|
+
# `BatchPutDocument` API.
|
1015
1008
|
#
|
1016
1009
|
# For more information on how to create, modify and delete document
|
1017
1010
|
# metadata, or make other content alterations when you ingest
|
@@ -1151,8 +1144,8 @@ module Aws::Kendra
|
|
1151
1144
|
end
|
1152
1145
|
|
1153
1146
|
# Gathers information about when a particular result was clicked by a
|
1154
|
-
# user. Your application uses the `SubmitFeedback`
|
1155
|
-
#
|
1147
|
+
# user. Your application uses the `SubmitFeedback` API to provide click
|
1148
|
+
# information.
|
1156
1149
|
#
|
1157
1150
|
# @note When making an API call, you may pass ClickFeedback
|
1158
1151
|
# data as a hash:
|
@@ -1214,7 +1207,7 @@ module Aws::Kendra
|
|
1214
1207
|
# @!attribute [rw] field_mappings
|
1215
1208
|
# An array of objects that map database column names to the
|
1216
1209
|
# corresponding fields in an index. You must first create the fields
|
1217
|
-
# in the index using the `UpdateIndex`
|
1210
|
+
# in the index using the `UpdateIndex` API.
|
1218
1211
|
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
1219
1212
|
#
|
1220
1213
|
# @!attribute [rw] change_detecting_columns
|
@@ -1272,7 +1265,7 @@ module Aws::Kendra
|
|
1272
1265
|
# Defines how attachment metadata fields should be mapped to index
|
1273
1266
|
# fields. Before you can map a field, you must first create an index
|
1274
1267
|
# field with a matching type using the console or the `UpdateIndex`
|
1275
|
-
#
|
1268
|
+
# API.
|
1276
1269
|
#
|
1277
1270
|
# If you specify the `AttachentFieldMappings` parameter, you must
|
1278
1271
|
# specify at least one field mapping.
|
@@ -1290,8 +1283,7 @@ module Aws::Kendra
|
|
1290
1283
|
# Defines the mapping between a field in the Confluence data source to a
|
1291
1284
|
# Amazon Kendra index field.
|
1292
1285
|
#
|
1293
|
-
# You must first create the index field using the `UpdateIndex`
|
1294
|
-
# operation.
|
1286
|
+
# You must first create the index field using the `UpdateIndex` API.
|
1295
1287
|
#
|
1296
1288
|
# @note When making an API call, you may pass ConfluenceAttachmentToIndexFieldMapping
|
1297
1289
|
# data as a hash:
|
@@ -1305,8 +1297,7 @@ module Aws::Kendra
|
|
1305
1297
|
# @!attribute [rw] data_source_field_name
|
1306
1298
|
# The name of the field in the data source.
|
1307
1299
|
#
|
1308
|
-
# You must first create the index field using the `UpdateIndex`
|
1309
|
-
# operation.
|
1300
|
+
# You must first create the index field using the `UpdateIndex` API.
|
1310
1301
|
# @return [String]
|
1311
1302
|
#
|
1312
1303
|
# @!attribute [rw] date_field_format
|
@@ -1334,7 +1325,7 @@ module Aws::Kendra
|
|
1334
1325
|
# Specifies the blog settings for the Confluence data source. Blogs are
|
1335
1326
|
# always indexed unless filtered from the index by the
|
1336
1327
|
# `ExclusionPatterns` or `InclusionPatterns` fields in the
|
1337
|
-
# `ConfluenceConfiguration`
|
1328
|
+
# `ConfluenceConfiguration` object.
|
1338
1329
|
#
|
1339
1330
|
# @note When making an API call, you may pass ConfluenceBlogConfiguration
|
1340
1331
|
# data as a hash:
|
@@ -1352,8 +1343,7 @@ module Aws::Kendra
|
|
1352
1343
|
# @!attribute [rw] blog_field_mappings
|
1353
1344
|
# Defines how blog metadata fields should be mapped to index fields.
|
1354
1345
|
# Before you can map a field, you must first create an index field
|
1355
|
-
# with a matching type using the console or the `UpdateIndex`
|
1356
|
-
# operation.
|
1346
|
+
# with a matching type using the console or the `UpdateIndex` API.
|
1357
1347
|
#
|
1358
1348
|
# If you specify the `BlogFieldMappings` parameter, you must specify
|
1359
1349
|
# at least one field mapping.
|
@@ -1370,8 +1360,7 @@ module Aws::Kendra
|
|
1370
1360
|
# Defines the mapping between a blog field in the Confluence data source
|
1371
1361
|
# to a Amazon Kendra index field.
|
1372
1362
|
#
|
1373
|
-
# You must first create the index field using the `UpdateIndex`
|
1374
|
-
# operation.
|
1363
|
+
# You must first create the index field using the `UpdateIndex` API.
|
1375
1364
|
#
|
1376
1365
|
# @note When making an API call, you may pass ConfluenceBlogToIndexFieldMapping
|
1377
1366
|
# data as a hash:
|
@@ -1408,8 +1397,8 @@ module Aws::Kendra
|
|
1408
1397
|
include Aws::Structure
|
1409
1398
|
end
|
1410
1399
|
|
1411
|
-
# Provides configuration information
|
1412
|
-
#
|
1400
|
+
# Provides the configuration information to connect to Confluence as
|
1401
|
+
# your data source.
|
1413
1402
|
#
|
1414
1403
|
# @note When making an API call, you may pass ConfluenceConfiguration
|
1415
1404
|
# data as a hash:
|
@@ -1566,8 +1555,7 @@ module Aws::Kendra
|
|
1566
1555
|
# @!attribute [rw] page_field_mappings
|
1567
1556
|
# Defines how page metadata fields should be mapped to index fields.
|
1568
1557
|
# Before you can map a field, you must first create an index field
|
1569
|
-
# with a matching type using the console or the `UpdateIndex`
|
1570
|
-
# operation.
|
1558
|
+
# with a matching type using the console or the `UpdateIndex` API.
|
1571
1559
|
#
|
1572
1560
|
# If you specify the `PageFieldMappings` parameter, you must specify
|
1573
1561
|
# at least one field mapping.
|
@@ -1584,8 +1572,7 @@ module Aws::Kendra
|
|
1584
1572
|
# Defines the mapping between a field in the Confluence data source to a
|
1585
1573
|
# Amazon Kendra index field.
|
1586
1574
|
#
|
1587
|
-
# You must first create the index field using the `UpdateIndex`
|
1588
|
-
# operation.
|
1575
|
+
# You must first create the index field using the `UpdateIndex` API.
|
1589
1576
|
#
|
1590
1577
|
# @note When making an API call, you may pass ConfluencePageToIndexFieldMapping
|
1591
1578
|
# data as a hash:
|
@@ -1676,8 +1663,7 @@ module Aws::Kendra
|
|
1676
1663
|
# @!attribute [rw] space_field_mappings
|
1677
1664
|
# Defines how space metadata fields should be mapped to index fields.
|
1678
1665
|
# Before you can map a field, you must first create an index field
|
1679
|
-
# with a matching type using the console or the `UpdateIndex`
|
1680
|
-
# operation.
|
1666
|
+
# with a matching type using the console or the `UpdateIndex` API.
|
1681
1667
|
#
|
1682
1668
|
# If you specify the `SpaceFieldMappings` parameter, you must specify
|
1683
1669
|
# at least one field mapping.
|
@@ -1695,11 +1681,10 @@ module Aws::Kendra
|
|
1695
1681
|
include Aws::Structure
|
1696
1682
|
end
|
1697
1683
|
|
1698
|
-
# Defines the mapping between a field in the Confluence data source to
|
1699
|
-
# Amazon Kendra index field.
|
1684
|
+
# Defines the mapping between a field in the Confluence data source to
|
1685
|
+
# an Amazon Kendra index field.
|
1700
1686
|
#
|
1701
|
-
# You must first create the index field using the `UpdateIndex`
|
1702
|
-
# operation.
|
1687
|
+
# You must first create the index field using the `UpdateIndex` API.
|
1703
1688
|
#
|
1704
1689
|
# @note When making an API call, you may pass ConfluenceSpaceToIndexFieldMapping
|
1705
1690
|
# data as a hash:
|
@@ -1736,7 +1721,8 @@ module Aws::Kendra
|
|
1736
1721
|
include Aws::Structure
|
1737
1722
|
end
|
1738
1723
|
|
1739
|
-
# Provides the information
|
1724
|
+
# Provides the configuration information that's required to connect to
|
1725
|
+
# a database.
|
1740
1726
|
#
|
1741
1727
|
# @note When making an API call, you may pass ConnectionConfiguration
|
1742
1728
|
# data as a hash:
|
@@ -1791,8 +1777,9 @@ module Aws::Kendra
|
|
1791
1777
|
include Aws::Structure
|
1792
1778
|
end
|
1793
1779
|
|
1794
|
-
#
|
1795
|
-
# sources, FAQs, and content indexed directly via
|
1780
|
+
# Provides the configuration information for your content sources, such
|
1781
|
+
# as data sources, FAQs, and content indexed directly via
|
1782
|
+
# [BatchPutDocument][1].
|
1796
1783
|
#
|
1797
1784
|
#
|
1798
1785
|
#
|
@@ -1819,7 +1806,7 @@ module Aws::Kendra
|
|
1819
1806
|
#
|
1820
1807
|
# @!attribute [rw] direct_put_content
|
1821
1808
|
# `TRUE` to use documents you indexed directly using the
|
1822
|
-
# `BatchPutDocument`
|
1809
|
+
# `BatchPutDocument` API.
|
1823
1810
|
# @return [Boolean]
|
1824
1811
|
#
|
1825
1812
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ContentSourceConfiguration AWS API Documentation
|
@@ -1832,13 +1819,44 @@ module Aws::Kendra
|
|
1832
1819
|
include Aws::Structure
|
1833
1820
|
end
|
1834
1821
|
|
1822
|
+
# A corrected misspelled word in a query.
|
1823
|
+
#
|
1824
|
+
# @!attribute [rw] begin_offset
|
1825
|
+
# The zero-based location in the response string or text where the
|
1826
|
+
# corrected word starts.
|
1827
|
+
# @return [Integer]
|
1828
|
+
#
|
1829
|
+
# @!attribute [rw] end_offset
|
1830
|
+
# The zero-based location in the response string or text where the
|
1831
|
+
# corrected word ends.
|
1832
|
+
# @return [Integer]
|
1833
|
+
#
|
1834
|
+
# @!attribute [rw] term
|
1835
|
+
# The string or text of a misspelled word in a query.
|
1836
|
+
# @return [String]
|
1837
|
+
#
|
1838
|
+
# @!attribute [rw] corrected_term
|
1839
|
+
# The string or text of a corrected misspelled word in a query.
|
1840
|
+
# @return [String]
|
1841
|
+
#
|
1842
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Correction AWS API Documentation
|
1843
|
+
#
|
1844
|
+
class Correction < Struct.new(
|
1845
|
+
:begin_offset,
|
1846
|
+
:end_offset,
|
1847
|
+
:term,
|
1848
|
+
:corrected_term)
|
1849
|
+
SENSITIVE = []
|
1850
|
+
include Aws::Structure
|
1851
|
+
end
|
1852
|
+
|
1835
1853
|
# @note When making an API call, you may pass CreateDataSourceRequest
|
1836
1854
|
# data as a hash:
|
1837
1855
|
#
|
1838
1856
|
# {
|
1839
1857
|
# name: "DataSourceName", # required
|
1840
1858
|
# index_id: "IndexId", # required
|
1841
|
-
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS
|
1859
|
+
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX
|
1842
1860
|
# configuration: {
|
1843
1861
|
# s3_configuration: {
|
1844
1862
|
# bucket_name: "S3BucketName", # required
|
@@ -2150,6 +2168,24 @@ module Aws::Kendra
|
|
2150
2168
|
# },
|
2151
2169
|
# ],
|
2152
2170
|
# },
|
2171
|
+
# fsx_configuration: {
|
2172
|
+
# file_system_id: "FileSystemId", # required
|
2173
|
+
# file_system_type: "WINDOWS", # required, accepts WINDOWS
|
2174
|
+
# vpc_configuration: { # required
|
2175
|
+
# subnet_ids: ["SubnetId"], # required
|
2176
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
2177
|
+
# },
|
2178
|
+
# secret_arn: "SecretArn",
|
2179
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2180
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2181
|
+
# field_mappings: [
|
2182
|
+
# {
|
2183
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2184
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2185
|
+
# index_field_name: "IndexFieldName", # required
|
2186
|
+
# },
|
2187
|
+
# ],
|
2188
|
+
# },
|
2153
2189
|
# },
|
2154
2190
|
# description: "Description",
|
2155
2191
|
# schedule: "ScanSchedule",
|
@@ -2235,8 +2271,8 @@ module Aws::Kendra
|
|
2235
2271
|
# @return [String]
|
2236
2272
|
#
|
2237
2273
|
# @!attribute [rw] configuration
|
2238
|
-
#
|
2239
|
-
#
|
2274
|
+
# Configuration information that is required to access the data source
|
2275
|
+
# repository.
|
2240
2276
|
#
|
2241
2277
|
# You can't specify the `Configuration` parameter when the `Type`
|
2242
2278
|
# parameter is set to `CUSTOM`. If you do, you receive a
|
@@ -2251,10 +2287,10 @@ module Aws::Kendra
|
|
2251
2287
|
# @return [String]
|
2252
2288
|
#
|
2253
2289
|
# @!attribute [rw] schedule
|
2254
|
-
# Sets the frequency
|
2255
|
-
#
|
2256
|
-
#
|
2257
|
-
#
|
2290
|
+
# Sets the frequency for Amazon Kendra to check the documents in your
|
2291
|
+
# repository and update the index. If you don't set a schedule Amazon
|
2292
|
+
# Kendra will not periodically update the index. You can call the
|
2293
|
+
# `StartDataSourceSyncJob` API to update the index.
|
2258
2294
|
#
|
2259
2295
|
# You can't specify the `Schedule` parameter when the `Type`
|
2260
2296
|
# parameter is set to `CUSTOM`. If you do, you receive a
|
@@ -2285,8 +2321,8 @@ module Aws::Kendra
|
|
2285
2321
|
#
|
2286
2322
|
# @!attribute [rw] client_token
|
2287
2323
|
# A token that you provide to identify the request to create a data
|
2288
|
-
# source. Multiple calls to the `CreateDataSource`
|
2289
|
-
#
|
2324
|
+
# source. Multiple calls to the `CreateDataSource` API with the same
|
2325
|
+
# client token will create only one data source.
|
2290
2326
|
#
|
2291
2327
|
# **A suitable default value is auto-generated.** You should normally
|
2292
2328
|
# not need to pass this option.
|
@@ -2379,10 +2415,9 @@ module Aws::Kendra
|
|
2379
2415
|
#
|
2380
2416
|
# @!attribute [rw] role_arn
|
2381
2417
|
# The Amazon Resource Name (ARN) of a role with permission to access
|
2382
|
-
# `Query`
|
2383
|
-
#
|
2384
|
-
#
|
2385
|
-
# Kendra][1].
|
2418
|
+
# `Query` API, `QuerySuggestions` API, `SubmitFeedback` API, and
|
2419
|
+
# Amazon Web Services SSO that stores your user and group information.
|
2420
|
+
# For more information, see [IAM roles for Amazon Kendra][1].
|
2386
2421
|
#
|
2387
2422
|
#
|
2388
2423
|
#
|
@@ -2390,11 +2425,11 @@ module Aws::Kendra
|
|
2390
2425
|
# @return [String]
|
2391
2426
|
#
|
2392
2427
|
# @!attribute [rw] configuration
|
2393
|
-
#
|
2394
|
-
#
|
2395
|
-
#
|
2396
|
-
#
|
2397
|
-
#
|
2428
|
+
# Configuration information for your Amazon Kendra experience. This
|
2429
|
+
# includes `ContentSourceConfiguration`, which specifies the data
|
2430
|
+
# source IDs and/or FAQ IDs, and `UserIdentityConfiguration`, which
|
2431
|
+
# specifies the user or group information to grant access to your
|
2432
|
+
# Amazon Kendra experience.
|
2398
2433
|
# @return [Types::ExperienceConfiguration]
|
2399
2434
|
#
|
2400
2435
|
# @!attribute [rw] description
|
@@ -2404,7 +2439,7 @@ module Aws::Kendra
|
|
2404
2439
|
# @!attribute [rw] client_token
|
2405
2440
|
# A token that you provide to identify the request to create your
|
2406
2441
|
# Amazon Kendra experience. Multiple calls to the `CreateExperience`
|
2407
|
-
#
|
2442
|
+
# API with the same client token creates only one Amazon Kendra
|
2408
2443
|
# experience.
|
2409
2444
|
#
|
2410
2445
|
# **A suitable default value is auto-generated.** You should normally
|
@@ -2508,8 +2543,8 @@ module Aws::Kendra
|
|
2508
2543
|
#
|
2509
2544
|
# @!attribute [rw] client_token
|
2510
2545
|
# A token that you provide to identify the request to create a FAQ.
|
2511
|
-
# Multiple calls to the `CreateFaqRequest`
|
2512
|
-
#
|
2546
|
+
# Multiple calls to the `CreateFaqRequest` API with the same client
|
2547
|
+
# token will create only one FAQ.
|
2513
2548
|
#
|
2514
2549
|
# **A suitable default value is auto-generated.** You should normally
|
2515
2550
|
# not need to pass this option.
|
@@ -2620,8 +2655,8 @@ module Aws::Kendra
|
|
2620
2655
|
# @!attribute [rw] role_arn
|
2621
2656
|
# An Identity and Access Management(IAM) role that gives Amazon Kendra
|
2622
2657
|
# permissions to access your Amazon CloudWatch logs and metrics. This
|
2623
|
-
# is also the role used when you use the `BatchPutDocument`
|
2624
|
-
#
|
2658
|
+
# is also the role used when you use the `BatchPutDocument` API to
|
2659
|
+
# index documents from an Amazon S3 bucket.
|
2625
2660
|
# @return [String]
|
2626
2661
|
#
|
2627
2662
|
# @!attribute [rw] server_side_encryption_configuration
|
@@ -2636,8 +2671,8 @@ module Aws::Kendra
|
|
2636
2671
|
#
|
2637
2672
|
# @!attribute [rw] client_token
|
2638
2673
|
# A token that you provide to identify the request to create an index.
|
2639
|
-
# Multiple calls to the `CreateIndex`
|
2640
|
-
#
|
2674
|
+
# Multiple calls to the `CreateIndex` API with the same client token
|
2675
|
+
# will create only one index.
|
2641
2676
|
#
|
2642
2677
|
# **A suitable default value is auto-generated.** You should normally
|
2643
2678
|
# not need to pass this option.
|
@@ -2778,10 +2813,10 @@ module Aws::Kendra
|
|
2778
2813
|
# The IAM (Identity and Access Management) role used by Amazon Kendra
|
2779
2814
|
# to access the block list text file in your S3 bucket.
|
2780
2815
|
#
|
2781
|
-
# You need permissions to the role ARN (Amazon
|
2782
|
-
# role needs S3 read permissions to your file in S3 and
|
2783
|
-
# STS (Security Token Service) assume role permissions
|
2784
|
-
# Kendra.
|
2816
|
+
# You need permissions to the role ARN (Amazon Web Services Resource
|
2817
|
+
# Name). The role needs S3 read permissions to your file in S3 and
|
2818
|
+
# needs to give STS (Security Token Service) assume role permissions
|
2819
|
+
# to Amazon Kendra.
|
2785
2820
|
# @return [String]
|
2786
2821
|
#
|
2787
2822
|
# @!attribute [rw] tags
|
@@ -2865,8 +2900,8 @@ module Aws::Kendra
|
|
2865
2900
|
#
|
2866
2901
|
# @!attribute [rw] client_token
|
2867
2902
|
# A token that you provide to identify the request to create a
|
2868
|
-
# thesaurus. Multiple calls to the `CreateThesaurus`
|
2869
|
-
#
|
2903
|
+
# thesaurus. Multiple calls to the `CreateThesaurus` API with the same
|
2904
|
+
# client token will create only one thesaurus.
|
2870
2905
|
#
|
2871
2906
|
# **A suitable default value is auto-generated.** You should normally
|
2872
2907
|
# not need to pass this option.
|
@@ -3020,7 +3055,8 @@ module Aws::Kendra
|
|
3020
3055
|
include Aws::Structure
|
3021
3056
|
end
|
3022
3057
|
|
3023
|
-
#
|
3058
|
+
# Provides the configuration information for an Amazon Kendra data
|
3059
|
+
# source.
|
3024
3060
|
#
|
3025
3061
|
# @note When making an API call, you may pass DataSourceConfiguration
|
3026
3062
|
# data as a hash:
|
@@ -3336,36 +3372,54 @@ module Aws::Kendra
|
|
3336
3372
|
# },
|
3337
3373
|
# ],
|
3338
3374
|
# },
|
3375
|
+
# fsx_configuration: {
|
3376
|
+
# file_system_id: "FileSystemId", # required
|
3377
|
+
# file_system_type: "WINDOWS", # required, accepts WINDOWS
|
3378
|
+
# vpc_configuration: { # required
|
3379
|
+
# subnet_ids: ["SubnetId"], # required
|
3380
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
3381
|
+
# },
|
3382
|
+
# secret_arn: "SecretArn",
|
3383
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
3384
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
3385
|
+
# field_mappings: [
|
3386
|
+
# {
|
3387
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
3388
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
3389
|
+
# index_field_name: "IndexFieldName", # required
|
3390
|
+
# },
|
3391
|
+
# ],
|
3392
|
+
# },
|
3339
3393
|
# }
|
3340
3394
|
#
|
3341
3395
|
# @!attribute [rw] s3_configuration
|
3342
|
-
# Provides information to
|
3343
|
-
#
|
3396
|
+
# Provides the configuration information to connect to an Amazon S3
|
3397
|
+
# bucket as your data source.
|
3344
3398
|
# @return [Types::S3DataSourceConfiguration]
|
3345
3399
|
#
|
3346
3400
|
# @!attribute [rw] share_point_configuration
|
3347
|
-
# Provides information
|
3348
|
-
#
|
3401
|
+
# Provides the configuration information to connect to Microsoft
|
3402
|
+
# SharePoint as your data source.
|
3349
3403
|
# @return [Types::SharePointConfiguration]
|
3350
3404
|
#
|
3351
3405
|
# @!attribute [rw] database_configuration
|
3352
|
-
# Provides information
|
3353
|
-
#
|
3406
|
+
# Provides the configuration information to connect to a database as
|
3407
|
+
# your data source.
|
3354
3408
|
# @return [Types::DatabaseConfiguration]
|
3355
3409
|
#
|
3356
3410
|
# @!attribute [rw] salesforce_configuration
|
3357
|
-
# Provides configuration information
|
3358
|
-
#
|
3411
|
+
# Provides the configuration information to connect to Salesforce as
|
3412
|
+
# your data source.
|
3359
3413
|
# @return [Types::SalesforceConfiguration]
|
3360
3414
|
#
|
3361
3415
|
# @!attribute [rw] one_drive_configuration
|
3362
|
-
# Provides configuration
|
3363
|
-
# OneDrive.
|
3416
|
+
# Provides the configuration information to connect to Microsoft
|
3417
|
+
# OneDrive as your data source.
|
3364
3418
|
# @return [Types::OneDriveConfiguration]
|
3365
3419
|
#
|
3366
3420
|
# @!attribute [rw] service_now_configuration
|
3367
|
-
# Provides configuration
|
3368
|
-
#
|
3421
|
+
# Provides the configuration information to connect to ServiceNow as
|
3422
|
+
# your data source.
|
3369
3423
|
# @return [Types::ServiceNowConfiguration]
|
3370
3424
|
#
|
3371
3425
|
# @!attribute [rw] confluence_configuration
|
@@ -3374,8 +3428,8 @@ module Aws::Kendra
|
|
3374
3428
|
# @return [Types::ConfluenceConfiguration]
|
3375
3429
|
#
|
3376
3430
|
# @!attribute [rw] google_drive_configuration
|
3377
|
-
# Provides configuration
|
3378
|
-
#
|
3431
|
+
# Provides the configuration information to connect to Google Drive as
|
3432
|
+
# your data source.
|
3379
3433
|
# @return [Types::GoogleDriveConfiguration]
|
3380
3434
|
#
|
3381
3435
|
# @!attribute [rw] web_crawler_configuration
|
@@ -3384,10 +3438,15 @@ module Aws::Kendra
|
|
3384
3438
|
# @return [Types::WebCrawlerConfiguration]
|
3385
3439
|
#
|
3386
3440
|
# @!attribute [rw] work_docs_configuration
|
3387
|
-
# Provides the configuration information to connect to WorkDocs
|
3388
|
-
# your data source.
|
3441
|
+
# Provides the configuration information to connect to Amazon WorkDocs
|
3442
|
+
# as your data source.
|
3389
3443
|
# @return [Types::WorkDocsConfiguration]
|
3390
3444
|
#
|
3445
|
+
# @!attribute [rw] fsx_configuration
|
3446
|
+
# Provides the configuration information to connect to Amazon FSx as
|
3447
|
+
# your data source.
|
3448
|
+
# @return [Types::FsxConfiguration]
|
3449
|
+
#
|
3391
3450
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceConfiguration AWS API Documentation
|
3392
3451
|
#
|
3393
3452
|
class DataSourceConfiguration < Struct.new(
|
@@ -3400,7 +3459,8 @@ module Aws::Kendra
|
|
3400
3459
|
:confluence_configuration,
|
3401
3460
|
:google_drive_configuration,
|
3402
3461
|
:web_crawler_configuration,
|
3403
|
-
:work_docs_configuration
|
3462
|
+
:work_docs_configuration,
|
3463
|
+
:fsx_configuration)
|
3404
3464
|
SENSITIVE = []
|
3405
3465
|
include Aws::Structure
|
3406
3466
|
end
|
@@ -3436,8 +3496,8 @@ module Aws::Kendra
|
|
3436
3496
|
include Aws::Structure
|
3437
3497
|
end
|
3438
3498
|
|
3439
|
-
# Summary information for
|
3440
|
-
# call to the `DescribeDataSource`
|
3499
|
+
# Summary information for an Amazon Kendra data source. Returned in a
|
3500
|
+
# call to the `DescribeDataSource` API.
|
3441
3501
|
#
|
3442
3502
|
# @!attribute [rw] name
|
3443
3503
|
# The name of the data source.
|
@@ -3489,18 +3549,18 @@ module Aws::Kendra
|
|
3489
3549
|
include Aws::Structure
|
3490
3550
|
end
|
3491
3551
|
|
3492
|
-
# Provides information about a synchronization job.
|
3552
|
+
# Provides information about a data source synchronization job.
|
3493
3553
|
#
|
3494
3554
|
# @!attribute [rw] execution_id
|
3495
3555
|
# A unique identifier for the synchronization job.
|
3496
3556
|
# @return [String]
|
3497
3557
|
#
|
3498
3558
|
# @!attribute [rw] start_time
|
3499
|
-
# The UNIX datetime that the synchronization job
|
3559
|
+
# The UNIX datetime that the synchronization job started.
|
3500
3560
|
# @return [Time]
|
3501
3561
|
#
|
3502
3562
|
# @!attribute [rw] end_time
|
3503
|
-
# The UNIX datetime that the synchronization job
|
3563
|
+
# The UNIX datetime that the synchronization job completed.
|
3504
3564
|
# @return [Time]
|
3505
3565
|
#
|
3506
3566
|
# @!attribute [rw] status
|
@@ -3518,7 +3578,7 @@ module Aws::Kendra
|
|
3518
3578
|
#
|
3519
3579
|
# @!attribute [rw] error_code
|
3520
3580
|
# If the `Status` field is set to `FAILED`, the `ErrorCode` field
|
3521
|
-
#
|
3581
|
+
# indicates the reason the synchronization failed.
|
3522
3582
|
# @return [String]
|
3523
3583
|
#
|
3524
3584
|
# @!attribute [rw] data_source_error_code
|
@@ -3626,8 +3686,7 @@ module Aws::Kendra
|
|
3626
3686
|
end
|
3627
3687
|
|
3628
3688
|
# Maps a column or attribute in the data source to an index field. You
|
3629
|
-
# must first create the fields in the index using the `UpdateIndex`
|
3630
|
-
# operation.
|
3689
|
+
# must first create the fields in the index using the `UpdateIndex` API.
|
3631
3690
|
#
|
3632
3691
|
# @note When making an API call, you may pass DataSourceToIndexFieldMapping
|
3633
3692
|
# data as a hash:
|
@@ -3660,7 +3719,7 @@ module Aws::Kendra
|
|
3660
3719
|
include Aws::Structure
|
3661
3720
|
end
|
3662
3721
|
|
3663
|
-
# Provides information
|
3722
|
+
# Provides the configuration information to connect to an Amazon VPC.
|
3664
3723
|
#
|
3665
3724
|
# @note When making an API call, you may pass DataSourceVpcConfiguration
|
3666
3725
|
# data as a hash:
|
@@ -3691,7 +3750,7 @@ module Aws::Kendra
|
|
3691
3750
|
include Aws::Structure
|
3692
3751
|
end
|
3693
3752
|
|
3694
|
-
# Provides the information
|
3753
|
+
# Provides the configuration information to connect to a index.
|
3695
3754
|
#
|
3696
3755
|
# @note When making an API call, you may pass DatabaseConfiguration
|
3697
3756
|
# data as a hash:
|
@@ -3735,11 +3794,11 @@ module Aws::Kendra
|
|
3735
3794
|
# @return [String]
|
3736
3795
|
#
|
3737
3796
|
# @!attribute [rw] connection_configuration
|
3738
|
-
#
|
3797
|
+
# Configuration information that's required to connect to a database.
|
3739
3798
|
# @return [Types::ConnectionConfiguration]
|
3740
3799
|
#
|
3741
3800
|
# @!attribute [rw] vpc_configuration
|
3742
|
-
# Provides information
|
3801
|
+
# Provides the configuration information to connect to an Amazon VPC.
|
3743
3802
|
# @return [Types::DataSourceVpcConfiguration]
|
3744
3803
|
#
|
3745
3804
|
# @!attribute [rw] column_configuration
|
@@ -4023,9 +4082,8 @@ module Aws::Kendra
|
|
4023
4082
|
# @return [String]
|
4024
4083
|
#
|
4025
4084
|
# @!attribute [rw] configuration
|
4026
|
-
#
|
4027
|
-
#
|
4028
|
-
# description depends on the data source provider.
|
4085
|
+
# Describes how the data source is configured. The specific
|
4086
|
+
# information in the description depends on the data source provider.
|
4029
4087
|
# @return [Types::DataSourceConfiguration]
|
4030
4088
|
#
|
4031
4089
|
# @!attribute [rw] created_at
|
@@ -4048,7 +4106,7 @@ module Aws::Kendra
|
|
4048
4106
|
# @return [String]
|
4049
4107
|
#
|
4050
4108
|
# @!attribute [rw] schedule
|
4051
|
-
# The schedule
|
4109
|
+
# The schedule for Amazon Kendra to update the index.
|
4052
4110
|
# @return [String]
|
4053
4111
|
#
|
4054
4112
|
# @!attribute [rw] role_arn
|
@@ -4182,9 +4240,9 @@ module Aws::Kendra
|
|
4182
4240
|
#
|
4183
4241
|
# @!attribute [rw] role_arn
|
4184
4242
|
# Shows the Amazon Resource Name (ARN) of a role with permission to
|
4185
|
-
# access `Query`
|
4186
|
-
#
|
4187
|
-
#
|
4243
|
+
# access `Query` API, `QuerySuggestions` API, `SubmitFeedback` API,
|
4244
|
+
# and Amazon Web Services SSO that stores your user and group
|
4245
|
+
# information.
|
4188
4246
|
# @return [String]
|
4189
4247
|
#
|
4190
4248
|
# @!attribute [rw] error_message
|
@@ -4649,7 +4707,7 @@ module Aws::Kendra
|
|
4649
4707
|
#
|
4650
4708
|
# By default, Amazon Kendra enables query suggestions.`LEARN_ONLY`
|
4651
4709
|
# turns off query suggestions for your users. You can change the mode
|
4652
|
-
# using the [UpdateQuerySuggestionsConfig][1]
|
4710
|
+
# using the [UpdateQuerySuggestionsConfig][1] API.
|
4653
4711
|
#
|
4654
4712
|
#
|
4655
4713
|
#
|
@@ -4987,9 +5045,9 @@ module Aws::Kendra
|
|
4987
5045
|
#
|
4988
5046
|
# Documents passed to the `Blob` parameter must be base64 encoded.
|
4989
5047
|
# Your code might not need to encode the document file bytes if
|
4990
|
-
# you're using an Amazon Web Services SDK to call Amazon Kendra
|
4991
|
-
#
|
4992
|
-
#
|
5048
|
+
# you're using an Amazon Web Services SDK to call Amazon Kendra APIs.
|
5049
|
+
# If you are calling the Amazon Kendra endpoint directly using REST,
|
5050
|
+
# you must base64 encode the contents before sending.
|
4993
5051
|
# @return [String]
|
4994
5052
|
#
|
4995
5053
|
# @!attribute [rw] s3_path
|
@@ -5001,6 +5059,12 @@ module Aws::Kendra
|
|
5001
5059
|
# attributes to provide additional information for searching, to
|
5002
5060
|
# provide facets for refining searches, and to provide additional
|
5003
5061
|
# information in the query response.
|
5062
|
+
#
|
5063
|
+
# For example, 'DataSourceId' and 'DataSourceSyncJobId' are custom
|
5064
|
+
# attributes that provide information on the synchronization of
|
5065
|
+
# documents running on a data source. Note, 'DataSourceSyncJobId'
|
5066
|
+
# could be an optional custom attribute as Amazon Kendra will use the
|
5067
|
+
# ID of a running sync job.
|
5004
5068
|
# @return [Array<Types::DocumentAttribute>]
|
5005
5069
|
#
|
5006
5070
|
# @!attribute [rw] access_control_list
|
@@ -5453,7 +5517,7 @@ module Aws::Kendra
|
|
5453
5517
|
include Aws::Structure
|
5454
5518
|
end
|
5455
5519
|
|
5456
|
-
# Provides the configuration information
|
5520
|
+
# Provides the configuration information for users or groups in your
|
5457
5521
|
# Amazon Web Services SSO identity source to grant access your Amazon
|
5458
5522
|
# Kendra experience.
|
5459
5523
|
#
|
@@ -5517,7 +5581,7 @@ module Aws::Kendra
|
|
5517
5581
|
include Aws::Structure
|
5518
5582
|
end
|
5519
5583
|
|
5520
|
-
# Provides the configuration information
|
5584
|
+
# Provides the configuration information for users or groups in your
|
5521
5585
|
# Amazon Web Services SSO identity source for access to your Amazon
|
5522
5586
|
# Kendra experience. Specific permissions are defined for each user or
|
5523
5587
|
# group once they are granted access to your Amazon Kendra experience.
|
@@ -5556,7 +5620,7 @@ module Aws::Kendra
|
|
5556
5620
|
include Aws::Structure
|
5557
5621
|
end
|
5558
5622
|
|
5559
|
-
#
|
5623
|
+
# Provides the configuration information for your Amazon Kendra
|
5560
5624
|
# experience. This includes the data source IDs and/or FAQ IDs, and user
|
5561
5625
|
# or group information to grant access to your Amazon Kendra experience.
|
5562
5626
|
#
|
@@ -5577,8 +5641,8 @@ module Aws::Kendra
|
|
5577
5641
|
# @!attribute [rw] content_source_configuration
|
5578
5642
|
# The identifiers of your data sources and FAQs. Or, you can specify
|
5579
5643
|
# that you want to use documents indexed via the `BatchPutDocument`
|
5580
|
-
#
|
5581
|
-
#
|
5644
|
+
# API. This is the content you want to use for your Amazon Kendra
|
5645
|
+
# experience.
|
5582
5646
|
# @return [Types::ContentSourceConfiguration]
|
5583
5647
|
#
|
5584
5648
|
# @!attribute [rw] user_identity_configuration
|
@@ -5595,8 +5659,8 @@ module Aws::Kendra
|
|
5595
5659
|
include Aws::Structure
|
5596
5660
|
end
|
5597
5661
|
|
5598
|
-
# Provides the configuration information
|
5599
|
-
# Kendra experience.
|
5662
|
+
# Provides the configuration information for the endpoint for your
|
5663
|
+
# Amazon Kendra experience.
|
5600
5664
|
#
|
5601
5665
|
# @!attribute [rw] endpoint_type
|
5602
5666
|
# The type of endpoint for your Amazon Kendra experience. The type
|
@@ -5837,6 +5901,116 @@ module Aws::Kendra
|
|
5837
5901
|
include Aws::Structure
|
5838
5902
|
end
|
5839
5903
|
|
5904
|
+
# Provides the configuration information to connect to Amazon FSx as
|
5905
|
+
# your data source.
|
5906
|
+
#
|
5907
|
+
# @note When making an API call, you may pass FsxConfiguration
|
5908
|
+
# data as a hash:
|
5909
|
+
#
|
5910
|
+
# {
|
5911
|
+
# file_system_id: "FileSystemId", # required
|
5912
|
+
# file_system_type: "WINDOWS", # required, accepts WINDOWS
|
5913
|
+
# vpc_configuration: { # required
|
5914
|
+
# subnet_ids: ["SubnetId"], # required
|
5915
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
5916
|
+
# },
|
5917
|
+
# secret_arn: "SecretArn",
|
5918
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
5919
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
5920
|
+
# field_mappings: [
|
5921
|
+
# {
|
5922
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
5923
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
5924
|
+
# index_field_name: "IndexFieldName", # required
|
5925
|
+
# },
|
5926
|
+
# ],
|
5927
|
+
# }
|
5928
|
+
#
|
5929
|
+
# @!attribute [rw] file_system_id
|
5930
|
+
# The identifier of the Amazon FSx file system.
|
5931
|
+
#
|
5932
|
+
# You can find your file system ID on the file system dashboard in the
|
5933
|
+
# Amazon FSx console. For information on how to create a file system
|
5934
|
+
# in Amazon FSx console, using Windows File Server as an example, see
|
5935
|
+
# [Amazon FSx Getting started guide][1].
|
5936
|
+
#
|
5937
|
+
#
|
5938
|
+
#
|
5939
|
+
# [1]: https://docs.aws.amazon.com/fsx/latest/WindowsGuide/getting-started-step1.html
|
5940
|
+
# @return [String]
|
5941
|
+
#
|
5942
|
+
# @!attribute [rw] file_system_type
|
5943
|
+
# The Amazon FSx file system type. Windows is currently the only
|
5944
|
+
# supported type.
|
5945
|
+
# @return [String]
|
5946
|
+
#
|
5947
|
+
# @!attribute [rw] vpc_configuration
|
5948
|
+
# Configuration information for connecting to an Amazon Virtual
|
5949
|
+
# Private Cloud for your Amazon FSx. Your Amazon FSx instance must
|
5950
|
+
# reside inside your VPC.
|
5951
|
+
# @return [Types::DataSourceVpcConfiguration]
|
5952
|
+
#
|
5953
|
+
# @!attribute [rw] secret_arn
|
5954
|
+
# The Amazon Resource Name (ARN) of an Secrets Manager secret that
|
5955
|
+
# contains the key-value pairs required to connect to your Amazon FSx
|
5956
|
+
# file system. Windows is currently the only supported type. The
|
5957
|
+
# secret must contain a JSON structure with the following keys:
|
5958
|
+
#
|
5959
|
+
# * username—The Active Directory user name, along with the Domain
|
5960
|
+
# Name System (DNS) domain name. For example,
|
5961
|
+
# *user@corp.example.com*. The Active Directory user account must
|
5962
|
+
# have read and mounting access to the Amazon FSx file system for
|
5963
|
+
# Windows.
|
5964
|
+
#
|
5965
|
+
# * password—The password of the Active Directory user account with
|
5966
|
+
# read and mounting access to the Amazon FSx Windows file system.
|
5967
|
+
# @return [String]
|
5968
|
+
#
|
5969
|
+
# @!attribute [rw] inclusion_patterns
|
5970
|
+
# A list of regular expression patterns to include certain files in
|
5971
|
+
# your Amazon FSx file system. Files that match the patterns are
|
5972
|
+
# included in the index. Files that don't match the patterns are
|
5973
|
+
# excluded from the index. If a file matches both an inclusion pattern
|
5974
|
+
# and an exclusion pattern, the exclusion pattern takes precedence and
|
5975
|
+
# the file isn't included in the index.
|
5976
|
+
# @return [Array<String>]
|
5977
|
+
#
|
5978
|
+
# @!attribute [rw] exclusion_patterns
|
5979
|
+
# A list of regular expression patterns to exclude certain files in
|
5980
|
+
# your Amazon FSx file system. Files that match the patterns are
|
5981
|
+
# excluded from the index. Files that don’t match the patterns are
|
5982
|
+
# included in the index. If a file matches both an inclusion pattern
|
5983
|
+
# and an exclusion pattern, the exclusion pattern takes precedence and
|
5984
|
+
# the file isn't included in the index.
|
5985
|
+
# @return [Array<String>]
|
5986
|
+
#
|
5987
|
+
# @!attribute [rw] field_mappings
|
5988
|
+
# A list of `DataSourceToIndexFieldMapping` objects that map Amazon
|
5989
|
+
# FSx data source attributes or field names to Amazon Kendra index
|
5990
|
+
# field names. To create custom fields, use the `UpdateIndex` API
|
5991
|
+
# before you map to Amazon FSx fields. For more information, see
|
5992
|
+
# [Mapping data source fields][1]. The Amazon FSx data source field
|
5993
|
+
# names must exist in your Amazon FSx custom metadata.
|
5994
|
+
#
|
5995
|
+
#
|
5996
|
+
#
|
5997
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
5998
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
5999
|
+
#
|
6000
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/FsxConfiguration AWS API Documentation
|
6001
|
+
#
|
6002
|
+
class FsxConfiguration < Struct.new(
|
6003
|
+
:file_system_id,
|
6004
|
+
:file_system_type,
|
6005
|
+
:vpc_configuration,
|
6006
|
+
:secret_arn,
|
6007
|
+
:inclusion_patterns,
|
6008
|
+
:exclusion_patterns,
|
6009
|
+
:field_mappings)
|
6010
|
+
SENSITIVE = []
|
6011
|
+
include Aws::Structure
|
6012
|
+
end
|
6013
|
+
|
5840
6014
|
# @note When making an API call, you may pass GetQuerySuggestionsRequest
|
5841
6015
|
# data as a hash:
|
5842
6016
|
#
|
@@ -5999,8 +6173,8 @@ module Aws::Kendra
|
|
5999
6173
|
include Aws::Structure
|
6000
6174
|
end
|
6001
6175
|
|
6002
|
-
# Provides configuration information
|
6003
|
-
#
|
6176
|
+
# Provides the configuration information to connect to Google Drive as
|
6177
|
+
# your data source.
|
6004
6178
|
#
|
6005
6179
|
# @note When making an API call, you may pass GoogleDriveConfiguration
|
6006
6180
|
# data as a hash:
|
@@ -6056,7 +6230,7 @@ module Aws::Kendra
|
|
6056
6230
|
#
|
6057
6231
|
# If you are using the console, you can define index fields when
|
6058
6232
|
# creating the mapping. If you are using the API, you must first
|
6059
|
-
# create the field using the `UpdateIndex`
|
6233
|
+
# create the field using the `UpdateIndex` API.
|
6060
6234
|
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
6061
6235
|
#
|
6062
6236
|
# @!attribute [rw] exclude_mime_types
|
@@ -6364,7 +6538,7 @@ module Aws::Kendra
|
|
6364
6538
|
include Aws::Structure
|
6365
6539
|
end
|
6366
6540
|
|
6367
|
-
# A summary of information
|
6541
|
+
# A summary of information on the configuration of an index.
|
6368
6542
|
#
|
6369
6543
|
# @!attribute [rw] name
|
6370
6544
|
# The name of the index.
|
@@ -6372,7 +6546,7 @@ module Aws::Kendra
|
|
6372
6546
|
#
|
6373
6547
|
# @!attribute [rw] id
|
6374
6548
|
# A unique identifier for the index. Use this to identify the index
|
6375
|
-
# when you are using
|
6549
|
+
# when you are using APIs such as `Query`, `DescribeIndex`,
|
6376
6550
|
# `UpdateIndex`, and `DeleteIndex`.
|
6377
6551
|
# @return [String]
|
6378
6552
|
#
|
@@ -6387,7 +6561,7 @@ module Aws::Kendra
|
|
6387
6561
|
#
|
6388
6562
|
# @!attribute [rw] updated_at
|
6389
6563
|
# The Unix timestamp when the index was last updated by the
|
6390
|
-
# `UpdateIndex`
|
6564
|
+
# `UpdateIndex` API.
|
6391
6565
|
# @return [Time]
|
6392
6566
|
#
|
6393
6567
|
# @!attribute [rw] status
|
@@ -6519,7 +6693,7 @@ module Aws::Kendra
|
|
6519
6693
|
include Aws::Structure
|
6520
6694
|
end
|
6521
6695
|
|
6522
|
-
#
|
6696
|
+
# Provides the configuration information for the JSON token type.
|
6523
6697
|
#
|
6524
6698
|
# @note When making an API call, you may pass JsonTokenTypeConfiguration
|
6525
6699
|
# data as a hash:
|
@@ -6546,7 +6720,7 @@ module Aws::Kendra
|
|
6546
6720
|
include Aws::Structure
|
6547
6721
|
end
|
6548
6722
|
|
6549
|
-
#
|
6723
|
+
# Provides the configuration information for the JWT token type.
|
6550
6724
|
#
|
6551
6725
|
# @note When making an API call, you may pass JwtTokenTypeConfiguration
|
6552
6726
|
# data as a hash:
|
@@ -7056,7 +7230,8 @@ module Aws::Kendra
|
|
7056
7230
|
end
|
7057
7231
|
|
7058
7232
|
# @!attribute [rw] index_configuration_summary_items
|
7059
|
-
# An array of summary information
|
7233
|
+
# An array of summary information on the configuration of one or more
|
7234
|
+
# indexes.
|
7060
7235
|
# @return [Array<Types::IndexConfigurationSummary>]
|
7061
7236
|
#
|
7062
7237
|
# @!attribute [rw] next_token
|
@@ -7281,8 +7456,8 @@ module Aws::Kendra
|
|
7281
7456
|
include Aws::Structure
|
7282
7457
|
end
|
7283
7458
|
|
7284
|
-
# Provides configuration information
|
7285
|
-
#
|
7459
|
+
# Provides the configuration information to connect to OneDrive as your
|
7460
|
+
# data source.
|
7286
7461
|
#
|
7287
7462
|
# @note When making an API call, you may pass OneDriveConfiguration
|
7288
7463
|
# data as a hash:
|
@@ -7773,11 +7948,14 @@ module Aws::Kendra
|
|
7773
7948
|
# ],
|
7774
7949
|
# },
|
7775
7950
|
# visitor_id: "VisitorId",
|
7951
|
+
# spell_correction_configuration: {
|
7952
|
+
# include_query_spell_check_suggestions: false, # required
|
7953
|
+
# },
|
7776
7954
|
# }
|
7777
7955
|
#
|
7778
7956
|
# @!attribute [rw] index_id
|
7779
7957
|
# The unique identifier of the index to search. The identifier is
|
7780
|
-
# returned in the response from the `CreateIndex`
|
7958
|
+
# returned in the response from the `CreateIndex` API.
|
7781
7959
|
# @return [String]
|
7782
7960
|
#
|
7783
7961
|
# @!attribute [rw] query_text
|
@@ -7866,6 +8044,10 @@ module Aws::Kendra
|
|
7866
8044
|
# `VisitorId`.
|
7867
8045
|
# @return [String]
|
7868
8046
|
#
|
8047
|
+
# @!attribute [rw] spell_correction_configuration
|
8048
|
+
# Enables suggested spell corrections for queries.
|
8049
|
+
# @return [Types::SpellCorrectionConfiguration]
|
8050
|
+
#
|
7869
8051
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryRequest AWS API Documentation
|
7870
8052
|
#
|
7871
8053
|
class QueryRequest < Struct.new(
|
@@ -7880,7 +8062,8 @@ module Aws::Kendra
|
|
7880
8062
|
:page_size,
|
7881
8063
|
:sorting_configuration,
|
7882
8064
|
:user_context,
|
7883
|
-
:visitor_id
|
8065
|
+
:visitor_id,
|
8066
|
+
:spell_correction_configuration)
|
7884
8067
|
SENSITIVE = []
|
7885
8068
|
include Aws::Structure
|
7886
8069
|
end
|
@@ -7919,6 +8102,11 @@ module Aws::Kendra
|
|
7919
8102
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax
|
7920
8103
|
# @return [Array<Types::Warning>]
|
7921
8104
|
#
|
8105
|
+
# @!attribute [rw] spell_corrected_queries
|
8106
|
+
# A list of information related to suggested spell corrections for a
|
8107
|
+
# query.
|
8108
|
+
# @return [Array<Types::SpellCorrectedQuery>]
|
8109
|
+
#
|
7922
8110
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/QueryResult AWS API Documentation
|
7923
8111
|
#
|
7924
8112
|
class QueryResult < Struct.new(
|
@@ -7926,7 +8114,8 @@ module Aws::Kendra
|
|
7926
8114
|
:result_items,
|
7927
8115
|
:facet_results,
|
7928
8116
|
:total_number_of_results,
|
7929
|
-
:warnings
|
8117
|
+
:warnings,
|
8118
|
+
:spell_corrected_queries)
|
7930
8119
|
SENSITIVE = []
|
7931
8120
|
include Aws::Structure
|
7932
8121
|
end
|
@@ -8148,7 +8337,7 @@ module Aws::Kendra
|
|
8148
8337
|
end
|
8149
8338
|
|
8150
8339
|
# Provides feedback on how relevant a document is to a search. Your
|
8151
|
-
# application uses the `SubmitFeedback`
|
8340
|
+
# application uses the `SubmitFeedback` API to provide relevance
|
8152
8341
|
# information.
|
8153
8342
|
#
|
8154
8343
|
# @note When making an API call, you may pass RelevanceFeedback
|
@@ -8221,8 +8410,8 @@ module Aws::Kendra
|
|
8221
8410
|
include Aws::Structure
|
8222
8411
|
end
|
8223
8412
|
|
8224
|
-
# Provides configuration information
|
8225
|
-
#
|
8413
|
+
# Provides the configuration information to connect to an Amazon S3
|
8414
|
+
# bucket.
|
8226
8415
|
#
|
8227
8416
|
# @note When making an API call, you may pass S3DataSourceConfiguration
|
8228
8417
|
# data as a hash:
|
@@ -8350,8 +8539,8 @@ module Aws::Kendra
|
|
8350
8539
|
include Aws::Structure
|
8351
8540
|
end
|
8352
8541
|
|
8353
|
-
#
|
8354
|
-
# contents of the object comes from the Salesforce FeedItem table.
|
8542
|
+
# The configuration information for syncing a Salesforce chatter feed.
|
8543
|
+
# The contents of the object comes from the Salesforce FeedItem table.
|
8355
8544
|
#
|
8356
8545
|
# @note When making an API call, you may pass SalesforceChatterFeedConfiguration
|
8357
8546
|
# data as a hash:
|
@@ -8533,8 +8722,8 @@ module Aws::Kendra
|
|
8533
8722
|
# @return [Boolean]
|
8534
8723
|
#
|
8535
8724
|
# @!attribute [rw] standard_object_attachment_configuration
|
8536
|
-
#
|
8537
|
-
#
|
8725
|
+
# Configuration information for processing attachments to Salesforce
|
8726
|
+
# standard objects.
|
8538
8727
|
# @return [Types::SalesforceStandardObjectAttachmentConfiguration]
|
8539
8728
|
#
|
8540
8729
|
# @!attribute [rw] include_attachment_file_patterns
|
@@ -8622,7 +8811,7 @@ module Aws::Kendra
|
|
8622
8811
|
include Aws::Structure
|
8623
8812
|
end
|
8624
8813
|
|
8625
|
-
#
|
8814
|
+
# Provides the configuration information for the knowledge article types
|
8626
8815
|
# that Amazon Kendra indexes. Amazon Kendra indexes standard knowledge
|
8627
8816
|
# articles and the standard fields of knowledge articles, or the custom
|
8628
8817
|
# fields of custom knowledge articles, but not both
|
@@ -8666,13 +8855,12 @@ module Aws::Kendra
|
|
8666
8855
|
# @return [Array<String>]
|
8667
8856
|
#
|
8668
8857
|
# @!attribute [rw] standard_knowledge_article_type_configuration
|
8669
|
-
#
|
8858
|
+
# Configuration information for standard Salesforce knowledge
|
8670
8859
|
# articles.
|
8671
8860
|
# @return [Types::SalesforceStandardKnowledgeArticleTypeConfiguration]
|
8672
8861
|
#
|
8673
8862
|
# @!attribute [rw] custom_knowledge_article_type_configurations
|
8674
|
-
#
|
8675
|
-
# articles.
|
8863
|
+
# Configuration information for custom Salesforce knowledge articles.
|
8676
8864
|
# @return [Array<Types::SalesforceCustomKnowledgeArticleTypeConfiguration>]
|
8677
8865
|
#
|
8678
8866
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SalesforceKnowledgeArticleConfiguration AWS API Documentation
|
@@ -8685,8 +8873,7 @@ module Aws::Kendra
|
|
8685
8873
|
include Aws::Structure
|
8686
8874
|
end
|
8687
8875
|
|
8688
|
-
#
|
8689
|
-
# articles.
|
8876
|
+
# Configuration information for standard Salesforce knowledge articles.
|
8690
8877
|
#
|
8691
8878
|
# @note When making an API call, you may pass SalesforceStandardKnowledgeArticleTypeConfiguration
|
8692
8879
|
# data as a hash:
|
@@ -8727,7 +8914,7 @@ module Aws::Kendra
|
|
8727
8914
|
include Aws::Structure
|
8728
8915
|
end
|
8729
8916
|
|
8730
|
-
# Provides configuration information for processing attachments to
|
8917
|
+
# Provides the configuration information for processing attachments to
|
8731
8918
|
# Salesforce standard objects.
|
8732
8919
|
#
|
8733
8920
|
# @note When making an API call, you may pass SalesforceStandardObjectAttachmentConfiguration
|
@@ -8762,7 +8949,7 @@ module Aws::Kendra
|
|
8762
8949
|
include Aws::Structure
|
8763
8950
|
end
|
8764
8951
|
|
8765
|
-
#
|
8952
|
+
# Provides the configuration information for indexing a single standard
|
8766
8953
|
# object.
|
8767
8954
|
#
|
8768
8955
|
# @note When making an API call, you may pass SalesforceStandardObjectConfiguration
|
@@ -8877,7 +9064,7 @@ module Aws::Kendra
|
|
8877
9064
|
include Aws::Structure
|
8878
9065
|
end
|
8879
9066
|
|
8880
|
-
# Provides the configuration information
|
9067
|
+
# Provides the configuration information for the seed or starting point
|
8881
9068
|
# URLs to crawl.
|
8882
9069
|
#
|
8883
9070
|
# *When selecting websites to index, you must adhere to the [Amazon
|
@@ -8954,8 +9141,8 @@ module Aws::Kendra
|
|
8954
9141
|
include Aws::Structure
|
8955
9142
|
end
|
8956
9143
|
|
8957
|
-
# Provides configuration information
|
8958
|
-
# data source.
|
9144
|
+
# Provides the configuration information to connect to ServiceNow as
|
9145
|
+
# your data source.
|
8959
9146
|
#
|
8960
9147
|
# @note When making an API call, you may pass ServiceNowConfiguration
|
8961
9148
|
# data as a hash:
|
@@ -9014,13 +9201,13 @@ module Aws::Kendra
|
|
9014
9201
|
# @return [String]
|
9015
9202
|
#
|
9016
9203
|
# @!attribute [rw] knowledge_article_configuration
|
9017
|
-
#
|
9018
|
-
#
|
9204
|
+
# Configuration information for crawling knowledge articles in the
|
9205
|
+
# ServiceNow site.
|
9019
9206
|
# @return [Types::ServiceNowKnowledgeArticleConfiguration]
|
9020
9207
|
#
|
9021
9208
|
# @!attribute [rw] service_catalog_configuration
|
9022
|
-
#
|
9023
|
-
#
|
9209
|
+
# Configuration information for crawling service catalogs in the
|
9210
|
+
# ServiceNow site.
|
9024
9211
|
# @return [Types::ServiceNowServiceCatalogConfiguration]
|
9025
9212
|
#
|
9026
9213
|
# @!attribute [rw] authentication_type
|
@@ -9055,8 +9242,8 @@ module Aws::Kendra
|
|
9055
9242
|
include Aws::Structure
|
9056
9243
|
end
|
9057
9244
|
|
9058
|
-
# Provides configuration information for crawling knowledge articles
|
9059
|
-
# the ServiceNow site.
|
9245
|
+
# Provides the configuration information for crawling knowledge articles
|
9246
|
+
# in the ServiceNow site.
|
9060
9247
|
#
|
9061
9248
|
# @note When making an API call, you may pass ServiceNowKnowledgeArticleConfiguration
|
9062
9249
|
# data as a hash:
|
@@ -9137,8 +9324,8 @@ module Aws::Kendra
|
|
9137
9324
|
include Aws::Structure
|
9138
9325
|
end
|
9139
9326
|
|
9140
|
-
# Provides configuration information for crawling service catalog
|
9141
|
-
# in the ServiceNow site
|
9327
|
+
# Provides the configuration information for crawling service catalog
|
9328
|
+
# items in the ServiceNow site
|
9142
9329
|
#
|
9143
9330
|
# @note When making an API call, you may pass ServiceNowServiceCatalogConfiguration
|
9144
9331
|
# data as a hash:
|
@@ -9222,8 +9409,8 @@ module Aws::Kendra
|
|
9222
9409
|
include Aws::Structure
|
9223
9410
|
end
|
9224
9411
|
|
9225
|
-
# Provides configuration information
|
9226
|
-
# SharePoint data source.
|
9412
|
+
# Provides the configuration information to connect to Microsoft
|
9413
|
+
# SharePoint as your data source.
|
9227
9414
|
#
|
9228
9415
|
# @note When making an API call, you may pass SharePointConfiguration
|
9229
9416
|
# data as a hash:
|
@@ -9315,15 +9502,15 @@ module Aws::Kendra
|
|
9315
9502
|
# @return [Array<String>]
|
9316
9503
|
#
|
9317
9504
|
# @!attribute [rw] vpc_configuration
|
9318
|
-
# Provides information
|
9505
|
+
# Provides the configuration information to connect to an Amazon VPC.
|
9319
9506
|
# @return [Types::DataSourceVpcConfiguration]
|
9320
9507
|
#
|
9321
9508
|
# @!attribute [rw] field_mappings
|
9322
9509
|
# A list of `DataSourceToIndexFieldMapping` objects that map Microsoft
|
9323
9510
|
# SharePoint attributes to custom fields in the Amazon Kendra index.
|
9324
|
-
# You must first create the index fields using the `UpdateIndex`
|
9325
|
-
#
|
9326
|
-
#
|
9511
|
+
# You must first create the index fields using the `UpdateIndex` API
|
9512
|
+
# before you map SharePoint attributes. For more information, see
|
9513
|
+
# [Mapping Data Source Fields][1].
|
9327
9514
|
#
|
9328
9515
|
#
|
9329
9516
|
#
|
@@ -9363,7 +9550,7 @@ module Aws::Kendra
|
|
9363
9550
|
include Aws::Structure
|
9364
9551
|
end
|
9365
9552
|
|
9366
|
-
# Provides the configuration information
|
9553
|
+
# Provides the configuration information for the sitemap URLs to crawl.
|
9367
9554
|
#
|
9368
9555
|
# *When selecting websites to index, you must adhere to the [Amazon
|
9369
9556
|
# Acceptable Use Policy][1] and all other Amazon terms. Remember that
|
@@ -9454,8 +9641,60 @@ module Aws::Kendra
|
|
9454
9641
|
include Aws::Structure
|
9455
9642
|
end
|
9456
9643
|
|
9457
|
-
#
|
9458
|
-
#
|
9644
|
+
# A query with suggested spell corrections.
|
9645
|
+
#
|
9646
|
+
# @!attribute [rw] suggested_query_text
|
9647
|
+
# The query with the suggested spell corrections.
|
9648
|
+
# @return [String]
|
9649
|
+
#
|
9650
|
+
# @!attribute [rw] corrections
|
9651
|
+
# The corrected misspelled word or words in a query.
|
9652
|
+
# @return [Array<Types::Correction>]
|
9653
|
+
#
|
9654
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SpellCorrectedQuery AWS API Documentation
|
9655
|
+
#
|
9656
|
+
class SpellCorrectedQuery < Struct.new(
|
9657
|
+
:suggested_query_text,
|
9658
|
+
:corrections)
|
9659
|
+
SENSITIVE = []
|
9660
|
+
include Aws::Structure
|
9661
|
+
end
|
9662
|
+
|
9663
|
+
# Provides the configuration information for suggested query spell
|
9664
|
+
# corrections.
|
9665
|
+
#
|
9666
|
+
# Suggested spell corrections are based on words that appear in your
|
9667
|
+
# indexed documents and how closely a corrected word matches a
|
9668
|
+
# misspelled word.
|
9669
|
+
#
|
9670
|
+
# This feature is designed with certain defaults or limits. For
|
9671
|
+
# information on the current limits and how to request more support for
|
9672
|
+
# some limits, see the [Spell Checker documentation][1].
|
9673
|
+
#
|
9674
|
+
#
|
9675
|
+
#
|
9676
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/query-spell-check.html
|
9677
|
+
#
|
9678
|
+
# @note When making an API call, you may pass SpellCorrectionConfiguration
|
9679
|
+
# data as a hash:
|
9680
|
+
#
|
9681
|
+
# {
|
9682
|
+
# include_query_spell_check_suggestions: false, # required
|
9683
|
+
# }
|
9684
|
+
#
|
9685
|
+
# @!attribute [rw] include_query_spell_check_suggestions
|
9686
|
+
# `TRUE` to suggest spell corrections for queries.
|
9687
|
+
# @return [Boolean]
|
9688
|
+
#
|
9689
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SpellCorrectionConfiguration AWS API Documentation
|
9690
|
+
#
|
9691
|
+
class SpellCorrectionConfiguration < Struct.new(
|
9692
|
+
:include_query_spell_check_suggestions)
|
9693
|
+
SENSITIVE = []
|
9694
|
+
include Aws::Structure
|
9695
|
+
end
|
9696
|
+
|
9697
|
+
# Provides the configuration information to use a SQL database.
|
9459
9698
|
#
|
9460
9699
|
# @note When making an API call, you may pass SqlConfiguration
|
9461
9700
|
# data as a hash:
|
@@ -9614,7 +9853,7 @@ module Aws::Kendra
|
|
9614
9853
|
# @!attribute [rw] query_id
|
9615
9854
|
# The identifier of the specific query for which you are submitting
|
9616
9855
|
# feedback. The query ID is returned in the response to the `Query`
|
9617
|
-
#
|
9856
|
+
# API.
|
9618
9857
|
# @return [String]
|
9619
9858
|
#
|
9620
9859
|
# @!attribute [rw] click_feedback_items
|
@@ -10245,6 +10484,24 @@ module Aws::Kendra
|
|
10245
10484
|
# },
|
10246
10485
|
# ],
|
10247
10486
|
# },
|
10487
|
+
# fsx_configuration: {
|
10488
|
+
# file_system_id: "FileSystemId", # required
|
10489
|
+
# file_system_type: "WINDOWS", # required, accepts WINDOWS
|
10490
|
+
# vpc_configuration: { # required
|
10491
|
+
# subnet_ids: ["SubnetId"], # required
|
10492
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
10493
|
+
# },
|
10494
|
+
# secret_arn: "SecretArn",
|
10495
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
10496
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
10497
|
+
# field_mappings: [
|
10498
|
+
# {
|
10499
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
10500
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
10501
|
+
# index_field_name: "IndexFieldName", # required
|
10502
|
+
# },
|
10503
|
+
# ],
|
10504
|
+
# },
|
10248
10505
|
# },
|
10249
10506
|
# description: "Description",
|
10250
10507
|
# schedule: "ScanSchedule",
|
@@ -10323,7 +10580,8 @@ module Aws::Kendra
|
|
10323
10580
|
# @return [String]
|
10324
10581
|
#
|
10325
10582
|
# @!attribute [rw] configuration
|
10326
|
-
# Configuration information for an Amazon Kendra data source
|
10583
|
+
# Configuration information for an Amazon Kendra data source you want
|
10584
|
+
# to update.
|
10327
10585
|
# @return [Types::DataSourceConfiguration]
|
10328
10586
|
#
|
10329
10587
|
# @!attribute [rw] description
|
@@ -10417,10 +10675,9 @@ module Aws::Kendra
|
|
10417
10675
|
#
|
10418
10676
|
# @!attribute [rw] role_arn
|
10419
10677
|
# The Amazon Resource Name (ARN) of a role with permission to access
|
10420
|
-
# `Query`
|
10421
|
-
#
|
10422
|
-
#
|
10423
|
-
# Kendra][1].
|
10678
|
+
# `Query` API, `QuerySuggestions` API, `SubmitFeedback` API, and
|
10679
|
+
# Amazon Web Services SSO that stores your user and group information.
|
10680
|
+
# For more information, see [IAM roles for Amazon Kendra][1].
|
10424
10681
|
#
|
10425
10682
|
#
|
10426
10683
|
#
|
@@ -10428,9 +10685,7 @@ module Aws::Kendra
|
|
10428
10685
|
# @return [String]
|
10429
10686
|
#
|
10430
10687
|
# @!attribute [rw] configuration
|
10431
|
-
#
|
10432
|
-
# Amazon Web Services SSO field name that contains the identifiers of
|
10433
|
-
# your users, such as their emails.
|
10688
|
+
# Configuration information for your Amazon Kendra you want to update.
|
10434
10689
|
# @return [Types::ExperienceConfiguration]
|
10435
10690
|
#
|
10436
10691
|
# @!attribute [rw] description
|
@@ -10524,7 +10779,7 @@ module Aws::Kendra
|
|
10524
10779
|
# @return [String]
|
10525
10780
|
#
|
10526
10781
|
# @!attribute [rw] document_metadata_configuration_updates
|
10527
|
-
# The document metadata to update.
|
10782
|
+
# The document metadata you want to update.
|
10528
10783
|
# @return [Array<Types::DocumentMetadataConfiguration>]
|
10529
10784
|
#
|
10530
10785
|
# @!attribute [rw] capacity_units
|
@@ -10805,8 +11060,8 @@ module Aws::Kendra
|
|
10805
11060
|
# }
|
10806
11061
|
#
|
10807
11062
|
# @!attribute [rw] seed_url_configuration
|
10808
|
-
#
|
10809
|
-
#
|
11063
|
+
# Configuration of the seed or starting point URLs of the websites you
|
11064
|
+
# want to crawl.
|
10810
11065
|
#
|
10811
11066
|
# You can choose to crawl only the website host names, or the website
|
10812
11067
|
# host names with subdomains, or the website host names with
|
@@ -10816,8 +11071,7 @@ module Aws::Kendra
|
|
10816
11071
|
# @return [Types::SeedUrlConfiguration]
|
10817
11072
|
#
|
10818
11073
|
# @!attribute [rw] site_maps_configuration
|
10819
|
-
#
|
10820
|
-
# want to crawl.
|
11074
|
+
# Configuration of the sitemap URLs of the websites you want to crawl.
|
10821
11075
|
#
|
10822
11076
|
# Only URLs belonging to the same website host names are crawled. You
|
10823
11077
|
# can list up to three sitemap URLs.
|
@@ -10899,7 +11153,7 @@ module Aws::Kendra
|
|
10899
11153
|
# Amazon Kendra filters search results for different users based on
|
10900
11154
|
# their group's access to documents. You can also map your users to
|
10901
11155
|
# their groups for user context filtering using the [PutPrincipalMapping
|
10902
|
-
#
|
11156
|
+
# API][1].
|
10903
11157
|
#
|
10904
11158
|
# To set up an Amazon Web Services SSO identity source in the console to
|
10905
11159
|
# use with Amazon Kendra, see [Getting started with an Amazon Web
|
@@ -10910,7 +11164,7 @@ module Aws::Kendra
|
|
10910
11164
|
# Amazon Kendra currently does not support using
|
10911
11165
|
# `UserGroupResolutionConfiguration` with an Amazon Web Services
|
10912
11166
|
# organization member account for your Amazon Web Services SSO identify
|
10913
|
-
# source. You must create your index in the
|
11167
|
+
# source. You must create your index in the management account for the
|
10914
11168
|
# organization in order to use `UserGroupResolutionConfiguration`.
|
10915
11169
|
#
|
10916
11170
|
#
|
@@ -10942,7 +11196,8 @@ module Aws::Kendra
|
|
10942
11196
|
include Aws::Structure
|
10943
11197
|
end
|
10944
11198
|
|
10945
|
-
#
|
11199
|
+
# Provides the configuration information for the identifiers of your
|
11200
|
+
# users.
|
10946
11201
|
#
|
10947
11202
|
# @note When making an API call, you may pass UserIdentityConfiguration
|
10948
11203
|
# data as a hash:
|
@@ -10975,7 +11230,7 @@ module Aws::Kendra
|
|
10975
11230
|
include Aws::Structure
|
10976
11231
|
end
|
10977
11232
|
|
10978
|
-
# Provides configuration information for a token
|
11233
|
+
# Provides the configuration information for a token.
|
10979
11234
|
#
|
10980
11235
|
# @note When making an API call, you may pass UserTokenConfiguration
|
10981
11236
|
# data as a hash:
|
@@ -11160,8 +11415,8 @@ module Aws::Kendra
|
|
11160
11415
|
# @return [Array<String>]
|
11161
11416
|
#
|
11162
11417
|
# @!attribute [rw] proxy_configuration
|
11163
|
-
#
|
11164
|
-
#
|
11418
|
+
# Configuration information required to connect to your internal
|
11419
|
+
# websites via a web proxy.
|
11165
11420
|
#
|
11166
11421
|
# You must provide the website host name and port number. For example,
|
11167
11422
|
# the host name of https://a.example.com/page1.html is
|
@@ -11177,8 +11432,8 @@ module Aws::Kendra
|
|
11177
11432
|
# @return [Types::ProxyConfiguration]
|
11178
11433
|
#
|
11179
11434
|
# @!attribute [rw] authentication_configuration
|
11180
|
-
#
|
11181
|
-
#
|
11435
|
+
# Configuration information required to connect to websites using
|
11436
|
+
# authentication.
|
11182
11437
|
#
|
11183
11438
|
# You can connect to websites using basic authentication of user name
|
11184
11439
|
# and password.
|
@@ -11292,9 +11547,9 @@ module Aws::Kendra
|
|
11292
11547
|
# A list of `DataSourceToIndexFieldMapping` objects that map Amazon
|
11293
11548
|
# WorkDocs field names to custom index field names in Amazon Kendra.
|
11294
11549
|
# You must first create the custom index fields using the
|
11295
|
-
# `UpdateIndex`
|
11296
|
-
#
|
11297
|
-
#
|
11550
|
+
# `UpdateIndex` API before you map to Amazon WorkDocs fields. For more
|
11551
|
+
# information, see [Mapping Data Source Fields][1]. The Amazon
|
11552
|
+
# WorkDocs data source field names need to exist in your Amazon
|
11298
11553
|
# WorkDocs custom metadata.
|
11299
11554
|
#
|
11300
11555
|
#
|