aws-sdk-kendra 1.56.0 → 1.58.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 +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kendra/client.rb +39 -35
- data/lib/aws-sdk-kendra/client_api.rb +2 -0
- data/lib/aws-sdk-kendra/types.rb +121 -65
- 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: 68ff32b7cf1fb139e0097eb90d3397579e38706df2934e7c6ffc57fbe55152f8
|
4
|
+
data.tar.gz: dacbe47acd24aa07112dee77e763a1b201ff3baa0d38ac636711373384f881ea
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: a6f64a1dbad854b8288702ec5a1e84e391fe4a11bd0919f4dec956b777cbc1a87ab22811a1130d8cf93d54d7d848810cc94ee8e7d3d0a4c3822c09d20e42f174
|
7
|
+
data.tar.gz: 7035b06ed63b1790e5c1fef30a192dd65d1c9bd76882e226a0e777fcfa22e448a3430ef87fff05c7c1e57a364d23d60c7175018fea331ea7d49ca8dbc4d3f649
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,16 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.58.0 (2022-09-13)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release enables our customer to choose the option of Sharepoint 2019 for the on-premise Sharepoint connector.
|
8
|
+
|
9
|
+
1.57.0 (2022-08-19)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - This release adds support for a new authentication type - Personal Access Token (PAT) for confluence server.
|
13
|
+
|
4
14
|
1.56.0 (2022-08-17)
|
5
15
|
------------------
|
6
16
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.58.0
|
@@ -932,8 +932,8 @@ module Aws::Kendra
|
|
932
932
|
req.send_request(options)
|
933
933
|
end
|
934
934
|
|
935
|
-
# Creates a data source that you want to use with an Amazon
|
936
|
-
# index.
|
935
|
+
# Creates a data source connector that you want to use with an Amazon
|
936
|
+
# Kendra index.
|
937
937
|
#
|
938
938
|
# You specify a name, data source connector type and description for
|
939
939
|
# your data source. You also specify configuration information for the
|
@@ -1000,8 +1000,8 @@ module Aws::Kendra
|
|
1000
1000
|
#
|
1001
1001
|
# @option params [String] :role_arn
|
1002
1002
|
# The Amazon Resource Name (ARN) of a role with permission to access the
|
1003
|
-
# data source
|
1004
|
-
# Kendra][1].
|
1003
|
+
# data source and required resources. For more information, see [IAM
|
1004
|
+
# roles for Amazon Kendra][1].
|
1005
1005
|
#
|
1006
1006
|
# You can't specify the `RoleArn` parameter when the `Type` parameter
|
1007
1007
|
# is set to `CUSTOM`. If you do, you receive a `ValidationException`
|
@@ -1074,7 +1074,7 @@ module Aws::Kendra
|
|
1074
1074
|
# },
|
1075
1075
|
# },
|
1076
1076
|
# share_point_configuration: {
|
1077
|
-
# share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE
|
1077
|
+
# share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE, SHAREPOINT_2019
|
1078
1078
|
# urls: ["Url"], # required
|
1079
1079
|
# secret_arn: "SecretArn", # required
|
1080
1080
|
# crawl_attachments: false,
|
@@ -1321,6 +1321,7 @@ module Aws::Kendra
|
|
1321
1321
|
# port: 1, # required
|
1322
1322
|
# credentials: "SecretArn",
|
1323
1323
|
# },
|
1324
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, PAT
|
1324
1325
|
# },
|
1325
1326
|
# google_drive_configuration: {
|
1326
1327
|
# secret_arn: "SecretArn", # required
|
@@ -2329,9 +2330,9 @@ module Aws::Kendra
|
|
2329
2330
|
req.send_request(options)
|
2330
2331
|
end
|
2331
2332
|
|
2332
|
-
# Deletes an Amazon Kendra data source. An exception is not
|
2333
|
-
# the data source is already being deleted. While the data
|
2334
|
-
# 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
|
2335
2336
|
# `DescribeDataSource` API is set to `DELETING`. For more information,
|
2336
2337
|
# see [Deleting Data Sources][1].
|
2337
2338
|
#
|
@@ -2340,10 +2341,10 @@ module Aws::Kendra
|
|
2340
2341
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/delete-data-source.html
|
2341
2342
|
#
|
2342
2343
|
# @option params [required, String] :id
|
2343
|
-
# The identifier of the data source you want to delete.
|
2344
|
+
# The identifier of the data source connector you want to delete.
|
2344
2345
|
#
|
2345
2346
|
# @option params [required, String] :index_id
|
2346
|
-
# The identifier of the index used with the data source.
|
2347
|
+
# The identifier of the index used with the data source connector.
|
2347
2348
|
#
|
2348
2349
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
2349
2350
|
#
|
@@ -2633,13 +2634,13 @@ module Aws::Kendra
|
|
2633
2634
|
req.send_request(options)
|
2634
2635
|
end
|
2635
2636
|
|
2636
|
-
# Gets information about an Amazon Kendra data source.
|
2637
|
+
# Gets information about an Amazon Kendra data source connector.
|
2637
2638
|
#
|
2638
2639
|
# @option params [required, String] :id
|
2639
|
-
# The identifier of the data source.
|
2640
|
+
# The identifier of the data source connector.
|
2640
2641
|
#
|
2641
2642
|
# @option params [required, String] :index_id
|
2642
|
-
# The identifier of the index used with the data source.
|
2643
|
+
# The identifier of the index used with the data source connector.
|
2643
2644
|
#
|
2644
2645
|
# @return [Types::DescribeDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2645
2646
|
#
|
@@ -2681,7 +2682,7 @@ module Aws::Kendra
|
|
2681
2682
|
# resp.configuration.s3_configuration.exclusion_patterns[0] #=> String
|
2682
2683
|
# resp.configuration.s3_configuration.documents_metadata_configuration.s3_prefix #=> String
|
2683
2684
|
# resp.configuration.s3_configuration.access_control_list_configuration.key_path #=> String
|
2684
|
-
# resp.configuration.share_point_configuration.share_point_version #=> String, one of "SHAREPOINT_2013", "SHAREPOINT_2016", "SHAREPOINT_ONLINE"
|
2685
|
+
# resp.configuration.share_point_configuration.share_point_version #=> String, one of "SHAREPOINT_2013", "SHAREPOINT_2016", "SHAREPOINT_ONLINE", "SHAREPOINT_2019"
|
2685
2686
|
# resp.configuration.share_point_configuration.urls #=> Array
|
2686
2687
|
# resp.configuration.share_point_configuration.urls[0] #=> String
|
2687
2688
|
# resp.configuration.share_point_configuration.secret_arn #=> String
|
@@ -2851,6 +2852,7 @@ module Aws::Kendra
|
|
2851
2852
|
# resp.configuration.confluence_configuration.proxy_configuration.host #=> String
|
2852
2853
|
# resp.configuration.confluence_configuration.proxy_configuration.port #=> Integer
|
2853
2854
|
# resp.configuration.confluence_configuration.proxy_configuration.credentials #=> String
|
2855
|
+
# resp.configuration.confluence_configuration.authentication_type #=> String, one of "HTTP_BASIC", "PAT"
|
2854
2856
|
# resp.configuration.google_drive_configuration.secret_arn #=> String
|
2855
2857
|
# resp.configuration.google_drive_configuration.inclusion_patterns #=> Array
|
2856
2858
|
# resp.configuration.google_drive_configuration.inclusion_patterns[0] #=> String
|
@@ -3906,13 +3908,13 @@ module Aws::Kendra
|
|
3906
3908
|
req.send_request(options)
|
3907
3909
|
end
|
3908
3910
|
|
3909
|
-
# Gets statistics about synchronizing
|
3911
|
+
# Gets statistics about synchronizing a data source connector.
|
3910
3912
|
#
|
3911
3913
|
# @option params [required, String] :id
|
3912
|
-
# The identifier of the data source.
|
3914
|
+
# The identifier of the data source connector.
|
3913
3915
|
#
|
3914
3916
|
# @option params [required, String] :index_id
|
3915
|
-
# The identifier of the index used with the data source.
|
3917
|
+
# The identifier of the index used with the data source connector.
|
3916
3918
|
#
|
3917
3919
|
# @option params [String] :next_token
|
3918
3920
|
# If the previous response was incomplete (because there is more data to
|
@@ -3929,8 +3931,8 @@ module Aws::Kendra
|
|
3929
3931
|
# limited to jobs between the specified dates.
|
3930
3932
|
#
|
3931
3933
|
# @option params [String] :status_filter
|
3932
|
-
#
|
3933
|
-
#
|
3934
|
+
# Only returns synchronization jobs with the `Status` field equal to the
|
3935
|
+
# specified status.
|
3934
3936
|
#
|
3935
3937
|
# @return [Types::ListDataSourceSyncJobsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3936
3938
|
#
|
@@ -3979,19 +3981,20 @@ module Aws::Kendra
|
|
3979
3981
|
req.send_request(options)
|
3980
3982
|
end
|
3981
3983
|
|
3982
|
-
# Lists the data
|
3984
|
+
# Lists the data source connectors that you have created.
|
3983
3985
|
#
|
3984
3986
|
# @option params [required, String] :index_id
|
3985
|
-
# 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.
|
3986
3989
|
#
|
3987
3990
|
# @option params [String] :next_token
|
3988
3991
|
# If the previous response was incomplete (because there is more data to
|
3989
3992
|
# retrieve), Amazon Kendra returns a pagination token in the response.
|
3990
3993
|
# You can use this pagination token to retrieve the next set of data
|
3991
|
-
#
|
3994
|
+
# source connectors (`DataSourceSummaryItems`).
|
3992
3995
|
#
|
3993
3996
|
# @option params [Integer] :max_results
|
3994
|
-
# The maximum number of data
|
3997
|
+
# The maximum number of data source connectors to return.
|
3995
3998
|
#
|
3996
3999
|
# @return [Types::ListDataSourcesResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3997
4000
|
#
|
@@ -4935,15 +4938,15 @@ module Aws::Kendra
|
|
4935
4938
|
req.send_request(options)
|
4936
4939
|
end
|
4937
4940
|
|
4938
|
-
# Starts a synchronization job for a data source. If a
|
4939
|
-
# 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
|
4940
4943
|
# `ResourceInUseException` exception.
|
4941
4944
|
#
|
4942
4945
|
# @option params [required, String] :id
|
4943
|
-
# The identifier of the data source to synchronize.
|
4946
|
+
# The identifier of the data source connector to synchronize.
|
4944
4947
|
#
|
4945
4948
|
# @option params [required, String] :index_id
|
4946
|
-
# The identifier of the index
|
4949
|
+
# The identifier of the index used with the data source connector.
|
4947
4950
|
#
|
4948
4951
|
# @return [Types::StartDataSourceSyncJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4949
4952
|
#
|
@@ -4973,11 +4976,11 @@ module Aws::Kendra
|
|
4973
4976
|
# a scheduled synchronization job.
|
4974
4977
|
#
|
4975
4978
|
# @option params [required, String] :id
|
4976
|
-
# The identifier of the data source for which to stop the
|
4979
|
+
# The identifier of the data source connector for which to stop the
|
4977
4980
|
# synchronization jobs.
|
4978
4981
|
#
|
4979
4982
|
# @option params [required, String] :index_id
|
4980
|
-
# The identifier of the index
|
4983
|
+
# The identifier of the index used with the data source connector.
|
4981
4984
|
#
|
4982
4985
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
4983
4986
|
#
|
@@ -5207,10 +5210,10 @@ module Aws::Kendra
|
|
5207
5210
|
req.send_request(options)
|
5208
5211
|
end
|
5209
5212
|
|
5210
|
-
# Updates an existing Amazon Kendra data source.
|
5213
|
+
# Updates an existing Amazon Kendra data source connector.
|
5211
5214
|
#
|
5212
5215
|
# @option params [required, String] :id
|
5213
|
-
# The identifier of the data source you want to update.
|
5216
|
+
# The identifier of the data source connector you want to update.
|
5214
5217
|
#
|
5215
5218
|
# @option params [String] :name
|
5216
5219
|
# A new name for the data source connector.
|
@@ -5239,8 +5242,8 @@ module Aws::Kendra
|
|
5239
5242
|
#
|
5240
5243
|
# @option params [String] :role_arn
|
5241
5244
|
# The Amazon Resource Name (ARN) of a role with permission to access the
|
5242
|
-
# data source. For more information, see [IAM
|
5243
|
-
# Kendra][1].
|
5245
|
+
# data source and required resources. For more information, see [IAM
|
5246
|
+
# roles for Amazon Kendra][1].
|
5244
5247
|
#
|
5245
5248
|
#
|
5246
5249
|
#
|
@@ -5292,7 +5295,7 @@ module Aws::Kendra
|
|
5292
5295
|
# },
|
5293
5296
|
# },
|
5294
5297
|
# share_point_configuration: {
|
5295
|
-
# share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE
|
5298
|
+
# share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE, SHAREPOINT_2019
|
5296
5299
|
# urls: ["Url"], # required
|
5297
5300
|
# secret_arn: "SecretArn", # required
|
5298
5301
|
# crawl_attachments: false,
|
@@ -5539,6 +5542,7 @@ module Aws::Kendra
|
|
5539
5542
|
# port: 1, # required
|
5540
5543
|
# credentials: "SecretArn",
|
5541
5544
|
# },
|
5545
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, PAT
|
5542
5546
|
# },
|
5543
5547
|
# google_drive_configuration: {
|
5544
5548
|
# secret_arn: "SecretArn", # required
|
@@ -6383,7 +6387,7 @@ module Aws::Kendra
|
|
6383
6387
|
params: params,
|
6384
6388
|
config: config)
|
6385
6389
|
context[:gem_name] = 'aws-sdk-kendra'
|
6386
|
-
context[:gem_version] = '1.
|
6390
|
+
context[:gem_version] = '1.58.0'
|
6387
6391
|
Seahorse::Client::Request.new(handlers, context)
|
6388
6392
|
end
|
6389
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')
|
@@ -743,6 +744,7 @@ module Aws::Kendra
|
|
743
744
|
ConfluenceConfiguration.add_member(:inclusion_patterns, Shapes::ShapeRef.new(shape: DataSourceInclusionsExclusionsStrings, location_name: "InclusionPatterns"))
|
744
745
|
ConfluenceConfiguration.add_member(:exclusion_patterns, Shapes::ShapeRef.new(shape: DataSourceInclusionsExclusionsStrings, location_name: "ExclusionPatterns"))
|
745
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"))
|
746
748
|
ConfluenceConfiguration.struct_class = Types::ConfluenceConfiguration
|
747
749
|
|
748
750
|
ConfluencePageConfiguration.add_member(:page_field_mappings, Shapes::ShapeRef.new(shape: ConfluencePageFieldMappingsList, location_name: "PageFieldMappings"))
|
data/lib/aws-sdk-kendra/types.rb
CHANGED
@@ -203,7 +203,16 @@ module Aws::Kendra
|
|
203
203
|
#
|
204
204
|
# @!attribute [rw] ssl_certificate_s3_path
|
205
205
|
# The path to the SSL certificate stored in an Amazon S3 bucket. You
|
206
|
-
# 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
|
207
216
|
# @return [Types::S3Path]
|
208
217
|
#
|
209
218
|
# @!attribute [rw] crawl_system_folders
|
@@ -415,7 +424,8 @@ module Aws::Kendra
|
|
415
424
|
include Aws::Structure
|
416
425
|
end
|
417
426
|
|
418
|
-
# Provides filtering the query results based on document attributes
|
427
|
+
# Provides filtering the query results based on document attributes or
|
428
|
+
# metadata fields.
|
419
429
|
#
|
420
430
|
# When you use the `AndAllFilters` or `OrAllFilters`, filters you can
|
421
431
|
# use 2 layers under the first attribute filter. For example, you can
|
@@ -748,39 +758,44 @@ module Aws::Kendra
|
|
748
758
|
# @return [Types::AttributeFilter]
|
749
759
|
#
|
750
760
|
# @!attribute [rw] equals_to
|
751
|
-
# Performs an equals operation on two document attributes
|
761
|
+
# Performs an equals operation on two document attributes or metadata
|
762
|
+
# fields.
|
752
763
|
# @return [Types::DocumentAttribute]
|
753
764
|
#
|
754
765
|
# @!attribute [rw] contains_all
|
755
766
|
# Returns true when a document contains all of the specified document
|
756
|
-
# attributes. This filter is only applicable to
|
757
|
-
# metadata.
|
767
|
+
# attributes or metadata fields. This filter is only applicable to
|
768
|
+
# `StringListValue` metadata.
|
758
769
|
# @return [Types::DocumentAttribute]
|
759
770
|
#
|
760
771
|
# @!attribute [rw] contains_any
|
761
772
|
# Returns true when a document contains any of the specified document
|
762
|
-
# attributes. This filter is only applicable to
|
763
|
-
# metadata.
|
773
|
+
# attributes or metadata fields. This filter is only applicable to
|
774
|
+
# `StringListValue` metadata.
|
764
775
|
# @return [Types::DocumentAttribute]
|
765
776
|
#
|
766
777
|
# @!attribute [rw] greater_than
|
767
|
-
# Performs a greater than operation on two document attributes
|
768
|
-
# with a document attribute of type `Date` or
|
778
|
+
# Performs a greater than operation on two document attributes or
|
779
|
+
# metadata fields. Use with a document attribute of type `Date` or
|
780
|
+
# `Long`.
|
769
781
|
# @return [Types::DocumentAttribute]
|
770
782
|
#
|
771
783
|
# @!attribute [rw] greater_than_or_equals
|
772
784
|
# Performs a greater or equals than operation on two document
|
773
|
-
# attributes. Use with a document attribute of type
|
785
|
+
# attributes or metadata fields. Use with a document attribute of type
|
786
|
+
# `Date` or `Long`.
|
774
787
|
# @return [Types::DocumentAttribute]
|
775
788
|
#
|
776
789
|
# @!attribute [rw] less_than
|
777
|
-
# Performs a less than operation on two document attributes
|
778
|
-
# a document attribute of type `Date` or
|
790
|
+
# Performs a less than operation on two document attributes or
|
791
|
+
# metadata fields. Use with a document attribute of type `Date` or
|
792
|
+
# `Long`.
|
779
793
|
# @return [Types::DocumentAttribute]
|
780
794
|
#
|
781
795
|
# @!attribute [rw] less_than_or_equals
|
782
|
-
# Performs a less than or equals operation on two document attributes
|
783
|
-
# Use with a document attribute of type `Date` or
|
796
|
+
# Performs a less than or equals operation on two document attributes
|
797
|
+
# or metadata fields. Use with a document attribute of type `Date` or
|
798
|
+
# `Long`.
|
784
799
|
# @return [Types::DocumentAttribute]
|
785
800
|
#
|
786
801
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AttributeFilter AWS API Documentation
|
@@ -1880,6 +1895,7 @@ module Aws::Kendra
|
|
1880
1895
|
# port: 1, # required
|
1881
1896
|
# credentials: "SecretArn",
|
1882
1897
|
# },
|
1898
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, PAT
|
1883
1899
|
# }
|
1884
1900
|
#
|
1885
1901
|
# @!attribute [rw] server_url
|
@@ -1891,13 +1907,18 @@ module Aws::Kendra
|
|
1891
1907
|
# @!attribute [rw] secret_arn
|
1892
1908
|
# The Amazon Resource Name (ARN) of an Secrets Manager secret that
|
1893
1909
|
# contains the user name and password required to connect to the
|
1894
|
-
# Confluence instance. If you use Confluence
|
1910
|
+
# Confluence instance. If you use Confluence Cloud, you use a
|
1895
1911
|
# generated API token as the password. For more information, see
|
1896
1912
|
# [Using a Confluence data source][1].
|
1897
1913
|
#
|
1914
|
+
# You can also provide authentication credentials in the form of a
|
1915
|
+
# personal access token. For more information, see [Authentication for
|
1916
|
+
# a Confluence data source][2].
|
1917
|
+
#
|
1898
1918
|
#
|
1899
1919
|
#
|
1900
1920
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-confluence.html
|
1921
|
+
# [2]: https://docs.aws.amazon.com/kendra/latest/dg/data-source-confluence.html#confluence-authentication
|
1901
1922
|
# @return [String]
|
1902
1923
|
#
|
1903
1924
|
# @!attribute [rw] version
|
@@ -1973,6 +1994,12 @@ module Aws::Kendra
|
|
1973
1994
|
# for any security and load requirements.
|
1974
1995
|
# @return [Types::ProxyConfiguration]
|
1975
1996
|
#
|
1997
|
+
# @!attribute [rw] authentication_type
|
1998
|
+
# Whether you want to connect to Confluence using basic authentication
|
1999
|
+
# of user name and password, or a personal access token. You can use a
|
2000
|
+
# personal access token for Confluence Server.
|
2001
|
+
# @return [String]
|
2002
|
+
#
|
1976
2003
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ConfluenceConfiguration AWS API Documentation
|
1977
2004
|
#
|
1978
2005
|
class ConfluenceConfiguration < Struct.new(
|
@@ -1986,7 +2013,8 @@ module Aws::Kendra
|
|
1986
2013
|
:vpc_configuration,
|
1987
2014
|
:inclusion_patterns,
|
1988
2015
|
:exclusion_patterns,
|
1989
|
-
:proxy_configuration
|
2016
|
+
:proxy_configuration,
|
2017
|
+
:authentication_type)
|
1990
2018
|
SENSITIVE = []
|
1991
2019
|
include Aws::Structure
|
1992
2020
|
end
|
@@ -2442,7 +2470,7 @@ module Aws::Kendra
|
|
2442
2470
|
# },
|
2443
2471
|
# },
|
2444
2472
|
# share_point_configuration: {
|
2445
|
-
# share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE
|
2473
|
+
# share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE, SHAREPOINT_2019
|
2446
2474
|
# urls: ["Url"], # required
|
2447
2475
|
# secret_arn: "SecretArn", # required
|
2448
2476
|
# crawl_attachments: false,
|
@@ -2689,6 +2717,7 @@ module Aws::Kendra
|
|
2689
2717
|
# port: 1, # required
|
2690
2718
|
# credentials: "SecretArn",
|
2691
2719
|
# },
|
2720
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, PAT
|
2692
2721
|
# },
|
2693
2722
|
# google_drive_configuration: {
|
2694
2723
|
# secret_arn: "SecretArn", # required
|
@@ -3181,8 +3210,8 @@ module Aws::Kendra
|
|
3181
3210
|
#
|
3182
3211
|
# @!attribute [rw] role_arn
|
3183
3212
|
# The Amazon Resource Name (ARN) of a role with permission to access
|
3184
|
-
# the data source
|
3185
|
-
# Amazon Kendra][1].
|
3213
|
+
# the data source and required resources. For more information, see
|
3214
|
+
# [IAM roles for Amazon Kendra][1].
|
3186
3215
|
#
|
3187
3216
|
# You can't specify the `RoleArn` parameter when the `Type` parameter
|
3188
3217
|
# is set to `CUSTOM`. If you do, you receive a `ValidationException`
|
@@ -3958,7 +3987,7 @@ module Aws::Kendra
|
|
3958
3987
|
# },
|
3959
3988
|
# },
|
3960
3989
|
# share_point_configuration: {
|
3961
|
-
# share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE
|
3990
|
+
# share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE, SHAREPOINT_2019
|
3962
3991
|
# urls: ["Url"], # required
|
3963
3992
|
# secret_arn: "SecretArn", # required
|
3964
3993
|
# crawl_attachments: false,
|
@@ -4205,6 +4234,7 @@ module Aws::Kendra
|
|
4205
4234
|
# port: 1, # required
|
4206
4235
|
# credentials: "SecretArn",
|
4207
4236
|
# },
|
4237
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, PAT
|
4208
4238
|
# },
|
4209
4239
|
# google_drive_configuration: {
|
4210
4240
|
# secret_arn: "SecretArn", # required
|
@@ -5092,11 +5122,11 @@ module Aws::Kendra
|
|
5092
5122
|
# }
|
5093
5123
|
#
|
5094
5124
|
# @!attribute [rw] id
|
5095
|
-
# The identifier of the data source you want to delete.
|
5125
|
+
# The identifier of the data source connector you want to delete.
|
5096
5126
|
# @return [String]
|
5097
5127
|
#
|
5098
5128
|
# @!attribute [rw] index_id
|
5099
|
-
# The identifier of the index used with the data source.
|
5129
|
+
# The identifier of the index used with the data source connector.
|
5100
5130
|
# @return [String]
|
5101
5131
|
#
|
5102
5132
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeleteDataSourceRequest AWS API Documentation
|
@@ -5369,11 +5399,11 @@ module Aws::Kendra
|
|
5369
5399
|
# }
|
5370
5400
|
#
|
5371
5401
|
# @!attribute [rw] id
|
5372
|
-
# The identifier of the data source.
|
5402
|
+
# The identifier of the data source connector.
|
5373
5403
|
# @return [String]
|
5374
5404
|
#
|
5375
5405
|
# @!attribute [rw] index_id
|
5376
|
-
# The identifier of the index used with the data source.
|
5406
|
+
# The identifier of the index used with the data source connector.
|
5377
5407
|
# @return [String]
|
5378
5408
|
#
|
5379
5409
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeDataSourceRequest AWS API Documentation
|
@@ -5386,25 +5416,25 @@ module Aws::Kendra
|
|
5386
5416
|
end
|
5387
5417
|
|
5388
5418
|
# @!attribute [rw] id
|
5389
|
-
# The identifier of the data source.
|
5419
|
+
# The identifier of the data source connector.
|
5390
5420
|
# @return [String]
|
5391
5421
|
#
|
5392
5422
|
# @!attribute [rw] index_id
|
5393
|
-
# The identifier of the index
|
5423
|
+
# The identifier of the index used with the data source connector.
|
5394
5424
|
# @return [String]
|
5395
5425
|
#
|
5396
5426
|
# @!attribute [rw] name
|
5397
|
-
# The name for the data source.
|
5427
|
+
# The name for the data source connector.
|
5398
5428
|
# @return [String]
|
5399
5429
|
#
|
5400
5430
|
# @!attribute [rw] type
|
5401
|
-
# The type of the data source.
|
5431
|
+
# The type of the data source. For example, `SHAREPOINT`.
|
5402
5432
|
# @return [String]
|
5403
5433
|
#
|
5404
5434
|
# @!attribute [rw] configuration
|
5405
|
-
# Configuration details for the data source. This shows how
|
5406
|
-
# source is configured. The configuration options for a data
|
5407
|
-
# depend on the data source provider.
|
5435
|
+
# Configuration details for the data source connector. This shows how
|
5436
|
+
# the data source is configured. The configuration options for a data
|
5437
|
+
# source depend on the data source provider.
|
5408
5438
|
# @return [Types::DataSourceConfiguration]
|
5409
5439
|
#
|
5410
5440
|
# @!attribute [rw] vpc_configuration
|
@@ -5418,22 +5448,23 @@ module Aws::Kendra
|
|
5418
5448
|
# @return [Types::DataSourceVpcConfiguration]
|
5419
5449
|
#
|
5420
5450
|
# @!attribute [rw] created_at
|
5421
|
-
# The Unix timestamp of when the data source was created.
|
5451
|
+
# The Unix timestamp of when the data source connector was created.
|
5422
5452
|
# @return [Time]
|
5423
5453
|
#
|
5424
5454
|
# @!attribute [rw] updated_at
|
5425
|
-
# The Unix timestamp of when the data source was last
|
5455
|
+
# The Unix timestamp of when the data source connector was last
|
5456
|
+
# updated.
|
5426
5457
|
# @return [Time]
|
5427
5458
|
#
|
5428
5459
|
# @!attribute [rw] description
|
5429
|
-
# The description for the data source.
|
5460
|
+
# The description for the data source connector.
|
5430
5461
|
# @return [String]
|
5431
5462
|
#
|
5432
5463
|
# @!attribute [rw] status
|
5433
|
-
# The current status of the data source. When the status is
|
5434
|
-
# the data source is ready to use. When the status is
|
5435
|
-
# `ErrorMessage` field contains the reason that the data
|
5436
|
-
# failed.
|
5464
|
+
# The current status of the data source connector. When the status is
|
5465
|
+
# `ACTIVE` the data source is ready to use. When the status is
|
5466
|
+
# `FAILED`, the `ErrorMessage` field contains the reason that the data
|
5467
|
+
# source failed.
|
5437
5468
|
# @return [String]
|
5438
5469
|
#
|
5439
5470
|
# @!attribute [rw] schedule
|
@@ -5441,8 +5472,8 @@ module Aws::Kendra
|
|
5441
5472
|
# @return [String]
|
5442
5473
|
#
|
5443
5474
|
# @!attribute [rw] role_arn
|
5444
|
-
# The Amazon Resource Name (ARN) of the role
|
5445
|
-
# source
|
5475
|
+
# The Amazon Resource Name (ARN) of the role with permission to access
|
5476
|
+
# the data source and required resources.
|
5446
5477
|
# @return [String]
|
5447
5478
|
#
|
5448
5479
|
# @!attribute [rw] error_message
|
@@ -8892,11 +8923,11 @@ module Aws::Kendra
|
|
8892
8923
|
# }
|
8893
8924
|
#
|
8894
8925
|
# @!attribute [rw] id
|
8895
|
-
# The identifier of the data source.
|
8926
|
+
# The identifier of the data source connector.
|
8896
8927
|
# @return [String]
|
8897
8928
|
#
|
8898
8929
|
# @!attribute [rw] index_id
|
8899
|
-
# The identifier of the index used with the data source.
|
8930
|
+
# The identifier of the index used with the data source connector.
|
8900
8931
|
# @return [String]
|
8901
8932
|
#
|
8902
8933
|
# @!attribute [rw] next_token
|
@@ -8918,8 +8949,8 @@ module Aws::Kendra
|
|
8918
8949
|
# @return [Types::TimeRange]
|
8919
8950
|
#
|
8920
8951
|
# @!attribute [rw] status_filter
|
8921
|
-
#
|
8922
|
-
#
|
8952
|
+
# Only returns synchronization jobs with the `Status` field equal to
|
8953
|
+
# the specified status.
|
8923
8954
|
# @return [String]
|
8924
8955
|
#
|
8925
8956
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourceSyncJobsRequest AWS API Documentation
|
@@ -8936,7 +8967,7 @@ module Aws::Kendra
|
|
8936
8967
|
end
|
8937
8968
|
|
8938
8969
|
# @!attribute [rw] history
|
8939
|
-
# A history of synchronization jobs for the data source.
|
8970
|
+
# A history of synchronization jobs for the data source connector.
|
8940
8971
|
# @return [Array<Types::DataSourceSyncJob>]
|
8941
8972
|
#
|
8942
8973
|
# @!attribute [rw] next_token
|
@@ -8964,18 +8995,19 @@ module Aws::Kendra
|
|
8964
8995
|
# }
|
8965
8996
|
#
|
8966
8997
|
# @!attribute [rw] index_id
|
8967
|
-
# The identifier of the index used with one or more data
|
8998
|
+
# The identifier of the index used with one or more data source
|
8999
|
+
# connectors.
|
8968
9000
|
# @return [String]
|
8969
9001
|
#
|
8970
9002
|
# @!attribute [rw] next_token
|
8971
9003
|
# If the previous response was incomplete (because there is more data
|
8972
9004
|
# to retrieve), Amazon Kendra returns a pagination token in the
|
8973
9005
|
# response. You can use this pagination token to retrieve the next set
|
8974
|
-
# of data
|
9006
|
+
# of data source connectors (`DataSourceSummaryItems`).
|
8975
9007
|
# @return [String]
|
8976
9008
|
#
|
8977
9009
|
# @!attribute [rw] max_results
|
8978
|
-
# The maximum number of data
|
9010
|
+
# The maximum number of data source connectors to return.
|
8979
9011
|
# @return [Integer]
|
8980
9012
|
#
|
8981
9013
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourcesRequest AWS API Documentation
|
@@ -8989,13 +9021,14 @@ module Aws::Kendra
|
|
8989
9021
|
end
|
8990
9022
|
|
8991
9023
|
# @!attribute [rw] summary_items
|
8992
|
-
# An array of summary information for one or more data
|
9024
|
+
# An array of summary information for one or more data source
|
9025
|
+
# connector.
|
8993
9026
|
# @return [Array<Types::DataSourceSummary>]
|
8994
9027
|
#
|
8995
9028
|
# @!attribute [rw] next_token
|
8996
9029
|
# If the response is truncated, Amazon Kendra returns this token that
|
8997
9030
|
# you can use in the subsequent request to retrieve the next set of
|
8998
|
-
# data
|
9031
|
+
# data source connectors.
|
8999
9032
|
# @return [String]
|
9000
9033
|
#
|
9001
9034
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourcesResponse AWS API Documentation
|
@@ -9584,7 +9617,16 @@ module Aws::Kendra
|
|
9584
9617
|
#
|
9585
9618
|
# @!attribute [rw] ssl_certificate_s3_path
|
9586
9619
|
# The path to the SSL certificate stored in an Amazon S3 bucket. You
|
9587
|
-
# use this to connect to GitHub
|
9620
|
+
# use this to connect to GitHub if you require a secure SSL
|
9621
|
+
# connection.
|
9622
|
+
#
|
9623
|
+
# You can simply generate a self-signed X509 certificate on any
|
9624
|
+
# computer using OpenSSL. For an example of using OpenSSL to create an
|
9625
|
+
# X509 certificate, see [Create and sign an X509 certificate][1].
|
9626
|
+
#
|
9627
|
+
#
|
9628
|
+
#
|
9629
|
+
# [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html
|
9588
9630
|
# @return [Types::S3Path]
|
9589
9631
|
#
|
9590
9632
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/OnPremiseConfiguration AWS API Documentation
|
@@ -10454,7 +10496,9 @@ module Aws::Kendra
|
|
10454
10496
|
# }
|
10455
10497
|
#
|
10456
10498
|
# @!attribute [rw] domain
|
10457
|
-
# The Quip site domain.
|
10499
|
+
# The Quip site domain. For example,
|
10500
|
+
# *https://quip-company.quipdomain.com/browse*. The domain in this
|
10501
|
+
# example is "quipdomain".
|
10458
10502
|
# @return [String]
|
10459
10503
|
#
|
10460
10504
|
# @!attribute [rw] secret_arn
|
@@ -10487,8 +10531,10 @@ module Aws::Kendra
|
|
10487
10531
|
#
|
10488
10532
|
# @!attribute [rw] folder_ids
|
10489
10533
|
# The identifiers of the Quip folders you want to index. You can find
|
10490
|
-
# in your browser URL when you access your folder in
|
10491
|
-
# example,
|
10534
|
+
# the folder ID in your browser URL when you access your folder in
|
10535
|
+
# Quip. For example,
|
10536
|
+
# *https://quip-company.quipdomain.com/zlLuOVNSarTL/folder-name*. The
|
10537
|
+
# folder ID in this example is "zlLuOVNSarTL".
|
10492
10538
|
# @return [Array<String>]
|
10493
10539
|
#
|
10494
10540
|
# @!attribute [rw] thread_field_mappings
|
@@ -11828,7 +11874,7 @@ module Aws::Kendra
|
|
11828
11874
|
# data as a hash:
|
11829
11875
|
#
|
11830
11876
|
# {
|
11831
|
-
# share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE
|
11877
|
+
# share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE, SHAREPOINT_2019
|
11832
11878
|
# urls: ["Url"], # required
|
11833
11879
|
# secret_arn: "SecretArn", # required
|
11834
11880
|
# crawl_attachments: false,
|
@@ -11866,7 +11912,7 @@ module Aws::Kendra
|
|
11866
11912
|
#
|
11867
11913
|
# @!attribute [rw] urls
|
11868
11914
|
# The Microsoft SharePoint site URLs for the documents you want to
|
11869
|
-
#
|
11915
|
+
# index.
|
11870
11916
|
# @return [Array<String>]
|
11871
11917
|
#
|
11872
11918
|
# @!attribute [rw] secret_arn
|
@@ -11953,7 +11999,16 @@ module Aws::Kendra
|
|
11953
11999
|
#
|
11954
12000
|
# @!attribute [rw] ssl_certificate_s3_path
|
11955
12001
|
# The path to the SSL certificate stored in an Amazon S3 bucket. You
|
11956
|
-
# use this to connect to SharePoint
|
12002
|
+
# use this to connect to SharePoint Server if you require a secure SSL
|
12003
|
+
# connection.
|
12004
|
+
#
|
12005
|
+
# You can simply generate a self-signed X509 certificate on any
|
12006
|
+
# computer using OpenSSL. For an example of using OpenSSL to create an
|
12007
|
+
# X509 certificate, see [Create and sign an X509 certificate][1].
|
12008
|
+
#
|
12009
|
+
#
|
12010
|
+
#
|
12011
|
+
# [1]: https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/configuring-https-ssl.html
|
11957
12012
|
# @return [Types::S3Path]
|
11958
12013
|
#
|
11959
12014
|
# @!attribute [rw] authentication_type
|
@@ -12368,11 +12423,11 @@ module Aws::Kendra
|
|
12368
12423
|
# }
|
12369
12424
|
#
|
12370
12425
|
# @!attribute [rw] id
|
12371
|
-
# The identifier of the data source to synchronize.
|
12426
|
+
# The identifier of the data source connector to synchronize.
|
12372
12427
|
# @return [String]
|
12373
12428
|
#
|
12374
12429
|
# @!attribute [rw] index_id
|
12375
|
-
# The identifier of the index
|
12430
|
+
# The identifier of the index used with the data source connector.
|
12376
12431
|
# @return [String]
|
12377
12432
|
#
|
12378
12433
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/StartDataSourceSyncJobRequest AWS API Documentation
|
@@ -12440,12 +12495,12 @@ module Aws::Kendra
|
|
12440
12495
|
# }
|
12441
12496
|
#
|
12442
12497
|
# @!attribute [rw] id
|
12443
|
-
# The identifier of the data source for which to stop the
|
12498
|
+
# The identifier of the data source connector for which to stop the
|
12444
12499
|
# synchronization jobs.
|
12445
12500
|
# @return [String]
|
12446
12501
|
#
|
12447
12502
|
# @!attribute [rw] index_id
|
12448
|
-
# The identifier of the index
|
12503
|
+
# The identifier of the index used with the data source connector.
|
12449
12504
|
# @return [String]
|
12450
12505
|
#
|
12451
12506
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/StopDataSourceSyncJobRequest AWS API Documentation
|
@@ -12932,7 +12987,7 @@ module Aws::Kendra
|
|
12932
12987
|
# },
|
12933
12988
|
# },
|
12934
12989
|
# share_point_configuration: {
|
12935
|
-
# share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE
|
12990
|
+
# share_point_version: "SHAREPOINT_2013", # required, accepts SHAREPOINT_2013, SHAREPOINT_2016, SHAREPOINT_ONLINE, SHAREPOINT_2019
|
12936
12991
|
# urls: ["Url"], # required
|
12937
12992
|
# secret_arn: "SecretArn", # required
|
12938
12993
|
# crawl_attachments: false,
|
@@ -13179,6 +13234,7 @@ module Aws::Kendra
|
|
13179
13234
|
# port: 1, # required
|
13180
13235
|
# credentials: "SecretArn",
|
13181
13236
|
# },
|
13237
|
+
# authentication_type: "HTTP_BASIC", # accepts HTTP_BASIC, PAT
|
13182
13238
|
# },
|
13183
13239
|
# google_drive_configuration: {
|
13184
13240
|
# secret_arn: "SecretArn", # required
|
@@ -13614,7 +13670,7 @@ module Aws::Kendra
|
|
13614
13670
|
# }
|
13615
13671
|
#
|
13616
13672
|
# @!attribute [rw] id
|
13617
|
-
# The identifier of the data source you want to update.
|
13673
|
+
# The identifier of the data source connector you want to update.
|
13618
13674
|
# @return [String]
|
13619
13675
|
#
|
13620
13676
|
# @!attribute [rw] name
|
@@ -13650,8 +13706,8 @@ module Aws::Kendra
|
|
13650
13706
|
#
|
13651
13707
|
# @!attribute [rw] role_arn
|
13652
13708
|
# The Amazon Resource Name (ARN) of a role with permission to access
|
13653
|
-
# the data source. For more information, see
|
13654
|
-
# Kendra][1].
|
13709
|
+
# the data source and required resources. For more information, see
|
13710
|
+
# [IAM roles for Amazon Kendra][1].
|
13655
13711
|
#
|
13656
13712
|
#
|
13657
13713
|
#
|
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.58.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-09-13 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|