aws-sdk-kendra 1.12.0 → 1.17.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/lib/aws-sdk-kendra.rb +1 -1
- data/lib/aws-sdk-kendra/client.rb +211 -19
- data/lib/aws-sdk-kendra/client_api.rb +89 -2
- data/lib/aws-sdk-kendra/types.rb +755 -22
- metadata +4 -4
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
@@ -486,12 +486,10 @@ module Aws::Kendra
|
|
486
486
|
|
487
487
|
# Creates a data source that you use to with an Amazon Kendra index.
|
488
488
|
#
|
489
|
-
# You specify a name, connector type and description for
|
490
|
-
# source. You
|
491
|
-
#
|
492
|
-
#
|
493
|
-
# You also specify configuration information such as document metadata
|
494
|
-
# (author, source URI, and so on) and user context information.
|
489
|
+
# You specify a name, data source connector type and description for
|
490
|
+
# your data source. You also specify configuration information such as
|
491
|
+
# document metadata (author, source URI, and so on) and user context
|
492
|
+
# information.
|
495
493
|
#
|
496
494
|
# `CreateDataSource` is a synchronous operation. The operation returns
|
497
495
|
# 200 if the data source was successfully created. Otherwise, an
|
@@ -508,10 +506,16 @@ module Aws::Kendra
|
|
508
506
|
# @option params [required, String] :type
|
509
507
|
# The type of repository that contains the data source.
|
510
508
|
#
|
511
|
-
# @option params [
|
509
|
+
# @option params [Types::DataSourceConfiguration] :configuration
|
512
510
|
# The connector configuration information that is required to access the
|
513
511
|
# repository.
|
514
512
|
#
|
513
|
+
# You can't specify the `Configuration` parameter when the `Type`
|
514
|
+
# parameter is set to `CUSTOM`. If you do, you receive a
|
515
|
+
# `ValidationException` exception.
|
516
|
+
#
|
517
|
+
# The `Configuration` parameter is required for all other data sources.
|
518
|
+
#
|
515
519
|
# @option params [String] :description
|
516
520
|
# A description for the data source.
|
517
521
|
#
|
@@ -521,11 +525,21 @@ module Aws::Kendra
|
|
521
525
|
# Kendra will not periodically update the index. You can call the
|
522
526
|
# `StartDataSourceSyncJob` operation to update the index.
|
523
527
|
#
|
524
|
-
#
|
528
|
+
# You can't specify the `Schedule` parameter when the `Type` parameter
|
529
|
+
# is set to `CUSTOM`. If you do, you receive a `ValidationException`
|
530
|
+
# exception.
|
531
|
+
#
|
532
|
+
# @option params [String] :role_arn
|
525
533
|
# The Amazon Resource Name (ARN) of a role with permission to access the
|
526
534
|
# data source. For more information, see [IAM Roles for Amazon
|
527
535
|
# Kendra][1].
|
528
536
|
#
|
537
|
+
# You can't specify the `RoleArn` parameter when the `Type` parameter
|
538
|
+
# is set to `CUSTOM`. If you do, you receive a `ValidationException`
|
539
|
+
# exception.
|
540
|
+
#
|
541
|
+
# The `RoleArn` parameter is required for all other data sources.
|
542
|
+
#
|
529
543
|
#
|
530
544
|
#
|
531
545
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html
|
@@ -535,6 +549,14 @@ module Aws::Kendra
|
|
535
549
|
# the tags to identify and organize your resources and to control access
|
536
550
|
# to resources.
|
537
551
|
#
|
552
|
+
# @option params [String] :client_token
|
553
|
+
# A token that you provide to identify the request to create a data
|
554
|
+
# source. Multiple calls to the `CreateDataSource` operation with the
|
555
|
+
# same client token will create only one data source.
|
556
|
+
#
|
557
|
+
# **A suitable default value is auto-generated.** You should normally
|
558
|
+
# not need to pass this option.**
|
559
|
+
#
|
538
560
|
# @return [Types::CreateDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
539
561
|
#
|
540
562
|
# * {Types::CreateDataSourceResponse#id #id} => String
|
@@ -544,11 +566,12 @@ module Aws::Kendra
|
|
544
566
|
# resp = client.create_data_source({
|
545
567
|
# name: "DataSourceName", # required
|
546
568
|
# index_id: "IndexId", # required
|
547
|
-
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW
|
548
|
-
# configuration: {
|
569
|
+
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE
|
570
|
+
# configuration: {
|
549
571
|
# s3_configuration: {
|
550
572
|
# bucket_name: "S3BucketName", # required
|
551
573
|
# inclusion_prefixes: ["DataSourceInclusionsExclusionsStringsMember"],
|
574
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
552
575
|
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
553
576
|
# documents_metadata_configuration: {
|
554
577
|
# s3_prefix: "S3ObjectKey",
|
@@ -735,16 +758,69 @@ module Aws::Kendra
|
|
735
758
|
# ],
|
736
759
|
# },
|
737
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
|
+
# },
|
738
813
|
# },
|
739
814
|
# description: "Description",
|
740
815
|
# schedule: "ScanSchedule",
|
741
|
-
# role_arn: "RoleArn",
|
816
|
+
# role_arn: "RoleArn",
|
742
817
|
# tags: [
|
743
818
|
# {
|
744
819
|
# key: "TagKey", # required
|
745
820
|
# value: "TagValue", # required
|
746
821
|
# },
|
747
822
|
# ],
|
823
|
+
# client_token: "ClientTokenName",
|
748
824
|
# })
|
749
825
|
#
|
750
826
|
# @example Response structure
|
@@ -789,6 +865,28 @@ module Aws::Kendra
|
|
789
865
|
# to identify and organize your resources and to control access to
|
790
866
|
# resources.
|
791
867
|
#
|
868
|
+
# @option params [String] :file_format
|
869
|
+
# The format of the input file. You can choose between a basic CSV
|
870
|
+
# format, a CSV format that includes customs attributes in a header, and
|
871
|
+
# a JSON format that includes custom attributes.
|
872
|
+
#
|
873
|
+
# The format must match the format of the file stored in the S3 bucket
|
874
|
+
# identified in the `S3Path` parameter.
|
875
|
+
#
|
876
|
+
# For more information, see [Adding questions and answers][1].
|
877
|
+
#
|
878
|
+
#
|
879
|
+
#
|
880
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html
|
881
|
+
#
|
882
|
+
# @option params [String] :client_token
|
883
|
+
# A token that you provide to identify the request to create a FAQ.
|
884
|
+
# Multiple calls to the `CreateFaqRequest` operation with the same
|
885
|
+
# client token will create only one FAQ.
|
886
|
+
#
|
887
|
+
# **A suitable default value is auto-generated.** You should normally
|
888
|
+
# not need to pass this option.**
|
889
|
+
#
|
792
890
|
# @return [Types::CreateFaqResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
793
891
|
#
|
794
892
|
# * {Types::CreateFaqResponse#id #id} => String
|
@@ -810,6 +908,8 @@ module Aws::Kendra
|
|
810
908
|
# value: "TagValue", # required
|
811
909
|
# },
|
812
910
|
# ],
|
911
|
+
# file_format: "CSV", # accepts CSV, CSV_WITH_HEADER, JSON
|
912
|
+
# client_token: "ClientTokenName",
|
813
913
|
# })
|
814
914
|
#
|
815
915
|
# @example Response structure
|
@@ -847,10 +947,10 @@ module Aws::Kendra
|
|
847
947
|
# default is `ENTERPRISE_EDITION`.
|
848
948
|
#
|
849
949
|
# @option params [required, String] :role_arn
|
850
|
-
# An
|
851
|
-
#
|
852
|
-
#
|
853
|
-
# bucket.
|
950
|
+
# An AWS Identity and Access Management (IAM) role that gives Amazon
|
951
|
+
# Kendra permissions to access your Amazon CloudWatch logs and metrics.
|
952
|
+
# This is also the role used when you use the `BatchPutDocument`
|
953
|
+
# operation to index documents from an Amazon S3 bucket.
|
854
954
|
#
|
855
955
|
# @option params [Types::ServerSideEncryptionConfiguration] :server_side_encryption_configuration
|
856
956
|
# The identifier of the AWS KMS customer managed key (CMK) to use to
|
@@ -863,7 +963,7 @@ module Aws::Kendra
|
|
863
963
|
# @option params [String] :client_token
|
864
964
|
# A token that you provide to identify the request to create an index.
|
865
965
|
# Multiple calls to the `CreateIndex` operation with the same client
|
866
|
-
# token will create only one index
|
966
|
+
# token will create only one index.
|
867
967
|
#
|
868
968
|
# **A suitable default value is auto-generated.** You should normally
|
869
969
|
# not need to pass this option.**
|
@@ -1029,10 +1129,12 @@ module Aws::Kendra
|
|
1029
1129
|
# resp.id #=> String
|
1030
1130
|
# resp.index_id #=> String
|
1031
1131
|
# resp.name #=> String
|
1032
|
-
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW"
|
1132
|
+
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE"
|
1033
1133
|
# resp.configuration.s3_configuration.bucket_name #=> String
|
1034
1134
|
# resp.configuration.s3_configuration.inclusion_prefixes #=> Array
|
1035
1135
|
# resp.configuration.s3_configuration.inclusion_prefixes[0] #=> String
|
1136
|
+
# resp.configuration.s3_configuration.inclusion_patterns #=> Array
|
1137
|
+
# resp.configuration.s3_configuration.inclusion_patterns[0] #=> String
|
1036
1138
|
# resp.configuration.s3_configuration.exclusion_patterns #=> Array
|
1037
1139
|
# resp.configuration.s3_configuration.exclusion_patterns[0] #=> String
|
1038
1140
|
# resp.configuration.s3_configuration.documents_metadata_configuration.s3_prefix #=> String
|
@@ -1160,6 +1262,40 @@ module Aws::Kendra
|
|
1160
1262
|
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].data_source_field_name #=> String
|
1161
1263
|
# resp.configuration.service_now_configuration.service_catalog_configuration.field_mappings[0].date_field_format #=> String
|
1162
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
|
1163
1299
|
# resp.created_at #=> Time
|
1164
1300
|
# resp.updated_at #=> Time
|
1165
1301
|
# resp.description #=> String
|
@@ -1197,6 +1333,7 @@ module Aws::Kendra
|
|
1197
1333
|
# * {Types::DescribeFaqResponse#status #status} => String
|
1198
1334
|
# * {Types::DescribeFaqResponse#role_arn #role_arn} => String
|
1199
1335
|
# * {Types::DescribeFaqResponse#error_message #error_message} => String
|
1336
|
+
# * {Types::DescribeFaqResponse#file_format #file_format} => String
|
1200
1337
|
#
|
1201
1338
|
# @example Request syntax with placeholder values
|
1202
1339
|
#
|
@@ -1218,6 +1355,7 @@ module Aws::Kendra
|
|
1218
1355
|
# resp.status #=> String, one of "CREATING", "UPDATING", "ACTIVE", "DELETING", "FAILED"
|
1219
1356
|
# resp.role_arn #=> String
|
1220
1357
|
# resp.error_message #=> String
|
1358
|
+
# resp.file_format #=> String, one of "CSV", "CSV_WITH_HEADER", "JSON"
|
1221
1359
|
#
|
1222
1360
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeFaq AWS API Documentation
|
1223
1361
|
#
|
@@ -1401,7 +1539,7 @@ module Aws::Kendra
|
|
1401
1539
|
# resp.summary_items #=> Array
|
1402
1540
|
# resp.summary_items[0].name #=> String
|
1403
1541
|
# resp.summary_items[0].id #=> String
|
1404
|
-
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW"
|
1542
|
+
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE"
|
1405
1543
|
# resp.summary_items[0].created_at #=> Time
|
1406
1544
|
# resp.summary_items[0].updated_at #=> Time
|
1407
1545
|
# resp.summary_items[0].status #=> String, one of "CREATING", "DELETING", "FAILED", "UPDATING", "ACTIVE"
|
@@ -1452,6 +1590,7 @@ module Aws::Kendra
|
|
1452
1590
|
# resp.faq_summary_items[0].status #=> String, one of "CREATING", "UPDATING", "ACTIVE", "DELETING", "FAILED"
|
1453
1591
|
# resp.faq_summary_items[0].created_at #=> Time
|
1454
1592
|
# resp.faq_summary_items[0].updated_at #=> Time
|
1593
|
+
# resp.faq_summary_items[0].file_format #=> String, one of "CSV", "CSV_WITH_HEADER", "JSON"
|
1455
1594
|
#
|
1456
1595
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListFaqs AWS API Documentation
|
1457
1596
|
#
|
@@ -1983,6 +2122,7 @@ module Aws::Kendra
|
|
1983
2122
|
# s3_configuration: {
|
1984
2123
|
# bucket_name: "S3BucketName", # required
|
1985
2124
|
# inclusion_prefixes: ["DataSourceInclusionsExclusionsStringsMember"],
|
2125
|
+
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1986
2126
|
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1987
2127
|
# documents_metadata_configuration: {
|
1988
2128
|
# s3_prefix: "S3ObjectKey",
|
@@ -2169,6 +2309,58 @@ module Aws::Kendra
|
|
2169
2309
|
# ],
|
2170
2310
|
# },
|
2171
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
|
+
# },
|
2172
2364
|
# },
|
2173
2365
|
# description: "Description",
|
2174
2366
|
# schedule: "ScanSchedule",
|
@@ -2268,7 +2460,7 @@ module Aws::Kendra
|
|
2268
2460
|
params: params,
|
2269
2461
|
config: config)
|
2270
2462
|
context[:gem_name] = 'aws-sdk-kendra'
|
2271
|
-
context[:gem_version] = '1.
|
2463
|
+
context[:gem_version] = '1.17.0'
|
2272
2464
|
Seahorse::Client::Request.new(handlers, context)
|
2273
2465
|
end
|
2274
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')
|
@@ -110,6 +130,7 @@ module Aws::Kendra
|
|
110
130
|
FacetList = Shapes::ListShape.new(name: 'FacetList')
|
111
131
|
FacetResult = Shapes::StructureShape.new(name: 'FacetResult')
|
112
132
|
FacetResultList = Shapes::ListShape.new(name: 'FacetResultList')
|
133
|
+
FaqFileFormat = Shapes::StringShape.new(name: 'FaqFileFormat')
|
113
134
|
FaqId = Shapes::StringShape.new(name: 'FaqId')
|
114
135
|
FaqName = Shapes::StringShape.new(name: 'FaqName')
|
115
136
|
FaqStatistics = Shapes::StructureShape.new(name: 'FaqStatistics')
|
@@ -335,6 +356,65 @@ module Aws::Kendra
|
|
335
356
|
ConflictException.add_member(:message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "Message"))
|
336
357
|
ConflictException.struct_class = Types::ConflictException
|
337
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
|
+
|
338
418
|
ConnectionConfiguration.add_member(:database_host, Shapes::ShapeRef.new(shape: DatabaseHost, required: true, location_name: "DatabaseHost"))
|
339
419
|
ConnectionConfiguration.add_member(:database_port, Shapes::ShapeRef.new(shape: DatabasePort, required: true, location_name: "DatabasePort"))
|
340
420
|
ConnectionConfiguration.add_member(:database_name, Shapes::ShapeRef.new(shape: DatabaseName, required: true, location_name: "DatabaseName"))
|
@@ -345,11 +425,12 @@ module Aws::Kendra
|
|
345
425
|
CreateDataSourceRequest.add_member(:name, Shapes::ShapeRef.new(shape: DataSourceName, required: true, location_name: "Name"))
|
346
426
|
CreateDataSourceRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
|
347
427
|
CreateDataSourceRequest.add_member(:type, Shapes::ShapeRef.new(shape: DataSourceType, required: true, location_name: "Type"))
|
348
|
-
CreateDataSourceRequest.add_member(:configuration, Shapes::ShapeRef.new(shape: DataSourceConfiguration,
|
428
|
+
CreateDataSourceRequest.add_member(:configuration, Shapes::ShapeRef.new(shape: DataSourceConfiguration, location_name: "Configuration"))
|
349
429
|
CreateDataSourceRequest.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
|
350
430
|
CreateDataSourceRequest.add_member(:schedule, Shapes::ShapeRef.new(shape: ScanSchedule, location_name: "Schedule"))
|
351
|
-
CreateDataSourceRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn,
|
431
|
+
CreateDataSourceRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "RoleArn"))
|
352
432
|
CreateDataSourceRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
433
|
+
CreateDataSourceRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientTokenName, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
|
353
434
|
CreateDataSourceRequest.struct_class = Types::CreateDataSourceRequest
|
354
435
|
|
355
436
|
CreateDataSourceResponse.add_member(:id, Shapes::ShapeRef.new(shape: DataSourceId, required: true, location_name: "Id"))
|
@@ -361,6 +442,8 @@ module Aws::Kendra
|
|
361
442
|
CreateFaqRequest.add_member(:s3_path, Shapes::ShapeRef.new(shape: S3Path, required: true, location_name: "S3Path"))
|
362
443
|
CreateFaqRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "RoleArn"))
|
363
444
|
CreateFaqRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
445
|
+
CreateFaqRequest.add_member(:file_format, Shapes::ShapeRef.new(shape: FaqFileFormat, location_name: "FileFormat"))
|
446
|
+
CreateFaqRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientTokenName, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
|
364
447
|
CreateFaqRequest.struct_class = Types::CreateFaqRequest
|
365
448
|
|
366
449
|
CreateFaqResponse.add_member(:id, Shapes::ShapeRef.new(shape: FaqId, location_name: "Id"))
|
@@ -384,6 +467,7 @@ module Aws::Kendra
|
|
384
467
|
DataSourceConfiguration.add_member(:salesforce_configuration, Shapes::ShapeRef.new(shape: SalesforceConfiguration, location_name: "SalesforceConfiguration"))
|
385
468
|
DataSourceConfiguration.add_member(:one_drive_configuration, Shapes::ShapeRef.new(shape: OneDriveConfiguration, location_name: "OneDriveConfiguration"))
|
386
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"))
|
387
471
|
DataSourceConfiguration.struct_class = Types::DataSourceConfiguration
|
388
472
|
|
389
473
|
DataSourceInclusionsExclusionsStrings.member = Shapes::ShapeRef.new(shape: DataSourceInclusionsExclusionsStringsMember)
|
@@ -483,6 +567,7 @@ module Aws::Kendra
|
|
483
567
|
DescribeFaqResponse.add_member(:status, Shapes::ShapeRef.new(shape: FaqStatus, location_name: "Status"))
|
484
568
|
DescribeFaqResponse.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "RoleArn"))
|
485
569
|
DescribeFaqResponse.add_member(:error_message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "ErrorMessage"))
|
570
|
+
DescribeFaqResponse.add_member(:file_format, Shapes::ShapeRef.new(shape: FaqFileFormat, location_name: "FileFormat"))
|
486
571
|
DescribeFaqResponse.struct_class = Types::DescribeFaqResponse
|
487
572
|
|
488
573
|
DescribeIndexRequest.add_member(:id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "Id"))
|
@@ -569,6 +654,7 @@ module Aws::Kendra
|
|
569
654
|
FaqSummary.add_member(:status, Shapes::ShapeRef.new(shape: FaqStatus, location_name: "Status"))
|
570
655
|
FaqSummary.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreatedAt"))
|
571
656
|
FaqSummary.add_member(:updated_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "UpdatedAt"))
|
657
|
+
FaqSummary.add_member(:file_format, Shapes::ShapeRef.new(shape: FaqFileFormat, location_name: "FileFormat"))
|
572
658
|
FaqSummary.struct_class = Types::FaqSummary
|
573
659
|
|
574
660
|
FaqSummaryItems.member = Shapes::ShapeRef.new(shape: FaqSummary)
|
@@ -719,6 +805,7 @@ module Aws::Kendra
|
|
719
805
|
|
720
806
|
S3DataSourceConfiguration.add_member(:bucket_name, Shapes::ShapeRef.new(shape: S3BucketName, required: true, location_name: "BucketName"))
|
721
807
|
S3DataSourceConfiguration.add_member(:inclusion_prefixes, Shapes::ShapeRef.new(shape: DataSourceInclusionsExclusionsStrings, location_name: "InclusionPrefixes"))
|
808
|
+
S3DataSourceConfiguration.add_member(:inclusion_patterns, Shapes::ShapeRef.new(shape: DataSourceInclusionsExclusionsStrings, location_name: "InclusionPatterns"))
|
722
809
|
S3DataSourceConfiguration.add_member(:exclusion_patterns, Shapes::ShapeRef.new(shape: DataSourceInclusionsExclusionsStrings, location_name: "ExclusionPatterns"))
|
723
810
|
S3DataSourceConfiguration.add_member(:documents_metadata_configuration, Shapes::ShapeRef.new(shape: DocumentsMetadataConfiguration, location_name: "DocumentsMetadataConfiguration"))
|
724
811
|
S3DataSourceConfiguration.add_member(:access_control_list_configuration, Shapes::ShapeRef.new(shape: AccessControlListConfiguration, location_name: "AccessControlListConfiguration"))
|