aws-sdk-kendra 1.52.0 → 1.55.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kendra/client.rb +621 -124
- data/lib/aws-sdk-kendra/client_api.rb +169 -0
- data/lib/aws-sdk-kendra/types.rb +949 -258
- data/lib/aws-sdk-kendra.rb +1 -1
- metadata +2 -2
data/lib/aws-sdk-kendra/types.rb
CHANGED
@@ -10,6 +10,21 @@
|
|
10
10
|
module Aws::Kendra
|
11
11
|
module Types
|
12
12
|
|
13
|
+
# Summary information on an access control configuration that you
|
14
|
+
# created for your documents in an index.
|
15
|
+
#
|
16
|
+
# @!attribute [rw] id
|
17
|
+
# The identifier of the access control configuration.
|
18
|
+
# @return [String]
|
19
|
+
#
|
20
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AccessControlConfigurationSummary AWS API Documentation
|
21
|
+
#
|
22
|
+
class AccessControlConfigurationSummary < Struct.new(
|
23
|
+
:id)
|
24
|
+
SENSITIVE = []
|
25
|
+
include Aws::Structure
|
26
|
+
end
|
27
|
+
|
13
28
|
# Access Control List files for the documents in a data source. For the
|
14
29
|
# format of the file, see [Access control for S3 data sources][1].
|
15
30
|
#
|
@@ -112,6 +127,186 @@ module Aws::Kendra
|
|
112
127
|
include Aws::Structure
|
113
128
|
end
|
114
129
|
|
130
|
+
# Provides the configuration information to connect to Alfresco as your
|
131
|
+
# data source.
|
132
|
+
#
|
133
|
+
# <note markdown="1"> Alfresco data source connector is currently in preview mode. Basic
|
134
|
+
# authentication is currently supported. If you would like to use
|
135
|
+
# Alfresco connector in production, contact [Support][1].
|
136
|
+
#
|
137
|
+
# </note>
|
138
|
+
#
|
139
|
+
#
|
140
|
+
#
|
141
|
+
# [1]: http://aws.amazon.com/contact-us/
|
142
|
+
#
|
143
|
+
# @note When making an API call, you may pass AlfrescoConfiguration
|
144
|
+
# data as a hash:
|
145
|
+
#
|
146
|
+
# {
|
147
|
+
# site_url: "SiteUrl", # required
|
148
|
+
# site_id: "SiteId", # required
|
149
|
+
# secret_arn: "SecretArn", # required
|
150
|
+
# ssl_certificate_s3_path: { # required
|
151
|
+
# bucket: "S3BucketName", # required
|
152
|
+
# key: "S3ObjectKey", # required
|
153
|
+
# },
|
154
|
+
# crawl_system_folders: false,
|
155
|
+
# crawl_comments: false,
|
156
|
+
# entity_filter: ["wiki"], # accepts wiki, blog, documentLibrary
|
157
|
+
# document_library_field_mappings: [
|
158
|
+
# {
|
159
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
160
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
161
|
+
# index_field_name: "IndexFieldName", # required
|
162
|
+
# },
|
163
|
+
# ],
|
164
|
+
# blog_field_mappings: [
|
165
|
+
# {
|
166
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
167
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
168
|
+
# index_field_name: "IndexFieldName", # required
|
169
|
+
# },
|
170
|
+
# ],
|
171
|
+
# wiki_field_mappings: [
|
172
|
+
# {
|
173
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
174
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
175
|
+
# index_field_name: "IndexFieldName", # required
|
176
|
+
# },
|
177
|
+
# ],
|
178
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
179
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
180
|
+
# vpc_configuration: {
|
181
|
+
# subnet_ids: ["SubnetId"], # required
|
182
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
183
|
+
# },
|
184
|
+
# }
|
185
|
+
#
|
186
|
+
# @!attribute [rw] site_url
|
187
|
+
# The URL of the Alfresco site. For example, *https://hostname:8080*.
|
188
|
+
# @return [String]
|
189
|
+
#
|
190
|
+
# @!attribute [rw] site_id
|
191
|
+
# The identifier of the Alfresco site. For example, *my-site*.
|
192
|
+
# @return [String]
|
193
|
+
#
|
194
|
+
# @!attribute [rw] secret_arn
|
195
|
+
# The Amazon Resource Name (ARN) of an Secrets Manager secret that
|
196
|
+
# contains the key-value pairs required to connect to your Alfresco
|
197
|
+
# data source. The secret must contain a JSON structure with the
|
198
|
+
# following keys:
|
199
|
+
#
|
200
|
+
# * username—The user name of the Alfresco account.
|
201
|
+
#
|
202
|
+
# * password—The password of the Alfresco account.
|
203
|
+
# @return [String]
|
204
|
+
#
|
205
|
+
# @!attribute [rw] ssl_certificate_s3_path
|
206
|
+
# The path to the SSL certificate stored in an Amazon S3 bucket. You
|
207
|
+
# use this to connect to Alfresco.
|
208
|
+
# @return [Types::S3Path]
|
209
|
+
#
|
210
|
+
# @!attribute [rw] crawl_system_folders
|
211
|
+
# `TRUE` to index shared files.
|
212
|
+
# @return [Boolean]
|
213
|
+
#
|
214
|
+
# @!attribute [rw] crawl_comments
|
215
|
+
# `TRUE` to index comments of blogs and other content.
|
216
|
+
# @return [Boolean]
|
217
|
+
#
|
218
|
+
# @!attribute [rw] entity_filter
|
219
|
+
# Specify whether to index document libraries, wikis, or blogs. You
|
220
|
+
# can specify one or more of these options.
|
221
|
+
# @return [Array<String>]
|
222
|
+
#
|
223
|
+
# @!attribute [rw] document_library_field_mappings
|
224
|
+
# A list of `DataSourceToIndexFieldMapping` objects that map
|
225
|
+
# attributes or field names of Alfresco document libraries to Amazon
|
226
|
+
# Kendra index field names. To create custom fields, use the
|
227
|
+
# `UpdateIndex` API before you map to Alfresco fields. For more
|
228
|
+
# information, see [ Mapping data source fields][1]. The Alfresco data
|
229
|
+
# source field names must exist in your Alfresco custom metadata.
|
230
|
+
#
|
231
|
+
#
|
232
|
+
#
|
233
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
234
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
235
|
+
#
|
236
|
+
# @!attribute [rw] blog_field_mappings
|
237
|
+
# A list of `DataSourceToIndexFieldMapping` objects that map
|
238
|
+
# attributes or field names of Alfresco blogs to Amazon Kendra index
|
239
|
+
# field names. To create custom fields, use the `UpdateIndex` API
|
240
|
+
# before you map to Alfresco fields. For more information, see [
|
241
|
+
# Mapping data source fields][1]. The Alfresco data source field names
|
242
|
+
# must exist in your Alfresco custom metadata.
|
243
|
+
#
|
244
|
+
#
|
245
|
+
#
|
246
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
247
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
248
|
+
#
|
249
|
+
# @!attribute [rw] wiki_field_mappings
|
250
|
+
# A list of `DataSourceToIndexFieldMapping` objects that map
|
251
|
+
# attributes or field names of Alfresco wikis to Amazon Kendra index
|
252
|
+
# field names. To create custom fields, use the `UpdateIndex` API
|
253
|
+
# before you map to Alfresco fields. For more information, see [
|
254
|
+
# Mapping data source fields][1]. The Alfresco data source field names
|
255
|
+
# must exist in your Alfresco custom metadata.
|
256
|
+
#
|
257
|
+
#
|
258
|
+
#
|
259
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/field-mapping.html
|
260
|
+
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
261
|
+
#
|
262
|
+
# @!attribute [rw] inclusion_patterns
|
263
|
+
# A list of regular expression patterns to include certain files in
|
264
|
+
# your Alfresco data source. Files that match the patterns are
|
265
|
+
# included in the index. Files that don't match the patterns are
|
266
|
+
# excluded from the index. If a file matches both an inclusion pattern
|
267
|
+
# and an exclusion pattern, the exclusion pattern takes precedence and
|
268
|
+
# the file isn't included in the index.
|
269
|
+
# @return [Array<String>]
|
270
|
+
#
|
271
|
+
# @!attribute [rw] exclusion_patterns
|
272
|
+
# A list of regular expression patterns to exclude certain files in
|
273
|
+
# your Alfresco data source. Files that match the patterns are
|
274
|
+
# excluded from the index. Files that don't match the patterns are
|
275
|
+
# included in the index. If a file matches both an inclusion pattern
|
276
|
+
# and an exclusion pattern, the exclusion pattern takes precedence and
|
277
|
+
# the file isn't included in the index.
|
278
|
+
# @return [Array<String>]
|
279
|
+
#
|
280
|
+
# @!attribute [rw] vpc_configuration
|
281
|
+
# Configuration information for an Amazon Virtual Private Cloud to
|
282
|
+
# connect to your Alfresco. For more information, see [Configuring a
|
283
|
+
# VPC][1].
|
284
|
+
#
|
285
|
+
#
|
286
|
+
#
|
287
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
|
288
|
+
# @return [Types::DataSourceVpcConfiguration]
|
289
|
+
#
|
290
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AlfrescoConfiguration AWS API Documentation
|
291
|
+
#
|
292
|
+
class AlfrescoConfiguration < Struct.new(
|
293
|
+
:site_url,
|
294
|
+
:site_id,
|
295
|
+
:secret_arn,
|
296
|
+
:ssl_certificate_s3_path,
|
297
|
+
:crawl_system_folders,
|
298
|
+
:crawl_comments,
|
299
|
+
:entity_filter,
|
300
|
+
:document_library_field_mappings,
|
301
|
+
:blog_field_mappings,
|
302
|
+
:wiki_field_mappings,
|
303
|
+
:inclusion_patterns,
|
304
|
+
:exclusion_patterns,
|
305
|
+
:vpc_configuration)
|
306
|
+
SENSITIVE = []
|
307
|
+
include Aws::Structure
|
308
|
+
end
|
309
|
+
|
115
310
|
# @note When making an API call, you may pass AssociateEntitiesToExperienceRequest
|
116
311
|
# data as a hash:
|
117
312
|
#
|
@@ -907,6 +1102,7 @@ module Aws::Kendra
|
|
907
1102
|
# },
|
908
1103
|
# ],
|
909
1104
|
# content_type: "PDF", # accepts PDF, HTML, MS_WORD, PLAIN_TEXT, PPT
|
1105
|
+
# access_control_configuration_id: "AccessControlConfigurationId",
|
910
1106
|
# },
|
911
1107
|
# ],
|
912
1108
|
# custom_document_enrichment_configuration: {
|
@@ -1294,7 +1490,7 @@ module Aws::Kendra
|
|
1294
1490
|
# @!attribute [rw] storage_capacity_units
|
1295
1491
|
# The amount of extra storage capacity for an index. A single capacity
|
1296
1492
|
# unit provides 30 GB of storage space or 100,000 documents, whichever
|
1297
|
-
# is reached first.
|
1493
|
+
# is reached first. You can add up to 100 extra capacity units.
|
1298
1494
|
# @return [Integer]
|
1299
1495
|
#
|
1300
1496
|
# @!attribute [rw] query_capacity_units
|
@@ -1302,7 +1498,8 @@ module Aws::Kendra
|
|
1302
1498
|
# [GetQuerySuggestions][1] capacity.
|
1303
1499
|
#
|
1304
1500
|
# A single extra capacity unit for an index provides 0.1 queries per
|
1305
|
-
# second or approximately 8,000 queries per day.
|
1501
|
+
# second or approximately 8,000 queries per day. You can add up to 100
|
1502
|
+
# extra capacity units.
|
1306
1503
|
#
|
1307
1504
|
# `GetQuerySuggestions` capacity is five times the provisioned query
|
1308
1505
|
# capacity for an index, or the base capacity of 2.5 calls per second,
|
@@ -1461,8 +1658,7 @@ module Aws::Kendra
|
|
1461
1658
|
# }
|
1462
1659
|
#
|
1463
1660
|
# @!attribute [rw] crawl_attachments
|
1464
|
-
#
|
1465
|
-
# blogs in the Confluence data source.
|
1661
|
+
# `TRUE` to index attachments of pages and blogs in Confluence.
|
1466
1662
|
# @return [Boolean]
|
1467
1663
|
#
|
1468
1664
|
# @!attribute [rw] attachment_field_mappings
|
@@ -1690,20 +1886,18 @@ module Aws::Kendra
|
|
1690
1886
|
#
|
1691
1887
|
# @!attribute [rw] secret_arn
|
1692
1888
|
# The Amazon Resource Name (ARN) of an Secrets Manager secret that
|
1693
|
-
# contains the
|
1694
|
-
#
|
1695
|
-
#
|
1889
|
+
# contains the user name and password required to connect to the
|
1890
|
+
# Confluence instance. If you use Confluence cloud, you use a
|
1891
|
+
# generated API token as the password. For more information, see
|
1892
|
+
# [Using a Confluence data source][1].
|
1696
1893
|
#
|
1697
|
-
# * username—The user name or email address of a user with
|
1698
|
-
# administrative privileges for the Confluence server.
|
1699
1894
|
#
|
1700
|
-
#
|
1701
|
-
#
|
1895
|
+
#
|
1896
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-confluence.html
|
1702
1897
|
# @return [String]
|
1703
1898
|
#
|
1704
1899
|
# @!attribute [rw] version
|
1705
|
-
#
|
1706
|
-
# connecting to.
|
1900
|
+
# The version or the type of Confluence installation to connect to.
|
1707
1901
|
# @return [String]
|
1708
1902
|
#
|
1709
1903
|
# @!attribute [rw] space_configuration
|
@@ -1744,9 +1938,9 @@ module Aws::Kendra
|
|
1744
1938
|
# @return [Array<String>]
|
1745
1939
|
#
|
1746
1940
|
# @!attribute [rw] exclusion_patterns
|
1747
|
-
#
|
1748
|
-
#
|
1749
|
-
#
|
1941
|
+
# A list of regular expression patterns to exclude certain blog posts,
|
1942
|
+
# pages, spaces, or attachments in your Confluence. Content that
|
1943
|
+
# matches the patterns are excluded from the index. Content that
|
1750
1944
|
# doesn't match the patterns is included in the index. If content
|
1751
1945
|
# matches both an inclusion and exclusion pattern, the exclusion
|
1752
1946
|
# pattern takes precedence and the content isn't included in the
|
@@ -1786,12 +1980,11 @@ module Aws::Kendra
|
|
1786
1980
|
# }
|
1787
1981
|
#
|
1788
1982
|
# @!attribute [rw] page_field_mappings
|
1789
|
-
#
|
1790
|
-
#
|
1791
|
-
#
|
1792
|
-
#
|
1793
|
-
#
|
1794
|
-
# metadata.
|
1983
|
+
# Maps attributes or field names of Confluence pages to Amazon Kendra
|
1984
|
+
# index field names. To create custom fields, use the `UpdateIndex`
|
1985
|
+
# API before you map to Confluence fields. For more information, see
|
1986
|
+
# [Mapping data source fields][1]. The Confluence data source field
|
1987
|
+
# names must exist in your Confluence custom metadata.
|
1795
1988
|
#
|
1796
1989
|
# If you specify the `PageFieldMappings` parameter, you must specify
|
1797
1990
|
# at least one field mapping.
|
@@ -1874,11 +2067,11 @@ module Aws::Kendra
|
|
1874
2067
|
# }
|
1875
2068
|
#
|
1876
2069
|
# @!attribute [rw] crawl_personal_spaces
|
1877
|
-
#
|
1878
|
-
#
|
1879
|
-
#
|
1880
|
-
#
|
1881
|
-
#
|
2070
|
+
# `TRUE` to index personal spaces. You can add restrictions to items
|
2071
|
+
# in personal spaces. If personal spaces are indexed, queries without
|
2072
|
+
# user context information may return restricted items from a personal
|
2073
|
+
# space in their results. For more information, see [Filtering on user
|
2074
|
+
# context][1].
|
1882
2075
|
#
|
1883
2076
|
#
|
1884
2077
|
#
|
@@ -1886,7 +2079,7 @@ module Aws::Kendra
|
|
1886
2079
|
# @return [Boolean]
|
1887
2080
|
#
|
1888
2081
|
# @!attribute [rw] crawl_archived_spaces
|
1889
|
-
#
|
2082
|
+
# `TRUE` to index archived spaces.
|
1890
2083
|
# @return [Boolean]
|
1891
2084
|
#
|
1892
2085
|
# @!attribute [rw] include_spaces
|
@@ -2106,13 +2299,108 @@ module Aws::Kendra
|
|
2106
2299
|
include Aws::Structure
|
2107
2300
|
end
|
2108
2301
|
|
2302
|
+
# @note When making an API call, you may pass CreateAccessControlConfigurationRequest
|
2303
|
+
# data as a hash:
|
2304
|
+
#
|
2305
|
+
# {
|
2306
|
+
# index_id: "IndexId", # required
|
2307
|
+
# name: "AccessControlConfigurationName", # required
|
2308
|
+
# description: "Description",
|
2309
|
+
# access_control_list: [
|
2310
|
+
# {
|
2311
|
+
# name: "PrincipalName", # required
|
2312
|
+
# type: "USER", # required, accepts USER, GROUP
|
2313
|
+
# access: "ALLOW", # required, accepts ALLOW, DENY
|
2314
|
+
# data_source_id: "DataSourceId",
|
2315
|
+
# },
|
2316
|
+
# ],
|
2317
|
+
# hierarchical_access_control_list: [
|
2318
|
+
# {
|
2319
|
+
# principal_list: [ # required
|
2320
|
+
# {
|
2321
|
+
# name: "PrincipalName", # required
|
2322
|
+
# type: "USER", # required, accepts USER, GROUP
|
2323
|
+
# access: "ALLOW", # required, accepts ALLOW, DENY
|
2324
|
+
# data_source_id: "DataSourceId",
|
2325
|
+
# },
|
2326
|
+
# ],
|
2327
|
+
# },
|
2328
|
+
# ],
|
2329
|
+
# client_token: "ClientTokenName",
|
2330
|
+
# }
|
2331
|
+
#
|
2332
|
+
# @!attribute [rw] index_id
|
2333
|
+
# The identifier of the index to create an access control
|
2334
|
+
# configuration for your documents.
|
2335
|
+
# @return [String]
|
2336
|
+
#
|
2337
|
+
# @!attribute [rw] name
|
2338
|
+
# A name for the access control configuration.
|
2339
|
+
# @return [String]
|
2340
|
+
#
|
2341
|
+
# @!attribute [rw] description
|
2342
|
+
# A description for the access control configuration.
|
2343
|
+
# @return [String]
|
2344
|
+
#
|
2345
|
+
# @!attribute [rw] access_control_list
|
2346
|
+
# Information on principals (users and/or groups) and which documents
|
2347
|
+
# they should have access to. This is useful for user context
|
2348
|
+
# filtering, where search results are filtered based on the user or
|
2349
|
+
# their group access to documents.
|
2350
|
+
# @return [Array<Types::Principal>]
|
2351
|
+
#
|
2352
|
+
# @!attribute [rw] hierarchical_access_control_list
|
2353
|
+
# The list of [principal][1] lists that define the hierarchy for which
|
2354
|
+
# documents users should have access to.
|
2355
|
+
#
|
2356
|
+
#
|
2357
|
+
#
|
2358
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html
|
2359
|
+
# @return [Array<Types::HierarchicalPrincipal>]
|
2360
|
+
#
|
2361
|
+
# @!attribute [rw] client_token
|
2362
|
+
# A token that you provide to identify the request to create an access
|
2363
|
+
# control configuration. Multiple calls to the
|
2364
|
+
# `CreateAccessControlConfiguration` API with the same client token
|
2365
|
+
# will create only one access control configuration.
|
2366
|
+
#
|
2367
|
+
# **A suitable default value is auto-generated.** You should normally
|
2368
|
+
# not need to pass this option.
|
2369
|
+
# @return [String]
|
2370
|
+
#
|
2371
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateAccessControlConfigurationRequest AWS API Documentation
|
2372
|
+
#
|
2373
|
+
class CreateAccessControlConfigurationRequest < Struct.new(
|
2374
|
+
:index_id,
|
2375
|
+
:name,
|
2376
|
+
:description,
|
2377
|
+
:access_control_list,
|
2378
|
+
:hierarchical_access_control_list,
|
2379
|
+
:client_token)
|
2380
|
+
SENSITIVE = []
|
2381
|
+
include Aws::Structure
|
2382
|
+
end
|
2383
|
+
|
2384
|
+
# @!attribute [rw] id
|
2385
|
+
# The identifier of the access control configuration for your
|
2386
|
+
# documents in an index.
|
2387
|
+
# @return [String]
|
2388
|
+
#
|
2389
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateAccessControlConfigurationResponse AWS API Documentation
|
2390
|
+
#
|
2391
|
+
class CreateAccessControlConfigurationResponse < Struct.new(
|
2392
|
+
:id)
|
2393
|
+
SENSITIVE = []
|
2394
|
+
include Aws::Structure
|
2395
|
+
end
|
2396
|
+
|
2109
2397
|
# @note When making an API call, you may pass CreateDataSourceRequest
|
2110
2398
|
# data as a hash:
|
2111
2399
|
#
|
2112
2400
|
# {
|
2113
2401
|
# name: "DataSourceName", # required
|
2114
2402
|
# index_id: "IndexId", # required
|
2115
|
-
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX, SLACK, BOX, QUIP, JIRA, GITHUB
|
2403
|
+
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX, SLACK, BOX, QUIP, JIRA, GITHUB, ALFRESCO
|
2116
2404
|
# configuration: {
|
2117
2405
|
# s3_configuration: {
|
2118
2406
|
# bucket_name: "S3BucketName", # required
|
@@ -2151,6 +2439,7 @@ module Aws::Kendra
|
|
2151
2439
|
# bucket: "S3BucketName", # required
|
2152
2440
|
# key: "S3ObjectKey", # required
|
2153
2441
|
# },
|
2442
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
|
2154
2443
|
# },
|
2155
2444
|
# database_configuration: {
|
2156
2445
|
# database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
|
@@ -2687,6 +2976,45 @@ module Aws::Kendra
|
|
2687
2976
|
# },
|
2688
2977
|
# ],
|
2689
2978
|
# },
|
2979
|
+
# alfresco_configuration: {
|
2980
|
+
# site_url: "SiteUrl", # required
|
2981
|
+
# site_id: "SiteId", # required
|
2982
|
+
# secret_arn: "SecretArn", # required
|
2983
|
+
# ssl_certificate_s3_path: { # required
|
2984
|
+
# bucket: "S3BucketName", # required
|
2985
|
+
# key: "S3ObjectKey", # required
|
2986
|
+
# },
|
2987
|
+
# crawl_system_folders: false,
|
2988
|
+
# crawl_comments: false,
|
2989
|
+
# entity_filter: ["wiki"], # accepts wiki, blog, documentLibrary
|
2990
|
+
# document_library_field_mappings: [
|
2991
|
+
# {
|
2992
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
2993
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2994
|
+
# index_field_name: "IndexFieldName", # required
|
2995
|
+
# },
|
2996
|
+
# ],
|
2997
|
+
# blog_field_mappings: [
|
2998
|
+
# {
|
2999
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
3000
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
3001
|
+
# index_field_name: "IndexFieldName", # required
|
3002
|
+
# },
|
3003
|
+
# ],
|
3004
|
+
# wiki_field_mappings: [
|
3005
|
+
# {
|
3006
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
3007
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
3008
|
+
# index_field_name: "IndexFieldName", # required
|
3009
|
+
# },
|
3010
|
+
# ],
|
3011
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
3012
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
3013
|
+
# vpc_configuration: {
|
3014
|
+
# subnet_ids: ["SubnetId"], # required
|
3015
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
3016
|
+
# },
|
3017
|
+
# },
|
2690
3018
|
# },
|
2691
3019
|
# description: "Description",
|
2692
3020
|
# schedule: "ScanSchedule",
|
@@ -2758,22 +3086,22 @@ module Aws::Kendra
|
|
2758
3086
|
# }
|
2759
3087
|
#
|
2760
3088
|
# @!attribute [rw] name
|
2761
|
-
# A unique name for the data source. A data source name
|
2762
|
-
# changed without deleting and recreating the data source
|
3089
|
+
# A unique name for the data source connector. A data source name
|
3090
|
+
# can't be changed without deleting and recreating the data source
|
3091
|
+
# connector.
|
2763
3092
|
# @return [String]
|
2764
3093
|
#
|
2765
3094
|
# @!attribute [rw] index_id
|
2766
|
-
# The identifier of the index
|
2767
|
-
#
|
3095
|
+
# The identifier of the index you want to use with the data source
|
3096
|
+
# connector.
|
2768
3097
|
# @return [String]
|
2769
3098
|
#
|
2770
3099
|
# @!attribute [rw] type
|
2771
|
-
# The type of
|
3100
|
+
# The type of data source repository. For example, `SHAREPOINT`.
|
2772
3101
|
# @return [String]
|
2773
3102
|
#
|
2774
3103
|
# @!attribute [rw] configuration
|
2775
|
-
# Configuration information
|
2776
|
-
# repository.
|
3104
|
+
# Configuration information to connect to your data source repository.
|
2777
3105
|
#
|
2778
3106
|
# You can't specify the `Configuration` parameter when the `Type`
|
2779
3107
|
# parameter is set to `CUSTOM`. If you do, you receive a
|
@@ -2784,14 +3112,14 @@ module Aws::Kendra
|
|
2784
3112
|
# @return [Types::DataSourceConfiguration]
|
2785
3113
|
#
|
2786
3114
|
# @!attribute [rw] description
|
2787
|
-
# A description for the data source.
|
3115
|
+
# A description for the data source connector.
|
2788
3116
|
# @return [String]
|
2789
3117
|
#
|
2790
3118
|
# @!attribute [rw] schedule
|
2791
3119
|
# Sets the frequency for Amazon Kendra to check the documents in your
|
2792
|
-
# repository and update the index. If you don't set a
|
2793
|
-
# Kendra will not periodically update the index. You
|
2794
|
-
# `StartDataSourceSyncJob` API to update the index.
|
3120
|
+
# data source repository and update the index. If you don't set a
|
3121
|
+
# schedule Amazon Kendra will not periodically update the index. You
|
3122
|
+
# can call the `StartDataSourceSyncJob` API to update the index.
|
2795
3123
|
#
|
2796
3124
|
# You can't specify the `Schedule` parameter when the `Type`
|
2797
3125
|
# parameter is set to `CUSTOM`. If you do, you receive a
|
@@ -2800,8 +3128,8 @@ module Aws::Kendra
|
|
2800
3128
|
#
|
2801
3129
|
# @!attribute [rw] role_arn
|
2802
3130
|
# The Amazon Resource Name (ARN) of a role with permission to access
|
2803
|
-
# the data source. For more information, see [IAM Roles for
|
2804
|
-
# Kendra][1].
|
3131
|
+
# the data source connector. For more information, see [IAM Roles for
|
3132
|
+
# Amazon Kendra][1].
|
2805
3133
|
#
|
2806
3134
|
# You can't specify the `RoleArn` parameter when the `Type` parameter
|
2807
3135
|
# is set to `CUSTOM`. If you do, you receive a `ValidationException`
|
@@ -2815,15 +3143,15 @@ module Aws::Kendra
|
|
2815
3143
|
# @return [String]
|
2816
3144
|
#
|
2817
3145
|
# @!attribute [rw] tags
|
2818
|
-
# A list of key-value pairs that identify the data source.
|
2819
|
-
# the tags to identify and organize your resources and to
|
2820
|
-
# access to resources.
|
3146
|
+
# A list of key-value pairs that identify the data source connector.
|
3147
|
+
# You can use the tags to identify and organize your resources and to
|
3148
|
+
# control access to resources.
|
2821
3149
|
# @return [Array<Types::Tag>]
|
2822
3150
|
#
|
2823
3151
|
# @!attribute [rw] client_token
|
2824
3152
|
# A token that you provide to identify the request to create a data
|
2825
|
-
# source. Multiple calls to the `CreateDataSource` API with
|
2826
|
-
# client token will create only one data source.
|
3153
|
+
# source connector. Multiple calls to the `CreateDataSource` API with
|
3154
|
+
# the same client token will create only one data source connector.
|
2827
3155
|
#
|
2828
3156
|
# **A suitable default value is auto-generated.** You should normally
|
2829
3157
|
# not need to pass this option.
|
@@ -2831,9 +3159,9 @@ module Aws::Kendra
|
|
2831
3159
|
#
|
2832
3160
|
# @!attribute [rw] language_code
|
2833
3161
|
# The code for a language. This allows you to support a language for
|
2834
|
-
# all documents when creating the data source. English is
|
2835
|
-
# default. For more information on supported languages,
|
2836
|
-
# their codes, see [Adding documents in languages other than
|
3162
|
+
# all documents when creating the data source connector. English is
|
3163
|
+
# supported by default. For more information on supported languages,
|
3164
|
+
# including their codes, see [Adding documents in languages other than
|
2837
3165
|
# English][1].
|
2838
3166
|
#
|
2839
3167
|
#
|
@@ -2843,7 +3171,7 @@ module Aws::Kendra
|
|
2843
3171
|
#
|
2844
3172
|
# @!attribute [rw] custom_document_enrichment_configuration
|
2845
3173
|
# Configuration information for altering document metadata and content
|
2846
|
-
# during the document ingestion process
|
3174
|
+
# during the document ingestion process.
|
2847
3175
|
#
|
2848
3176
|
# For more information on how to create, modify and delete document
|
2849
3177
|
# metadata, or make other content alterations when you ingest
|
@@ -2874,7 +3202,7 @@ module Aws::Kendra
|
|
2874
3202
|
end
|
2875
3203
|
|
2876
3204
|
# @!attribute [rw] id
|
2877
|
-
#
|
3205
|
+
# The identifier of the data source connector.
|
2878
3206
|
# @return [String]
|
2879
3207
|
#
|
2880
3208
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateDataSourceResponse AWS API Documentation
|
@@ -2996,19 +3324,19 @@ module Aws::Kendra
|
|
2996
3324
|
# }
|
2997
3325
|
#
|
2998
3326
|
# @!attribute [rw] index_id
|
2999
|
-
# The identifier of the index
|
3327
|
+
# The identifier of the index for the FAQ.
|
3000
3328
|
# @return [String]
|
3001
3329
|
#
|
3002
3330
|
# @!attribute [rw] name
|
3003
|
-
#
|
3331
|
+
# A name for the FAQ.
|
3004
3332
|
# @return [String]
|
3005
3333
|
#
|
3006
3334
|
# @!attribute [rw] description
|
3007
|
-
# A description
|
3335
|
+
# A description for the FAQ.
|
3008
3336
|
# @return [String]
|
3009
3337
|
#
|
3010
3338
|
# @!attribute [rw] s3_path
|
3011
|
-
# The
|
3339
|
+
# The path to the FAQ file in S3.
|
3012
3340
|
# @return [Types::S3Path]
|
3013
3341
|
#
|
3014
3342
|
# @!attribute [rw] role_arn
|
@@ -3028,7 +3356,7 @@ module Aws::Kendra
|
|
3028
3356
|
# @return [Array<Types::Tag>]
|
3029
3357
|
#
|
3030
3358
|
# @!attribute [rw] file_format
|
3031
|
-
# The format of the input file. You can choose between a basic CSV
|
3359
|
+
# The format of the FAQ input file. You can choose between a basic CSV
|
3032
3360
|
# format, a CSV format that includes customs attributes in a header,
|
3033
3361
|
# and a JSON format that includes custom attributes.
|
3034
3362
|
#
|
@@ -3132,7 +3460,7 @@ module Aws::Kendra
|
|
3132
3460
|
# }
|
3133
3461
|
#
|
3134
3462
|
# @!attribute [rw] name
|
3135
|
-
#
|
3463
|
+
# A name for the index.
|
3136
3464
|
# @return [String]
|
3137
3465
|
#
|
3138
3466
|
# @!attribute [rw] edition
|
@@ -3373,15 +3701,15 @@ module Aws::Kendra
|
|
3373
3701
|
# }
|
3374
3702
|
#
|
3375
3703
|
# @!attribute [rw] index_id
|
3376
|
-
# The
|
3704
|
+
# The identifier of the index for the thesaurus.
|
3377
3705
|
# @return [String]
|
3378
3706
|
#
|
3379
3707
|
# @!attribute [rw] name
|
3380
|
-
#
|
3708
|
+
# A name for the thesaurus.
|
3381
3709
|
# @return [String]
|
3382
3710
|
#
|
3383
3711
|
# @!attribute [rw] description
|
3384
|
-
#
|
3712
|
+
# A description for the thesaurus.
|
3385
3713
|
# @return [String]
|
3386
3714
|
#
|
3387
3715
|
# @!attribute [rw] role_arn
|
@@ -3396,7 +3724,7 @@ module Aws::Kendra
|
|
3396
3724
|
# @return [Array<Types::Tag>]
|
3397
3725
|
#
|
3398
3726
|
# @!attribute [rw] source_s3_path
|
3399
|
-
# The thesaurus file
|
3727
|
+
# The path to the thesaurus file in S3.
|
3400
3728
|
# @return [Types::S3Path]
|
3401
3729
|
#
|
3402
3730
|
# @!attribute [rw] client_token
|
@@ -3600,6 +3928,7 @@ module Aws::Kendra
|
|
3600
3928
|
# bucket: "S3BucketName", # required
|
3601
3929
|
# key: "S3ObjectKey", # required
|
3602
3930
|
# },
|
3931
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
|
3603
3932
|
# },
|
3604
3933
|
# database_configuration: {
|
3605
3934
|
# database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
|
@@ -4136,6 +4465,45 @@ module Aws::Kendra
|
|
4136
4465
|
# },
|
4137
4466
|
# ],
|
4138
4467
|
# },
|
4468
|
+
# alfresco_configuration: {
|
4469
|
+
# site_url: "SiteUrl", # required
|
4470
|
+
# site_id: "SiteId", # required
|
4471
|
+
# secret_arn: "SecretArn", # required
|
4472
|
+
# ssl_certificate_s3_path: { # required
|
4473
|
+
# bucket: "S3BucketName", # required
|
4474
|
+
# key: "S3ObjectKey", # required
|
4475
|
+
# },
|
4476
|
+
# crawl_system_folders: false,
|
4477
|
+
# crawl_comments: false,
|
4478
|
+
# entity_filter: ["wiki"], # accepts wiki, blog, documentLibrary
|
4479
|
+
# document_library_field_mappings: [
|
4480
|
+
# {
|
4481
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
4482
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
4483
|
+
# index_field_name: "IndexFieldName", # required
|
4484
|
+
# },
|
4485
|
+
# ],
|
4486
|
+
# blog_field_mappings: [
|
4487
|
+
# {
|
4488
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
4489
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
4490
|
+
# index_field_name: "IndexFieldName", # required
|
4491
|
+
# },
|
4492
|
+
# ],
|
4493
|
+
# wiki_field_mappings: [
|
4494
|
+
# {
|
4495
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
4496
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
4497
|
+
# index_field_name: "IndexFieldName", # required
|
4498
|
+
# },
|
4499
|
+
# ],
|
4500
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
4501
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
4502
|
+
# vpc_configuration: {
|
4503
|
+
# subnet_ids: ["SubnetId"], # required
|
4504
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
4505
|
+
# },
|
4506
|
+
# },
|
4139
4507
|
# }
|
4140
4508
|
#
|
4141
4509
|
# @!attribute [rw] s3_configuration
|
@@ -4218,6 +4586,11 @@ module Aws::Kendra
|
|
4218
4586
|
# data source.
|
4219
4587
|
# @return [Types::GitHubConfiguration]
|
4220
4588
|
#
|
4589
|
+
# @!attribute [rw] alfresco_configuration
|
4590
|
+
# Provides the configuration information to connect to Alfresco as
|
4591
|
+
# your data source.
|
4592
|
+
# @return [Types::AlfrescoConfiguration]
|
4593
|
+
#
|
4221
4594
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceConfiguration AWS API Documentation
|
4222
4595
|
#
|
4223
4596
|
class DataSourceConfiguration < Struct.new(
|
@@ -4236,7 +4609,8 @@ module Aws::Kendra
|
|
4236
4609
|
:box_configuration,
|
4237
4610
|
:quip_configuration,
|
4238
4611
|
:jira_configuration,
|
4239
|
-
:git_hub_configuration
|
4612
|
+
:git_hub_configuration,
|
4613
|
+
:alfresco_configuration)
|
4240
4614
|
SENSITIVE = []
|
4241
4615
|
include Aws::Structure
|
4242
4616
|
end
|
@@ -4605,6 +4979,36 @@ module Aws::Kendra
|
|
4605
4979
|
include Aws::Structure
|
4606
4980
|
end
|
4607
4981
|
|
4982
|
+
# @note When making an API call, you may pass DeleteAccessControlConfigurationRequest
|
4983
|
+
# data as a hash:
|
4984
|
+
#
|
4985
|
+
# {
|
4986
|
+
# index_id: "IndexId", # required
|
4987
|
+
# id: "AccessControlConfigurationId", # required
|
4988
|
+
# }
|
4989
|
+
#
|
4990
|
+
# @!attribute [rw] index_id
|
4991
|
+
# The identifier of the index for an access control configuration.
|
4992
|
+
# @return [String]
|
4993
|
+
#
|
4994
|
+
# @!attribute [rw] id
|
4995
|
+
# The identifier of the access control configuration you want to
|
4996
|
+
# delete.
|
4997
|
+
# @return [String]
|
4998
|
+
#
|
4999
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteAccessControlConfigurationRequest AWS API Documentation
|
5000
|
+
#
|
5001
|
+
class DeleteAccessControlConfigurationRequest < Struct.new(
|
5002
|
+
:index_id,
|
5003
|
+
:id)
|
5004
|
+
SENSITIVE = []
|
5005
|
+
include Aws::Structure
|
5006
|
+
end
|
5007
|
+
|
5008
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteAccessControlConfigurationResponse AWS API Documentation
|
5009
|
+
#
|
5010
|
+
class DeleteAccessControlConfigurationResponse < Aws::EmptyStructure; end
|
5011
|
+
|
4608
5012
|
# @note When making an API call, you may pass DeleteDataSourceRequest
|
4609
5013
|
# data as a hash:
|
4610
5014
|
#
|
@@ -4614,11 +5018,11 @@ module Aws::Kendra
|
|
4614
5018
|
# }
|
4615
5019
|
#
|
4616
5020
|
# @!attribute [rw] id
|
4617
|
-
# The
|
5021
|
+
# The identifier of the data source you want to delete.
|
4618
5022
|
# @return [String]
|
4619
5023
|
#
|
4620
5024
|
# @!attribute [rw] index_id
|
4621
|
-
# The
|
5025
|
+
# The identifier of the index used with the data source.
|
4622
5026
|
# @return [String]
|
4623
5027
|
#
|
4624
5028
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteDataSourceRequest AWS API Documentation
|
@@ -4643,8 +5047,7 @@ module Aws::Kendra
|
|
4643
5047
|
# @return [String]
|
4644
5048
|
#
|
4645
5049
|
# @!attribute [rw] index_id
|
4646
|
-
# The identifier of the index for your Amazon Kendra experience
|
4647
|
-
# want to delete.
|
5050
|
+
# The identifier of the index for your Amazon Kendra experience.
|
4648
5051
|
# @return [String]
|
4649
5052
|
#
|
4650
5053
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteExperienceRequest AWS API Documentation
|
@@ -4669,11 +5072,11 @@ module Aws::Kendra
|
|
4669
5072
|
# }
|
4670
5073
|
#
|
4671
5074
|
# @!attribute [rw] id
|
4672
|
-
# The identifier of the FAQ to remove.
|
5075
|
+
# The identifier of the FAQ you want to remove.
|
4673
5076
|
# @return [String]
|
4674
5077
|
#
|
4675
5078
|
# @!attribute [rw] index_id
|
4676
|
-
# The index
|
5079
|
+
# The identifier of the index for the FAQ.
|
4677
5080
|
# @return [String]
|
4678
5081
|
#
|
4679
5082
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteFaqRequest AWS API Documentation
|
@@ -4693,7 +5096,7 @@ module Aws::Kendra
|
|
4693
5096
|
# }
|
4694
5097
|
#
|
4695
5098
|
# @!attribute [rw] id
|
4696
|
-
# The identifier of the index to delete.
|
5099
|
+
# The identifier of the index you want to delete.
|
4697
5100
|
# @return [String]
|
4698
5101
|
#
|
4699
5102
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteIndexRequest AWS API Documentation
|
@@ -4721,15 +5124,15 @@ module Aws::Kendra
|
|
4721
5124
|
# @!attribute [rw] data_source_id
|
4722
5125
|
# The identifier of the data source you want to delete a group from.
|
4723
5126
|
#
|
4724
|
-
#
|
4725
|
-
#
|
4726
|
-
#
|
4727
|
-
#
|
4728
|
-
#
|
4729
|
-
#
|
4730
|
-
#
|
4731
|
-
#
|
4732
|
-
#
|
5127
|
+
# A group can be tied to multiple data sources. You can delete a group
|
5128
|
+
# from accessing documents in a certain data source. For example, the
|
5129
|
+
# groups "Research", "Engineering", and "Sales and Marketing"
|
5130
|
+
# are all tied to the company's documents stored in the data sources
|
5131
|
+
# Confluence and Salesforce. You want to delete "Research" and
|
5132
|
+
# "Engineering" groups from Salesforce, so that these groups cannot
|
5133
|
+
# access customer-related documents stored in Salesforce. Only "Sales
|
5134
|
+
# and Marketing" should access documents in the Salesforce data
|
5135
|
+
# source.
|
4733
5136
|
# @return [String]
|
4734
5137
|
#
|
4735
5138
|
# @!attribute [rw] group_id
|
@@ -4775,11 +5178,11 @@ module Aws::Kendra
|
|
4775
5178
|
# }
|
4776
5179
|
#
|
4777
5180
|
# @!attribute [rw] index_id
|
4778
|
-
# The identifier of the
|
5181
|
+
# The identifier of the index for the block list.
|
4779
5182
|
# @return [String]
|
4780
5183
|
#
|
4781
5184
|
# @!attribute [rw] id
|
4782
|
-
# The
|
5185
|
+
# The identifier of the block list you want to delete.
|
4783
5186
|
# @return [String]
|
4784
5187
|
#
|
4785
5188
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteQuerySuggestionsBlockListRequest AWS API Documentation
|
@@ -4800,11 +5203,11 @@ module Aws::Kendra
|
|
4800
5203
|
# }
|
4801
5204
|
#
|
4802
5205
|
# @!attribute [rw] id
|
4803
|
-
# The identifier of the thesaurus to delete.
|
5206
|
+
# The identifier of the thesaurus you want to delete.
|
4804
5207
|
# @return [String]
|
4805
5208
|
#
|
4806
5209
|
# @!attribute [rw] index_id
|
4807
|
-
# The identifier of the index
|
5210
|
+
# The identifier of the index for the thesaurus.
|
4808
5211
|
# @return [String]
|
4809
5212
|
#
|
4810
5213
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteThesaurusRequest AWS API Documentation
|
@@ -4816,6 +5219,73 @@ module Aws::Kendra
|
|
4816
5219
|
include Aws::Structure
|
4817
5220
|
end
|
4818
5221
|
|
5222
|
+
# @note When making an API call, you may pass DescribeAccessControlConfigurationRequest
|
5223
|
+
# data as a hash:
|
5224
|
+
#
|
5225
|
+
# {
|
5226
|
+
# index_id: "IndexId", # required
|
5227
|
+
# id: "AccessControlConfigurationId", # required
|
5228
|
+
# }
|
5229
|
+
#
|
5230
|
+
# @!attribute [rw] index_id
|
5231
|
+
# The identifier of the index for an access control configuration.
|
5232
|
+
# @return [String]
|
5233
|
+
#
|
5234
|
+
# @!attribute [rw] id
|
5235
|
+
# The identifier of the access control configuration you want to get
|
5236
|
+
# information on.
|
5237
|
+
# @return [String]
|
5238
|
+
#
|
5239
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeAccessControlConfigurationRequest AWS API Documentation
|
5240
|
+
#
|
5241
|
+
class DescribeAccessControlConfigurationRequest < Struct.new(
|
5242
|
+
:index_id,
|
5243
|
+
:id)
|
5244
|
+
SENSITIVE = []
|
5245
|
+
include Aws::Structure
|
5246
|
+
end
|
5247
|
+
|
5248
|
+
# @!attribute [rw] name
|
5249
|
+
# The name for the access control configuration.
|
5250
|
+
# @return [String]
|
5251
|
+
#
|
5252
|
+
# @!attribute [rw] description
|
5253
|
+
# The description for the access control configuration.
|
5254
|
+
# @return [String]
|
5255
|
+
#
|
5256
|
+
# @!attribute [rw] error_message
|
5257
|
+
# The error message containing details if there are issues processing
|
5258
|
+
# the access control configuration.
|
5259
|
+
# @return [String]
|
5260
|
+
#
|
5261
|
+
# @!attribute [rw] access_control_list
|
5262
|
+
# Information on principals (users and/or groups) and which documents
|
5263
|
+
# they should have access to. This is useful for user context
|
5264
|
+
# filtering, where search results are filtered based on the user or
|
5265
|
+
# their group access to documents.
|
5266
|
+
# @return [Array<Types::Principal>]
|
5267
|
+
#
|
5268
|
+
# @!attribute [rw] hierarchical_access_control_list
|
5269
|
+
# The list of [principal][1] lists that define the hierarchy for which
|
5270
|
+
# documents users should have access to.
|
5271
|
+
#
|
5272
|
+
#
|
5273
|
+
#
|
5274
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html
|
5275
|
+
# @return [Array<Types::HierarchicalPrincipal>]
|
5276
|
+
#
|
5277
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeAccessControlConfigurationResponse AWS API Documentation
|
5278
|
+
#
|
5279
|
+
class DescribeAccessControlConfigurationResponse < Struct.new(
|
5280
|
+
:name,
|
5281
|
+
:description,
|
5282
|
+
:error_message,
|
5283
|
+
:access_control_list,
|
5284
|
+
:hierarchical_access_control_list)
|
5285
|
+
SENSITIVE = []
|
5286
|
+
include Aws::Structure
|
5287
|
+
end
|
5288
|
+
|
4819
5289
|
# @note When making an API call, you may pass DescribeDataSourceRequest
|
4820
5290
|
# data as a hash:
|
4821
5291
|
#
|
@@ -4825,11 +5295,11 @@ module Aws::Kendra
|
|
4825
5295
|
# }
|
4826
5296
|
#
|
4827
5297
|
# @!attribute [rw] id
|
4828
|
-
# The
|
5298
|
+
# The identifier of the data source.
|
4829
5299
|
# @return [String]
|
4830
5300
|
#
|
4831
5301
|
# @!attribute [rw] index_id
|
4832
|
-
# The identifier of the index
|
5302
|
+
# The identifier of the index used with the data source.
|
4833
5303
|
# @return [String]
|
4834
5304
|
#
|
4835
5305
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeDataSourceRequest AWS API Documentation
|
@@ -4858,8 +5328,9 @@ module Aws::Kendra
|
|
4858
5328
|
# @return [String]
|
4859
5329
|
#
|
4860
5330
|
# @!attribute [rw] configuration
|
4861
|
-
#
|
4862
|
-
#
|
5331
|
+
# Configuration details for the data source. This shows how the data
|
5332
|
+
# source is configured. The configuration options for a data source
|
5333
|
+
# depend on the data source provider.
|
4863
5334
|
# @return [Types::DataSourceConfiguration]
|
4864
5335
|
#
|
4865
5336
|
# @!attribute [rw] created_at
|
@@ -4871,7 +5342,7 @@ module Aws::Kendra
|
|
4871
5342
|
# @return [Time]
|
4872
5343
|
#
|
4873
5344
|
# @!attribute [rw] description
|
4874
|
-
# The description
|
5345
|
+
# The description for the data source.
|
4875
5346
|
# @return [String]
|
4876
5347
|
#
|
4877
5348
|
# @!attribute [rw] status
|
@@ -4957,8 +5428,7 @@ module Aws::Kendra
|
|
4957
5428
|
# @return [String]
|
4958
5429
|
#
|
4959
5430
|
# @!attribute [rw] index_id
|
4960
|
-
# The identifier of the index for your Amazon Kendra experience
|
4961
|
-
# want to get information on.
|
5431
|
+
# The identifier of the index for your Amazon Kendra experience.
|
4962
5432
|
# @return [String]
|
4963
5433
|
#
|
4964
5434
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeExperienceRequest AWS API Documentation
|
@@ -5052,11 +5522,11 @@ module Aws::Kendra
|
|
5052
5522
|
# }
|
5053
5523
|
#
|
5054
5524
|
# @!attribute [rw] id
|
5055
|
-
# The
|
5525
|
+
# The identifier of the FAQ you want to get information on.
|
5056
5526
|
# @return [String]
|
5057
5527
|
#
|
5058
5528
|
# @!attribute [rw] index_id
|
5059
|
-
# The identifier of the index
|
5529
|
+
# The identifier of the index for the FAQ.
|
5060
5530
|
# @return [String]
|
5061
5531
|
#
|
5062
5532
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeFaqRequest AWS API Documentation
|
@@ -5073,7 +5543,7 @@ module Aws::Kendra
|
|
5073
5543
|
# @return [String]
|
5074
5544
|
#
|
5075
5545
|
# @!attribute [rw] index_id
|
5076
|
-
# The identifier of the index
|
5546
|
+
# The identifier of the index for the FAQ.
|
5077
5547
|
# @return [String]
|
5078
5548
|
#
|
5079
5549
|
# @!attribute [rw] name
|
@@ -5153,7 +5623,7 @@ module Aws::Kendra
|
|
5153
5623
|
# }
|
5154
5624
|
#
|
5155
5625
|
# @!attribute [rw] id
|
5156
|
-
# The identifier of the index to
|
5626
|
+
# The identifier of the index you want to get information on.
|
5157
5627
|
# @return [String]
|
5158
5628
|
#
|
5159
5629
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndexRequest AWS API Documentation
|
@@ -5206,8 +5676,10 @@ module Aws::Kendra
|
|
5206
5676
|
# @return [Time]
|
5207
5677
|
#
|
5208
5678
|
# @!attribute [rw] document_metadata_configurations
|
5209
|
-
# Configuration
|
5210
|
-
#
|
5679
|
+
# Configuration information for document metadata or fields. Document
|
5680
|
+
# metadata are fields or attributes associated with your documents.
|
5681
|
+
# For example, the company department name associated with each
|
5682
|
+
# document.
|
5211
5683
|
# @return [Array<Types::DocumentMetadataConfiguration>]
|
5212
5684
|
#
|
5213
5685
|
# @!attribute [rw] index_statistics
|
@@ -5242,7 +5714,7 @@ module Aws::Kendra
|
|
5242
5714
|
# @return [String]
|
5243
5715
|
#
|
5244
5716
|
# @!attribute [rw] user_group_resolution_configuration
|
5245
|
-
#
|
5717
|
+
# Whether you have enabled the configuration for fetching access
|
5246
5718
|
# levels of groups and users from an Amazon Web Services Single Sign
|
5247
5719
|
# On identity source.
|
5248
5720
|
# @return [Types::UserGroupResolutionConfiguration]
|
@@ -5363,7 +5835,7 @@ module Aws::Kendra
|
|
5363
5835
|
# @return [String]
|
5364
5836
|
#
|
5365
5837
|
# @!attribute [rw] id
|
5366
|
-
# The
|
5838
|
+
# The identifier of the block list you want to get information on.
|
5367
5839
|
# @return [String]
|
5368
5840
|
#
|
5369
5841
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsBlockListRequest AWS API Documentation
|
@@ -5376,38 +5848,37 @@ module Aws::Kendra
|
|
5376
5848
|
end
|
5377
5849
|
|
5378
5850
|
# @!attribute [rw] index_id
|
5379
|
-
#
|
5851
|
+
# The identifier of the index for the block list.
|
5380
5852
|
# @return [String]
|
5381
5853
|
#
|
5382
5854
|
# @!attribute [rw] id
|
5383
|
-
#
|
5855
|
+
# The identifier of the block list.
|
5384
5856
|
# @return [String]
|
5385
5857
|
#
|
5386
5858
|
# @!attribute [rw] name
|
5387
|
-
#
|
5859
|
+
# The name of the block list.
|
5388
5860
|
# @return [String]
|
5389
5861
|
#
|
5390
5862
|
# @!attribute [rw] description
|
5391
|
-
#
|
5863
|
+
# The description for the block list.
|
5392
5864
|
# @return [String]
|
5393
5865
|
#
|
5394
5866
|
# @!attribute [rw] status
|
5395
|
-
#
|
5396
|
-
#
|
5867
|
+
# The current status of the block list. When the value is `ACTIVE`,
|
5868
|
+
# the block list is ready for use.
|
5397
5869
|
# @return [String]
|
5398
5870
|
#
|
5399
5871
|
# @!attribute [rw] error_message
|
5400
|
-
#
|
5401
|
-
#
|
5872
|
+
# The error message containing details if there are issues processing
|
5873
|
+
# the block list.
|
5402
5874
|
# @return [String]
|
5403
5875
|
#
|
5404
5876
|
# @!attribute [rw] created_at
|
5405
|
-
#
|
5877
|
+
# The date-time a block list for query suggestions was created.
|
5406
5878
|
# @return [Time]
|
5407
5879
|
#
|
5408
5880
|
# @!attribute [rw] updated_at
|
5409
|
-
#
|
5410
|
-
# updated.
|
5881
|
+
# The date-time a block list for query suggestions was last updated.
|
5411
5882
|
# @return [Time]
|
5412
5883
|
#
|
5413
5884
|
# @!attribute [rw] source_s3_path
|
@@ -5426,17 +5897,17 @@ module Aws::Kendra
|
|
5426
5897
|
# @return [Types::S3Path]
|
5427
5898
|
#
|
5428
5899
|
# @!attribute [rw] item_count
|
5429
|
-
#
|
5430
|
-
#
|
5900
|
+
# The current number of valid, non-empty words or phrases in the block
|
5901
|
+
# list text file.
|
5431
5902
|
# @return [Integer]
|
5432
5903
|
#
|
5433
5904
|
# @!attribute [rw] file_size_bytes
|
5434
|
-
#
|
5905
|
+
# The current size of the block list text file in S3.
|
5435
5906
|
# @return [Integer]
|
5436
5907
|
#
|
5437
5908
|
# @!attribute [rw] role_arn
|
5438
|
-
#
|
5439
|
-
#
|
5909
|
+
# The IAM (Identity and Access Management) role used by Amazon Kendra
|
5910
|
+
# to access the block list text file in S3.
|
5440
5911
|
#
|
5441
5912
|
# The role needs S3 read permissions to your file in S3 and needs to
|
5442
5913
|
# give STS (Security Token Service) assume role permissions to Amazon
|
@@ -5470,8 +5941,8 @@ module Aws::Kendra
|
|
5470
5941
|
# }
|
5471
5942
|
#
|
5472
5943
|
# @!attribute [rw] index_id
|
5473
|
-
# The identifier of the index you want to
|
5474
|
-
#
|
5944
|
+
# The identifier of the index with query suggestions that you want to
|
5945
|
+
# get information on.
|
5475
5946
|
# @return [String]
|
5476
5947
|
#
|
5477
5948
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeQuerySuggestionsConfigRequest AWS API Documentation
|
@@ -5483,7 +5954,7 @@ module Aws::Kendra
|
|
5483
5954
|
end
|
5484
5955
|
|
5485
5956
|
# @!attribute [rw] mode
|
5486
|
-
#
|
5957
|
+
# Whether query suggestions are currently in `ENABLED` mode or
|
5487
5958
|
# `LEARN_ONLY` mode.
|
5488
5959
|
#
|
5489
5960
|
# By default, Amazon Kendra enables query suggestions.`LEARN_ONLY`
|
@@ -5496,39 +5967,38 @@ module Aws::Kendra
|
|
5496
5967
|
# @return [String]
|
5497
5968
|
#
|
5498
5969
|
# @!attribute [rw] status
|
5499
|
-
#
|
5500
|
-
#
|
5970
|
+
# Whether the status of query suggestions settings is currently
|
5971
|
+
# `ACTIVE` or `UPDATING`.
|
5501
5972
|
#
|
5502
5973
|
# Active means the current settings apply and Updating means your
|
5503
5974
|
# changed settings are in the process of applying.
|
5504
5975
|
# @return [String]
|
5505
5976
|
#
|
5506
5977
|
# @!attribute [rw] query_log_look_back_window_in_days
|
5507
|
-
#
|
5508
|
-
# days).
|
5978
|
+
# How recent your queries are in your query log time window (in days).
|
5509
5979
|
# @return [Integer]
|
5510
5980
|
#
|
5511
5981
|
# @!attribute [rw] include_queries_without_user_information
|
5512
|
-
#
|
5513
|
-
#
|
5982
|
+
# `TRUE` to use all queries, otherwise use only queries that include
|
5983
|
+
# user information to generate the query suggestions.
|
5514
5984
|
# @return [Boolean]
|
5515
5985
|
#
|
5516
5986
|
# @!attribute [rw] minimum_number_of_querying_users
|
5517
|
-
#
|
5518
|
-
#
|
5987
|
+
# The minimum number of unique users who must search a query in order
|
5988
|
+
# for the query to be eligible to suggest to your users.
|
5519
5989
|
# @return [Integer]
|
5520
5990
|
#
|
5521
5991
|
# @!attribute [rw] minimum_query_count
|
5522
|
-
#
|
5523
|
-
#
|
5992
|
+
# The minimum number of times a query must be searched in order for
|
5993
|
+
# the query to be eligible to suggest to your users.
|
5524
5994
|
# @return [Integer]
|
5525
5995
|
#
|
5526
5996
|
# @!attribute [rw] last_suggestions_build_time
|
5527
|
-
#
|
5997
|
+
# The date-time query suggestions for an index was last updated.
|
5528
5998
|
# @return [Time]
|
5529
5999
|
#
|
5530
6000
|
# @!attribute [rw] last_clear_time
|
5531
|
-
#
|
6001
|
+
# The date-time query suggestions for an index was last cleared.
|
5532
6002
|
#
|
5533
6003
|
# After you clear suggestions, Amazon Kendra learns new suggestions
|
5534
6004
|
# based on new queries added to the query log from the time you
|
@@ -5537,7 +6007,7 @@ module Aws::Kendra
|
|
5537
6007
|
# @return [Time]
|
5538
6008
|
#
|
5539
6009
|
# @!attribute [rw] total_suggestions_count
|
5540
|
-
#
|
6010
|
+
# The current total count of query suggestions for an index.
|
5541
6011
|
#
|
5542
6012
|
# This count can change when you update your query suggestions
|
5543
6013
|
# settings, if you filter out certain queries from suggestions using a
|
@@ -5570,12 +6040,11 @@ module Aws::Kendra
|
|
5570
6040
|
# }
|
5571
6041
|
#
|
5572
6042
|
# @!attribute [rw] id
|
5573
|
-
# The identifier of the thesaurus to
|
6043
|
+
# The identifier of the thesaurus you want to get information on.
|
5574
6044
|
# @return [String]
|
5575
6045
|
#
|
5576
6046
|
# @!attribute [rw] index_id
|
5577
|
-
# The identifier of the index
|
5578
|
-
# describe.
|
6047
|
+
# The identifier of the index for the thesaurus.
|
5579
6048
|
# @return [String]
|
5580
6049
|
#
|
5581
6050
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeThesaurusRequest AWS API Documentation
|
@@ -5592,8 +6061,7 @@ module Aws::Kendra
|
|
5592
6061
|
# @return [String]
|
5593
6062
|
#
|
5594
6063
|
# @!attribute [rw] index_id
|
5595
|
-
# The identifier of the index
|
5596
|
-
# describe.
|
6064
|
+
# The identifier of the index for the thesaurus.
|
5597
6065
|
# @return [String]
|
5598
6066
|
#
|
5599
6067
|
# @!attribute [rw] name
|
@@ -5811,6 +6279,7 @@ module Aws::Kendra
|
|
5811
6279
|
# },
|
5812
6280
|
# ],
|
5813
6281
|
# content_type: "PDF", # accepts PDF, HTML, MS_WORD, PLAIN_TEXT, PPT
|
6282
|
+
# access_control_configuration_id: "AccessControlConfigurationId",
|
5814
6283
|
# }
|
5815
6284
|
#
|
5816
6285
|
# @!attribute [rw] id
|
@@ -5855,8 +6324,10 @@ module Aws::Kendra
|
|
5855
6324
|
# @return [Array<Types::DocumentAttribute>]
|
5856
6325
|
#
|
5857
6326
|
# @!attribute [rw] access_control_list
|
5858
|
-
# Information on
|
5859
|
-
#
|
6327
|
+
# Information on principals (users and/or groups) and which documents
|
6328
|
+
# they should have access to. This is useful for user context
|
6329
|
+
# filtering, where search results are filtered based on the user or
|
6330
|
+
# their group access to documents.
|
5860
6331
|
# @return [Array<Types::Principal>]
|
5861
6332
|
#
|
5862
6333
|
# @!attribute [rw] hierarchical_access_control_list
|
@@ -5872,6 +6343,11 @@ module Aws::Kendra
|
|
5872
6343
|
# The file type of the document in the `Blob` field.
|
5873
6344
|
# @return [String]
|
5874
6345
|
#
|
6346
|
+
# @!attribute [rw] access_control_configuration_id
|
6347
|
+
# The identifier of the access control configuration that you want to
|
6348
|
+
# apply to the document.
|
6349
|
+
# @return [String]
|
6350
|
+
#
|
5875
6351
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/Document AWS API Documentation
|
5876
6352
|
#
|
5877
6353
|
class Document < Struct.new(
|
@@ -5882,7 +6358,8 @@ module Aws::Kendra
|
|
5882
6358
|
:attributes,
|
5883
6359
|
:access_control_list,
|
5884
6360
|
:hierarchical_access_control_list,
|
5885
|
-
:content_type
|
6361
|
+
:content_type,
|
6362
|
+
:access_control_configuration_id)
|
5886
6363
|
SENSITIVE = []
|
5887
6364
|
include Aws::Structure
|
5888
6365
|
end
|
@@ -6199,7 +6676,8 @@ module Aws::Kendra
|
|
6199
6676
|
include Aws::Structure
|
6200
6677
|
end
|
6201
6678
|
|
6202
|
-
# Specifies the properties
|
6679
|
+
# Specifies the properties, such as relevance tuning and searchability,
|
6680
|
+
# of an index field.
|
6203
6681
|
#
|
6204
6682
|
# @note When making an API call, you may pass DocumentMetadataConfiguration
|
6205
6683
|
# data as a hash:
|
@@ -6233,8 +6711,8 @@ module Aws::Kendra
|
|
6233
6711
|
# @return [String]
|
6234
6712
|
#
|
6235
6713
|
# @!attribute [rw] relevance
|
6236
|
-
# Provides
|
6237
|
-
#
|
6714
|
+
# Provides tuning parameters to determine how the field affects the
|
6715
|
+
# search results.
|
6238
6716
|
# @return [Types::Relevance]
|
6239
6717
|
#
|
6240
6718
|
# @!attribute [rw] search
|
@@ -6271,13 +6749,12 @@ module Aws::Kendra
|
|
6271
6749
|
# }
|
6272
6750
|
#
|
6273
6751
|
# @!attribute [rw] name
|
6274
|
-
# The name of the
|
6275
|
-
# at the index level.
|
6752
|
+
# The name of the index field.
|
6276
6753
|
# @return [String]
|
6277
6754
|
#
|
6278
6755
|
# @!attribute [rw] relevance
|
6279
|
-
# Provides information for
|
6280
|
-
#
|
6756
|
+
# Provides information for tuning the relevance of a field in a
|
6757
|
+
# search. When a query includes terms that match the field, the
|
6281
6758
|
# results are given a boost in the response based on these tuning
|
6282
6759
|
# parameters.
|
6283
6760
|
# @return [Types::Relevance]
|
@@ -6702,8 +7179,8 @@ module Aws::Kendra
|
|
6702
7179
|
include Aws::Structure
|
6703
7180
|
end
|
6704
7181
|
|
6705
|
-
#
|
6706
|
-
#
|
7182
|
+
# Summary information for frequently asked questions and answers
|
7183
|
+
# included in an index.
|
6707
7184
|
#
|
6708
7185
|
# @!attribute [rw] id
|
6709
7186
|
# The unique identifier of the FAQ.
|
@@ -7537,9 +8014,9 @@ module Aws::Kendra
|
|
7537
8014
|
include Aws::Structure
|
7538
8015
|
end
|
7539
8016
|
|
7540
|
-
# A list of users or sub groups that belong to a group.
|
7541
|
-
#
|
7542
|
-
# their group
|
8017
|
+
# A list of users or sub groups that belong to a group. This is useful
|
8018
|
+
# for user context filtering, where search results are filtered based on
|
8019
|
+
# the user or their group access to documents.
|
7543
8020
|
#
|
7544
8021
|
# @note When making an API call, you may pass GroupMembers
|
7545
8022
|
# data as a hash:
|
@@ -7600,8 +8077,8 @@ module Aws::Kendra
|
|
7600
8077
|
include Aws::Structure
|
7601
8078
|
end
|
7602
8079
|
|
7603
|
-
#
|
7604
|
-
# mapping users to their groups.
|
8080
|
+
# Summary information on the processing of `PUT` and `DELETE` actions
|
8081
|
+
# for mapping users to their groups.
|
7605
8082
|
#
|
7606
8083
|
# @!attribute [rw] status
|
7607
8084
|
# The current processing status of actions for mapping users to their
|
@@ -7641,7 +8118,7 @@ module Aws::Kendra
|
|
7641
8118
|
include Aws::Structure
|
7642
8119
|
end
|
7643
8120
|
|
7644
|
-
#
|
8121
|
+
# Summary information for groups.
|
7645
8122
|
#
|
7646
8123
|
# @!attribute [rw] group_id
|
7647
8124
|
# The identifier of the group you want group summary information on.
|
@@ -7805,7 +8282,7 @@ module Aws::Kendra
|
|
7805
8282
|
include Aws::Structure
|
7806
8283
|
end
|
7807
8284
|
|
7808
|
-
#
|
8285
|
+
# Summary information on the configuration of an index.
|
7809
8286
|
#
|
7810
8287
|
# @!attribute [rw] name
|
7811
8288
|
# The identifier of the index.
|
@@ -8018,24 +8495,33 @@ module Aws::Kendra
|
|
8018
8495
|
# }
|
8019
8496
|
#
|
8020
8497
|
# @!attribute [rw] jira_account_url
|
8021
|
-
# The URL of the Jira account. For example, company.
|
8022
|
-
# https://jira.company.com
|
8023
|
-
# URL of your profile page for Jira desktop.
|
8498
|
+
# The URL of the Jira account. For example, *company.atlassian.net* or
|
8499
|
+
# *https://jira.company.com*. You can find your Jira account URL in
|
8500
|
+
# the URL of your profile page for Jira desktop.
|
8024
8501
|
# @return [String]
|
8025
8502
|
#
|
8026
8503
|
# @!attribute [rw] secret_arn
|
8027
|
-
# The Amazon Resource Name (ARN) of
|
8504
|
+
# The Amazon Resource Name (ARN) of a secret in Secrets Manager
|
8028
8505
|
# contains the key-value pairs required to connect to your Jira data
|
8029
8506
|
# source. The secret must contain a JSON structure with the following
|
8030
8507
|
# keys:
|
8031
8508
|
#
|
8032
|
-
# *
|
8509
|
+
# * jiraId—The Jira username.
|
8510
|
+
#
|
8511
|
+
# * jiraCredentials—The Jira API token. For more information on
|
8512
|
+
# creating an API token in Jira, see [ Authentication for a Jira
|
8513
|
+
# data source][1].
|
8514
|
+
#
|
8033
8515
|
#
|
8034
|
-
#
|
8516
|
+
#
|
8517
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-jira.html#jira-authentication
|
8035
8518
|
# @return [String]
|
8036
8519
|
#
|
8037
8520
|
# @!attribute [rw] use_change_log
|
8038
|
-
#
|
8521
|
+
# `TRUE` to use the Jira change log to determine which documents
|
8522
|
+
# require updating in the index. Depending on the change log's size,
|
8523
|
+
# it may take longer for Amazon Kendra to use the change log than to
|
8524
|
+
# scan all of your documents in Jira.
|
8039
8525
|
# @return [Boolean]
|
8040
8526
|
#
|
8041
8527
|
# @!attribute [rw] project
|
@@ -8252,6 +8738,59 @@ module Aws::Kendra
|
|
8252
8738
|
include Aws::Structure
|
8253
8739
|
end
|
8254
8740
|
|
8741
|
+
# @note When making an API call, you may pass ListAccessControlConfigurationsRequest
|
8742
|
+
# data as a hash:
|
8743
|
+
#
|
8744
|
+
# {
|
8745
|
+
# index_id: "IndexId", # required
|
8746
|
+
# next_token: "String",
|
8747
|
+
# max_results: 1,
|
8748
|
+
# }
|
8749
|
+
#
|
8750
|
+
# @!attribute [rw] index_id
|
8751
|
+
# The identifier of the index for the access control configuration.
|
8752
|
+
# @return [String]
|
8753
|
+
#
|
8754
|
+
# @!attribute [rw] next_token
|
8755
|
+
# If the previous response was incomplete (because there's more data
|
8756
|
+
# to retrieve), Amazon Kendra returns a pagination token in the
|
8757
|
+
# response. You can use this pagination token to retrieve the next set
|
8758
|
+
# of access control configurations.
|
8759
|
+
# @return [String]
|
8760
|
+
#
|
8761
|
+
# @!attribute [rw] max_results
|
8762
|
+
# The maximum number of access control configurations to return.
|
8763
|
+
# @return [Integer]
|
8764
|
+
#
|
8765
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListAccessControlConfigurationsRequest AWS API Documentation
|
8766
|
+
#
|
8767
|
+
class ListAccessControlConfigurationsRequest < Struct.new(
|
8768
|
+
:index_id,
|
8769
|
+
:next_token,
|
8770
|
+
:max_results)
|
8771
|
+
SENSITIVE = []
|
8772
|
+
include Aws::Structure
|
8773
|
+
end
|
8774
|
+
|
8775
|
+
# @!attribute [rw] next_token
|
8776
|
+
# If the response is truncated, Amazon Kendra returns this token,
|
8777
|
+
# which you can use in the subsequent request to retrieve the next set
|
8778
|
+
# of access control configurations.
|
8779
|
+
# @return [String]
|
8780
|
+
#
|
8781
|
+
# @!attribute [rw] access_control_configurations
|
8782
|
+
# The details of your access control configurations.
|
8783
|
+
# @return [Array<Types::AccessControlConfigurationSummary>]
|
8784
|
+
#
|
8785
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListAccessControlConfigurationsResponse AWS API Documentation
|
8786
|
+
#
|
8787
|
+
class ListAccessControlConfigurationsResponse < Struct.new(
|
8788
|
+
:next_token,
|
8789
|
+
:access_control_configurations)
|
8790
|
+
SENSITIVE = []
|
8791
|
+
include Aws::Structure
|
8792
|
+
end
|
8793
|
+
|
8255
8794
|
# @note When making an API call, you may pass ListDataSourceSyncJobsRequest
|
8256
8795
|
# data as a hash:
|
8257
8796
|
#
|
@@ -8272,7 +8811,7 @@ module Aws::Kendra
|
|
8272
8811
|
# @return [String]
|
8273
8812
|
#
|
8274
8813
|
# @!attribute [rw] index_id
|
8275
|
-
# The identifier of the index
|
8814
|
+
# The identifier of the index used with the data source.
|
8276
8815
|
# @return [String]
|
8277
8816
|
#
|
8278
8817
|
# @!attribute [rw] next_token
|
@@ -8340,7 +8879,7 @@ module Aws::Kendra
|
|
8340
8879
|
# }
|
8341
8880
|
#
|
8342
8881
|
# @!attribute [rw] index_id
|
8343
|
-
# The identifier of the index
|
8882
|
+
# The identifier of the index used with one or more data sources.
|
8344
8883
|
# @return [String]
|
8345
8884
|
#
|
8346
8885
|
# @!attribute [rw] next_token
|
@@ -8838,7 +9377,7 @@ module Aws::Kendra
|
|
8838
9377
|
# }
|
8839
9378
|
#
|
8840
9379
|
# @!attribute [rw] index_id
|
8841
|
-
# The identifier of the index
|
9380
|
+
# The identifier of the index with one or more thesauri.
|
8842
9381
|
# @return [String]
|
8843
9382
|
#
|
8844
9383
|
# @!attribute [rw] next_token
|
@@ -8959,7 +9498,8 @@ module Aws::Kendra
|
|
8959
9498
|
# @return [String]
|
8960
9499
|
#
|
8961
9500
|
# @!attribute [rw] ssl_certificate_s3_path
|
8962
|
-
#
|
9501
|
+
# The path to the SSL certificate stored in an Amazon S3 bucket. You
|
9502
|
+
# use this to connect to GitHub.
|
8963
9503
|
# @return [Types::S3Path]
|
8964
9504
|
#
|
8965
9505
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/OnPremiseConfiguration AWS API Documentation
|
@@ -9051,8 +9591,7 @@ module Aws::Kendra
|
|
9051
9591
|
# @return [Array<Types::DataSourceToIndexFieldMapping>]
|
9052
9592
|
#
|
9053
9593
|
# @!attribute [rw] disable_local_groups
|
9054
|
-
#
|
9055
|
-
# (`True`) or enabled (`False`).
|
9594
|
+
# `TRUE` to disable local groups information.
|
9056
9595
|
# @return [Boolean]
|
9057
9596
|
#
|
9058
9597
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/OneDriveConfiguration AWS API Documentation
|
@@ -9152,7 +9691,11 @@ module Aws::Kendra
|
|
9152
9691
|
include Aws::Structure
|
9153
9692
|
end
|
9154
9693
|
|
9155
|
-
# Provides user and group information for
|
9694
|
+
# Provides user and group information for [user context filtering][1].
|
9695
|
+
#
|
9696
|
+
#
|
9697
|
+
#
|
9698
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html
|
9156
9699
|
#
|
9157
9700
|
# @note When making an API call, you may pass Principal
|
9158
9701
|
# data as a hash:
|
@@ -9173,7 +9716,7 @@ module Aws::Kendra
|
|
9173
9716
|
# @return [String]
|
9174
9717
|
#
|
9175
9718
|
# @!attribute [rw] access
|
9176
|
-
# Whether to allow or deny access to the principal.
|
9719
|
+
# Whether to allow or deny document access to the principal.
|
9177
9720
|
# @return [String]
|
9178
9721
|
#
|
9179
9722
|
# @!attribute [rw] data_source_id
|
@@ -9846,22 +10389,19 @@ module Aws::Kendra
|
|
9846
10389
|
# @return [String]
|
9847
10390
|
#
|
9848
10391
|
# @!attribute [rw] crawl_file_comments
|
9849
|
-
#
|
9850
|
-
# or more of these options.
|
10392
|
+
# `TRUE` to index file comments.
|
9851
10393
|
# @return [Boolean]
|
9852
10394
|
#
|
9853
10395
|
# @!attribute [rw] crawl_chat_rooms
|
9854
|
-
#
|
9855
|
-
# more of these options.
|
10396
|
+
# `TRUE` to index the contents of chat rooms.
|
9856
10397
|
# @return [Boolean]
|
9857
10398
|
#
|
9858
10399
|
# @!attribute [rw] crawl_attachments
|
9859
|
-
#
|
9860
|
-
# more of these options.
|
10400
|
+
# `TRUE` to index attachments.
|
9861
10401
|
# @return [Boolean]
|
9862
10402
|
#
|
9863
10403
|
# @!attribute [rw] folder_ids
|
9864
|
-
# The
|
10404
|
+
# The identifiers of the Quip folders you want to index.
|
9865
10405
|
# @return [Array<String>]
|
9866
10406
|
#
|
9867
10407
|
# @!attribute [rw] thread_field_mappings
|
@@ -9950,9 +10490,9 @@ module Aws::Kendra
|
|
9950
10490
|
include Aws::Structure
|
9951
10491
|
end
|
9952
10492
|
|
9953
|
-
# Provides information for
|
9954
|
-
#
|
9955
|
-
#
|
10493
|
+
# Provides information for tuning the relevance of a field in a search.
|
10494
|
+
# When a query includes terms that match the field, the results are
|
10495
|
+
# given a boost in the response based on these tuning parameters.
|
9956
10496
|
#
|
9957
10497
|
# @note When making an API call, you may pass Relevance
|
9958
10498
|
# data as a hash:
|
@@ -10945,7 +11485,14 @@ module Aws::Kendra
|
|
10945
11485
|
# @!attribute [rw] secret_arn
|
10946
11486
|
# The Amazon Resource Name (ARN) of the Secrets Manager secret that
|
10947
11487
|
# contains the user name and password required to connect to the
|
10948
|
-
# ServiceNow instance.
|
11488
|
+
# ServiceNow instance. You can also provide OAuth authentication
|
11489
|
+
# credentials of user name, password, client ID, and client secret.
|
11490
|
+
# For more information, see [Authentication for a ServiceNow data
|
11491
|
+
# source][1].
|
11492
|
+
#
|
11493
|
+
#
|
11494
|
+
#
|
11495
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-servicenow.html#servicenow-authentication
|
10949
11496
|
# @return [String]
|
10950
11497
|
#
|
10951
11498
|
# @!attribute [rw] service_now_build_version
|
@@ -10967,10 +11514,9 @@ module Aws::Kendra
|
|
10967
11514
|
# The type of authentication used to connect to the ServiceNow
|
10968
11515
|
# instance. If you choose `HTTP_BASIC`, Amazon Kendra is authenticated
|
10969
11516
|
# using the user name and password provided in the Secrets Manager
|
10970
|
-
# secret in the `SecretArn` field.
|
10971
|
-
# Kendra is authenticated using the
|
10972
|
-
#
|
10973
|
-
# to determine which information Amazon Kendra has access to.
|
11517
|
+
# secret in the `SecretArn` field. If you choose `OAUTH2`, Amazon
|
11518
|
+
# Kendra is authenticated using the credentials of client ID, client
|
11519
|
+
# secret, user name and password.
|
10974
11520
|
#
|
10975
11521
|
# When you use `OAUTH2` authentication, you must generate a token and
|
10976
11522
|
# a client secret using the ServiceNow console. For more information,
|
@@ -11017,8 +11563,7 @@ module Aws::Kendra
|
|
11017
11563
|
# }
|
11018
11564
|
#
|
11019
11565
|
# @!attribute [rw] crawl_attachments
|
11020
|
-
#
|
11021
|
-
# knowledge articles.
|
11566
|
+
# `TRUE` to index attachments to knowledge articles.
|
11022
11567
|
# @return [Boolean]
|
11023
11568
|
#
|
11024
11569
|
# @!attribute [rw] include_attachment_file_patterns
|
@@ -11118,8 +11663,7 @@ module Aws::Kendra
|
|
11118
11663
|
# }
|
11119
11664
|
#
|
11120
11665
|
# @!attribute [rw] crawl_attachments
|
11121
|
-
#
|
11122
|
-
# service catalog items.
|
11666
|
+
# `TRUE` to index attachments to service catalog items.
|
11123
11667
|
# @return [Boolean]
|
11124
11668
|
#
|
11125
11669
|
# @!attribute [rw] include_attachment_file_patterns
|
@@ -11221,36 +11765,37 @@ module Aws::Kendra
|
|
11221
11765
|
# bucket: "S3BucketName", # required
|
11222
11766
|
# key: "S3ObjectKey", # required
|
11223
11767
|
# },
|
11768
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
|
11224
11769
|
# }
|
11225
11770
|
#
|
11226
11771
|
# @!attribute [rw] share_point_version
|
11227
|
-
# The version of Microsoft SharePoint that you
|
11228
|
-
# source.
|
11772
|
+
# The version of Microsoft SharePoint that you use.
|
11229
11773
|
# @return [String]
|
11230
11774
|
#
|
11231
11775
|
# @!attribute [rw] urls
|
11232
|
-
# The
|
11233
|
-
#
|
11776
|
+
# The Microsoft SharePoint site URLs for the documents you want to
|
11777
|
+
# indext.
|
11234
11778
|
# @return [Array<String>]
|
11235
11779
|
#
|
11236
11780
|
# @!attribute [rw] secret_arn
|
11237
|
-
# The Amazon Resource Name (ARN) of
|
11238
|
-
#
|
11239
|
-
# SharePoint Server, you also need to
|
11240
|
-
# part of the credentials. For more
|
11241
|
-
# Microsoft SharePoint Data Source][1].
|
11242
|
-
#
|
11243
|
-
#
|
11781
|
+
# The Amazon Resource Name (ARN) of an Secrets Manager secret that
|
11782
|
+
# contains the user name and password required to connect to the
|
11783
|
+
# SharePoint instance. If you use SharePoint Server, you also need to
|
11784
|
+
# provide the sever domain name as part of the credentials. For more
|
11785
|
+
# information, see [Using a Microsoft SharePoint Data Source][1].
|
11786
|
+
#
|
11787
|
+
# You can also provide OAuth authentication credentials of user name,
|
11788
|
+
# password, client ID, and client secret. For more information, see
|
11789
|
+
# [Authentication for a SharePoint data source][2].
|
11244
11790
|
#
|
11245
11791
|
#
|
11246
11792
|
#
|
11247
11793
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html
|
11248
|
-
# [2]: https://docs.aws.amazon.com/
|
11794
|
+
# [2]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html#sharepoint-authentication
|
11249
11795
|
# @return [String]
|
11250
11796
|
#
|
11251
11797
|
# @!attribute [rw] crawl_attachments
|
11252
|
-
# `TRUE` to
|
11253
|
-
# SharePoint site in the index; otherwise, `FALSE`.
|
11798
|
+
# `TRUE` to index document attachments.
|
11254
11799
|
# @return [Boolean]
|
11255
11800
|
#
|
11256
11801
|
# @!attribute [rw] use_change_log
|
@@ -11268,7 +11813,7 @@ module Aws::Kendra
|
|
11268
11813
|
# exclusion pattern, the exclusion pattern takes precedence and the
|
11269
11814
|
# document isn't included in the index.
|
11270
11815
|
#
|
11271
|
-
# The regex
|
11816
|
+
# The regex applies to the display URL of the SharePoint document.
|
11272
11817
|
# @return [Array<String>]
|
11273
11818
|
#
|
11274
11819
|
# @!attribute [rw] exclusion_patterns
|
@@ -11279,11 +11824,17 @@ module Aws::Kendra
|
|
11279
11824
|
# exclusion pattern, the exclusion pattern takes precedence and the
|
11280
11825
|
# document isn't included in the index.
|
11281
11826
|
#
|
11282
|
-
# The regex
|
11827
|
+
# The regex applies to the display URL of the SharePoint document.
|
11283
11828
|
# @return [Array<String>]
|
11284
11829
|
#
|
11285
11830
|
# @!attribute [rw] vpc_configuration
|
11286
|
-
#
|
11831
|
+
# Configuration information for an Amazon Virtual Private Cloud to
|
11832
|
+
# connect to your Microsoft SharePoint. For more information, see
|
11833
|
+
# [Configuring a VPC][1].
|
11834
|
+
#
|
11835
|
+
#
|
11836
|
+
#
|
11837
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
|
11287
11838
|
# @return [Types::DataSourceVpcConfiguration]
|
11288
11839
|
#
|
11289
11840
|
# @!attribute [rw] field_mappings
|
@@ -11305,14 +11856,21 @@ module Aws::Kendra
|
|
11305
11856
|
# @return [String]
|
11306
11857
|
#
|
11307
11858
|
# @!attribute [rw] disable_local_groups
|
11308
|
-
#
|
11309
|
-
# (`True`) or enabled (`False`).
|
11859
|
+
# `TRUE` to disable local groups information.
|
11310
11860
|
# @return [Boolean]
|
11311
11861
|
#
|
11312
11862
|
# @!attribute [rw] ssl_certificate_s3_path
|
11313
|
-
#
|
11863
|
+
# The path to the SSL certificate stored in an Amazon S3 bucket. You
|
11864
|
+
# use this to connect to SharePoint.
|
11314
11865
|
# @return [Types::S3Path]
|
11315
11866
|
#
|
11867
|
+
# @!attribute [rw] authentication_type
|
11868
|
+
# Whether you want to connect to SharePoint using basic authentication
|
11869
|
+
# of user name and password, or OAuth authentication of user name,
|
11870
|
+
# password, client ID, and client secret. You can use OAuth
|
11871
|
+
# authentication for SharePoint Online.
|
11872
|
+
# @return [String]
|
11873
|
+
#
|
11316
11874
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SharePointConfiguration AWS API Documentation
|
11317
11875
|
#
|
11318
11876
|
class SharePointConfiguration < Struct.new(
|
@@ -11327,7 +11885,8 @@ module Aws::Kendra
|
|
11327
11885
|
:field_mappings,
|
11328
11886
|
:document_title_field_name,
|
11329
11887
|
:disable_local_groups,
|
11330
|
-
:ssl_certificate_s3_path
|
11888
|
+
:ssl_certificate_s3_path,
|
11889
|
+
:authentication_type)
|
11331
11890
|
SENSITIVE = []
|
11332
11891
|
include Aws::Structure
|
11333
11892
|
end
|
@@ -12122,6 +12681,86 @@ module Aws::Kendra
|
|
12122
12681
|
#
|
12123
12682
|
class UntagResourceResponse < Aws::EmptyStructure; end
|
12124
12683
|
|
12684
|
+
# @note When making an API call, you may pass UpdateAccessControlConfigurationRequest
|
12685
|
+
# data as a hash:
|
12686
|
+
#
|
12687
|
+
# {
|
12688
|
+
# index_id: "IndexId", # required
|
12689
|
+
# id: "AccessControlConfigurationId", # required
|
12690
|
+
# name: "AccessControlConfigurationName",
|
12691
|
+
# description: "Description",
|
12692
|
+
# access_control_list: [
|
12693
|
+
# {
|
12694
|
+
# name: "PrincipalName", # required
|
12695
|
+
# type: "USER", # required, accepts USER, GROUP
|
12696
|
+
# access: "ALLOW", # required, accepts ALLOW, DENY
|
12697
|
+
# data_source_id: "DataSourceId",
|
12698
|
+
# },
|
12699
|
+
# ],
|
12700
|
+
# hierarchical_access_control_list: [
|
12701
|
+
# {
|
12702
|
+
# principal_list: [ # required
|
12703
|
+
# {
|
12704
|
+
# name: "PrincipalName", # required
|
12705
|
+
# type: "USER", # required, accepts USER, GROUP
|
12706
|
+
# access: "ALLOW", # required, accepts ALLOW, DENY
|
12707
|
+
# data_source_id: "DataSourceId",
|
12708
|
+
# },
|
12709
|
+
# ],
|
12710
|
+
# },
|
12711
|
+
# ],
|
12712
|
+
# }
|
12713
|
+
#
|
12714
|
+
# @!attribute [rw] index_id
|
12715
|
+
# The identifier of the index for an access control configuration.
|
12716
|
+
# @return [String]
|
12717
|
+
#
|
12718
|
+
# @!attribute [rw] id
|
12719
|
+
# The identifier of the access control configuration you want to
|
12720
|
+
# update.
|
12721
|
+
# @return [String]
|
12722
|
+
#
|
12723
|
+
# @!attribute [rw] name
|
12724
|
+
# A new name for the access control configuration.
|
12725
|
+
# @return [String]
|
12726
|
+
#
|
12727
|
+
# @!attribute [rw] description
|
12728
|
+
# A new description for the access control configuration.
|
12729
|
+
# @return [String]
|
12730
|
+
#
|
12731
|
+
# @!attribute [rw] access_control_list
|
12732
|
+
# Information you want to update on principals (users and/or groups)
|
12733
|
+
# and which documents they should have access to. This is useful for
|
12734
|
+
# user context filtering, where search results are filtered based on
|
12735
|
+
# the user or their group access to documents.
|
12736
|
+
# @return [Array<Types::Principal>]
|
12737
|
+
#
|
12738
|
+
# @!attribute [rw] hierarchical_access_control_list
|
12739
|
+
# The updated list of [principal][1] lists that define the hierarchy
|
12740
|
+
# for which documents users should have access to.
|
12741
|
+
#
|
12742
|
+
#
|
12743
|
+
#
|
12744
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html
|
12745
|
+
# @return [Array<Types::HierarchicalPrincipal>]
|
12746
|
+
#
|
12747
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateAccessControlConfigurationRequest AWS API Documentation
|
12748
|
+
#
|
12749
|
+
class UpdateAccessControlConfigurationRequest < Struct.new(
|
12750
|
+
:index_id,
|
12751
|
+
:id,
|
12752
|
+
:name,
|
12753
|
+
:description,
|
12754
|
+
:access_control_list,
|
12755
|
+
:hierarchical_access_control_list)
|
12756
|
+
SENSITIVE = []
|
12757
|
+
include Aws::Structure
|
12758
|
+
end
|
12759
|
+
|
12760
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateAccessControlConfigurationResponse AWS API Documentation
|
12761
|
+
#
|
12762
|
+
class UpdateAccessControlConfigurationResponse < Aws::EmptyStructure; end
|
12763
|
+
|
12125
12764
|
# @note When making an API call, you may pass UpdateDataSourceRequest
|
12126
12765
|
# data as a hash:
|
12127
12766
|
#
|
@@ -12167,6 +12806,7 @@ module Aws::Kendra
|
|
12167
12806
|
# bucket: "S3BucketName", # required
|
12168
12807
|
# key: "S3ObjectKey", # required
|
12169
12808
|
# },
|
12809
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
|
12170
12810
|
# },
|
12171
12811
|
# database_configuration: {
|
12172
12812
|
# database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
|
@@ -12703,6 +13343,45 @@ module Aws::Kendra
|
|
12703
13343
|
# },
|
12704
13344
|
# ],
|
12705
13345
|
# },
|
13346
|
+
# alfresco_configuration: {
|
13347
|
+
# site_url: "SiteUrl", # required
|
13348
|
+
# site_id: "SiteId", # required
|
13349
|
+
# secret_arn: "SecretArn", # required
|
13350
|
+
# ssl_certificate_s3_path: { # required
|
13351
|
+
# bucket: "S3BucketName", # required
|
13352
|
+
# key: "S3ObjectKey", # required
|
13353
|
+
# },
|
13354
|
+
# crawl_system_folders: false,
|
13355
|
+
# crawl_comments: false,
|
13356
|
+
# entity_filter: ["wiki"], # accepts wiki, blog, documentLibrary
|
13357
|
+
# document_library_field_mappings: [
|
13358
|
+
# {
|
13359
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
13360
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
13361
|
+
# index_field_name: "IndexFieldName", # required
|
13362
|
+
# },
|
13363
|
+
# ],
|
13364
|
+
# blog_field_mappings: [
|
13365
|
+
# {
|
13366
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
13367
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
13368
|
+
# index_field_name: "IndexFieldName", # required
|
13369
|
+
# },
|
13370
|
+
# ],
|
13371
|
+
# wiki_field_mappings: [
|
13372
|
+
# {
|
13373
|
+
# data_source_field_name: "DataSourceFieldName", # required
|
13374
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
13375
|
+
# index_field_name: "IndexFieldName", # required
|
13376
|
+
# },
|
13377
|
+
# ],
|
13378
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
13379
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
13380
|
+
# vpc_configuration: {
|
13381
|
+
# subnet_ids: ["SubnetId"], # required
|
13382
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
13383
|
+
# },
|
13384
|
+
# },
|
12706
13385
|
# },
|
12707
13386
|
# description: "Description",
|
12708
13387
|
# schedule: "ScanSchedule",
|
@@ -12767,43 +13446,47 @@ module Aws::Kendra
|
|
12767
13446
|
# }
|
12768
13447
|
#
|
12769
13448
|
# @!attribute [rw] id
|
12770
|
-
# The
|
13449
|
+
# The identifier of the data source you want to update.
|
12771
13450
|
# @return [String]
|
12772
13451
|
#
|
12773
13452
|
# @!attribute [rw] name
|
12774
|
-
#
|
12775
|
-
#
|
12776
|
-
# source and re-create it.
|
13453
|
+
# A new name for the data source connector. You must first delete the
|
13454
|
+
# data source and re-create it to change the name of the data source.
|
12777
13455
|
# @return [String]
|
12778
13456
|
#
|
12779
13457
|
# @!attribute [rw] index_id
|
12780
|
-
# The identifier of the index
|
13458
|
+
# The identifier of the index used with the data source connector.
|
12781
13459
|
# @return [String]
|
12782
13460
|
#
|
12783
13461
|
# @!attribute [rw] configuration
|
12784
|
-
# Configuration information
|
12785
|
-
#
|
13462
|
+
# Configuration information you want to update for the data source
|
13463
|
+
# connector.
|
12786
13464
|
# @return [Types::DataSourceConfiguration]
|
12787
13465
|
#
|
12788
13466
|
# @!attribute [rw] description
|
12789
|
-
#
|
13467
|
+
# A new description for the data source connector.
|
12790
13468
|
# @return [String]
|
12791
13469
|
#
|
12792
13470
|
# @!attribute [rw] schedule
|
12793
|
-
# The
|
13471
|
+
# The sync schedule you want to update for the data source connector.
|
12794
13472
|
# @return [String]
|
12795
13473
|
#
|
12796
13474
|
# @!attribute [rw] role_arn
|
12797
|
-
# The Amazon Resource Name (ARN) of
|
12798
|
-
# source
|
13475
|
+
# The Amazon Resource Name (ARN) of a role with permission to access
|
13476
|
+
# the data source. For more information, see [IAM Roles for Amazon
|
13477
|
+
# Kendra][1].
|
13478
|
+
#
|
13479
|
+
#
|
13480
|
+
#
|
13481
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
|
12799
13482
|
# @return [String]
|
12800
13483
|
#
|
12801
13484
|
# @!attribute [rw] language_code
|
12802
|
-
# The code for a language
|
12803
|
-
#
|
12804
|
-
#
|
12805
|
-
#
|
12806
|
-
# English][1].
|
13485
|
+
# The code for a language you want to update for the data source
|
13486
|
+
# connector. This allows you to support a language for all documents
|
13487
|
+
# when updating the data source. English is supported by default. For
|
13488
|
+
# more information on supported languages, including their codes, see
|
13489
|
+
# [Adding documents in languages other than English][1].
|
12807
13490
|
#
|
12808
13491
|
#
|
12809
13492
|
#
|
@@ -12811,8 +13494,8 @@ module Aws::Kendra
|
|
12811
13494
|
# @return [String]
|
12812
13495
|
#
|
12813
13496
|
# @!attribute [rw] custom_document_enrichment_configuration
|
12814
|
-
# Configuration information for altering document
|
12815
|
-
# during the document ingestion process
|
13497
|
+
# Configuration information you want to update for altering document
|
13498
|
+
# metadata and content during the document ingestion process.
|
12816
13499
|
#
|
12817
13500
|
# For more information on how to create, modify and delete document
|
12818
13501
|
# metadata, or make other content alterations when you ingest
|
@@ -12866,12 +13549,11 @@ module Aws::Kendra
|
|
12866
13549
|
# @return [String]
|
12867
13550
|
#
|
12868
13551
|
# @!attribute [rw] name
|
12869
|
-
#
|
13552
|
+
# A new name for your Amazon Kendra experience.
|
12870
13553
|
# @return [String]
|
12871
13554
|
#
|
12872
13555
|
# @!attribute [rw] index_id
|
12873
|
-
# The identifier of the index for your Amazon Kendra experience
|
12874
|
-
# want to update.
|
13556
|
+
# The identifier of the index for your Amazon Kendra experience.
|
12875
13557
|
# @return [String]
|
12876
13558
|
#
|
12877
13559
|
# @!attribute [rw] role_arn
|
@@ -12886,11 +13568,12 @@ module Aws::Kendra
|
|
12886
13568
|
# @return [String]
|
12887
13569
|
#
|
12888
13570
|
# @!attribute [rw] configuration
|
12889
|
-
# Configuration information for your Amazon Kendra
|
13571
|
+
# Configuration information you want to update for your Amazon Kendra
|
13572
|
+
# experience.
|
12890
13573
|
# @return [Types::ExperienceConfiguration]
|
12891
13574
|
#
|
12892
13575
|
# @!attribute [rw] description
|
12893
|
-
#
|
13576
|
+
# A new description for your Amazon Kendra experience.
|
12894
13577
|
# @return [String]
|
12895
13578
|
#
|
12896
13579
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateExperienceRequest AWS API Documentation
|
@@ -12963,16 +13646,16 @@ module Aws::Kendra
|
|
12963
13646
|
# }
|
12964
13647
|
#
|
12965
13648
|
# @!attribute [rw] id
|
12966
|
-
# The identifier of the index to update.
|
13649
|
+
# The identifier of the index you want to update.
|
12967
13650
|
# @return [String]
|
12968
13651
|
#
|
12969
13652
|
# @!attribute [rw] name
|
12970
|
-
# The name of the index to update.
|
13653
|
+
# The name of the index you want to update.
|
12971
13654
|
# @return [String]
|
12972
13655
|
#
|
12973
13656
|
# @!attribute [rw] role_arn
|
12974
|
-
#
|
12975
|
-
# Amazon CloudWatch logs.
|
13657
|
+
# An Identity and Access Management (IAM) role that gives Amazon
|
13658
|
+
# Kendra permission to access Amazon CloudWatch logs and metrics.
|
12976
13659
|
# @return [String]
|
12977
13660
|
#
|
12978
13661
|
# @!attribute [rw] description
|
@@ -12980,7 +13663,10 @@ module Aws::Kendra
|
|
12980
13663
|
# @return [String]
|
12981
13664
|
#
|
12982
13665
|
# @!attribute [rw] document_metadata_configuration_updates
|
12983
|
-
# The document metadata you want to update
|
13666
|
+
# The document metadata configuration you want to update for the
|
13667
|
+
# index. Document metadata are fields or attributes associated with
|
13668
|
+
# your documents. For example, the company department name associated
|
13669
|
+
# with each document.
|
12984
13670
|
# @return [Array<Types::DocumentMetadataConfiguration>]
|
12985
13671
|
#
|
12986
13672
|
# @!attribute [rw] capacity_units
|
@@ -13043,19 +13729,19 @@ module Aws::Kendra
|
|
13043
13729
|
# }
|
13044
13730
|
#
|
13045
13731
|
# @!attribute [rw] index_id
|
13046
|
-
# The identifier of the index for
|
13732
|
+
# The identifier of the index for the block list.
|
13047
13733
|
# @return [String]
|
13048
13734
|
#
|
13049
13735
|
# @!attribute [rw] id
|
13050
|
-
# The
|
13736
|
+
# The identifier of the block list you want to update.
|
13051
13737
|
# @return [String]
|
13052
13738
|
#
|
13053
13739
|
# @!attribute [rw] name
|
13054
|
-
#
|
13740
|
+
# A new name for the block list.
|
13055
13741
|
# @return [String]
|
13056
13742
|
#
|
13057
13743
|
# @!attribute [rw] description
|
13058
|
-
#
|
13744
|
+
# A new description for the block list.
|
13059
13745
|
# @return [String]
|
13060
13746
|
#
|
13061
13747
|
# @!attribute [rw] source_s3_path
|
@@ -13103,8 +13789,8 @@ module Aws::Kendra
|
|
13103
13789
|
# }
|
13104
13790
|
#
|
13105
13791
|
# @!attribute [rw] index_id
|
13106
|
-
# The identifier of the index you want to
|
13107
|
-
#
|
13792
|
+
# The identifier of the index with query suggestions you want to
|
13793
|
+
# update.
|
13108
13794
|
# @return [String]
|
13109
13795
|
#
|
13110
13796
|
# @!attribute [rw] mode
|
@@ -13195,23 +13881,24 @@ module Aws::Kendra
|
|
13195
13881
|
# }
|
13196
13882
|
#
|
13197
13883
|
# @!attribute [rw] id
|
13198
|
-
# The identifier of the thesaurus to update.
|
13884
|
+
# The identifier of the thesaurus you want to update.
|
13199
13885
|
# @return [String]
|
13200
13886
|
#
|
13201
13887
|
# @!attribute [rw] name
|
13202
|
-
#
|
13888
|
+
# A new name for the thesaurus.
|
13203
13889
|
# @return [String]
|
13204
13890
|
#
|
13205
13891
|
# @!attribute [rw] index_id
|
13206
|
-
# The identifier of the index
|
13892
|
+
# The identifier of the index for the thesaurus.
|
13207
13893
|
# @return [String]
|
13208
13894
|
#
|
13209
13895
|
# @!attribute [rw] description
|
13210
|
-
#
|
13896
|
+
# A new description for the thesaurus.
|
13211
13897
|
# @return [String]
|
13212
13898
|
#
|
13213
13899
|
# @!attribute [rw] role_arn
|
13214
|
-
#
|
13900
|
+
# An IAM role that gives Amazon Kendra permissions to access thesaurus
|
13901
|
+
# file specified in `SourceS3Path`.
|
13215
13902
|
# @return [String]
|
13216
13903
|
#
|
13217
13904
|
# @!attribute [rw] source_s3_path
|
@@ -13290,8 +13977,13 @@ module Aws::Kendra
|
|
13290
13977
|
# Provides information about the user context for an Amazon Kendra
|
13291
13978
|
# index.
|
13292
13979
|
#
|
13293
|
-
#
|
13294
|
-
#
|
13980
|
+
# User context filtering is a kind of personalized search with the
|
13981
|
+
# benefit of controlling access to documents. For example, not all teams
|
13982
|
+
# that search the company portal for information should access
|
13983
|
+
# top-secret company documents, nor are these documents relevant to all
|
13984
|
+
# users. Only specific users or groups of teams given access to
|
13985
|
+
# top-secret documents should see these documents in their search
|
13986
|
+
# results.
|
13295
13987
|
#
|
13296
13988
|
# You provide one of the following:
|
13297
13989
|
#
|
@@ -13350,11 +14042,11 @@ module Aws::Kendra
|
|
13350
14042
|
|
13351
14043
|
# Provides the configuration information to fetch access levels of
|
13352
14044
|
# groups and users from an Amazon Web Services Single Sign On identity
|
13353
|
-
# source. This is useful for
|
13354
|
-
#
|
13355
|
-
#
|
13356
|
-
# their groups
|
13357
|
-
#
|
14045
|
+
# source. This is useful for user context filtering, where search
|
14046
|
+
# results are filtered based on the user or their group access to
|
14047
|
+
# documents. You can also use the [PutPrincipalMapping][1] API to map
|
14048
|
+
# users to their groups so that you only need to provide the user ID
|
14049
|
+
# when you issue the query.
|
13358
14050
|
#
|
13359
14051
|
# To set up an Amazon Web Services SSO identity source in the console to
|
13360
14052
|
# use with Amazon Kendra, see [Getting started with an Amazon Web
|
@@ -13639,13 +14331,12 @@ module Aws::Kendra
|
|
13639
14331
|
# authentication.
|
13640
14332
|
#
|
13641
14333
|
# You can connect to websites using basic authentication of user name
|
13642
|
-
# and password.
|
14334
|
+
# and password. You use a secret in [Secrets Manager][1] to store your
|
14335
|
+
# authentication credentials.
|
13643
14336
|
#
|
13644
14337
|
# You must provide the website host name and port number. For example,
|
13645
14338
|
# the host name of https://a.example.com/page1.html is
|
13646
14339
|
# "a.example.com" and the port is 443, the standard port for HTTPS.
|
13647
|
-
# You use a secret in [Secrets Manager][1] to store your
|
13648
|
-
# authentication credentials.
|
13649
14340
|
#
|
13650
14341
|
#
|
13651
14342
|
#
|