aws-sdk-kendra 1.54.0 → 1.57.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kendra/client.rb +119 -50
- data/lib/aws-sdk-kendra/client_api.rb +15 -0
- data/lib/aws-sdk-kendra/types.rb +306 -61
- data/lib/aws-sdk-kendra.rb +1 -1
- 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: ab3d1034ac88535ac6814f4dbf014787fded06c0d47ecc91d71b0d40d6cda2a6
|
4
|
+
data.tar.gz: '001933a25a070cd620ce4a0586e5cb296b3f6125e481796b653a663ef035d8b3'
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 396670050a9fcf08caa89d0487dd21d118345811e9180fa93c05910ff588406c54f56398bf4c0bae0edf0c471b95bd102071271459aee99f1bc9302b1a18d79a
|
7
|
+
data.tar.gz: 36b9b58b95efb57f124bef8fa3a4d443de02fa203df5c649c3a546b1fa82ba194919894b1e327c49d9c0006b241d01fcae149d85ecb9c6ffec43f73726605e4d
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,21 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.57.0 (2022-08-19)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release adds support for a new authentication type - Personal Access Token (PAT) for confluence server.
|
8
|
+
|
9
|
+
1.56.0 (2022-08-17)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - This release adds Zendesk connector (which allows you to specify Zendesk SAAS platform as data source), Proxy Support for Sharepoint and Confluence Server (which allows you to specify the proxy configuration if proxy is required to connect to your Sharepoint/Confluence Server as data source).
|
13
|
+
|
14
|
+
1.55.0 (2022-07-21)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Amazon Kendra now provides Oauth2 support for SharePoint Online. For more information, see https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html
|
18
|
+
|
4
19
|
1.54.0 (2022-07-14)
|
5
20
|
------------------
|
6
21
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.57.0
|
@@ -830,15 +830,14 @@ module Aws::Kendra
|
|
830
830
|
# control without indexing all of your documents again. For example,
|
831
831
|
# your index contains top-secret company documents that only certain
|
832
832
|
# employees or users should access. One of these users leaves the
|
833
|
-
# company or switches to a team that should be blocked from
|
834
|
-
# top-secret documents.
|
835
|
-
#
|
836
|
-
#
|
837
|
-
#
|
838
|
-
#
|
839
|
-
# the
|
840
|
-
#
|
841
|
-
# change.
|
833
|
+
# company or switches to a team that should be blocked from accessing
|
834
|
+
# top-secret documents. The user still has access to top-secret
|
835
|
+
# documents because the user had access when your documents were
|
836
|
+
# previously indexed. You can create a specific access control
|
837
|
+
# configuration for the user with deny access. You can later update the
|
838
|
+
# access control configuration to allow access if the user returns to
|
839
|
+
# the company and re-joins the 'top-secret' team. You can re-configure
|
840
|
+
# access control for your documents as circumstances change.
|
842
841
|
#
|
843
842
|
# To apply your access control configuration to certain documents, you
|
844
843
|
# call the [BatchPutDocument][1] API with the
|
@@ -933,8 +932,8 @@ module Aws::Kendra
|
|
933
932
|
req.send_request(options)
|
934
933
|
end
|
935
934
|
|
936
|
-
# Creates a data source that you want to use with an Amazon
|
937
|
-
# index.
|
935
|
+
# Creates a data source connector that you want to use with an Amazon
|
936
|
+
# Kendra index.
|
938
937
|
#
|
939
938
|
# You specify a name, data source connector type and description for
|
940
939
|
# your data source. You also specify configuration information for the
|
@@ -959,8 +958,7 @@ module Aws::Kendra
|
|
959
958
|
# [3]: https://docs.aws.amazon.com/kendra/latest/dg/gs-java.html
|
960
959
|
#
|
961
960
|
# @option params [required, String] :name
|
962
|
-
# A
|
963
|
-
# be changed without deleting and recreating the data source connector.
|
961
|
+
# A name for the data source connector.
|
964
962
|
#
|
965
963
|
# @option params [required, String] :index_id
|
966
964
|
# The identifier of the index you want to use with the data source
|
@@ -978,6 +976,15 @@ module Aws::Kendra
|
|
978
976
|
#
|
979
977
|
# The `Configuration` parameter is required for all other data sources.
|
980
978
|
#
|
979
|
+
# @option params [Types::DataSourceVpcConfiguration] :vpc_configuration
|
980
|
+
# Configuration information for an Amazon Virtual Private Cloud to
|
981
|
+
# connect to your data source. For more information, see [Configuring a
|
982
|
+
# VPC][1].
|
983
|
+
#
|
984
|
+
#
|
985
|
+
#
|
986
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
|
987
|
+
#
|
981
988
|
# @option params [String] :description
|
982
989
|
# A description for the data source connector.
|
983
990
|
#
|
@@ -993,8 +1000,8 @@ module Aws::Kendra
|
|
993
1000
|
#
|
994
1001
|
# @option params [String] :role_arn
|
995
1002
|
# The Amazon Resource Name (ARN) of a role with permission to access the
|
996
|
-
# data source
|
997
|
-
# Kendra][1].
|
1003
|
+
# data source and required resources. For more information, see [IAM
|
1004
|
+
# roles for Amazon Kendra][1].
|
998
1005
|
#
|
999
1006
|
# You can't specify the `RoleArn` parameter when the `Type` parameter
|
1000
1007
|
# is set to `CUSTOM`. If you do, you receive a `ValidationException`
|
@@ -1052,7 +1059,7 @@ module Aws::Kendra
|
|
1052
1059
|
# resp = client.create_data_source({
|
1053
1060
|
# name: "DataSourceName", # required
|
1054
1061
|
# index_id: "IndexId", # required
|
1055
|
-
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX, SLACK, BOX, QUIP, JIRA, GITHUB, ALFRESCO
|
1062
|
+
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX, SLACK, BOX, QUIP, JIRA, GITHUB, ALFRESCO, TEMPLATE
|
1056
1063
|
# configuration: {
|
1057
1064
|
# s3_configuration: {
|
1058
1065
|
# bucket_name: "S3BucketName", # required
|
@@ -1091,6 +1098,12 @@ module Aws::Kendra
|
|
1091
1098
|
# bucket: "S3BucketName", # required
|
1092
1099
|
# key: "S3ObjectKey", # required
|
1093
1100
|
# },
|
1101
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
|
1102
|
+
# proxy_configuration: {
|
1103
|
+
# host: "Host", # required
|
1104
|
+
# port: 1, # required
|
1105
|
+
# credentials: "SecretArn",
|
1106
|
+
# },
|
1094
1107
|
# },
|
1095
1108
|
# database_configuration: {
|
1096
1109
|
# database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
|
@@ -1303,6 +1316,12 @@ module Aws::Kendra
|
|
1303
1316
|
# },
|
1304
1317
|
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1305
1318
|
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1319
|
+
# proxy_configuration: {
|
1320
|
+
# host: "Host", # required
|
1321
|
+
# port: 1, # required
|
1322
|
+
# credentials: "SecretArn",
|
1323
|
+
# },
|
1324
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, PAT
|
1306
1325
|
# },
|
1307
1326
|
# google_drive_configuration: {
|
1308
1327
|
# secret_arn: "SecretArn", # required
|
@@ -1666,6 +1685,14 @@ module Aws::Kendra
|
|
1666
1685
|
# security_group_ids: ["VpcSecurityGroupId"], # required
|
1667
1686
|
# },
|
1668
1687
|
# },
|
1688
|
+
# template_configuration: {
|
1689
|
+
# template: {
|
1690
|
+
# },
|
1691
|
+
# },
|
1692
|
+
# },
|
1693
|
+
# vpc_configuration: {
|
1694
|
+
# subnet_ids: ["SubnetId"], # required
|
1695
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
1669
1696
|
# },
|
1670
1697
|
# description: "Description",
|
1671
1698
|
# schedule: "ScanSchedule",
|
@@ -2303,9 +2330,9 @@ module Aws::Kendra
|
|
2303
2330
|
req.send_request(options)
|
2304
2331
|
end
|
2305
2332
|
|
2306
|
-
# Deletes an Amazon Kendra data source. An exception is not
|
2307
|
-
# the data source is already being deleted. While the data
|
2308
|
-
# being deleted, the `Status` field returned by a call to the
|
2333
|
+
# Deletes an Amazon Kendra data source connector. An exception is not
|
2334
|
+
# thrown if the data source is already being deleted. While the data
|
2335
|
+
# source is being deleted, the `Status` field returned by a call to the
|
2309
2336
|
# `DescribeDataSource` API is set to `DELETING`. For more information,
|
2310
2337
|
# see [Deleting Data Sources][1].
|
2311
2338
|
#
|
@@ -2314,10 +2341,10 @@ module Aws::Kendra
|
|
2314
2341
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/delete-data-source.html
|
2315
2342
|
#
|
2316
2343
|
# @option params [required, String] :id
|
2317
|
-
# The identifier of the data source you want to delete.
|
2344
|
+
# The identifier of the data source connector you want to delete.
|
2318
2345
|
#
|
2319
2346
|
# @option params [required, String] :index_id
|
2320
|
-
# The identifier of the index used with the data source.
|
2347
|
+
# The identifier of the index used with the data source connector.
|
2321
2348
|
#
|
2322
2349
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2323
2350
|
#
|
@@ -2607,13 +2634,13 @@ module Aws::Kendra
|
|
2607
2634
|
req.send_request(options)
|
2608
2635
|
end
|
2609
2636
|
|
2610
|
-
# Gets information about an Amazon Kendra data source.
|
2637
|
+
# Gets information about an Amazon Kendra data source connector.
|
2611
2638
|
#
|
2612
2639
|
# @option params [required, String] :id
|
2613
|
-
# The identifier of the data source.
|
2640
|
+
# The identifier of the data source connector.
|
2614
2641
|
#
|
2615
2642
|
# @option params [required, String] :index_id
|
2616
|
-
# The identifier of the index used with the data source.
|
2643
|
+
# The identifier of the index used with the data source connector.
|
2617
2644
|
#
|
2618
2645
|
# @return [Types::DescribeDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2619
2646
|
#
|
@@ -2622,6 +2649,7 @@ module Aws::Kendra
|
|
2622
2649
|
# * {Types::DescribeDataSourceResponse#name #name} => String
|
2623
2650
|
# * {Types::DescribeDataSourceResponse#type #type} => String
|
2624
2651
|
# * {Types::DescribeDataSourceResponse#configuration #configuration} => Types::DataSourceConfiguration
|
2652
|
+
# * {Types::DescribeDataSourceResponse#vpc_configuration #vpc_configuration} => Types::DataSourceVpcConfiguration
|
2625
2653
|
# * {Types::DescribeDataSourceResponse#created_at #created_at} => Time
|
2626
2654
|
# * {Types::DescribeDataSourceResponse#updated_at #updated_at} => Time
|
2627
2655
|
# * {Types::DescribeDataSourceResponse#description #description} => String
|
@@ -2644,7 +2672,7 @@ module Aws::Kendra
|
|
2644
2672
|
# resp.id #=> String
|
2645
2673
|
# resp.index_id #=> String
|
2646
2674
|
# resp.name #=> String
|
2647
|
-
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS", "FSX", "SLACK", "BOX", "QUIP", "JIRA", "GITHUB", "ALFRESCO"
|
2675
|
+
# resp.type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS", "FSX", "SLACK", "BOX", "QUIP", "JIRA", "GITHUB", "ALFRESCO", "TEMPLATE"
|
2648
2676
|
# resp.configuration.s3_configuration.bucket_name #=> String
|
2649
2677
|
# resp.configuration.s3_configuration.inclusion_prefixes #=> Array
|
2650
2678
|
# resp.configuration.s3_configuration.inclusion_prefixes[0] #=> String
|
@@ -2676,6 +2704,10 @@ module Aws::Kendra
|
|
2676
2704
|
# resp.configuration.share_point_configuration.disable_local_groups #=> Boolean
|
2677
2705
|
# resp.configuration.share_point_configuration.ssl_certificate_s3_path.bucket #=> String
|
2678
2706
|
# resp.configuration.share_point_configuration.ssl_certificate_s3_path.key #=> String
|
2707
|
+
# resp.configuration.share_point_configuration.authentication_type #=> String, one of "HTTP_BASIC", "OAUTH2"
|
2708
|
+
# resp.configuration.share_point_configuration.proxy_configuration.host #=> String
|
2709
|
+
# resp.configuration.share_point_configuration.proxy_configuration.port #=> Integer
|
2710
|
+
# resp.configuration.share_point_configuration.proxy_configuration.credentials #=> String
|
2679
2711
|
# resp.configuration.database_configuration.database_engine_type #=> String, one of "RDS_AURORA_MYSQL", "RDS_AURORA_POSTGRESQL", "RDS_MYSQL", "RDS_POSTGRESQL"
|
2680
2712
|
# resp.configuration.database_configuration.connection_configuration.database_host #=> String
|
2681
2713
|
# resp.configuration.database_configuration.connection_configuration.database_port #=> Integer
|
@@ -2817,6 +2849,10 @@ module Aws::Kendra
|
|
2817
2849
|
# resp.configuration.confluence_configuration.inclusion_patterns[0] #=> String
|
2818
2850
|
# resp.configuration.confluence_configuration.exclusion_patterns #=> Array
|
2819
2851
|
# resp.configuration.confluence_configuration.exclusion_patterns[0] #=> String
|
2852
|
+
# resp.configuration.confluence_configuration.proxy_configuration.host #=> String
|
2853
|
+
# resp.configuration.confluence_configuration.proxy_configuration.port #=> Integer
|
2854
|
+
# resp.configuration.confluence_configuration.proxy_configuration.credentials #=> String
|
2855
|
+
# resp.configuration.confluence_configuration.authentication_type #=> String, one of "HTTP_BASIC", "PAT"
|
2820
2856
|
# resp.configuration.google_drive_configuration.secret_arn #=> String
|
2821
2857
|
# resp.configuration.google_drive_configuration.inclusion_patterns #=> Array
|
2822
2858
|
# resp.configuration.google_drive_configuration.inclusion_patterns[0] #=> String
|
@@ -3094,6 +3130,10 @@ module Aws::Kendra
|
|
3094
3130
|
# resp.configuration.alfresco_configuration.vpc_configuration.subnet_ids[0] #=> String
|
3095
3131
|
# resp.configuration.alfresco_configuration.vpc_configuration.security_group_ids #=> Array
|
3096
3132
|
# resp.configuration.alfresco_configuration.vpc_configuration.security_group_ids[0] #=> String
|
3133
|
+
# resp.vpc_configuration.subnet_ids #=> Array
|
3134
|
+
# resp.vpc_configuration.subnet_ids[0] #=> String
|
3135
|
+
# resp.vpc_configuration.security_group_ids #=> Array
|
3136
|
+
# resp.vpc_configuration.security_group_ids[0] #=> String
|
3097
3137
|
# resp.created_at #=> Time
|
3098
3138
|
# resp.updated_at #=> Time
|
3099
3139
|
# resp.description #=> String
|
@@ -3830,7 +3870,7 @@ module Aws::Kendra
|
|
3830
3870
|
# The identifier of the index for the access control configuration.
|
3831
3871
|
#
|
3832
3872
|
# @option params [String] :next_token
|
3833
|
-
# If the previous response was incomplete (because there
|
3873
|
+
# If the previous response was incomplete (because there's more data to
|
3834
3874
|
# retrieve), Amazon Kendra returns a pagination token in the response.
|
3835
3875
|
# You can use this pagination token to retrieve the next set of access
|
3836
3876
|
# control configurations.
|
@@ -3868,13 +3908,13 @@ module Aws::Kendra
|
|
3868
3908
|
req.send_request(options)
|
3869
3909
|
end
|
3870
3910
|
|
3871
|
-
# Gets statistics about synchronizing
|
3911
|
+
# Gets statistics about synchronizing a data source connector.
|
3872
3912
|
#
|
3873
3913
|
# @option params [required, String] :id
|
3874
|
-
# The identifier of the data source.
|
3914
|
+
# The identifier of the data source connector.
|
3875
3915
|
#
|
3876
3916
|
# @option params [required, String] :index_id
|
3877
|
-
# The identifier of the index used with the data source.
|
3917
|
+
# The identifier of the index used with the data source connector.
|
3878
3918
|
#
|
3879
3919
|
# @option params [String] :next_token
|
3880
3920
|
# If the previous response was incomplete (because there is more data to
|
@@ -3891,8 +3931,8 @@ module Aws::Kendra
|
|
3891
3931
|
# limited to jobs between the specified dates.
|
3892
3932
|
#
|
3893
3933
|
# @option params [String] :status_filter
|
3894
|
-
#
|
3895
|
-
#
|
3934
|
+
# Only returns synchronization jobs with the `Status` field equal to the
|
3935
|
+
# specified status.
|
3896
3936
|
#
|
3897
3937
|
# @return [Types::ListDataSourceSyncJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3898
3938
|
#
|
@@ -3941,19 +3981,20 @@ module Aws::Kendra
|
|
3941
3981
|
req.send_request(options)
|
3942
3982
|
end
|
3943
3983
|
|
3944
|
-
# Lists the data
|
3984
|
+
# Lists the data source connectors that you have created.
|
3945
3985
|
#
|
3946
3986
|
# @option params [required, String] :index_id
|
3947
|
-
# The identifier of the index used with one or more data
|
3987
|
+
# The identifier of the index used with one or more data source
|
3988
|
+
# connectors.
|
3948
3989
|
#
|
3949
3990
|
# @option params [String] :next_token
|
3950
3991
|
# If the previous response was incomplete (because there is more data to
|
3951
3992
|
# retrieve), Amazon Kendra returns a pagination token in the response.
|
3952
3993
|
# You can use this pagination token to retrieve the next set of data
|
3953
|
-
#
|
3994
|
+
# source connectors (`DataSourceSummaryItems`).
|
3954
3995
|
#
|
3955
3996
|
# @option params [Integer] :max_results
|
3956
|
-
# The maximum number of data
|
3997
|
+
# The maximum number of data source connectors to return.
|
3957
3998
|
#
|
3958
3999
|
# @return [Types::ListDataSourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3959
4000
|
#
|
@@ -3975,7 +4016,7 @@ module Aws::Kendra
|
|
3975
4016
|
# resp.summary_items #=> Array
|
3976
4017
|
# resp.summary_items[0].name #=> String
|
3977
4018
|
# resp.summary_items[0].id #=> String
|
3978
|
-
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS", "FSX", "SLACK", "BOX", "QUIP", "JIRA", "GITHUB", "ALFRESCO"
|
4019
|
+
# resp.summary_items[0].type #=> String, one of "S3", "SHAREPOINT", "DATABASE", "SALESFORCE", "ONEDRIVE", "SERVICENOW", "CUSTOM", "CONFLUENCE", "GOOGLEDRIVE", "WEBCRAWLER", "WORKDOCS", "FSX", "SLACK", "BOX", "QUIP", "JIRA", "GITHUB", "ALFRESCO", "TEMPLATE"
|
3979
4020
|
# resp.summary_items[0].created_at #=> Time
|
3980
4021
|
# resp.summary_items[0].updated_at #=> Time
|
3981
4022
|
# resp.summary_items[0].status #=> String, one of "CREATING", "DELETING", "FAILED", "UPDATING", "ACTIVE"
|
@@ -4897,15 +4938,15 @@ module Aws::Kendra
|
|
4897
4938
|
req.send_request(options)
|
4898
4939
|
end
|
4899
4940
|
|
4900
|
-
# Starts a synchronization job for a data source. If a
|
4901
|
-
# job is already in progress, Amazon Kendra returns a
|
4941
|
+
# Starts a synchronization job for a data source connector. If a
|
4942
|
+
# synchronization job is already in progress, Amazon Kendra returns a
|
4902
4943
|
# `ResourceInUseException` exception.
|
4903
4944
|
#
|
4904
4945
|
# @option params [required, String] :id
|
4905
|
-
# The identifier of the data source to synchronize.
|
4946
|
+
# The identifier of the data source connector to synchronize.
|
4906
4947
|
#
|
4907
4948
|
# @option params [required, String] :index_id
|
4908
|
-
# The identifier of the index
|
4949
|
+
# The identifier of the index used with the data source connector.
|
4909
4950
|
#
|
4910
4951
|
# @return [Types::StartDataSourceSyncJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4911
4952
|
#
|
@@ -4935,11 +4976,11 @@ module Aws::Kendra
|
|
4935
4976
|
# a scheduled synchronization job.
|
4936
4977
|
#
|
4937
4978
|
# @option params [required, String] :id
|
4938
|
-
# The identifier of the data source for which to stop the
|
4979
|
+
# The identifier of the data source connector for which to stop the
|
4939
4980
|
# synchronization jobs.
|
4940
4981
|
#
|
4941
4982
|
# @option params [required, String] :index_id
|
4942
|
-
# The identifier of the index
|
4983
|
+
# The identifier of the index used with the data source connector.
|
4943
4984
|
#
|
4944
4985
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4945
4986
|
#
|
@@ -5093,7 +5134,7 @@ module Aws::Kendra
|
|
5093
5134
|
# You call the [BatchPutDocument][1] API to apply the updated access
|
5094
5135
|
# control configuration, with the `AccessControlConfigurationId`
|
5095
5136
|
# included in the [Document][2] object. If you use an S3 bucket as a
|
5096
|
-
# data source, you synchronize your data source to apply the
|
5137
|
+
# data source, you synchronize your data source to apply the
|
5097
5138
|
# `AccessControlConfigurationId` in the `.metadata.json` file. Amazon
|
5098
5139
|
# Kendra currently only supports access control configuration for S3
|
5099
5140
|
# data sources and documents indexed using the `BatchPutDocument` API.
|
@@ -5169,14 +5210,13 @@ module Aws::Kendra
|
|
5169
5210
|
req.send_request(options)
|
5170
5211
|
end
|
5171
5212
|
|
5172
|
-
# Updates an existing Amazon Kendra data source.
|
5213
|
+
# Updates an existing Amazon Kendra data source connector.
|
5173
5214
|
#
|
5174
5215
|
# @option params [required, String] :id
|
5175
|
-
# The identifier of the data source you want to update.
|
5216
|
+
# The identifier of the data source connector you want to update.
|
5176
5217
|
#
|
5177
5218
|
# @option params [String] :name
|
5178
|
-
# A new name for the data source connector.
|
5179
|
-
# data source and re-create it to change the name of the data source.
|
5219
|
+
# A new name for the data source connector.
|
5180
5220
|
#
|
5181
5221
|
# @option params [required, String] :index_id
|
5182
5222
|
# The identifier of the index used with the data source connector.
|
@@ -5185,6 +5225,15 @@ module Aws::Kendra
|
|
5185
5225
|
# Configuration information you want to update for the data source
|
5186
5226
|
# connector.
|
5187
5227
|
#
|
5228
|
+
# @option params [Types::DataSourceVpcConfiguration] :vpc_configuration
|
5229
|
+
# Configuration information for an Amazon Virtual Private Cloud to
|
5230
|
+
# connect to your data source. For more information, see [Configuring a
|
5231
|
+
# VPC][1].
|
5232
|
+
#
|
5233
|
+
#
|
5234
|
+
#
|
5235
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
|
5236
|
+
#
|
5188
5237
|
# @option params [String] :description
|
5189
5238
|
# A new description for the data source connector.
|
5190
5239
|
#
|
@@ -5193,8 +5242,8 @@ module Aws::Kendra
|
|
5193
5242
|
#
|
5194
5243
|
# @option params [String] :role_arn
|
5195
5244
|
# The Amazon Resource Name (ARN) of a role with permission to access the
|
5196
|
-
# data source. For more information, see [IAM
|
5197
|
-
# Kendra][1].
|
5245
|
+
# data source and required resources. For more information, see [IAM
|
5246
|
+
# roles for Amazon Kendra][1].
|
5198
5247
|
#
|
5199
5248
|
#
|
5200
5249
|
#
|
@@ -5270,6 +5319,12 @@ module Aws::Kendra
|
|
5270
5319
|
# bucket: "S3BucketName", # required
|
5271
5320
|
# key: "S3ObjectKey", # required
|
5272
5321
|
# },
|
5322
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
|
5323
|
+
# proxy_configuration: {
|
5324
|
+
# host: "Host", # required
|
5325
|
+
# port: 1, # required
|
5326
|
+
# credentials: "SecretArn",
|
5327
|
+
# },
|
5273
5328
|
# },
|
5274
5329
|
# database_configuration: {
|
5275
5330
|
# database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
|
@@ -5482,6 +5537,12 @@ module Aws::Kendra
|
|
5482
5537
|
# },
|
5483
5538
|
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
5484
5539
|
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
5540
|
+
# proxy_configuration: {
|
5541
|
+
# host: "Host", # required
|
5542
|
+
# port: 1, # required
|
5543
|
+
# credentials: "SecretArn",
|
5544
|
+
# },
|
5545
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, PAT
|
5485
5546
|
# },
|
5486
5547
|
# google_drive_configuration: {
|
5487
5548
|
# secret_arn: "SecretArn", # required
|
@@ -5845,6 +5906,14 @@ module Aws::Kendra
|
|
5845
5906
|
# security_group_ids: ["VpcSecurityGroupId"], # required
|
5846
5907
|
# },
|
5847
5908
|
# },
|
5909
|
+
# template_configuration: {
|
5910
|
+
# template: {
|
5911
|
+
# },
|
5912
|
+
# },
|
5913
|
+
# },
|
5914
|
+
# vpc_configuration: {
|
5915
|
+
# subnet_ids: ["SubnetId"], # required
|
5916
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
5848
5917
|
# },
|
5849
5918
|
# description: "Description",
|
5850
5919
|
# schedule: "ScanSchedule",
|
@@ -6318,7 +6387,7 @@ module Aws::Kendra
|
|
6318
6387
|
params: params,
|
6319
6388
|
config: config)
|
6320
6389
|
context[:gem_name] = 'aws-sdk-kendra'
|
6321
|
-
context[:gem_version] = '1.
|
6390
|
+
context[:gem_version] = '1.57.0'
|
6322
6391
|
Seahorse::Client::Request.new(handlers, context)
|
6323
6392
|
end
|
6324
6393
|
|
@@ -68,6 +68,7 @@ module Aws::Kendra
|
|
68
68
|
ConfluenceAttachmentFieldMappingsList = Shapes::ListShape.new(name: 'ConfluenceAttachmentFieldMappingsList')
|
69
69
|
ConfluenceAttachmentFieldName = Shapes::StringShape.new(name: 'ConfluenceAttachmentFieldName')
|
70
70
|
ConfluenceAttachmentToIndexFieldMapping = Shapes::StructureShape.new(name: 'ConfluenceAttachmentToIndexFieldMapping')
|
71
|
+
ConfluenceAuthenticationType = Shapes::StringShape.new(name: 'ConfluenceAuthenticationType')
|
71
72
|
ConfluenceBlogConfiguration = Shapes::StructureShape.new(name: 'ConfluenceBlogConfiguration')
|
72
73
|
ConfluenceBlogFieldMappingsList = Shapes::ListShape.new(name: 'ConfluenceBlogFieldMappingsList')
|
73
74
|
ConfluenceBlogFieldName = Shapes::StringShape.new(name: 'ConfluenceBlogFieldName')
|
@@ -441,6 +442,7 @@ module Aws::Kendra
|
|
441
442
|
ServiceNowServiceCatalogConfiguration = Shapes::StructureShape.new(name: 'ServiceNowServiceCatalogConfiguration')
|
442
443
|
ServiceQuotaExceededException = Shapes::StructureShape.new(name: 'ServiceQuotaExceededException')
|
443
444
|
SharePointConfiguration = Shapes::StructureShape.new(name: 'SharePointConfiguration')
|
445
|
+
SharePointOnlineAuthenticationType = Shapes::StringShape.new(name: 'SharePointOnlineAuthenticationType')
|
444
446
|
SharePointUrlList = Shapes::ListShape.new(name: 'SharePointUrlList')
|
445
447
|
SharePointVersion = Shapes::StringShape.new(name: 'SharePointVersion')
|
446
448
|
SharedDriveId = Shapes::StringShape.new(name: 'SharedDriveId')
|
@@ -489,6 +491,8 @@ module Aws::Kendra
|
|
489
491
|
TagResourceResponse = Shapes::StructureShape.new(name: 'TagResourceResponse')
|
490
492
|
TagValue = Shapes::StringShape.new(name: 'TagValue')
|
491
493
|
TeamId = Shapes::StringShape.new(name: 'TeamId')
|
494
|
+
Template = Shapes::DocumentShape.new(name: 'Template', document: true)
|
495
|
+
TemplateConfiguration = Shapes::StructureShape.new(name: 'TemplateConfiguration')
|
492
496
|
TenantDomain = Shapes::StringShape.new(name: 'TenantDomain')
|
493
497
|
TextDocumentStatistics = Shapes::StructureShape.new(name: 'TextDocumentStatistics')
|
494
498
|
TextWithHighlights = Shapes::StructureShape.new(name: 'TextWithHighlights')
|
@@ -739,6 +743,8 @@ module Aws::Kendra
|
|
739
743
|
ConfluenceConfiguration.add_member(:vpc_configuration, Shapes::ShapeRef.new(shape: DataSourceVpcConfiguration, location_name: "VpcConfiguration"))
|
740
744
|
ConfluenceConfiguration.add_member(:inclusion_patterns, Shapes::ShapeRef.new(shape: DataSourceInclusionsExclusionsStrings, location_name: "InclusionPatterns"))
|
741
745
|
ConfluenceConfiguration.add_member(:exclusion_patterns, Shapes::ShapeRef.new(shape: DataSourceInclusionsExclusionsStrings, location_name: "ExclusionPatterns"))
|
746
|
+
ConfluenceConfiguration.add_member(:proxy_configuration, Shapes::ShapeRef.new(shape: ProxyConfiguration, location_name: "ProxyConfiguration"))
|
747
|
+
ConfluenceConfiguration.add_member(:authentication_type, Shapes::ShapeRef.new(shape: ConfluenceAuthenticationType, location_name: "AuthenticationType"))
|
742
748
|
ConfluenceConfiguration.struct_class = Types::ConfluenceConfiguration
|
743
749
|
|
744
750
|
ConfluencePageConfiguration.add_member(:page_field_mappings, Shapes::ShapeRef.new(shape: ConfluencePageFieldMappingsList, location_name: "PageFieldMappings"))
|
@@ -802,6 +808,7 @@ module Aws::Kendra
|
|
802
808
|
CreateDataSourceRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
|
803
809
|
CreateDataSourceRequest.add_member(:type, Shapes::ShapeRef.new(shape: DataSourceType, required: true, location_name: "Type"))
|
804
810
|
CreateDataSourceRequest.add_member(:configuration, Shapes::ShapeRef.new(shape: DataSourceConfiguration, location_name: "Configuration"))
|
811
|
+
CreateDataSourceRequest.add_member(:vpc_configuration, Shapes::ShapeRef.new(shape: DataSourceVpcConfiguration, location_name: "VpcConfiguration"))
|
805
812
|
CreateDataSourceRequest.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
|
806
813
|
CreateDataSourceRequest.add_member(:schedule, Shapes::ShapeRef.new(shape: ScanSchedule, location_name: "Schedule"))
|
807
814
|
CreateDataSourceRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "RoleArn"))
|
@@ -901,6 +908,7 @@ module Aws::Kendra
|
|
901
908
|
DataSourceConfiguration.add_member(:jira_configuration, Shapes::ShapeRef.new(shape: JiraConfiguration, location_name: "JiraConfiguration"))
|
902
909
|
DataSourceConfiguration.add_member(:git_hub_configuration, Shapes::ShapeRef.new(shape: GitHubConfiguration, location_name: "GitHubConfiguration"))
|
903
910
|
DataSourceConfiguration.add_member(:alfresco_configuration, Shapes::ShapeRef.new(shape: AlfrescoConfiguration, location_name: "AlfrescoConfiguration"))
|
911
|
+
DataSourceConfiguration.add_member(:template_configuration, Shapes::ShapeRef.new(shape: TemplateConfiguration, location_name: "TemplateConfiguration"))
|
904
912
|
DataSourceConfiguration.struct_class = Types::DataSourceConfiguration
|
905
913
|
|
906
914
|
DataSourceGroup.add_member(:group_id, Shapes::ShapeRef.new(shape: PrincipalName, required: true, location_name: "GroupId"))
|
@@ -1023,6 +1031,7 @@ module Aws::Kendra
|
|
1023
1031
|
DescribeDataSourceResponse.add_member(:name, Shapes::ShapeRef.new(shape: DataSourceName, location_name: "Name"))
|
1024
1032
|
DescribeDataSourceResponse.add_member(:type, Shapes::ShapeRef.new(shape: DataSourceType, location_name: "Type"))
|
1025
1033
|
DescribeDataSourceResponse.add_member(:configuration, Shapes::ShapeRef.new(shape: DataSourceConfiguration, location_name: "Configuration"))
|
1034
|
+
DescribeDataSourceResponse.add_member(:vpc_configuration, Shapes::ShapeRef.new(shape: DataSourceVpcConfiguration, location_name: "VpcConfiguration"))
|
1026
1035
|
DescribeDataSourceResponse.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreatedAt"))
|
1027
1036
|
DescribeDataSourceResponse.add_member(:updated_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "UpdatedAt"))
|
1028
1037
|
DescribeDataSourceResponse.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
|
@@ -1901,6 +1910,8 @@ module Aws::Kendra
|
|
1901
1910
|
SharePointConfiguration.add_member(:document_title_field_name, Shapes::ShapeRef.new(shape: DataSourceFieldName, location_name: "DocumentTitleFieldName"))
|
1902
1911
|
SharePointConfiguration.add_member(:disable_local_groups, Shapes::ShapeRef.new(shape: Boolean, location_name: "DisableLocalGroups"))
|
1903
1912
|
SharePointConfiguration.add_member(:ssl_certificate_s3_path, Shapes::ShapeRef.new(shape: S3Path, location_name: "SslCertificateS3Path"))
|
1913
|
+
SharePointConfiguration.add_member(:authentication_type, Shapes::ShapeRef.new(shape: SharePointOnlineAuthenticationType, location_name: "AuthenticationType"))
|
1914
|
+
SharePointConfiguration.add_member(:proxy_configuration, Shapes::ShapeRef.new(shape: ProxyConfiguration, location_name: "ProxyConfiguration"))
|
1904
1915
|
SharePointConfiguration.struct_class = Types::SharePointConfiguration
|
1905
1916
|
|
1906
1917
|
SharePointUrlList.member = Shapes::ShapeRef.new(shape: Url)
|
@@ -2010,6 +2021,9 @@ module Aws::Kendra
|
|
2010
2021
|
|
2011
2022
|
TagResourceResponse.struct_class = Types::TagResourceResponse
|
2012
2023
|
|
2024
|
+
TemplateConfiguration.add_member(:template, Shapes::ShapeRef.new(shape: Template, location_name: "Template"))
|
2025
|
+
TemplateConfiguration.struct_class = Types::TemplateConfiguration
|
2026
|
+
|
2013
2027
|
TextDocumentStatistics.add_member(:indexed_text_documents_count, Shapes::ShapeRef.new(shape: IndexedTextDocumentsCount, required: true, location_name: "IndexedTextDocumentsCount"))
|
2014
2028
|
TextDocumentStatistics.add_member(:indexed_text_bytes, Shapes::ShapeRef.new(shape: IndexedTextBytes, required: true, location_name: "IndexedTextBytes"))
|
2015
2029
|
TextDocumentStatistics.struct_class = Types::TextDocumentStatistics
|
@@ -2054,6 +2068,7 @@ module Aws::Kendra
|
|
2054
2068
|
UpdateDataSourceRequest.add_member(:name, Shapes::ShapeRef.new(shape: DataSourceName, location_name: "Name"))
|
2055
2069
|
UpdateDataSourceRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
|
2056
2070
|
UpdateDataSourceRequest.add_member(:configuration, Shapes::ShapeRef.new(shape: DataSourceConfiguration, location_name: "Configuration"))
|
2071
|
+
UpdateDataSourceRequest.add_member(:vpc_configuration, Shapes::ShapeRef.new(shape: DataSourceVpcConfiguration, location_name: "VpcConfiguration"))
|
2057
2072
|
UpdateDataSourceRequest.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
|
2058
2073
|
UpdateDataSourceRequest.add_member(:schedule, Shapes::ShapeRef.new(shape: ScanSchedule, location_name: "Schedule"))
|
2059
2074
|
UpdateDataSourceRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "RoleArn"))
|
data/lib/aws-sdk-kendra/types.rb
CHANGED
@@ -40,8 +40,7 @@ module Aws::Kendra
|
|
40
40
|
# }
|
41
41
|
#
|
42
42
|
# @!attribute [rw] key_path
|
43
|
-
# Path to the Amazon
|
44
|
-
# files.
|
43
|
+
# Path to the Amazon S3 bucket that contains the ACL files.
|
45
44
|
# @return [String]
|
46
45
|
#
|
47
46
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AccessControlListConfiguration AWS API Documentation
|
@@ -204,7 +203,16 @@ module Aws::Kendra
|
|
204
203
|
#
|
205
204
|
# @!attribute [rw] ssl_certificate_s3_path
|
206
205
|
# The path to the SSL certificate stored in an Amazon S3 bucket. You
|
207
|
-
# use this to connect to Alfresco
|
206
|
+
# use this to connect to Alfresco if you require a secure SSL
|
207
|
+
# connection.
|
208
|
+
#
|
209
|
+
# You can simply generate a self-signed X509 certificate on any
|
210
|
+
# computer using OpenSSL. For an example of using OpenSSL to create an
|
211
|
+
# X509 certificate, see [Create and sign an X509 certificate][1].
|
212
|
+
#
|
213
|
+
#
|
214
|
+
#
|
215
|
+
# [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html
|
208
216
|
# @return [Types::S3Path]
|
209
217
|
#
|
210
218
|
# @!attribute [rw] crawl_system_folders
|
@@ -1876,6 +1884,12 @@ module Aws::Kendra
|
|
1876
1884
|
# },
|
1877
1885
|
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1878
1886
|
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
1887
|
+
# proxy_configuration: {
|
1888
|
+
# host: "Host", # required
|
1889
|
+
# port: 1, # required
|
1890
|
+
# credentials: "SecretArn",
|
1891
|
+
# },
|
1892
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, PAT
|
1879
1893
|
# }
|
1880
1894
|
#
|
1881
1895
|
# @!attribute [rw] server_url
|
@@ -1887,13 +1901,18 @@ module Aws::Kendra
|
|
1887
1901
|
# @!attribute [rw] secret_arn
|
1888
1902
|
# The Amazon Resource Name (ARN) of an Secrets Manager secret that
|
1889
1903
|
# contains the user name and password required to connect to the
|
1890
|
-
# Confluence instance. If you use Confluence
|
1904
|
+
# Confluence instance. If you use Confluence Cloud, you use a
|
1891
1905
|
# generated API token as the password. For more information, see
|
1892
1906
|
# [Using a Confluence data source][1].
|
1893
1907
|
#
|
1908
|
+
# You can also provide authentication credentials in the form of a
|
1909
|
+
# personal access token. For more information, see [Authentication for
|
1910
|
+
# a Confluence data source][2].
|
1911
|
+
#
|
1894
1912
|
#
|
1895
1913
|
#
|
1896
1914
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-confluence.html
|
1915
|
+
# [2]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-confluence.html#confluence-authentication
|
1897
1916
|
# @return [String]
|
1898
1917
|
#
|
1899
1918
|
# @!attribute [rw] version
|
@@ -1947,6 +1966,34 @@ module Aws::Kendra
|
|
1947
1966
|
# index.
|
1948
1967
|
# @return [Array<String>]
|
1949
1968
|
#
|
1969
|
+
# @!attribute [rw] proxy_configuration
|
1970
|
+
# Configuration information to connect to your Confluence URL instance
|
1971
|
+
# via a web proxy. You can use this option for Confluence Server.
|
1972
|
+
#
|
1973
|
+
# You must provide the website host name and port number. For example,
|
1974
|
+
# the host name of *https://a.example.com/page1.html* is
|
1975
|
+
# "a.example.com" and the port is 443, the standard port for HTTPS.
|
1976
|
+
#
|
1977
|
+
# Web proxy credentials are optional and you can use them to connect
|
1978
|
+
# to a web proxy server that requires basic authentication of user
|
1979
|
+
# name and password. To store web proxy credentials, you use a secret
|
1980
|
+
# in Secrets Manager.
|
1981
|
+
#
|
1982
|
+
# It is recommended that you follow best security practices when
|
1983
|
+
# configuring your web proxy. This includes setting up throttling,
|
1984
|
+
# setting up logging and monitoring, and applying security patches on
|
1985
|
+
# a regular basis. If you use your web proxy with multiple data
|
1986
|
+
# sources, sync jobs that occur at the same time could strain the load
|
1987
|
+
# on your proxy. It is recommended you prepare your proxy beforehand
|
1988
|
+
# for any security and load requirements.
|
1989
|
+
# @return [Types::ProxyConfiguration]
|
1990
|
+
#
|
1991
|
+
# @!attribute [rw] authentication_type
|
1992
|
+
# Whether you want to connect to Confluence using basic authentication
|
1993
|
+
# of user name and password, or a personal access token. You can use a
|
1994
|
+
# personal access token for Confluence Server.
|
1995
|
+
# @return [String]
|
1996
|
+
#
|
1950
1997
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConfluenceConfiguration AWS API Documentation
|
1951
1998
|
#
|
1952
1999
|
class ConfluenceConfiguration < Struct.new(
|
@@ -1959,7 +2006,9 @@ module Aws::Kendra
|
|
1959
2006
|
:attachment_configuration,
|
1960
2007
|
:vpc_configuration,
|
1961
2008
|
:inclusion_patterns,
|
1962
|
-
:exclusion_patterns
|
2009
|
+
:exclusion_patterns,
|
2010
|
+
:proxy_configuration,
|
2011
|
+
:authentication_type)
|
1963
2012
|
SENSITIVE = []
|
1964
2013
|
include Aws::Structure
|
1965
2014
|
end
|
@@ -2400,7 +2449,7 @@ module Aws::Kendra
|
|
2400
2449
|
# {
|
2401
2450
|
# name: "DataSourceName", # required
|
2402
2451
|
# index_id: "IndexId", # required
|
2403
|
-
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX, SLACK, BOX, QUIP, JIRA, GITHUB, ALFRESCO
|
2452
|
+
# type: "S3", # required, accepts S3, SHAREPOINT, DATABASE, SALESFORCE, ONEDRIVE, SERVICENOW, CUSTOM, CONFLUENCE, GOOGLEDRIVE, WEBCRAWLER, WORKDOCS, FSX, SLACK, BOX, QUIP, JIRA, GITHUB, ALFRESCO, TEMPLATE
|
2404
2453
|
# configuration: {
|
2405
2454
|
# s3_configuration: {
|
2406
2455
|
# bucket_name: "S3BucketName", # required
|
@@ -2439,6 +2488,12 @@ module Aws::Kendra
|
|
2439
2488
|
# bucket: "S3BucketName", # required
|
2440
2489
|
# key: "S3ObjectKey", # required
|
2441
2490
|
# },
|
2491
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
|
2492
|
+
# proxy_configuration: {
|
2493
|
+
# host: "Host", # required
|
2494
|
+
# port: 1, # required
|
2495
|
+
# credentials: "SecretArn",
|
2496
|
+
# },
|
2442
2497
|
# },
|
2443
2498
|
# database_configuration: {
|
2444
2499
|
# database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
|
@@ -2651,6 +2706,12 @@ module Aws::Kendra
|
|
2651
2706
|
# },
|
2652
2707
|
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2653
2708
|
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
2709
|
+
# proxy_configuration: {
|
2710
|
+
# host: "Host", # required
|
2711
|
+
# port: 1, # required
|
2712
|
+
# credentials: "SecretArn",
|
2713
|
+
# },
|
2714
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, PAT
|
2654
2715
|
# },
|
2655
2716
|
# google_drive_configuration: {
|
2656
2717
|
# secret_arn: "SecretArn", # required
|
@@ -3014,6 +3075,14 @@ module Aws::Kendra
|
|
3014
3075
|
# security_group_ids: ["VpcSecurityGroupId"], # required
|
3015
3076
|
# },
|
3016
3077
|
# },
|
3078
|
+
# template_configuration: {
|
3079
|
+
# template: {
|
3080
|
+
# },
|
3081
|
+
# },
|
3082
|
+
# },
|
3083
|
+
# vpc_configuration: {
|
3084
|
+
# subnet_ids: ["SubnetId"], # required
|
3085
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
3017
3086
|
# },
|
3018
3087
|
# description: "Description",
|
3019
3088
|
# schedule: "ScanSchedule",
|
@@ -3085,9 +3154,7 @@ module Aws::Kendra
|
|
3085
3154
|
# }
|
3086
3155
|
#
|
3087
3156
|
# @!attribute [rw] name
|
3088
|
-
# A
|
3089
|
-
# can't be changed without deleting and recreating the data source
|
3090
|
-
# connector.
|
3157
|
+
# A name for the data source connector.
|
3091
3158
|
# @return [String]
|
3092
3159
|
#
|
3093
3160
|
# @!attribute [rw] index_id
|
@@ -3110,6 +3177,16 @@ module Aws::Kendra
|
|
3110
3177
|
# sources.
|
3111
3178
|
# @return [Types::DataSourceConfiguration]
|
3112
3179
|
#
|
3180
|
+
# @!attribute [rw] vpc_configuration
|
3181
|
+
# Configuration information for an Amazon Virtual Private Cloud to
|
3182
|
+
# connect to your data source. For more information, see [Configuring
|
3183
|
+
# a VPC][1].
|
3184
|
+
#
|
3185
|
+
#
|
3186
|
+
#
|
3187
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
|
3188
|
+
# @return [Types::DataSourceVpcConfiguration]
|
3189
|
+
#
|
3113
3190
|
# @!attribute [rw] description
|
3114
3191
|
# A description for the data source connector.
|
3115
3192
|
# @return [String]
|
@@ -3127,8 +3204,8 @@ module Aws::Kendra
|
|
3127
3204
|
#
|
3128
3205
|
# @!attribute [rw] role_arn
|
3129
3206
|
# The Amazon Resource Name (ARN) of a role with permission to access
|
3130
|
-
# the data source
|
3131
|
-
# Amazon Kendra][1].
|
3207
|
+
# the data source and required resources. For more information, see
|
3208
|
+
# [IAM roles for Amazon Kendra][1].
|
3132
3209
|
#
|
3133
3210
|
# You can't specify the `RoleArn` parameter when the `Type` parameter
|
3134
3211
|
# is set to `CUSTOM`. If you do, you receive a `ValidationException`
|
@@ -3189,6 +3266,7 @@ module Aws::Kendra
|
|
3189
3266
|
:index_id,
|
3190
3267
|
:type,
|
3191
3268
|
:configuration,
|
3269
|
+
:vpc_configuration,
|
3192
3270
|
:description,
|
3193
3271
|
:schedule,
|
3194
3272
|
:role_arn,
|
@@ -3927,6 +4005,12 @@ module Aws::Kendra
|
|
3927
4005
|
# bucket: "S3BucketName", # required
|
3928
4006
|
# key: "S3ObjectKey", # required
|
3929
4007
|
# },
|
4008
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
|
4009
|
+
# proxy_configuration: {
|
4010
|
+
# host: "Host", # required
|
4011
|
+
# port: 1, # required
|
4012
|
+
# credentials: "SecretArn",
|
4013
|
+
# },
|
3930
4014
|
# },
|
3931
4015
|
# database_configuration: {
|
3932
4016
|
# database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
|
@@ -4139,6 +4223,12 @@ module Aws::Kendra
|
|
4139
4223
|
# },
|
4140
4224
|
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
4141
4225
|
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
4226
|
+
# proxy_configuration: {
|
4227
|
+
# host: "Host", # required
|
4228
|
+
# port: 1, # required
|
4229
|
+
# credentials: "SecretArn",
|
4230
|
+
# },
|
4231
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, PAT
|
4142
4232
|
# },
|
4143
4233
|
# google_drive_configuration: {
|
4144
4234
|
# secret_arn: "SecretArn", # required
|
@@ -4502,6 +4592,10 @@ module Aws::Kendra
|
|
4502
4592
|
# security_group_ids: ["VpcSecurityGroupId"], # required
|
4503
4593
|
# },
|
4504
4594
|
# },
|
4595
|
+
# template_configuration: {
|
4596
|
+
# template: {
|
4597
|
+
# },
|
4598
|
+
# },
|
4505
4599
|
# }
|
4506
4600
|
#
|
4507
4601
|
# @!attribute [rw] s3_configuration
|
@@ -4589,6 +4683,11 @@ module Aws::Kendra
|
|
4589
4683
|
# your data source.
|
4590
4684
|
# @return [Types::AlfrescoConfiguration]
|
4591
4685
|
#
|
4686
|
+
# @!attribute [rw] template_configuration
|
4687
|
+
# Provides a template for the configuration information to connect to
|
4688
|
+
# your data source.
|
4689
|
+
# @return [Types::TemplateConfiguration]
|
4690
|
+
#
|
4592
4691
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceConfiguration AWS API Documentation
|
4593
4692
|
#
|
4594
4693
|
class DataSourceConfiguration < Struct.new(
|
@@ -4608,7 +4707,8 @@ module Aws::Kendra
|
|
4608
4707
|
:quip_configuration,
|
4609
4708
|
:jira_configuration,
|
4610
4709
|
:git_hub_configuration,
|
4611
|
-
:alfresco_configuration
|
4710
|
+
:alfresco_configuration,
|
4711
|
+
:template_configuration)
|
4612
4712
|
SENSITIVE = []
|
4613
4713
|
include Aws::Structure
|
4614
4714
|
end
|
@@ -5016,11 +5116,11 @@ module Aws::Kendra
|
|
5016
5116
|
# }
|
5017
5117
|
#
|
5018
5118
|
# @!attribute [rw] id
|
5019
|
-
# The identifier of the data source you want to delete.
|
5119
|
+
# The identifier of the data source connector you want to delete.
|
5020
5120
|
# @return [String]
|
5021
5121
|
#
|
5022
5122
|
# @!attribute [rw] index_id
|
5023
|
-
# The identifier of the index used with the data source.
|
5123
|
+
# The identifier of the index used with the data source connector.
|
5024
5124
|
# @return [String]
|
5025
5125
|
#
|
5026
5126
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteDataSourceRequest AWS API Documentation
|
@@ -5293,11 +5393,11 @@ module Aws::Kendra
|
|
5293
5393
|
# }
|
5294
5394
|
#
|
5295
5395
|
# @!attribute [rw] id
|
5296
|
-
# The identifier of the data source.
|
5396
|
+
# The identifier of the data source connector.
|
5297
5397
|
# @return [String]
|
5298
5398
|
#
|
5299
5399
|
# @!attribute [rw] index_id
|
5300
|
-
# The identifier of the index used with the data source.
|
5400
|
+
# The identifier of the index used with the data source connector.
|
5301
5401
|
# @return [String]
|
5302
5402
|
#
|
5303
5403
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeDataSourceRequest AWS API Documentation
|
@@ -5310,44 +5410,55 @@ module Aws::Kendra
|
|
5310
5410
|
end
|
5311
5411
|
|
5312
5412
|
# @!attribute [rw] id
|
5313
|
-
# The identifier of the data source.
|
5413
|
+
# The identifier of the data source connector.
|
5314
5414
|
# @return [String]
|
5315
5415
|
#
|
5316
5416
|
# @!attribute [rw] index_id
|
5317
|
-
# The identifier of the index
|
5417
|
+
# The identifier of the index used with the data source connector.
|
5318
5418
|
# @return [String]
|
5319
5419
|
#
|
5320
5420
|
# @!attribute [rw] name
|
5321
|
-
# The name
|
5421
|
+
# The name for the data source connector.
|
5322
5422
|
# @return [String]
|
5323
5423
|
#
|
5324
5424
|
# @!attribute [rw] type
|
5325
|
-
# The type of the data source.
|
5425
|
+
# The type of the data source. For example, `SHAREPOINT`.
|
5326
5426
|
# @return [String]
|
5327
5427
|
#
|
5328
5428
|
# @!attribute [rw] configuration
|
5329
|
-
# Configuration details for the data source. This shows how
|
5330
|
-
# source is configured. The configuration options for a data
|
5331
|
-
# depend on the data source provider.
|
5429
|
+
# Configuration details for the data source connector. This shows how
|
5430
|
+
# the data source is configured. The configuration options for a data
|
5431
|
+
# source depend on the data source provider.
|
5332
5432
|
# @return [Types::DataSourceConfiguration]
|
5333
5433
|
#
|
5434
|
+
# @!attribute [rw] vpc_configuration
|
5435
|
+
# Configuration information for an Amazon Virtual Private Cloud to
|
5436
|
+
# connect to your data source. For more information, see [Configuring
|
5437
|
+
# a VPC][1].
|
5438
|
+
#
|
5439
|
+
#
|
5440
|
+
#
|
5441
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
|
5442
|
+
# @return [Types::DataSourceVpcConfiguration]
|
5443
|
+
#
|
5334
5444
|
# @!attribute [rw] created_at
|
5335
|
-
# The Unix timestamp of when the data source was created.
|
5445
|
+
# The Unix timestamp of when the data source connector was created.
|
5336
5446
|
# @return [Time]
|
5337
5447
|
#
|
5338
5448
|
# @!attribute [rw] updated_at
|
5339
|
-
# The Unix timestamp of when the data source was last
|
5449
|
+
# The Unix timestamp of when the data source connector was last
|
5450
|
+
# updated.
|
5340
5451
|
# @return [Time]
|
5341
5452
|
#
|
5342
5453
|
# @!attribute [rw] description
|
5343
|
-
# The description for the data source.
|
5454
|
+
# The description for the data source connector.
|
5344
5455
|
# @return [String]
|
5345
5456
|
#
|
5346
5457
|
# @!attribute [rw] status
|
5347
|
-
# The current status of the data source. When the status is
|
5348
|
-
# the data source is ready to use. When the status is
|
5349
|
-
# `ErrorMessage` field contains the reason that the data
|
5350
|
-
# failed.
|
5458
|
+
# The current status of the data source connector. When the status is
|
5459
|
+
# `ACTIVE` the data source is ready to use. When the status is
|
5460
|
+
# `FAILED`, the `ErrorMessage` field contains the reason that the data
|
5461
|
+
# source failed.
|
5351
5462
|
# @return [String]
|
5352
5463
|
#
|
5353
5464
|
# @!attribute [rw] schedule
|
@@ -5355,8 +5466,8 @@ module Aws::Kendra
|
|
5355
5466
|
# @return [String]
|
5356
5467
|
#
|
5357
5468
|
# @!attribute [rw] role_arn
|
5358
|
-
# The Amazon Resource Name (ARN) of the role
|
5359
|
-
# source
|
5469
|
+
# The Amazon Resource Name (ARN) of the role with permission to access
|
5470
|
+
# the data source and required resources.
|
5360
5471
|
# @return [String]
|
5361
5472
|
#
|
5362
5473
|
# @!attribute [rw] error_message
|
@@ -5399,6 +5510,7 @@ module Aws::Kendra
|
|
5399
5510
|
:name,
|
5400
5511
|
:type,
|
5401
5512
|
:configuration,
|
5513
|
+
:vpc_configuration,
|
5402
5514
|
:created_at,
|
5403
5515
|
:updated_at,
|
5404
5516
|
:description,
|
@@ -8750,7 +8862,7 @@ module Aws::Kendra
|
|
8750
8862
|
# @return [String]
|
8751
8863
|
#
|
8752
8864
|
# @!attribute [rw] next_token
|
8753
|
-
# If the previous response was incomplete (because there
|
8865
|
+
# If the previous response was incomplete (because there's more data
|
8754
8866
|
# to retrieve), Amazon Kendra returns a pagination token in the
|
8755
8867
|
# response. You can use this pagination token to retrieve the next set
|
8756
8868
|
# of access control configurations.
|
@@ -8771,9 +8883,9 @@ module Aws::Kendra
|
|
8771
8883
|
end
|
8772
8884
|
|
8773
8885
|
# @!attribute [rw] next_token
|
8774
|
-
# If the response is truncated, Amazon Kendra returns this token
|
8775
|
-
# you can use in the subsequent request to retrieve the next set
|
8776
|
-
# access control configurations.
|
8886
|
+
# If the response is truncated, Amazon Kendra returns this token,
|
8887
|
+
# which you can use in the subsequent request to retrieve the next set
|
8888
|
+
# of access control configurations.
|
8777
8889
|
# @return [String]
|
8778
8890
|
#
|
8779
8891
|
# @!attribute [rw] access_control_configurations
|
@@ -8805,11 +8917,11 @@ module Aws::Kendra
|
|
8805
8917
|
# }
|
8806
8918
|
#
|
8807
8919
|
# @!attribute [rw] id
|
8808
|
-
# The identifier of the data source.
|
8920
|
+
# The identifier of the data source connector.
|
8809
8921
|
# @return [String]
|
8810
8922
|
#
|
8811
8923
|
# @!attribute [rw] index_id
|
8812
|
-
# The identifier of the index used with the data source.
|
8924
|
+
# The identifier of the index used with the data source connector.
|
8813
8925
|
# @return [String]
|
8814
8926
|
#
|
8815
8927
|
# @!attribute [rw] next_token
|
@@ -8831,8 +8943,8 @@ module Aws::Kendra
|
|
8831
8943
|
# @return [Types::TimeRange]
|
8832
8944
|
#
|
8833
8945
|
# @!attribute [rw] status_filter
|
8834
|
-
#
|
8835
|
-
#
|
8946
|
+
# Only returns synchronization jobs with the `Status` field equal to
|
8947
|
+
# the specified status.
|
8836
8948
|
# @return [String]
|
8837
8949
|
#
|
8838
8950
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourceSyncJobsRequest AWS API Documentation
|
@@ -8849,7 +8961,7 @@ module Aws::Kendra
|
|
8849
8961
|
end
|
8850
8962
|
|
8851
8963
|
# @!attribute [rw] history
|
8852
|
-
# A history of synchronization jobs for the data source.
|
8964
|
+
# A history of synchronization jobs for the data source connector.
|
8853
8965
|
# @return [Array<Types::DataSourceSyncJob>]
|
8854
8966
|
#
|
8855
8967
|
# @!attribute [rw] next_token
|
@@ -8877,18 +8989,19 @@ module Aws::Kendra
|
|
8877
8989
|
# }
|
8878
8990
|
#
|
8879
8991
|
# @!attribute [rw] index_id
|
8880
|
-
# The identifier of the index used with one or more data
|
8992
|
+
# The identifier of the index used with one or more data source
|
8993
|
+
# connectors.
|
8881
8994
|
# @return [String]
|
8882
8995
|
#
|
8883
8996
|
# @!attribute [rw] next_token
|
8884
8997
|
# If the previous response was incomplete (because there is more data
|
8885
8998
|
# to retrieve), Amazon Kendra returns a pagination token in the
|
8886
8999
|
# response. You can use this pagination token to retrieve the next set
|
8887
|
-
# of data
|
9000
|
+
# of data source connectors (`DataSourceSummaryItems`).
|
8888
9001
|
# @return [String]
|
8889
9002
|
#
|
8890
9003
|
# @!attribute [rw] max_results
|
8891
|
-
# The maximum number of data
|
9004
|
+
# The maximum number of data source connectors to return.
|
8892
9005
|
# @return [Integer]
|
8893
9006
|
#
|
8894
9007
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourcesRequest AWS API Documentation
|
@@ -8902,13 +9015,14 @@ module Aws::Kendra
|
|
8902
9015
|
end
|
8903
9016
|
|
8904
9017
|
# @!attribute [rw] summary_items
|
8905
|
-
# An array of summary information for one or more data
|
9018
|
+
# An array of summary information for one or more data source
|
9019
|
+
# connector.
|
8906
9020
|
# @return [Array<Types::DataSourceSummary>]
|
8907
9021
|
#
|
8908
9022
|
# @!attribute [rw] next_token
|
8909
9023
|
# If the response is truncated, Amazon Kendra returns this token that
|
8910
9024
|
# you can use in the subsequent request to retrieve the next set of
|
8911
|
-
# data
|
9025
|
+
# data source connectors.
|
8912
9026
|
# @return [String]
|
8913
9027
|
#
|
8914
9028
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourcesResponse AWS API Documentation
|
@@ -9497,7 +9611,16 @@ module Aws::Kendra
|
|
9497
9611
|
#
|
9498
9612
|
# @!attribute [rw] ssl_certificate_s3_path
|
9499
9613
|
# The path to the SSL certificate stored in an Amazon S3 bucket. You
|
9500
|
-
# use this to connect to GitHub
|
9614
|
+
# use this to connect to GitHub if you require a secure SSL
|
9615
|
+
# connection.
|
9616
|
+
#
|
9617
|
+
# You can simply generate a self-signed X509 certificate on any
|
9618
|
+
# computer using OpenSSL. For an example of using OpenSSL to create an
|
9619
|
+
# X509 certificate, see [Create and sign an X509 certificate][1].
|
9620
|
+
#
|
9621
|
+
#
|
9622
|
+
#
|
9623
|
+
# [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html
|
9501
9624
|
# @return [Types::S3Path]
|
9502
9625
|
#
|
9503
9626
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/OnPremiseConfiguration AWS API Documentation
|
@@ -10367,7 +10490,9 @@ module Aws::Kendra
|
|
10367
10490
|
# }
|
10368
10491
|
#
|
10369
10492
|
# @!attribute [rw] domain
|
10370
|
-
# The Quip site domain.
|
10493
|
+
# The Quip site domain. For example,
|
10494
|
+
# *https://quip-company.quipdomain.com/browse*. The domain in this
|
10495
|
+
# example is "quipdomain".
|
10371
10496
|
# @return [String]
|
10372
10497
|
#
|
10373
10498
|
# @!attribute [rw] secret_arn
|
@@ -10399,7 +10524,11 @@ module Aws::Kendra
|
|
10399
10524
|
# @return [Boolean]
|
10400
10525
|
#
|
10401
10526
|
# @!attribute [rw] folder_ids
|
10402
|
-
# The identifiers of the Quip folders you want to index.
|
10527
|
+
# The identifiers of the Quip folders you want to index. You can find
|
10528
|
+
# the folder ID in your browser URL when you access your folder in
|
10529
|
+
# Quip. For example,
|
10530
|
+
# *https://quip-company.quipdomain.com/zlLuOVNSarTL/folder-name*. The
|
10531
|
+
# folder ID in this example is "zlLuOVNSarTL".
|
10403
10532
|
# @return [Array<String>]
|
10404
10533
|
#
|
10405
10534
|
# @!attribute [rw] thread_field_mappings
|
@@ -11763,6 +11892,12 @@ module Aws::Kendra
|
|
11763
11892
|
# bucket: "S3BucketName", # required
|
11764
11893
|
# key: "S3ObjectKey", # required
|
11765
11894
|
# },
|
11895
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
|
11896
|
+
# proxy_configuration: {
|
11897
|
+
# host: "Host", # required
|
11898
|
+
# port: 1, # required
|
11899
|
+
# credentials: "SecretArn",
|
11900
|
+
# },
|
11766
11901
|
# }
|
11767
11902
|
#
|
11768
11903
|
# @!attribute [rw] share_point_version
|
@@ -11771,7 +11906,7 @@ module Aws::Kendra
|
|
11771
11906
|
#
|
11772
11907
|
# @!attribute [rw] urls
|
11773
11908
|
# The Microsoft SharePoint site URLs for the documents you want to
|
11774
|
-
#
|
11909
|
+
# index.
|
11775
11910
|
# @return [Array<String>]
|
11776
11911
|
#
|
11777
11912
|
# @!attribute [rw] secret_arn
|
@@ -11781,9 +11916,14 @@ module Aws::Kendra
|
|
11781
11916
|
# provide the sever domain name as part of the credentials. For more
|
11782
11917
|
# information, see [Using a Microsoft SharePoint Data Source][1].
|
11783
11918
|
#
|
11919
|
+
# You can also provide OAuth authentication credentials of user name,
|
11920
|
+
# password, client ID, and client secret. For more information, see
|
11921
|
+
# [Authentication for a SharePoint data source][2].
|
11922
|
+
#
|
11784
11923
|
#
|
11785
11924
|
#
|
11786
11925
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html
|
11926
|
+
# [2]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-sharepoint.html#sharepoint-authentication
|
11787
11927
|
# @return [String]
|
11788
11928
|
#
|
11789
11929
|
# @!attribute [rw] crawl_attachments
|
@@ -11853,9 +11993,48 @@ module Aws::Kendra
|
|
11853
11993
|
#
|
11854
11994
|
# @!attribute [rw] ssl_certificate_s3_path
|
11855
11995
|
# The path to the SSL certificate stored in an Amazon S3 bucket. You
|
11856
|
-
# use this to connect to SharePoint
|
11996
|
+
# use this to connect to SharePoint Server if you require a secure SSL
|
11997
|
+
# connection.
|
11998
|
+
#
|
11999
|
+
# You can simply generate a self-signed X509 certificate on any
|
12000
|
+
# computer using OpenSSL. For an example of using OpenSSL to create an
|
12001
|
+
# X509 certificate, see [Create and sign an X509 certificate][1].
|
12002
|
+
#
|
12003
|
+
#
|
12004
|
+
#
|
12005
|
+
# [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html
|
11857
12006
|
# @return [Types::S3Path]
|
11858
12007
|
#
|
12008
|
+
# @!attribute [rw] authentication_type
|
12009
|
+
# Whether you want to connect to SharePoint using basic authentication
|
12010
|
+
# of user name and password, or OAuth authentication of user name,
|
12011
|
+
# password, client ID, and client secret. You can use OAuth
|
12012
|
+
# authentication for SharePoint Online.
|
12013
|
+
# @return [String]
|
12014
|
+
#
|
12015
|
+
# @!attribute [rw] proxy_configuration
|
12016
|
+
# Configuration information to connect to your Microsoft SharePoint
|
12017
|
+
# site URLs via instance via a web proxy. You can use this option for
|
12018
|
+
# SharePoint Server.
|
12019
|
+
#
|
12020
|
+
# You must provide the website host name and port number. For example,
|
12021
|
+
# the host name of *https://a.example.com/page1.html* is
|
12022
|
+
# "a.example.com" and the port is 443, the standard port for HTTPS.
|
12023
|
+
#
|
12024
|
+
# Web proxy credentials are optional and you can use them to connect
|
12025
|
+
# to a web proxy server that requires basic authentication of user
|
12026
|
+
# name and password. To store web proxy credentials, you use a secret
|
12027
|
+
# in Secrets Manager.
|
12028
|
+
#
|
12029
|
+
# It is recommended that you follow best security practices when
|
12030
|
+
# configuring your web proxy. This includes setting up throttling,
|
12031
|
+
# setting up logging and monitoring, and applying security patches on
|
12032
|
+
# a regular basis. If you use your web proxy with multiple data
|
12033
|
+
# sources, sync jobs that occur at the same time could strain the load
|
12034
|
+
# on your proxy. It is recommended you prepare your proxy beforehand
|
12035
|
+
# for any security and load requirements.
|
12036
|
+
# @return [Types::ProxyConfiguration]
|
12037
|
+
#
|
11859
12038
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/SharePointConfiguration AWS API Documentation
|
11860
12039
|
#
|
11861
12040
|
class SharePointConfiguration < Struct.new(
|
@@ -11870,7 +12049,9 @@ module Aws::Kendra
|
|
11870
12049
|
:field_mappings,
|
11871
12050
|
:document_title_field_name,
|
11872
12051
|
:disable_local_groups,
|
11873
|
-
:ssl_certificate_s3_path
|
12052
|
+
:ssl_certificate_s3_path,
|
12053
|
+
:authentication_type,
|
12054
|
+
:proxy_configuration)
|
11874
12055
|
SENSITIVE = []
|
11875
12056
|
include Aws::Structure
|
11876
12057
|
end
|
@@ -12236,11 +12417,11 @@ module Aws::Kendra
|
|
12236
12417
|
# }
|
12237
12418
|
#
|
12238
12419
|
# @!attribute [rw] id
|
12239
|
-
# The identifier of the data source to synchronize.
|
12420
|
+
# The identifier of the data source connector to synchronize.
|
12240
12421
|
# @return [String]
|
12241
12422
|
#
|
12242
12423
|
# @!attribute [rw] index_id
|
12243
|
-
# The identifier of the index
|
12424
|
+
# The identifier of the index used with the data source connector.
|
12244
12425
|
# @return [String]
|
12245
12426
|
#
|
12246
12427
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/StartDataSourceSyncJobRequest AWS API Documentation
|
@@ -12308,12 +12489,12 @@ module Aws::Kendra
|
|
12308
12489
|
# }
|
12309
12490
|
#
|
12310
12491
|
# @!attribute [rw] id
|
12311
|
-
# The identifier of the data source for which to stop the
|
12492
|
+
# The identifier of the data source connector for which to stop the
|
12312
12493
|
# synchronization jobs.
|
12313
12494
|
# @return [String]
|
12314
12495
|
#
|
12315
12496
|
# @!attribute [rw] index_id
|
12316
|
-
# The identifier of the index
|
12497
|
+
# The identifier of the index used with the data source connector.
|
12317
12498
|
# @return [String]
|
12318
12499
|
#
|
12319
12500
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/StopDataSourceSyncJobRequest AWS API Documentation
|
@@ -12524,6 +12705,40 @@ module Aws::Kendra
|
|
12524
12705
|
#
|
12525
12706
|
class TagResourceResponse < Aws::EmptyStructure; end
|
12526
12707
|
|
12708
|
+
# Provides a template for the configuration information to connect to
|
12709
|
+
# your data source.
|
12710
|
+
#
|
12711
|
+
# @note When making an API call, you may pass TemplateConfiguration
|
12712
|
+
# data as a hash:
|
12713
|
+
#
|
12714
|
+
# {
|
12715
|
+
# template: {
|
12716
|
+
# },
|
12717
|
+
# }
|
12718
|
+
#
|
12719
|
+
# @!attribute [rw] template
|
12720
|
+
# The template schema used for the data source.
|
12721
|
+
#
|
12722
|
+
# The following links to the template schema for data sources where
|
12723
|
+
# templates are supported:
|
12724
|
+
#
|
12725
|
+
# * [Zendesk template schema][1]
|
12726
|
+
#
|
12727
|
+
# ^
|
12728
|
+
#
|
12729
|
+
#
|
12730
|
+
#
|
12731
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-zendesk.html#zendesk-template-schema
|
12732
|
+
# @return [Hash,Array,String,Numeric,Boolean]
|
12733
|
+
#
|
12734
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TemplateConfiguration AWS API Documentation
|
12735
|
+
#
|
12736
|
+
class TemplateConfiguration < Struct.new(
|
12737
|
+
:template)
|
12738
|
+
SENSITIVE = []
|
12739
|
+
include Aws::Structure
|
12740
|
+
end
|
12741
|
+
|
12527
12742
|
# Provides information about text documents indexed in an index.
|
12528
12743
|
#
|
12529
12744
|
# @!attribute [rw] indexed_text_documents_count
|
@@ -12790,6 +13005,12 @@ module Aws::Kendra
|
|
12790
13005
|
# bucket: "S3BucketName", # required
|
12791
13006
|
# key: "S3ObjectKey", # required
|
12792
13007
|
# },
|
13008
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, OAUTH2
|
13009
|
+
# proxy_configuration: {
|
13010
|
+
# host: "Host", # required
|
13011
|
+
# port: 1, # required
|
13012
|
+
# credentials: "SecretArn",
|
13013
|
+
# },
|
12793
13014
|
# },
|
12794
13015
|
# database_configuration: {
|
12795
13016
|
# database_engine_type: "RDS_AURORA_MYSQL", # required, accepts RDS_AURORA_MYSQL, RDS_AURORA_POSTGRESQL, RDS_MYSQL, RDS_POSTGRESQL
|
@@ -13002,6 +13223,12 @@ module Aws::Kendra
|
|
13002
13223
|
# },
|
13003
13224
|
# inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
13004
13225
|
# exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
|
13226
|
+
# proxy_configuration: {
|
13227
|
+
# host: "Host", # required
|
13228
|
+
# port: 1, # required
|
13229
|
+
# credentials: "SecretArn",
|
13230
|
+
# },
|
13231
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, PAT
|
13005
13232
|
# },
|
13006
13233
|
# google_drive_configuration: {
|
13007
13234
|
# secret_arn: "SecretArn", # required
|
@@ -13365,6 +13592,14 @@ module Aws::Kendra
|
|
13365
13592
|
# security_group_ids: ["VpcSecurityGroupId"], # required
|
13366
13593
|
# },
|
13367
13594
|
# },
|
13595
|
+
# template_configuration: {
|
13596
|
+
# template: {
|
13597
|
+
# },
|
13598
|
+
# },
|
13599
|
+
# },
|
13600
|
+
# vpc_configuration: {
|
13601
|
+
# subnet_ids: ["SubnetId"], # required
|
13602
|
+
# security_group_ids: ["VpcSecurityGroupId"], # required
|
13368
13603
|
# },
|
13369
13604
|
# description: "Description",
|
13370
13605
|
# schedule: "ScanSchedule",
|
@@ -13429,12 +13664,11 @@ module Aws::Kendra
|
|
13429
13664
|
# }
|
13430
13665
|
#
|
13431
13666
|
# @!attribute [rw] id
|
13432
|
-
# The identifier of the data source you want to update.
|
13667
|
+
# The identifier of the data source connector you want to update.
|
13433
13668
|
# @return [String]
|
13434
13669
|
#
|
13435
13670
|
# @!attribute [rw] name
|
13436
|
-
# A new name for the data source connector.
|
13437
|
-
# data source and re-create it to change the name of the data source.
|
13671
|
+
# A new name for the data source connector.
|
13438
13672
|
# @return [String]
|
13439
13673
|
#
|
13440
13674
|
# @!attribute [rw] index_id
|
@@ -13446,6 +13680,16 @@ module Aws::Kendra
|
|
13446
13680
|
# connector.
|
13447
13681
|
# @return [Types::DataSourceConfiguration]
|
13448
13682
|
#
|
13683
|
+
# @!attribute [rw] vpc_configuration
|
13684
|
+
# Configuration information for an Amazon Virtual Private Cloud to
|
13685
|
+
# connect to your data source. For more information, see [Configuring
|
13686
|
+
# a VPC][1].
|
13687
|
+
#
|
13688
|
+
#
|
13689
|
+
#
|
13690
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/vpc-configuration.html
|
13691
|
+
# @return [Types::DataSourceVpcConfiguration]
|
13692
|
+
#
|
13449
13693
|
# @!attribute [rw] description
|
13450
13694
|
# A new description for the data source connector.
|
13451
13695
|
# @return [String]
|
@@ -13456,8 +13700,8 @@ module Aws::Kendra
|
|
13456
13700
|
#
|
13457
13701
|
# @!attribute [rw] role_arn
|
13458
13702
|
# The Amazon Resource Name (ARN) of a role with permission to access
|
13459
|
-
# the data source. For more information, see
|
13460
|
-
# Kendra][1].
|
13703
|
+
# the data source and required resources. For more information, see
|
13704
|
+
# [IAM roles for Amazon Kendra][1].
|
13461
13705
|
#
|
13462
13706
|
#
|
13463
13707
|
#
|
@@ -13497,6 +13741,7 @@ module Aws::Kendra
|
|
13497
13741
|
:name,
|
13498
13742
|
:index_id,
|
13499
13743
|
:configuration,
|
13744
|
+
:vpc_configuration,
|
13500
13745
|
:description,
|
13501
13746
|
:schedule,
|
13502
13747
|
:role_arn,
|
data/lib/aws-sdk-kendra.rb
CHANGED
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.57.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: 2022-
|
11
|
+
date: 2022-08-19 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|