aws-sdk-kendra 1.16.0 → 1.17.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-kendra.rb +1 -1
- data/lib/aws-sdk-kendra/client.rb +142 -4
- data/lib/aws-sdk-kendra/client_api.rb +80 -0
- data/lib/aws-sdk-kendra/types.rb +649 -2
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: a8db0ca59a864122385a59026dc8a3fb2fc9d64c32415f3f697d4c3e52619bab
|
4
|
+
data.tar.gz: a389ce89ee5618a8a05b4ad262cb636f010f31999133a3e1b416d21b87c33dfe
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 4a4d7de8b23b6c5ec5a99a62d7824e5c778bdde8c30211cab013e6ece3922244aba7b7ddcb72dad34a4f02fdff7eb2259767adc20e6168dba87d605b391501a4
|
7
|
+
data.tar.gz: 0f223d17c0b08d6d1911029a13ea3f5e63ed8d01347fb5c324e7c8971e2458debf9c4e35734b2b0a358f9cf8878ceabe971b5687aeb0e1e49f676526f54a52a9
|
data/lib/aws-sdk-kendra.rb
CHANGED
@@ -566,7 +566,7 @@ module Aws::Kendra
|
|
566
566
|
# resp = client.create_data_source({
|
567
567
|
# name: "DataSourceName", # required
|
568
568
|
# index_id: "IndexId", # required
|
569
|
-
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM
|
569
|
+
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE
|
570
570
|
# configuration: {
|
571
571
|
# s3_configuration: {
|
572
572
|
# bucket_name: "S3BucketName", # required
|
@@ -758,6 +758,58 @@ module Aws::Kendra
|
|
758
758
|
# ],
|
759
759
|
# },
|
760
760
|
# },
|
761
|
+
# confluence_configuration: {
|
762
|
+
# server_url: "Url", # required
|
763
|
+
# secret_arn: "SecretArn", # required
|
764
|
+
# version: "SERVER", # required, accepts SERVER
|
765
|
+
# space_configuration: {
|
766
|
+
# crawl_personal_spaces: false,
|
767
|
+
# crawl_archived_spaces: false,
|
768
|
+
# include_spaces: ["ConfluenceSpaceIdentifier"],
|
769
|
+
# exclude_spaces: ["ConfluenceSpaceIdentifier"],
|
770
|
+
# space_field_mappings: [
|
771
|
+
# {
|
772
|
+
# data_source_field_name: "DISPLAY_URL", # accepts DISPLAY_URL, ITEM_TYPE, SPACE_KEY, URL
|
773
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
774
|
+
# index_field_name: "IndexFieldName",
|
775
|
+
# },
|
776
|
+
# ],
|
777
|
+
# },
|
778
|
+
# page_configuration: {
|
779
|
+
# page_field_mappings: [
|
780
|
+
# {
|
781
|
+
# data_source_field_name: "AUTHOR", # accepts AUTHOR, CONTENT_STATUS, CREATED_DATE, DISPLAY_URL, ITEM_TYPE, LABELS, MODIFIED_DATE, PARENT_ID, SPACE_KEY, SPACE_NAME, URL, VERSION
|
782
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
783
|
+
# index_field_name: "IndexFieldName",
|
784
|
+
# },
|
785
|
+
# ],
|
786
|
+
# },
|
787
|
+
# blog_configuration: {
|
788
|
+
# blog_field_mappings: [
|
789
|
+
# {
|
790
|
+
# data_source_field_name: "AUTHOR", # accepts AUTHOR, DISPLAY_URL, ITEM_TYPE, LABELS, PUBLISH_DATE, SPACE_KEY, SPACE_NAME, URL, VERSION
|
791
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
792
|
+
# index_field_name: "IndexFieldName",
|
793
|
+
# },
|
794
|
+
# ],
|
795
|
+
# },
|
796
|
+
# attachment_configuration: {
|
797
|
+
# crawl_attachments: false,
|
798
|
+
# attachment_field_mappings: [
|
799
|
+
# {
|
800
|
+
# data_source_field_name: "AUTHOR", # accepts AUTHOR, CONTENT_TYPE, CREATED_DATE, DISPLAY_URL, FILE_SIZE, ITEM_TYPE, PARENT_ID, SPACE_KEY, SPACE_NAME, URL, VERSION
|
801
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
802
|
+
# index_field_name: "IndexFieldName",
|
803
|
+
# },
|
804
|
+
# ],
|
805
|
+
# },
|
806
|
+
# vpc_configuration: {
|
807
|
+
# subnet_ids: ["SubnetId"], # required
|
808
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
809
|
+
# },
|
810
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
811
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
812
|
+
# },
|
761
813
|
# },
|
762
814
|
# description: "Description",
|
763
815
|
# schedule: "ScanSchedule",
|
@@ -1077,7 +1129,7 @@ module Aws::Kendra
|
|
1077
1129
|
# resp.id #=> String
|
1078
1130
|
# resp.index_id #=> String
|
1079
1131
|
# resp.name #=> String
|
1080
|
-
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM"
|
1132
|
+
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE"
|
1081
1133
|
# resp.configuration.s3_configuration.bucket_name #=> String
|
1082
1134
|
# resp.configuration.s3_configuration.inclusion_prefixes #=> Array
|
1083
1135
|
# resp.configuration.s3_configuration.inclusion_prefixes[0] #=> String
|
@@ -1210,6 +1262,40 @@ module Aws::Kendra
|
|
1210
1262
|
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].data_source_field_name #=> String
|
1211
1263
|
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].date_field_format #=> String
|
1212
1264
|
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].index_field_name #=> String
|
1265
|
+
# resp.configuration.confluence_configuration.server_url #=> String
|
1266
|
+
# resp.configuration.confluence_configuration.secret_arn #=> String
|
1267
|
+
# resp.configuration.confluence_configuration.version #=> String, one of "SERVER"
|
1268
|
+
# resp.configuration.confluence_configuration.space_configuration.crawl_personal_spaces #=> Boolean
|
1269
|
+
# resp.configuration.confluence_configuration.space_configuration.crawl_archived_spaces #=> Boolean
|
1270
|
+
# resp.configuration.confluence_configuration.space_configuration.include_spaces #=> Array
|
1271
|
+
# resp.configuration.confluence_configuration.space_configuration.include_spaces[0] #=> String
|
1272
|
+
# resp.configuration.confluence_configuration.space_configuration.exclude_spaces #=> Array
|
1273
|
+
# resp.configuration.confluence_configuration.space_configuration.exclude_spaces[0] #=> String
|
1274
|
+
# resp.configuration.confluence_configuration.space_configuration.space_field_mappings #=> Array
|
1275
|
+
# resp.configuration.confluence_configuration.space_configuration.space_field_mappings[0].data_source_field_name #=> String, one of "DISPLAY_URL", "ITEM_TYPE", "SPACE_KEY", "URL"
|
1276
|
+
# resp.configuration.confluence_configuration.space_configuration.space_field_mappings[0].date_field_format #=> String
|
1277
|
+
# resp.configuration.confluence_configuration.space_configuration.space_field_mappings[0].index_field_name #=> String
|
1278
|
+
# resp.configuration.confluence_configuration.page_configuration.page_field_mappings #=> Array
|
1279
|
+
# resp.configuration.confluence_configuration.page_configuration.page_field_mappings[0].data_source_field_name #=> String, one of "AUTHOR", "CONTENT_STATUS", "CREATED_DATE", "DISPLAY_URL", "ITEM_TYPE", "LABELS", "MODIFIED_DATE", "PARENT_ID", "SPACE_KEY", "SPACE_NAME", "URL", "VERSION"
|
1280
|
+
# resp.configuration.confluence_configuration.page_configuration.page_field_mappings[0].date_field_format #=> String
|
1281
|
+
# resp.configuration.confluence_configuration.page_configuration.page_field_mappings[0].index_field_name #=> String
|
1282
|
+
# resp.configuration.confluence_configuration.blog_configuration.blog_field_mappings #=> Array
|
1283
|
+
# resp.configuration.confluence_configuration.blog_configuration.blog_field_mappings[0].data_source_field_name #=> String, one of "AUTHOR", "DISPLAY_URL", "ITEM_TYPE", "LABELS", "PUBLISH_DATE", "SPACE_KEY", "SPACE_NAME", "URL", "VERSION"
|
1284
|
+
# resp.configuration.confluence_configuration.blog_configuration.blog_field_mappings[0].date_field_format #=> String
|
1285
|
+
# resp.configuration.confluence_configuration.blog_configuration.blog_field_mappings[0].index_field_name #=> String
|
1286
|
+
# resp.configuration.confluence_configuration.attachment_configuration.crawl_attachments #=> Boolean
|
1287
|
+
# resp.configuration.confluence_configuration.attachment_configuration.attachment_field_mappings #=> Array
|
1288
|
+
# resp.configuration.confluence_configuration.attachment_configuration.attachment_field_mappings[0].data_source_field_name #=> String, one of "AUTHOR", "CONTENT_TYPE", "CREATED_DATE", "DISPLAY_URL", "FILE_SIZE", "ITEM_TYPE", "PARENT_ID", "SPACE_KEY", "SPACE_NAME", "URL", "VERSION"
|
1289
|
+
# resp.configuration.confluence_configuration.attachment_configuration.attachment_field_mappings[0].date_field_format #=> String
|
1290
|
+
# resp.configuration.confluence_configuration.attachment_configuration.attachment_field_mappings[0].index_field_name #=> String
|
1291
|
+
# resp.configuration.confluence_configuration.vpc_configuration.subnet_ids #=> Array
|
1292
|
+
# resp.configuration.confluence_configuration.vpc_configuration.subnet_ids[0] #=> String
|
1293
|
+
# resp.configuration.confluence_configuration.vpc_configuration.security_group_ids #=> Array
|
1294
|
+
# resp.configuration.confluence_configuration.vpc_configuration.security_group_ids[0] #=> String
|
1295
|
+
# resp.configuration.confluence_configuration.inclusion_patterns #=> Array
|
1296
|
+
# resp.configuration.confluence_configuration.inclusion_patterns[0] #=> String
|
1297
|
+
# resp.configuration.confluence_configuration.exclusion_patterns #=> Array
|
1298
|
+
# resp.configuration.confluence_configuration.exclusion_patterns[0] #=> String
|
1213
1299
|
# resp.created_at #=> Time
|
1214
1300
|
# resp.updated_at #=> Time
|
1215
1301
|
# resp.description #=> String
|
@@ -1453,7 +1539,7 @@ module Aws::Kendra
|
|
1453
1539
|
# resp.summary_items #=> Array
|
1454
1540
|
# resp.summary_items[0].name #=> String
|
1455
1541
|
# resp.summary_items[0].id #=> String
|
1456
|
-
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM"
|
1542
|
+
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE"
|
1457
1543
|
# resp.summary_items[0].created_at #=> Time
|
1458
1544
|
# resp.summary_items[0].updated_at #=> Time
|
1459
1545
|
# resp.summary_items[0].status #=> String, one of "CREATING", "DELETING", "FAILED", "UPDATING", "ACTIVE"
|
@@ -2223,6 +2309,58 @@ module Aws::Kendra
|
|
2223
2309
|
# ],
|
2224
2310
|
# },
|
2225
2311
|
# },
|
2312
|
+
# confluence_configuration: {
|
2313
|
+
# server_url: "Url", # required
|
2314
|
+
# secret_arn: "SecretArn", # required
|
2315
|
+
# version: "SERVER", # required, accepts SERVER
|
2316
|
+
# space_configuration: {
|
2317
|
+
# crawl_personal_spaces: false,
|
2318
|
+
# crawl_archived_spaces: false,
|
2319
|
+
# include_spaces: ["ConfluenceSpaceIdentifier"],
|
2320
|
+
# exclude_spaces: ["ConfluenceSpaceIdentifier"],
|
2321
|
+
# space_field_mappings: [
|
2322
|
+
# {
|
2323
|
+
# data_source_field_name: "DISPLAY_URL", # accepts DISPLAY_URL, ITEM_TYPE, SPACE_KEY, URL
|
2324
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2325
|
+
# index_field_name: "IndexFieldName",
|
2326
|
+
# },
|
2327
|
+
# ],
|
2328
|
+
# },
|
2329
|
+
# page_configuration: {
|
2330
|
+
# page_field_mappings: [
|
2331
|
+
# {
|
2332
|
+
# data_source_field_name: "AUTHOR", # accepts AUTHOR, CONTENT_STATUS, CREATED_DATE, DISPLAY_URL, ITEM_TYPE, LABELS, MODIFIED_DATE, PARENT_ID, SPACE_KEY, SPACE_NAME, URL, VERSION
|
2333
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2334
|
+
# index_field_name: "IndexFieldName",
|
2335
|
+
# },
|
2336
|
+
# ],
|
2337
|
+
# },
|
2338
|
+
# blog_configuration: {
|
2339
|
+
# blog_field_mappings: [
|
2340
|
+
# {
|
2341
|
+
# data_source_field_name: "AUTHOR", # accepts AUTHOR, DISPLAY_URL, ITEM_TYPE, LABELS, PUBLISH_DATE, SPACE_KEY, SPACE_NAME, URL, VERSION
|
2342
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2343
|
+
# index_field_name: "IndexFieldName",
|
2344
|
+
# },
|
2345
|
+
# ],
|
2346
|
+
# },
|
2347
|
+
# attachment_configuration: {
|
2348
|
+
# crawl_attachments: false,
|
2349
|
+
# attachment_field_mappings: [
|
2350
|
+
# {
|
2351
|
+
# data_source_field_name: "AUTHOR", # accepts AUTHOR, CONTENT_TYPE, CREATED_DATE, DISPLAY_URL, FILE_SIZE, ITEM_TYPE, PARENT_ID, SPACE_KEY, SPACE_NAME, URL, VERSION
|
2352
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2353
|
+
# index_field_name: "IndexFieldName",
|
2354
|
+
# },
|
2355
|
+
# ],
|
2356
|
+
# },
|
2357
|
+
# vpc_configuration: {
|
2358
|
+
# subnet_ids: ["SubnetId"], # required
|
2359
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
2360
|
+
# },
|
2361
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2362
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2363
|
+
# },
|
2226
2364
|
# },
|
2227
2365
|
# description: "Description",
|
2228
2366
|
# schedule: "ScanSchedule",
|
@@ -2322,7 +2460,7 @@ module Aws::Kendra
|
|
2322
2460
|
params: params,
|
2323
2461
|
config: config)
|
2324
2462
|
context[:gem_name] = 'aws-sdk-kendra'
|
2325
|
-
context[:gem_version] = '1.
|
2463
|
+
context[:gem_version] = '1.17.0'
|
2326
2464
|
Seahorse::Client::Request.new(handlers, context)
|
2327
2465
|
end
|
2328
2466
|
|
@@ -41,6 +41,26 @@ module Aws::Kendra
|
|
41
41
|
ColumnConfiguration = Shapes::StructureShape.new(name: 'ColumnConfiguration')
|
42
42
|
ColumnName = Shapes::StringShape.new(name: 'ColumnName')
|
43
43
|
ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
|
44
|
+
ConfluenceAttachmentConfiguration = Shapes::StructureShape.new(name: 'ConfluenceAttachmentConfiguration')
|
45
|
+
ConfluenceAttachmentFieldMappingsList = Shapes::ListShape.new(name: 'ConfluenceAttachmentFieldMappingsList')
|
46
|
+
ConfluenceAttachmentFieldName = Shapes::StringShape.new(name: 'ConfluenceAttachmentFieldName')
|
47
|
+
ConfluenceAttachmentToIndexFieldMapping = Shapes::StructureShape.new(name: 'ConfluenceAttachmentToIndexFieldMapping')
|
48
|
+
ConfluenceBlogConfiguration = Shapes::StructureShape.new(name: 'ConfluenceBlogConfiguration')
|
49
|
+
ConfluenceBlogFieldMappingsList = Shapes::ListShape.new(name: 'ConfluenceBlogFieldMappingsList')
|
50
|
+
ConfluenceBlogFieldName = Shapes::StringShape.new(name: 'ConfluenceBlogFieldName')
|
51
|
+
ConfluenceBlogToIndexFieldMapping = Shapes::StructureShape.new(name: 'ConfluenceBlogToIndexFieldMapping')
|
52
|
+
ConfluenceConfiguration = Shapes::StructureShape.new(name: 'ConfluenceConfiguration')
|
53
|
+
ConfluencePageConfiguration = Shapes::StructureShape.new(name: 'ConfluencePageConfiguration')
|
54
|
+
ConfluencePageFieldMappingsList = Shapes::ListShape.new(name: 'ConfluencePageFieldMappingsList')
|
55
|
+
ConfluencePageFieldName = Shapes::StringShape.new(name: 'ConfluencePageFieldName')
|
56
|
+
ConfluencePageToIndexFieldMapping = Shapes::StructureShape.new(name: 'ConfluencePageToIndexFieldMapping')
|
57
|
+
ConfluenceSpaceConfiguration = Shapes::StructureShape.new(name: 'ConfluenceSpaceConfiguration')
|
58
|
+
ConfluenceSpaceFieldMappingsList = Shapes::ListShape.new(name: 'ConfluenceSpaceFieldMappingsList')
|
59
|
+
ConfluenceSpaceFieldName = Shapes::StringShape.new(name: 'ConfluenceSpaceFieldName')
|
60
|
+
ConfluenceSpaceIdentifier = Shapes::StringShape.new(name: 'ConfluenceSpaceIdentifier')
|
61
|
+
ConfluenceSpaceList = Shapes::ListShape.new(name: 'ConfluenceSpaceList')
|
62
|
+
ConfluenceSpaceToIndexFieldMapping = Shapes::StructureShape.new(name: 'ConfluenceSpaceToIndexFieldMapping')
|
63
|
+
ConfluenceVersion = Shapes::StringShape.new(name: 'ConfluenceVersion')
|
44
64
|
ConnectionConfiguration = Shapes::StructureShape.new(name: 'ConnectionConfiguration')
|
45
65
|
ContentType = Shapes::StringShape.new(name: 'ContentType')
|
46
66
|
CreateDataSourceRequest = Shapes::StructureShape.new(name: 'CreateDataSourceRequest')
|
@@ -336,6 +356,65 @@ module Aws::Kendra
|
|
336
356
|
ConflictException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
|
337
357
|
ConflictException.struct_class = Types::ConflictException
|
338
358
|
|
359
|
+
ConfluenceAttachmentConfiguration.add_member(:crawl_attachments, Shapes::ShapeRef.new(shape: Boolean, location_name: "CrawlAttachments"))
|
360
|
+
ConfluenceAttachmentConfiguration.add_member(:attachment_field_mappings, Shapes::ShapeRef.new(shape: ConfluenceAttachmentFieldMappingsList, location_name: "AttachmentFieldMappings"))
|
361
|
+
ConfluenceAttachmentConfiguration.struct_class = Types::ConfluenceAttachmentConfiguration
|
362
|
+
|
363
|
+
ConfluenceAttachmentFieldMappingsList.member = Shapes::ShapeRef.new(shape: ConfluenceAttachmentToIndexFieldMapping)
|
364
|
+
|
365
|
+
ConfluenceAttachmentToIndexFieldMapping.add_member(:data_source_field_name, Shapes::ShapeRef.new(shape: ConfluenceAttachmentFieldName, location_name: "DataSourceFieldName"))
|
366
|
+
ConfluenceAttachmentToIndexFieldMapping.add_member(:date_field_format, Shapes::ShapeRef.new(shape: DataSourceDateFieldFormat, location_name: "DateFieldFormat"))
|
367
|
+
ConfluenceAttachmentToIndexFieldMapping.add_member(:index_field_name, Shapes::ShapeRef.new(shape: IndexFieldName, location_name: "IndexFieldName"))
|
368
|
+
ConfluenceAttachmentToIndexFieldMapping.struct_class = Types::ConfluenceAttachmentToIndexFieldMapping
|
369
|
+
|
370
|
+
ConfluenceBlogConfiguration.add_member(:blog_field_mappings, Shapes::ShapeRef.new(shape: ConfluenceBlogFieldMappingsList, location_name: "BlogFieldMappings"))
|
371
|
+
ConfluenceBlogConfiguration.struct_class = Types::ConfluenceBlogConfiguration
|
372
|
+
|
373
|
+
ConfluenceBlogFieldMappingsList.member = Shapes::ShapeRef.new(shape: ConfluenceBlogToIndexFieldMapping)
|
374
|
+
|
375
|
+
ConfluenceBlogToIndexFieldMapping.add_member(:data_source_field_name, Shapes::ShapeRef.new(shape: ConfluenceBlogFieldName, location_name: "DataSourceFieldName"))
|
376
|
+
ConfluenceBlogToIndexFieldMapping.add_member(:date_field_format, Shapes::ShapeRef.new(shape: DataSourceDateFieldFormat, location_name: "DateFieldFormat"))
|
377
|
+
ConfluenceBlogToIndexFieldMapping.add_member(:index_field_name, Shapes::ShapeRef.new(shape: IndexFieldName, location_name: "IndexFieldName"))
|
378
|
+
ConfluenceBlogToIndexFieldMapping.struct_class = Types::ConfluenceBlogToIndexFieldMapping
|
379
|
+
|
380
|
+
ConfluenceConfiguration.add_member(:server_url, Shapes::ShapeRef.new(shape: Url, required: true, location_name: "ServerUrl"))
|
381
|
+
ConfluenceConfiguration.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, required: true, location_name: "SecretArn"))
|
382
|
+
ConfluenceConfiguration.add_member(:version, Shapes::ShapeRef.new(shape: ConfluenceVersion, required: true, location_name: "Version"))
|
383
|
+
ConfluenceConfiguration.add_member(:space_configuration, Shapes::ShapeRef.new(shape: ConfluenceSpaceConfiguration, location_name: "SpaceConfiguration"))
|
384
|
+
ConfluenceConfiguration.add_member(:page_configuration, Shapes::ShapeRef.new(shape: ConfluencePageConfiguration, location_name: "PageConfiguration"))
|
385
|
+
ConfluenceConfiguration.add_member(:blog_configuration, Shapes::ShapeRef.new(shape: ConfluenceBlogConfiguration, location_name: "BlogConfiguration"))
|
386
|
+
ConfluenceConfiguration.add_member(:attachment_configuration, Shapes::ShapeRef.new(shape: ConfluenceAttachmentConfiguration, location_name: "AttachmentConfiguration"))
|
387
|
+
ConfluenceConfiguration.add_member(:vpc_configuration, Shapes::ShapeRef.new(shape: DataSourceVpcConfiguration, location_name: "VpcConfiguration"))
|
388
|
+
ConfluenceConfiguration.add_member(:inclusion_patterns, Shapes::ShapeRef.new(shape: DataSourceInclusionsExclusionsStrings, location_name: "InclusionPatterns"))
|
389
|
+
ConfluenceConfiguration.add_member(:exclusion_patterns, Shapes::ShapeRef.new(shape: DataSourceInclusionsExclusionsStrings, location_name: "ExclusionPatterns"))
|
390
|
+
ConfluenceConfiguration.struct_class = Types::ConfluenceConfiguration
|
391
|
+
|
392
|
+
ConfluencePageConfiguration.add_member(:page_field_mappings, Shapes::ShapeRef.new(shape: ConfluencePageFieldMappingsList, location_name: "PageFieldMappings"))
|
393
|
+
ConfluencePageConfiguration.struct_class = Types::ConfluencePageConfiguration
|
394
|
+
|
395
|
+
ConfluencePageFieldMappingsList.member = Shapes::ShapeRef.new(shape: ConfluencePageToIndexFieldMapping)
|
396
|
+
|
397
|
+
ConfluencePageToIndexFieldMapping.add_member(:data_source_field_name, Shapes::ShapeRef.new(shape: ConfluencePageFieldName, location_name: "DataSourceFieldName"))
|
398
|
+
ConfluencePageToIndexFieldMapping.add_member(:date_field_format, Shapes::ShapeRef.new(shape: DataSourceDateFieldFormat, location_name: "DateFieldFormat"))
|
399
|
+
ConfluencePageToIndexFieldMapping.add_member(:index_field_name, Shapes::ShapeRef.new(shape: IndexFieldName, location_name: "IndexFieldName"))
|
400
|
+
ConfluencePageToIndexFieldMapping.struct_class = Types::ConfluencePageToIndexFieldMapping
|
401
|
+
|
402
|
+
ConfluenceSpaceConfiguration.add_member(:crawl_personal_spaces, Shapes::ShapeRef.new(shape: Boolean, location_name: "CrawlPersonalSpaces"))
|
403
|
+
ConfluenceSpaceConfiguration.add_member(:crawl_archived_spaces, Shapes::ShapeRef.new(shape: Boolean, location_name: "CrawlArchivedSpaces"))
|
404
|
+
ConfluenceSpaceConfiguration.add_member(:include_spaces, Shapes::ShapeRef.new(shape: ConfluenceSpaceList, location_name: "IncludeSpaces"))
|
405
|
+
ConfluenceSpaceConfiguration.add_member(:exclude_spaces, Shapes::ShapeRef.new(shape: ConfluenceSpaceList, location_name: "ExcludeSpaces"))
|
406
|
+
ConfluenceSpaceConfiguration.add_member(:space_field_mappings, Shapes::ShapeRef.new(shape: ConfluenceSpaceFieldMappingsList, location_name: "SpaceFieldMappings"))
|
407
|
+
ConfluenceSpaceConfiguration.struct_class = Types::ConfluenceSpaceConfiguration
|
408
|
+
|
409
|
+
ConfluenceSpaceFieldMappingsList.member = Shapes::ShapeRef.new(shape: ConfluenceSpaceToIndexFieldMapping)
|
410
|
+
|
411
|
+
ConfluenceSpaceList.member = Shapes::ShapeRef.new(shape: ConfluenceSpaceIdentifier)
|
412
|
+
|
413
|
+
ConfluenceSpaceToIndexFieldMapping.add_member(:data_source_field_name, Shapes::ShapeRef.new(shape: ConfluenceSpaceFieldName, location_name: "DataSourceFieldName"))
|
414
|
+
ConfluenceSpaceToIndexFieldMapping.add_member(:date_field_format, Shapes::ShapeRef.new(shape: DataSourceDateFieldFormat, location_name: "DateFieldFormat"))
|
415
|
+
ConfluenceSpaceToIndexFieldMapping.add_member(:index_field_name, Shapes::ShapeRef.new(shape: IndexFieldName, location_name: "IndexFieldName"))
|
416
|
+
ConfluenceSpaceToIndexFieldMapping.struct_class = Types::ConfluenceSpaceToIndexFieldMapping
|
417
|
+
|
339
418
|
ConnectionConfiguration.add_member(:database_host, Shapes::ShapeRef.new(shape: DatabaseHost, required: true, location_name: "DatabaseHost"))
|
340
419
|
ConnectionConfiguration.add_member(:database_port, Shapes::ShapeRef.new(shape: DatabasePort, required: true, location_name: "DatabasePort"))
|
341
420
|
ConnectionConfiguration.add_member(:database_name, Shapes::ShapeRef.new(shape: DatabaseName, required: true, location_name: "DatabaseName"))
|
@@ -388,6 +467,7 @@ module Aws::Kendra
|
|
388
467
|
DataSourceConfiguration.add_member(:salesforce_configuration, Shapes::ShapeRef.new(shape: SalesforceConfiguration, location_name: "SalesforceConfiguration"))
|
389
468
|
DataSourceConfiguration.add_member(:one_drive_configuration, Shapes::ShapeRef.new(shape: OneDriveConfiguration, location_name: "OneDriveConfiguration"))
|
390
469
|
DataSourceConfiguration.add_member(:service_now_configuration, Shapes::ShapeRef.new(shape: ServiceNowConfiguration, location_name: "ServiceNowConfiguration"))
|
470
|
+
DataSourceConfiguration.add_member(:confluence_configuration, Shapes::ShapeRef.new(shape: ConfluenceConfiguration, location_name: "ConfluenceConfiguration"))
|
391
471
|
DataSourceConfiguration.struct_class = Types::DataSourceConfiguration
|
392
472
|
|
393
473
|
DataSourceInclusionsExclusionsStrings.member = Shapes::ShapeRef.new(shape: DataSourceInclusionsExclusionsStringsMember)
|
data/lib/aws-sdk-kendra/types.rb
CHANGED
@@ -818,6 +818,491 @@ module Aws::Kendra
|
|
818
818
|
include Aws::Structure
|
819
819
|
end
|
820
820
|
|
821
|
+
# Specifies the attachment settings for the Confluence data source.
|
822
|
+
# Attachment settings are optional, if you don't specify settings
|
823
|
+
# attachments, Amazon Kendra won't index them.
|
824
|
+
#
|
825
|
+
# @note When making an API call, you may pass ConfluenceAttachmentConfiguration
|
826
|
+
# data as a hash:
|
827
|
+
#
|
828
|
+
# {
|
829
|
+
# crawl_attachments: false,
|
830
|
+
# attachment_field_mappings: [
|
831
|
+
# {
|
832
|
+
# data_source_field_name: "AUTHOR", # accepts AUTHOR, CONTENT_TYPE, CREATED_DATE, DISPLAY_URL, FILE_SIZE, ITEM_TYPE, PARENT_ID, SPACE_KEY, SPACE_NAME, URL, VERSION
|
833
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
834
|
+
# index_field_name: "IndexFieldName",
|
835
|
+
# },
|
836
|
+
# ],
|
837
|
+
# }
|
838
|
+
#
|
839
|
+
# @!attribute [rw] crawl_attachments
|
840
|
+
# Indicates whether Amazon Kendra indexes attachments to the pages and
|
841
|
+
# blogs in the Confluence data source.
|
842
|
+
# @return [Boolean]
|
843
|
+
#
|
844
|
+
# @!attribute [rw] attachment_field_mappings
|
845
|
+
# Defines how attachment metadata fields should be mapped to index
|
846
|
+
# fields. Before you can map a field, you must first create an index
|
847
|
+
# field with a matching type using the console or the `UpdateIndex`
|
848
|
+
# operation.
|
849
|
+
#
|
850
|
+
# If you specify the `AttachentFieldMappings` parameter, you must
|
851
|
+
# specify at least one field mapping.
|
852
|
+
# @return [Array<Types::ConfluenceAttachmentToIndexFieldMapping>]
|
853
|
+
#
|
854
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConfluenceAttachmentConfiguration AWS API Documentation
|
855
|
+
#
|
856
|
+
class ConfluenceAttachmentConfiguration < Struct.new(
|
857
|
+
:crawl_attachments,
|
858
|
+
:attachment_field_mappings)
|
859
|
+
SENSITIVE = []
|
860
|
+
include Aws::Structure
|
861
|
+
end
|
862
|
+
|
863
|
+
# Defines the mapping between a field in the Confluence data source to a
|
864
|
+
# Amazon Kendra index field.
|
865
|
+
#
|
866
|
+
# You must first create the index field using the operation.
|
867
|
+
#
|
868
|
+
# @note When making an API call, you may pass ConfluenceAttachmentToIndexFieldMapping
|
869
|
+
# data as a hash:
|
870
|
+
#
|
871
|
+
# {
|
872
|
+
# data_source_field_name: "AUTHOR", # accepts AUTHOR, CONTENT_TYPE, CREATED_DATE, DISPLAY_URL, FILE_SIZE, ITEM_TYPE, PARENT_ID, SPACE_KEY, SPACE_NAME, URL, VERSION
|
873
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
874
|
+
# index_field_name: "IndexFieldName",
|
875
|
+
# }
|
876
|
+
#
|
877
|
+
# @!attribute [rw] data_source_field_name
|
878
|
+
# The name of the field in the data source.
|
879
|
+
#
|
880
|
+
# You must first create the index field using the operation.
|
881
|
+
# @return [String]
|
882
|
+
#
|
883
|
+
# @!attribute [rw] date_field_format
|
884
|
+
# The format for date fields in the data source. If the field
|
885
|
+
# specified in `DataSourceFieldName` is a date field you must specify
|
886
|
+
# the date format. If the field is not a date field, an exception is
|
887
|
+
# thrown.
|
888
|
+
# @return [String]
|
889
|
+
#
|
890
|
+
# @!attribute [rw] index_field_name
|
891
|
+
# The name of the index field to map to the Confluence data source
|
892
|
+
# field. The index field type must match the Confluence field type.
|
893
|
+
# @return [String]
|
894
|
+
#
|
895
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConfluenceAttachmentToIndexFieldMapping AWS API Documentation
|
896
|
+
#
|
897
|
+
class ConfluenceAttachmentToIndexFieldMapping < Struct.new(
|
898
|
+
:data_source_field_name,
|
899
|
+
:date_field_format,
|
900
|
+
:index_field_name)
|
901
|
+
SENSITIVE = []
|
902
|
+
include Aws::Structure
|
903
|
+
end
|
904
|
+
|
905
|
+
# Specifies the blog settings for the Confluence data source. Blogs are
|
906
|
+
# always indexed unless filtered from the index by the
|
907
|
+
# `ExclusionPatterns` or `InclusionPatterns` fields in the data type.
|
908
|
+
#
|
909
|
+
# @note When making an API call, you may pass ConfluenceBlogConfiguration
|
910
|
+
# data as a hash:
|
911
|
+
#
|
912
|
+
# {
|
913
|
+
# blog_field_mappings: [
|
914
|
+
# {
|
915
|
+
# data_source_field_name: "AUTHOR", # accepts AUTHOR, DISPLAY_URL, ITEM_TYPE, LABELS, PUBLISH_DATE, SPACE_KEY, SPACE_NAME, URL, VERSION
|
916
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
917
|
+
# index_field_name: "IndexFieldName",
|
918
|
+
# },
|
919
|
+
# ],
|
920
|
+
# }
|
921
|
+
#
|
922
|
+
# @!attribute [rw] blog_field_mappings
|
923
|
+
# Defines how blog metadata fields should be mapped to index fields.
|
924
|
+
# Before you can map a field, you must first create an index field
|
925
|
+
# with a matching type using the console or the `UpdateIndex`
|
926
|
+
# operation.
|
927
|
+
#
|
928
|
+
# If you specify the `BlogFieldMappings` parameter, you must specify
|
929
|
+
# at least one field mapping.
|
930
|
+
# @return [Array<Types::ConfluenceBlogToIndexFieldMapping>]
|
931
|
+
#
|
932
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConfluenceBlogConfiguration AWS API Documentation
|
933
|
+
#
|
934
|
+
class ConfluenceBlogConfiguration < Struct.new(
|
935
|
+
:blog_field_mappings)
|
936
|
+
SENSITIVE = []
|
937
|
+
include Aws::Structure
|
938
|
+
end
|
939
|
+
|
940
|
+
# Defines the mapping between a blog field in the Confluence data source
|
941
|
+
# to a Amazon Kendra index field.
|
942
|
+
#
|
943
|
+
# You must first create the index field using the operation.
|
944
|
+
#
|
945
|
+
# @note When making an API call, you may pass ConfluenceBlogToIndexFieldMapping
|
946
|
+
# data as a hash:
|
947
|
+
#
|
948
|
+
# {
|
949
|
+
# data_source_field_name: "AUTHOR", # accepts AUTHOR, DISPLAY_URL, ITEM_TYPE, LABELS, PUBLISH_DATE, SPACE_KEY, SPACE_NAME, URL, VERSION
|
950
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
951
|
+
# index_field_name: "IndexFieldName",
|
952
|
+
# }
|
953
|
+
#
|
954
|
+
# @!attribute [rw] data_source_field_name
|
955
|
+
# The name of the field in the data source.
|
956
|
+
# @return [String]
|
957
|
+
#
|
958
|
+
# @!attribute [rw] date_field_format
|
959
|
+
# The format for date fields in the data source. If the field
|
960
|
+
# specified in `DataSourceFieldName` is a date field you must specify
|
961
|
+
# the date format. If the field is not a date field, an exception is
|
962
|
+
# thrown.
|
963
|
+
# @return [String]
|
964
|
+
#
|
965
|
+
# @!attribute [rw] index_field_name
|
966
|
+
# The name of the index field to map to the Confluence data source
|
967
|
+
# field. The index field type must match the Confluence field type.
|
968
|
+
# @return [String]
|
969
|
+
#
|
970
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConfluenceBlogToIndexFieldMapping AWS API Documentation
|
971
|
+
#
|
972
|
+
class ConfluenceBlogToIndexFieldMapping < Struct.new(
|
973
|
+
:data_source_field_name,
|
974
|
+
:date_field_format,
|
975
|
+
:index_field_name)
|
976
|
+
SENSITIVE = []
|
977
|
+
include Aws::Structure
|
978
|
+
end
|
979
|
+
|
980
|
+
# Provides configuration information for data sources that connect to
|
981
|
+
# Confluence.
|
982
|
+
#
|
983
|
+
# @note When making an API call, you may pass ConfluenceConfiguration
|
984
|
+
# data as a hash:
|
985
|
+
#
|
986
|
+
# {
|
987
|
+
# server_url: "Url", # required
|
988
|
+
# secret_arn: "SecretArn", # required
|
989
|
+
# version: "SERVER", # required, accepts SERVER
|
990
|
+
# space_configuration: {
|
991
|
+
# crawl_personal_spaces: false,
|
992
|
+
# crawl_archived_spaces: false,
|
993
|
+
# include_spaces: ["ConfluenceSpaceIdentifier"],
|
994
|
+
# exclude_spaces: ["ConfluenceSpaceIdentifier"],
|
995
|
+
# space_field_mappings: [
|
996
|
+
# {
|
997
|
+
# data_source_field_name: "DISPLAY_URL", # accepts DISPLAY_URL, ITEM_TYPE, SPACE_KEY, URL
|
998
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
999
|
+
# index_field_name: "IndexFieldName",
|
1000
|
+
# },
|
1001
|
+
# ],
|
1002
|
+
# },
|
1003
|
+
# page_configuration: {
|
1004
|
+
# page_field_mappings: [
|
1005
|
+
# {
|
1006
|
+
# data_source_field_name: "AUTHOR", # accepts AUTHOR, CONTENT_STATUS, CREATED_DATE, DISPLAY_URL, ITEM_TYPE, LABELS, MODIFIED_DATE, PARENT_ID, SPACE_KEY, SPACE_NAME, URL, VERSION
|
1007
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1008
|
+
# index_field_name: "IndexFieldName",
|
1009
|
+
# },
|
1010
|
+
# ],
|
1011
|
+
# },
|
1012
|
+
# blog_configuration: {
|
1013
|
+
# blog_field_mappings: [
|
1014
|
+
# {
|
1015
|
+
# data_source_field_name: "AUTHOR", # accepts AUTHOR, DISPLAY_URL, ITEM_TYPE, LABELS, PUBLISH_DATE, SPACE_KEY, SPACE_NAME, URL, VERSION
|
1016
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1017
|
+
# index_field_name: "IndexFieldName",
|
1018
|
+
# },
|
1019
|
+
# ],
|
1020
|
+
# },
|
1021
|
+
# attachment_configuration: {
|
1022
|
+
# crawl_attachments: false,
|
1023
|
+
# attachment_field_mappings: [
|
1024
|
+
# {
|
1025
|
+
# data_source_field_name: "AUTHOR", # accepts AUTHOR, CONTENT_TYPE, CREATED_DATE, DISPLAY_URL, FILE_SIZE, ITEM_TYPE, PARENT_ID, SPACE_KEY, SPACE_NAME, URL, VERSION
|
1026
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1027
|
+
# index_field_name: "IndexFieldName",
|
1028
|
+
# },
|
1029
|
+
# ],
|
1030
|
+
# },
|
1031
|
+
# vpc_configuration: {
|
1032
|
+
# subnet_ids: ["SubnetId"], # required
|
1033
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
1034
|
+
# },
|
1035
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1036
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1037
|
+
# }
|
1038
|
+
#
|
1039
|
+
# @!attribute [rw] server_url
|
1040
|
+
# The URL of your Confluence instance. Use the full URL of the server.
|
1041
|
+
# For example, `https://server.example.com:port/`. You can also use an
|
1042
|
+
# IP address, for example, `https://192.168.1.113/`.
|
1043
|
+
# @return [String]
|
1044
|
+
#
|
1045
|
+
# @!attribute [rw] secret_arn
|
1046
|
+
# The Amazon Resource Name (ARN) of an AWS Secrets Manager secret that
|
1047
|
+
# contains the key/value pairs required to connect to your Confluence
|
1048
|
+
# server. The secret must contain a JSON structure with the following
|
1049
|
+
# keys:
|
1050
|
+
#
|
1051
|
+
# * username - The user name of a user with administrative privileges
|
1052
|
+
# for the Confluence server.
|
1053
|
+
#
|
1054
|
+
# * password - The password associated with the user logging in to the
|
1055
|
+
# Confluence server.
|
1056
|
+
# @return [String]
|
1057
|
+
#
|
1058
|
+
# @!attribute [rw] version
|
1059
|
+
# Specifies the version of the Confluence installation that you are
|
1060
|
+
# connecting to.
|
1061
|
+
# @return [String]
|
1062
|
+
#
|
1063
|
+
# @!attribute [rw] space_configuration
|
1064
|
+
# Specifies configuration information for indexing Confluence spaces.
|
1065
|
+
# @return [Types::ConfluenceSpaceConfiguration]
|
1066
|
+
#
|
1067
|
+
# @!attribute [rw] page_configuration
|
1068
|
+
# Specifies configuration information for indexing Confluence pages.
|
1069
|
+
# @return [Types::ConfluencePageConfiguration]
|
1070
|
+
#
|
1071
|
+
# @!attribute [rw] blog_configuration
|
1072
|
+
# Specifies configuration information for indexing Confluence blogs.
|
1073
|
+
# @return [Types::ConfluenceBlogConfiguration]
|
1074
|
+
#
|
1075
|
+
# @!attribute [rw] attachment_configuration
|
1076
|
+
# Specifies configuration information for indexing attachments to
|
1077
|
+
# Confluence blogs and pages.
|
1078
|
+
# @return [Types::ConfluenceAttachmentConfiguration]
|
1079
|
+
#
|
1080
|
+
# @!attribute [rw] vpc_configuration
|
1081
|
+
# Specifies the information for connecting to an Amazon VPC.
|
1082
|
+
# @return [Types::DataSourceVpcConfiguration]
|
1083
|
+
#
|
1084
|
+
# @!attribute [rw] inclusion_patterns
|
1085
|
+
# A list of regular expression patterns that apply to a URL on the
|
1086
|
+
# Confluence server. An inclusion pattern can apply to a blog post, a
|
1087
|
+
# page, a space, or an attachment. Items that match the patterns are
|
1088
|
+
# included in the index. Items that don't match the pattern are
|
1089
|
+
# excluded from the index. If an item matches both an inclusion
|
1090
|
+
# pattern and an exclusion pattern, the item isn't included in the
|
1091
|
+
# index.
|
1092
|
+
# @return [Array<String>]
|
1093
|
+
#
|
1094
|
+
# @!attribute [rw] exclusion_patterns
|
1095
|
+
# A list of regular expression patterns that apply to a URL on the
|
1096
|
+
# Confluence server. An exclusion pattern can apply to a blog post, a
|
1097
|
+
# page, a space, or an attachment. Items that match the pattern are
|
1098
|
+
# excluded from the index. Items that don't match the pattern are
|
1099
|
+
# included in the index. If a item matches both an exclusion pattern
|
1100
|
+
# and an inclusion pattern, the item isn't included in the index.
|
1101
|
+
# @return [Array<String>]
|
1102
|
+
#
|
1103
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConfluenceConfiguration AWS API Documentation
|
1104
|
+
#
|
1105
|
+
class ConfluenceConfiguration < Struct.new(
|
1106
|
+
:server_url,
|
1107
|
+
:secret_arn,
|
1108
|
+
:version,
|
1109
|
+
:space_configuration,
|
1110
|
+
:page_configuration,
|
1111
|
+
:blog_configuration,
|
1112
|
+
:attachment_configuration,
|
1113
|
+
:vpc_configuration,
|
1114
|
+
:inclusion_patterns,
|
1115
|
+
:exclusion_patterns)
|
1116
|
+
SENSITIVE = []
|
1117
|
+
include Aws::Structure
|
1118
|
+
end
|
1119
|
+
|
1120
|
+
# Specifies the page settings for the Confluence data source.
|
1121
|
+
#
|
1122
|
+
# @note When making an API call, you may pass ConfluencePageConfiguration
|
1123
|
+
# data as a hash:
|
1124
|
+
#
|
1125
|
+
# {
|
1126
|
+
# page_field_mappings: [
|
1127
|
+
# {
|
1128
|
+
# data_source_field_name: "AUTHOR", # accepts AUTHOR, CONTENT_STATUS, CREATED_DATE, DISPLAY_URL, ITEM_TYPE, LABELS, MODIFIED_DATE, PARENT_ID, SPACE_KEY, SPACE_NAME, URL, VERSION
|
1129
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1130
|
+
# index_field_name: "IndexFieldName",
|
1131
|
+
# },
|
1132
|
+
# ],
|
1133
|
+
# }
|
1134
|
+
#
|
1135
|
+
# @!attribute [rw] page_field_mappings
|
1136
|
+
# Defines how page metadata fields should be mapped to index fields.
|
1137
|
+
# Before you can map a field, you must first create an index field
|
1138
|
+
# with a matching type using the console or the `UpdateIndex`
|
1139
|
+
# operation.
|
1140
|
+
#
|
1141
|
+
# If you specify the `PageFieldMappings` parameter, you must specify
|
1142
|
+
# at least one field mapping.
|
1143
|
+
# @return [Array<Types::ConfluencePageToIndexFieldMapping>]
|
1144
|
+
#
|
1145
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConfluencePageConfiguration AWS API Documentation
|
1146
|
+
#
|
1147
|
+
class ConfluencePageConfiguration < Struct.new(
|
1148
|
+
:page_field_mappings)
|
1149
|
+
SENSITIVE = []
|
1150
|
+
include Aws::Structure
|
1151
|
+
end
|
1152
|
+
|
1153
|
+
# Defines the mapping between a field in the Confluence data source to a
|
1154
|
+
# Amazon Kendra index field.
|
1155
|
+
#
|
1156
|
+
# You must first create the index field using the operation.
|
1157
|
+
#
|
1158
|
+
# @note When making an API call, you may pass ConfluencePageToIndexFieldMapping
|
1159
|
+
# data as a hash:
|
1160
|
+
#
|
1161
|
+
# {
|
1162
|
+
# data_source_field_name: "AUTHOR", # accepts AUTHOR, CONTENT_STATUS, CREATED_DATE, DISPLAY_URL, ITEM_TYPE, LABELS, MODIFIED_DATE, PARENT_ID, SPACE_KEY, SPACE_NAME, URL, VERSION
|
1163
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1164
|
+
# index_field_name: "IndexFieldName",
|
1165
|
+
# }
|
1166
|
+
#
|
1167
|
+
# @!attribute [rw] data_source_field_name
|
1168
|
+
# The name of the field in the data source.
|
1169
|
+
# @return [String]
|
1170
|
+
#
|
1171
|
+
# @!attribute [rw] date_field_format
|
1172
|
+
# The format for date fields in the data source. If the field
|
1173
|
+
# specified in `DataSourceFieldName` is a date field you must specify
|
1174
|
+
# the date format. If the field is not a date field, an exception is
|
1175
|
+
# thrown.
|
1176
|
+
# @return [String]
|
1177
|
+
#
|
1178
|
+
# @!attribute [rw] index_field_name
|
1179
|
+
# The name of the index field to map to the Confluence data source
|
1180
|
+
# field. The index field type must match the Confluence field type.
|
1181
|
+
# @return [String]
|
1182
|
+
#
|
1183
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConfluencePageToIndexFieldMapping AWS API Documentation
|
1184
|
+
#
|
1185
|
+
class ConfluencePageToIndexFieldMapping < Struct.new(
|
1186
|
+
:data_source_field_name,
|
1187
|
+
:date_field_format,
|
1188
|
+
:index_field_name)
|
1189
|
+
SENSITIVE = []
|
1190
|
+
include Aws::Structure
|
1191
|
+
end
|
1192
|
+
|
1193
|
+
# Specifies the configuration for indexing Confluence spaces.
|
1194
|
+
#
|
1195
|
+
# @note When making an API call, you may pass ConfluenceSpaceConfiguration
|
1196
|
+
# data as a hash:
|
1197
|
+
#
|
1198
|
+
# {
|
1199
|
+
# crawl_personal_spaces: false,
|
1200
|
+
# crawl_archived_spaces: false,
|
1201
|
+
# include_spaces: ["ConfluenceSpaceIdentifier"],
|
1202
|
+
# exclude_spaces: ["ConfluenceSpaceIdentifier"],
|
1203
|
+
# space_field_mappings: [
|
1204
|
+
# {
|
1205
|
+
# data_source_field_name: "DISPLAY_URL", # accepts DISPLAY_URL, ITEM_TYPE, SPACE_KEY, URL
|
1206
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1207
|
+
# index_field_name: "IndexFieldName",
|
1208
|
+
# },
|
1209
|
+
# ],
|
1210
|
+
# }
|
1211
|
+
#
|
1212
|
+
# @!attribute [rw] crawl_personal_spaces
|
1213
|
+
# Specifies whether Amazon Kendra should index personal spaces. Users
|
1214
|
+
# can add restrictions to items in personal spaces. If personal spaces
|
1215
|
+
# are indexed, queries without user context information may return
|
1216
|
+
# restricted items from a personal space in their results. For more
|
1217
|
+
# information, see [Filtering on user context][1].
|
1218
|
+
#
|
1219
|
+
#
|
1220
|
+
#
|
1221
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html
|
1222
|
+
# @return [Boolean]
|
1223
|
+
#
|
1224
|
+
# @!attribute [rw] crawl_archived_spaces
|
1225
|
+
# Specifies whether Amazon Kendra should index archived spaces.
|
1226
|
+
# @return [Boolean]
|
1227
|
+
#
|
1228
|
+
# @!attribute [rw] include_spaces
|
1229
|
+
# A list of space keys for Confluence spaces. If you include a key,
|
1230
|
+
# the blogs, documents, and attachments in the space are indexed.
|
1231
|
+
# Spaces that aren't in the list aren't indexed. A space in the list
|
1232
|
+
# must exist. Otherwise, Amazon Kendra logs an error when the data
|
1233
|
+
# source is synchronized. If a space is in both the `IncludeSpaces`
|
1234
|
+
# and the `ExcludeSpaces` list, the space is excluded.
|
1235
|
+
# @return [Array<String>]
|
1236
|
+
#
|
1237
|
+
# @!attribute [rw] exclude_spaces
|
1238
|
+
# A list of space keys of Confluence spaces. If you include a key, the
|
1239
|
+
# blogs, documents, and attachments in the space are not indexed. If a
|
1240
|
+
# space is in both the `ExcludeSpaces` and the `IncludeSpaces` list,
|
1241
|
+
# the space is excluded.
|
1242
|
+
# @return [Array<String>]
|
1243
|
+
#
|
1244
|
+
# @!attribute [rw] space_field_mappings
|
1245
|
+
# Defines how space metadata fields should be mapped to index fields.
|
1246
|
+
# Before you can map a field, you must first create an index field
|
1247
|
+
# with a matching type using the console or the `UpdateIndex`
|
1248
|
+
# operation.
|
1249
|
+
#
|
1250
|
+
# If you specify the `SpaceFieldMappings` parameter, you must specify
|
1251
|
+
# at least one field mapping.
|
1252
|
+
# @return [Array<Types::ConfluenceSpaceToIndexFieldMapping>]
|
1253
|
+
#
|
1254
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConfluenceSpaceConfiguration AWS API Documentation
|
1255
|
+
#
|
1256
|
+
class ConfluenceSpaceConfiguration < Struct.new(
|
1257
|
+
:crawl_personal_spaces,
|
1258
|
+
:crawl_archived_spaces,
|
1259
|
+
:include_spaces,
|
1260
|
+
:exclude_spaces,
|
1261
|
+
:space_field_mappings)
|
1262
|
+
SENSITIVE = []
|
1263
|
+
include Aws::Structure
|
1264
|
+
end
|
1265
|
+
|
1266
|
+
# Defines the mapping between a field in the Confluence data source to a
|
1267
|
+
# Amazon Kendra index field.
|
1268
|
+
#
|
1269
|
+
# You must first create the index field using the operation.
|
1270
|
+
#
|
1271
|
+
# @note When making an API call, you may pass ConfluenceSpaceToIndexFieldMapping
|
1272
|
+
# data as a hash:
|
1273
|
+
#
|
1274
|
+
# {
|
1275
|
+
# data_source_field_name: "DISPLAY_URL", # accepts DISPLAY_URL, ITEM_TYPE, SPACE_KEY, URL
|
1276
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1277
|
+
# index_field_name: "IndexFieldName",
|
1278
|
+
# }
|
1279
|
+
#
|
1280
|
+
# @!attribute [rw] data_source_field_name
|
1281
|
+
# The name of the field in the data source.
|
1282
|
+
# @return [String]
|
1283
|
+
#
|
1284
|
+
# @!attribute [rw] date_field_format
|
1285
|
+
# The format for date fields in the data source. If the field
|
1286
|
+
# specified in `DataSourceFieldName` is a date field you must specify
|
1287
|
+
# the date format. If the field is not a date field, an exception is
|
1288
|
+
# thrown.
|
1289
|
+
# @return [String]
|
1290
|
+
#
|
1291
|
+
# @!attribute [rw] index_field_name
|
1292
|
+
# The name of the index field to map to the Confluence data source
|
1293
|
+
# field. The index field type must match the Confluence field type.
|
1294
|
+
# @return [String]
|
1295
|
+
#
|
1296
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConfluenceSpaceToIndexFieldMapping AWS API Documentation
|
1297
|
+
#
|
1298
|
+
class ConfluenceSpaceToIndexFieldMapping < Struct.new(
|
1299
|
+
:data_source_field_name,
|
1300
|
+
:date_field_format,
|
1301
|
+
:index_field_name)
|
1302
|
+
SENSITIVE = []
|
1303
|
+
include Aws::Structure
|
1304
|
+
end
|
1305
|
+
|
821
1306
|
# Provides the information necessary to connect to a database.
|
822
1307
|
#
|
823
1308
|
# @note When making an API call, you may pass ConnectionConfiguration
|
@@ -879,7 +1364,7 @@ module Aws::Kendra
|
|
879
1364
|
# {
|
880
1365
|
# name: "DataSourceName", # required
|
881
1366
|
# index_id: "IndexId", # required
|
882
|
-
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM
|
1367
|
+
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE
|
883
1368
|
# configuration: {
|
884
1369
|
# s3_configuration: {
|
885
1370
|
# bucket_name: "S3BucketName", # required
|
@@ -1071,6 +1556,58 @@ module Aws::Kendra
|
|
1071
1556
|
# ],
|
1072
1557
|
# },
|
1073
1558
|
# },
|
1559
|
+
# confluence_configuration: {
|
1560
|
+
# server_url: "Url", # required
|
1561
|
+
# secret_arn: "SecretArn", # required
|
1562
|
+
# version: "SERVER", # required, accepts SERVER
|
1563
|
+
# space_configuration: {
|
1564
|
+
# crawl_personal_spaces: false,
|
1565
|
+
# crawl_archived_spaces: false,
|
1566
|
+
# include_spaces: ["ConfluenceSpaceIdentifier"],
|
1567
|
+
# exclude_spaces: ["ConfluenceSpaceIdentifier"],
|
1568
|
+
# space_field_mappings: [
|
1569
|
+
# {
|
1570
|
+
# data_source_field_name: "DISPLAY_URL", # accepts DISPLAY_URL, ITEM_TYPE, SPACE_KEY, URL
|
1571
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1572
|
+
# index_field_name: "IndexFieldName",
|
1573
|
+
# },
|
1574
|
+
# ],
|
1575
|
+
# },
|
1576
|
+
# page_configuration: {
|
1577
|
+
# page_field_mappings: [
|
1578
|
+
# {
|
1579
|
+
# data_source_field_name: "AUTHOR", # accepts AUTHOR, CONTENT_STATUS, CREATED_DATE, DISPLAY_URL, ITEM_TYPE, LABELS, MODIFIED_DATE, PARENT_ID, SPACE_KEY, SPACE_NAME, URL, VERSION
|
1580
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1581
|
+
# index_field_name: "IndexFieldName",
|
1582
|
+
# },
|
1583
|
+
# ],
|
1584
|
+
# },
|
1585
|
+
# blog_configuration: {
|
1586
|
+
# blog_field_mappings: [
|
1587
|
+
# {
|
1588
|
+
# data_source_field_name: "AUTHOR", # accepts AUTHOR, DISPLAY_URL, ITEM_TYPE, LABELS, PUBLISH_DATE, SPACE_KEY, SPACE_NAME, URL, VERSION
|
1589
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1590
|
+
# index_field_name: "IndexFieldName",
|
1591
|
+
# },
|
1592
|
+
# ],
|
1593
|
+
# },
|
1594
|
+
# attachment_configuration: {
|
1595
|
+
# crawl_attachments: false,
|
1596
|
+
# attachment_field_mappings: [
|
1597
|
+
# {
|
1598
|
+
# data_source_field_name: "AUTHOR", # accepts AUTHOR, CONTENT_TYPE, CREATED_DATE, DISPLAY_URL, FILE_SIZE, ITEM_TYPE, PARENT_ID, SPACE_KEY, SPACE_NAME, URL, VERSION
|
1599
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
1600
|
+
# index_field_name: "IndexFieldName",
|
1601
|
+
# },
|
1602
|
+
# ],
|
1603
|
+
# },
|
1604
|
+
# vpc_configuration: {
|
1605
|
+
# subnet_ids: ["SubnetId"], # required
|
1606
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
1607
|
+
# },
|
1608
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1609
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1610
|
+
# },
|
1074
1611
|
# },
|
1075
1612
|
# description: "Description",
|
1076
1613
|
# schedule: "ScanSchedule",
|
@@ -1580,6 +2117,58 @@ module Aws::Kendra
|
|
1580
2117
|
# ],
|
1581
2118
|
# },
|
1582
2119
|
# },
|
2120
|
+
# confluence_configuration: {
|
2121
|
+
# server_url: "Url", # required
|
2122
|
+
# secret_arn: "SecretArn", # required
|
2123
|
+
# version: "SERVER", # required, accepts SERVER
|
2124
|
+
# space_configuration: {
|
2125
|
+
# crawl_personal_spaces: false,
|
2126
|
+
# crawl_archived_spaces: false,
|
2127
|
+
# include_spaces: ["ConfluenceSpaceIdentifier"],
|
2128
|
+
# exclude_spaces: ["ConfluenceSpaceIdentifier"],
|
2129
|
+
# space_field_mappings: [
|
2130
|
+
# {
|
2131
|
+
# data_source_field_name: "DISPLAY_URL", # accepts DISPLAY_URL, ITEM_TYPE, SPACE_KEY, URL
|
2132
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2133
|
+
# index_field_name: "IndexFieldName",
|
2134
|
+
# },
|
2135
|
+
# ],
|
2136
|
+
# },
|
2137
|
+
# page_configuration: {
|
2138
|
+
# page_field_mappings: [
|
2139
|
+
# {
|
2140
|
+
# data_source_field_name: "AUTHOR", # accepts AUTHOR, CONTENT_STATUS, CREATED_DATE, DISPLAY_URL, ITEM_TYPE, LABELS, MODIFIED_DATE, PARENT_ID, SPACE_KEY, SPACE_NAME, URL, VERSION
|
2141
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2142
|
+
# index_field_name: "IndexFieldName",
|
2143
|
+
# },
|
2144
|
+
# ],
|
2145
|
+
# },
|
2146
|
+
# blog_configuration: {
|
2147
|
+
# blog_field_mappings: [
|
2148
|
+
# {
|
2149
|
+
# data_source_field_name: "AUTHOR", # accepts AUTHOR, DISPLAY_URL, ITEM_TYPE, LABELS, PUBLISH_DATE, SPACE_KEY, SPACE_NAME, URL, VERSION
|
2150
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2151
|
+
# index_field_name: "IndexFieldName",
|
2152
|
+
# },
|
2153
|
+
# ],
|
2154
|
+
# },
|
2155
|
+
# attachment_configuration: {
|
2156
|
+
# crawl_attachments: false,
|
2157
|
+
# attachment_field_mappings: [
|
2158
|
+
# {
|
2159
|
+
# data_source_field_name: "AUTHOR", # accepts AUTHOR, CONTENT_TYPE, CREATED_DATE, DISPLAY_URL, FILE_SIZE, ITEM_TYPE, PARENT_ID, SPACE_KEY, SPACE_NAME, URL, VERSION
|
2160
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
2161
|
+
# index_field_name: "IndexFieldName",
|
2162
|
+
# },
|
2163
|
+
# ],
|
2164
|
+
# },
|
2165
|
+
# vpc_configuration: {
|
2166
|
+
# subnet_ids: ["SubnetId"], # required
|
2167
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
2168
|
+
# },
|
2169
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2170
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2171
|
+
# },
|
1583
2172
|
# }
|
1584
2173
|
#
|
1585
2174
|
# @!attribute [rw] s3_configuration
|
@@ -1612,6 +2201,11 @@ module Aws::Kendra
|
|
1612
2201
|
# instances.
|
1613
2202
|
# @return [Types::ServiceNowConfiguration]
|
1614
2203
|
#
|
2204
|
+
# @!attribute [rw] confluence_configuration
|
2205
|
+
# Provides configuration information for connecting to a Confluence
|
2206
|
+
# data source.
|
2207
|
+
# @return [Types::ConfluenceConfiguration]
|
2208
|
+
#
|
1615
2209
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceConfiguration AWS API Documentation
|
1616
2210
|
#
|
1617
2211
|
class DataSourceConfiguration < Struct.new(
|
@@ -1620,7 +2214,8 @@ module Aws::Kendra
|
|
1620
2214
|
:database_configuration,
|
1621
2215
|
:salesforce_configuration,
|
1622
2216
|
:one_drive_configuration,
|
1623
|
-
:service_now_configuration
|
2217
|
+
:service_now_configuration,
|
2218
|
+
:confluence_configuration)
|
1624
2219
|
SENSITIVE = []
|
1625
2220
|
include Aws::Structure
|
1626
2221
|
end
|
@@ -5198,6 +5793,58 @@ module Aws::Kendra
|
|
5198
5793
|
# ],
|
5199
5794
|
# },
|
5200
5795
|
# },
|
5796
|
+
# confluence_configuration: {
|
5797
|
+
# server_url: "Url", # required
|
5798
|
+
# secret_arn: "SecretArn", # required
|
5799
|
+
# version: "SERVER", # required, accepts SERVER
|
5800
|
+
# space_configuration: {
|
5801
|
+
# crawl_personal_spaces: false,
|
5802
|
+
# crawl_archived_spaces: false,
|
5803
|
+
# include_spaces: ["ConfluenceSpaceIdentifier"],
|
5804
|
+
# exclude_spaces: ["ConfluenceSpaceIdentifier"],
|
5805
|
+
# space_field_mappings: [
|
5806
|
+
# {
|
5807
|
+
# data_source_field_name: "DISPLAY_URL", # accepts DISPLAY_URL, ITEM_TYPE, SPACE_KEY, URL
|
5808
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
5809
|
+
# index_field_name: "IndexFieldName",
|
5810
|
+
# },
|
5811
|
+
# ],
|
5812
|
+
# },
|
5813
|
+
# page_configuration: {
|
5814
|
+
# page_field_mappings: [
|
5815
|
+
# {
|
5816
|
+
# data_source_field_name: "AUTHOR", # accepts AUTHOR, CONTENT_STATUS, CREATED_DATE, DISPLAY_URL, ITEM_TYPE, LABELS, MODIFIED_DATE, PARENT_ID, SPACE_KEY, SPACE_NAME, URL, VERSION
|
5817
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
5818
|
+
# index_field_name: "IndexFieldName",
|
5819
|
+
# },
|
5820
|
+
# ],
|
5821
|
+
# },
|
5822
|
+
# blog_configuration: {
|
5823
|
+
# blog_field_mappings: [
|
5824
|
+
# {
|
5825
|
+
# data_source_field_name: "AUTHOR", # accepts AUTHOR, DISPLAY_URL, ITEM_TYPE, LABELS, PUBLISH_DATE, SPACE_KEY, SPACE_NAME, URL, VERSION
|
5826
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
5827
|
+
# index_field_name: "IndexFieldName",
|
5828
|
+
# },
|
5829
|
+
# ],
|
5830
|
+
# },
|
5831
|
+
# attachment_configuration: {
|
5832
|
+
# crawl_attachments: false,
|
5833
|
+
# attachment_field_mappings: [
|
5834
|
+
# {
|
5835
|
+
# data_source_field_name: "AUTHOR", # accepts AUTHOR, CONTENT_TYPE, CREATED_DATE, DISPLAY_URL, FILE_SIZE, ITEM_TYPE, PARENT_ID, SPACE_KEY, SPACE_NAME, URL, VERSION
|
5836
|
+
# date_field_format: "DataSourceDateFieldFormat",
|
5837
|
+
# index_field_name: "IndexFieldName",
|
5838
|
+
# },
|
5839
|
+
# ],
|
5840
|
+
# },
|
5841
|
+
# vpc_configuration: {
|
5842
|
+
# subnet_ids: ["SubnetId"], # required
|
5843
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
5844
|
+
# },
|
5845
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
5846
|
+
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
5847
|
+
# },
|
5201
5848
|
# },
|
5202
5849
|
# description: "Description",
|
5203
5850
|
# schedule: "ScanSchedule",
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-kendra
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.17.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2020-10-
|
11
|
+
date: 2020-10-26 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|