aws-sdk-kendra 1.2.0 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: cf57702e6f3f79252d984a801f7fd4d29a86783a
4
- data.tar.gz: 656f6e43c1523631091bf5e4cbbce6a5405e0d05
3
+ metadata.gz: 573019697bbbb6b5e6a336f63c2f1311b6124b7c
4
+ data.tar.gz: 45b456f4b21752b1dff8cb9be29edb755bc58d1c
5
5
  SHA512:
6
- metadata.gz: f97eb2bac40be59a7b70a5ca7aa711d599b4ec5ee0eebcb7f9338e726facded7b8e2aaf8f0108b085c26d96a3414c3389f84e481fd3d912bc5e5f0452006e98a
7
- data.tar.gz: 86fff246f96d673ff753dabd52d72df7e42c96136d6122bee5fe04466d8cfb7559ae25d252c63c131b07e862e4a27e1c2dbbf714d32558448c1921aff1e2402c
6
+ metadata.gz: a318c8a73060683e5f9f118e75d574389d81305eed9fa8aa45a719bd2da994c020c8f6b0297be382c7d1526150a2495616761bfc658aa64844ade1c2d34daa43
7
+ data.tar.gz: c0083167e661fc2fd35e1fd6ee0bd0e45e36c82bf940b5d63750192b6d5981d0602191452ac65a09eb401f40f2b2b5baa1c55a1a44007e172f235ebcc689c59f
@@ -45,6 +45,6 @@ require_relative 'aws-sdk-kendra/customizations'
45
45
  # @service
46
46
  module Aws::Kendra
47
47
 
48
- GEM_VERSION = '1.2.0'
48
+ GEM_VERSION = '1.3.0'
49
49
 
50
50
  end
@@ -32,11 +32,11 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:kendra)
32
32
  module Aws::Kendra
33
33
  # An API client for Kendra. To construct a client, you need to configure a `:region` and `:credentials`.
34
34
  #
35
- # client = Aws::Kendra::Client.new(
36
- # region: region_name,
37
- # credentials: credentials,
38
- # # ...
39
- # )
35
+ # client = Aws::Kendra::Client.new(
36
+ # region: region_name,
37
+ # credentials: credentials,
38
+ # # ...
39
+ # )
40
40
  #
41
41
  # For details on configuring region and credentials see
42
42
  # the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
@@ -229,15 +229,19 @@ module Aws::Kendra
229
229
  #
230
230
  # @option options [String] :retry_mode ("legacy")
231
231
  # Specifies which retry algorithm to use. Values are:
232
- # * `legacy` - The pre-existing retry behavior. This is default value if
233
- # no retry mode is provided.
234
- # * `standard` - A standardized set of retry rules across the AWS SDKs.
235
- # This includes support for retry quotas, which limit the number of
236
- # unsuccessful retries a client can make.
237
- # * `adaptive` - An experimental retry mode that includes all the
238
- # functionality of `standard` mode along with automatic client side
239
- # throttling. This is a provisional mode that may change behavior
240
- # in the future.
232
+ #
233
+ # * `legacy` - The pre-existing retry behavior. This is default value if
234
+ # no retry mode is provided.
235
+ #
236
+ # * `standard` - A standardized set of retry rules across the AWS SDKs.
237
+ # This includes support for retry quotas, which limit the number of
238
+ # unsuccessful retries a client can make.
239
+ #
240
+ # * `adaptive` - An experimental retry mode that includes all the
241
+ # functionality of `standard` mode along with automatic client side
242
+ # throttling. This is a provisional mode that may change behavior
243
+ # in the future.
244
+ #
241
245
  #
242
246
  # @option options [String] :secret_access_key
243
247
  #
@@ -275,8 +279,7 @@ module Aws::Kendra
275
279
  #
276
280
  # @option options [Integer] :http_read_timeout (60) The default
277
281
  # number of seconds to wait for response data. This value can
278
- # safely be set
279
- # per-request on the session yielded by {#session_for}.
282
+ # safely be set per-request on the session.
280
283
  #
281
284
  # @option options [Float] :http_idle_timeout (5) The number of
282
285
  # seconds a connection is allowed to sit idle before it is
@@ -288,7 +291,7 @@ module Aws::Kendra
288
291
  # request body. This option has no effect unless the request has
289
292
  # "Expect" header set to "100-continue". Defaults to `nil` which
290
293
  # disables this behaviour. This value can safely be set per
291
- # request on the session yielded by {#session_for}.
294
+ # request on the session.
292
295
  #
293
296
  # @option options [Boolean] :http_wire_trace (false) When `true`,
294
297
  # HTTP debug output will be sent to the `:logger`.
@@ -516,6 +519,9 @@ module Aws::Kendra
516
519
  # urls: ["Url"], # required
517
520
  # secret_arn: "SecretArn", # required
518
521
  # crawl_attachments: false,
522
+ # use_change_log: false,
523
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
524
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
519
525
  # vpc_configuration: {
520
526
  # subnet_ids: ["SubnetId"], # required
521
527
  # security_group_ids: ["VpcSecurityGroupId"], # required
@@ -657,6 +663,14 @@ module Aws::Kendra
657
663
  # @option params [String] :description
658
664
  # A description for the index.
659
665
  #
666
+ # @option params [String] :client_token
667
+ # A token that you provide to identify the request to create an index.
668
+ # Multiple calls to the `CreateIndex` operation with the same client
669
+ # token will create only one index.”
670
+ #
671
+ # **A suitable default value is auto-generated.** You should normally
672
+ # not need to pass this option.**
673
+ #
660
674
  # @return [Types::CreateIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
661
675
  #
662
676
  # * {Types::CreateIndexResponse#id #id} => String
@@ -670,6 +684,7 @@ module Aws::Kendra
670
684
  # kms_key_id: "KmsKeyId",
671
685
  # },
672
686
  # description: "Description",
687
+ # client_token: "ClientTokenName",
673
688
  # })
674
689
  #
675
690
  # @example Response structure
@@ -784,6 +799,11 @@ module Aws::Kendra
784
799
  # resp.configuration.share_point_configuration.urls[0] #=> String
785
800
  # resp.configuration.share_point_configuration.secret_arn #=> String
786
801
  # resp.configuration.share_point_configuration.crawl_attachments #=> Boolean
802
+ # resp.configuration.share_point_configuration.use_change_log #=> Boolean
803
+ # resp.configuration.share_point_configuration.inclusion_patterns #=> Array
804
+ # resp.configuration.share_point_configuration.inclusion_patterns[0] #=> String
805
+ # resp.configuration.share_point_configuration.exclusion_patterns #=> Array
806
+ # resp.configuration.share_point_configuration.exclusion_patterns[0] #=> String
787
807
  # resp.configuration.share_point_configuration.vpc_configuration.subnet_ids #=> Array
788
808
  # resp.configuration.share_point_configuration.vpc_configuration.subnet_ids[0] #=> String
789
809
  # resp.configuration.share_point_configuration.vpc_configuration.security_group_ids #=> Array
@@ -971,6 +991,8 @@ module Aws::Kendra
971
991
  # * {Types::ListDataSourceSyncJobsResponse#history #history} => Array<Types::DataSourceSyncJob>
972
992
  # * {Types::ListDataSourceSyncJobsResponse#next_token #next_token} => String
973
993
  #
994
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
995
+ #
974
996
  # @example Request syntax with placeholder values
975
997
  #
976
998
  # resp = client.list_data_source_sync_jobs({
@@ -1025,6 +1047,8 @@ module Aws::Kendra
1025
1047
  # * {Types::ListDataSourcesResponse#summary_items #summary_items} => Array<Types::DataSourceSummary>
1026
1048
  # * {Types::ListDataSourcesResponse#next_token #next_token} => String
1027
1049
  #
1050
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1051
+ #
1028
1052
  # @example Request syntax with placeholder values
1029
1053
  #
1030
1054
  # resp = client.list_data_sources({
@@ -1115,6 +1139,8 @@ module Aws::Kendra
1115
1139
  # * {Types::ListIndicesResponse#index_configuration_summary_items #index_configuration_summary_items} => Array<Types::IndexConfigurationSummary>
1116
1140
  # * {Types::ListIndicesResponse#next_token #next_token} => String
1117
1141
  #
1142
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
1143
+ #
1118
1144
  # @example Request syntax with placeholder values
1119
1145
  #
1120
1146
  # resp = client.list_indices({
@@ -1516,6 +1542,9 @@ module Aws::Kendra
1516
1542
  # urls: ["Url"], # required
1517
1543
  # secret_arn: "SecretArn", # required
1518
1544
  # crawl_attachments: false,
1545
+ # use_change_log: false,
1546
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1547
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1519
1548
  # vpc_configuration: {
1520
1549
  # subnet_ids: ["SubnetId"], # required
1521
1550
  # security_group_ids: ["VpcSecurityGroupId"], # required
@@ -1645,7 +1674,7 @@ module Aws::Kendra
1645
1674
  params: params,
1646
1675
  config: config)
1647
1676
  context[:gem_name] = 'aws-sdk-kendra'
1648
- context[:gem_version] = '1.2.0'
1677
+ context[:gem_version] = '1.3.0'
1649
1678
  Seahorse::Client::Request.new(handlers, context)
1650
1679
  end
1651
1680
 
@@ -33,6 +33,7 @@ module Aws::Kendra
33
33
  ChangeDetectingColumns = Shapes::ListShape.new(name: 'ChangeDetectingColumns')
34
34
  ClickFeedback = Shapes::StructureShape.new(name: 'ClickFeedback')
35
35
  ClickFeedbackList = Shapes::ListShape.new(name: 'ClickFeedbackList')
36
+ ClientTokenName = Shapes::StringShape.new(name: 'ClientTokenName')
36
37
  ColumnConfiguration = Shapes::StructureShape.new(name: 'ColumnConfiguration')
37
38
  ColumnName = Shapes::StringShape.new(name: 'ColumnName')
38
39
  ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
@@ -307,6 +308,7 @@ module Aws::Kendra
307
308
  CreateIndexRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, required: true, location_name: "RoleArn"))
308
309
  CreateIndexRequest.add_member(:server_side_encryption_configuration, Shapes::ShapeRef.new(shape: ServerSideEncryptionConfiguration, location_name: "ServerSideEncryptionConfiguration"))
309
310
  CreateIndexRequest.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
311
+ CreateIndexRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientTokenName, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
310
312
  CreateIndexRequest.struct_class = Types::CreateIndexRequest
311
313
 
312
314
  CreateIndexResponse.add_member(:id, Shapes::ShapeRef.new(shape: IndexId, location_name: "Id"))
@@ -633,6 +635,9 @@ module Aws::Kendra
633
635
  SharePointConfiguration.add_member(:urls, Shapes::ShapeRef.new(shape: SharePointUrlList, required: true, location_name: "Urls"))
634
636
  SharePointConfiguration.add_member(:secret_arn, Shapes::ShapeRef.new(shape: SecretArn, required: true, location_name: "SecretArn"))
635
637
  SharePointConfiguration.add_member(:crawl_attachments, Shapes::ShapeRef.new(shape: Boolean, location_name: "CrawlAttachments"))
638
+ SharePointConfiguration.add_member(:use_change_log, Shapes::ShapeRef.new(shape: Boolean, location_name: "UseChangeLog"))
639
+ SharePointConfiguration.add_member(:inclusion_patterns, Shapes::ShapeRef.new(shape: DataSourceInclusionsExclusionsStrings, location_name: "InclusionPatterns"))
640
+ SharePointConfiguration.add_member(:exclusion_patterns, Shapes::ShapeRef.new(shape: DataSourceInclusionsExclusionsStrings, location_name: "ExclusionPatterns"))
636
641
  SharePointConfiguration.add_member(:vpc_configuration, Shapes::ShapeRef.new(shape: DataSourceVpcConfiguration, location_name: "VpcConfiguration"))
637
642
  SharePointConfiguration.add_member(:field_mappings, Shapes::ShapeRef.new(shape: DataSourceToIndexFieldMappingList, location_name: "FieldMappings"))
638
643
  SharePointConfiguration.add_member(:document_title_field_name, Shapes::ShapeRef.new(shape: DataSourceFieldName, location_name: "DocumentTitleFieldName"))
@@ -786,6 +791,7 @@ module Aws::Kendra
786
791
  o.errors << Shapes::ShapeRef.new(shape: ServiceQuotaExceededException)
787
792
  o.errors << Shapes::ShapeRef.new(shape: ThrottlingException)
788
793
  o.errors << Shapes::ShapeRef.new(shape: AccessDeniedException)
794
+ o.errors << Shapes::ShapeRef.new(shape: ConflictException)
789
795
  o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
790
796
  end)
791
797
 
@@ -6,13 +6,7 @@
6
6
  # WARNING ABOUT GENERATED CODE
7
7
 
8
8
  module Aws::Kendra
9
- # This class provides a resource oriented interface for Kendra.
10
- # To create a resource object:
11
- # resource = Aws::Kendra::Resource.new(region: 'us-west-2')
12
- # You can supply a client object with custom configuration that will be used for all resource operations.
13
- # If you do not pass +:client+, a default client will be constructed.
14
- # client = Aws::Kendra::Client.new(region: 'us-west-2')
15
- # resource = Aws::Kendra::Resource.new(client: client)
9
+
16
10
  class Resource
17
11
 
18
12
  # @param options ({})
@@ -96,6 +96,15 @@ module Aws::Kendra
96
96
 
97
97
  # Provides filtering the query results based on document attributes.
98
98
  #
99
+ # When you use the `AndAllFilters` or `OrAllFilters`, filters you can
100
+ # use a total of 3 layers. For example, you can use:
101
+ #
102
+ # 1. `<AndAllFilters>`
103
+ #
104
+ # 2. ` <OrAllFilters>`
105
+ #
106
+ # 3. ` <EqualTo>`
107
+ #
99
108
  # @note When making an API call, you may pass AttributeFilter
100
109
  # data as a hash:
101
110
  #
@@ -801,6 +810,9 @@ module Aws::Kendra
801
810
  # urls: ["Url"], # required
802
811
  # secret_arn: "SecretArn", # required
803
812
  # crawl_attachments: false,
813
+ # use_change_log: false,
814
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
815
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
804
816
  # vpc_configuration: {
805
817
  # subnet_ids: ["SubnetId"], # required
806
818
  # security_group_ids: ["VpcSecurityGroupId"], # required
@@ -986,6 +998,7 @@ module Aws::Kendra
986
998
  # kms_key_id: "KmsKeyId",
987
999
  # },
988
1000
  # description: "Description",
1001
+ # client_token: "ClientTokenName",
989
1002
  # }
990
1003
  #
991
1004
  # @!attribute [rw] name
@@ -1009,13 +1022,23 @@ module Aws::Kendra
1009
1022
  # A description for the index.
1010
1023
  # @return [String]
1011
1024
  #
1025
+ # @!attribute [rw] client_token
1026
+ # A token that you provide to identify the request to create an index.
1027
+ # Multiple calls to the `CreateIndex` operation with the same client
1028
+ # token will create only one index.”
1029
+ #
1030
+ # **A suitable default value is auto-generated.** You should normally
1031
+ # not need to pass this option.
1032
+ # @return [String]
1033
+ #
1012
1034
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateIndexRequest AWS API Documentation
1013
1035
  #
1014
1036
  class CreateIndexRequest < Struct.new(
1015
1037
  :name,
1016
1038
  :role_arn,
1017
1039
  :server_side_encryption_configuration,
1018
- :description)
1040
+ :description,
1041
+ :client_token)
1019
1042
  include Aws::Structure
1020
1043
  end
1021
1044
 
@@ -1053,6 +1076,9 @@ module Aws::Kendra
1053
1076
  # urls: ["Url"], # required
1054
1077
  # secret_arn: "SecretArn", # required
1055
1078
  # crawl_attachments: false,
1079
+ # use_change_log: false,
1080
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1081
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
1056
1082
  # vpc_configuration: {
1057
1083
  # subnet_ids: ["SubnetId"], # required
1058
1084
  # security_group_ids: ["VpcSecurityGroupId"], # required
@@ -1697,7 +1723,13 @@ module Aws::Kendra
1697
1723
  # @return [String]
1698
1724
  #
1699
1725
  # @!attribute [rw] blob
1700
- # The contents of the document as a base-64 encoded string.
1726
+ # The contents of the document.
1727
+ #
1728
+ # Documents passed to the `Blob` parameter must be base64 encoded.
1729
+ # Your code might not need to encode the document file bytes if
1730
+ # you're using an AWS SDK to call Amazon Kendra operations. If you
1731
+ # are calling the Amazon Kendra endpoint directly using REST, you must
1732
+ # base64 encode the contents before sending.
1701
1733
  # @return [String]
1702
1734
  #
1703
1735
  # @!attribute [rw] s3_path
@@ -2909,6 +2941,9 @@ module Aws::Kendra
2909
2941
  # urls: ["Url"], # required
2910
2942
  # secret_arn: "SecretArn", # required
2911
2943
  # crawl_attachments: false,
2944
+ # use_change_log: false,
2945
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
2946
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
2912
2947
  # vpc_configuration: {
2913
2948
  # subnet_ids: ["SubnetId"], # required
2914
2949
  # security_group_ids: ["VpcSecurityGroupId"], # required
@@ -2951,6 +2986,35 @@ module Aws::Kendra
2951
2986
  # SharePoint site in the index; otherwise, `FALSE`.
2952
2987
  # @return [Boolean]
2953
2988
  #
2989
+ # @!attribute [rw] use_change_log
2990
+ # Set to `TRUE` to use the Microsoft SharePoint change log to
2991
+ # determine the documents that need to be updated in the index.
2992
+ # Depending on the size of the SharePoint change log, it may take
2993
+ # longer for Amazon Kendra to use the change log than it takes it to
2994
+ # determine the changed documents using the Amazon Kendra document
2995
+ # crawler.
2996
+ # @return [Boolean]
2997
+ #
2998
+ # @!attribute [rw] inclusion_patterns
2999
+ # A list of regular expression patterns. Documents that match the
3000
+ # patterns are included in the index. Documents that don't match the
3001
+ # patterns are excluded from the index. If a document matches both an
3002
+ # inclusion pattern and an exclusion pattern, the document is not
3003
+ # included in the index.
3004
+ #
3005
+ # The regex is applied to the display URL of the SharePoint document.
3006
+ # @return [Array<String>]
3007
+ #
3008
+ # @!attribute [rw] exclusion_patterns
3009
+ # A list of regular expression patterns. Documents that match the
3010
+ # patterns are excluded from the index. Documents that don't match
3011
+ # the patterns are included in the index. If a document matches both
3012
+ # an exclusion pattern and an inclusion pattern, the document is not
3013
+ # included in the index.
3014
+ #
3015
+ # The regex is applied to the display URL of the SharePoint document.
3016
+ # @return [Array<String>]
3017
+ #
2954
3018
  # @!attribute [rw] vpc_configuration
2955
3019
  # Provides information for connecting to an Amazon VPC.
2956
3020
  # @return [Types::DataSourceVpcConfiguration]
@@ -2979,6 +3043,9 @@ module Aws::Kendra
2979
3043
  :urls,
2980
3044
  :secret_arn,
2981
3045
  :crawl_attachments,
3046
+ :use_change_log,
3047
+ :inclusion_patterns,
3048
+ :exclusion_patterns,
2982
3049
  :vpc_configuration,
2983
3050
  :field_mappings,
2984
3051
  :document_title_field_name)
@@ -3185,6 +3252,9 @@ module Aws::Kendra
3185
3252
  # urls: ["Url"], # required
3186
3253
  # secret_arn: "SecretArn", # required
3187
3254
  # crawl_attachments: false,
3255
+ # use_change_log: false,
3256
+ # inclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
3257
+ # exclusion_patterns: ["DataSourceInclusionsExclusionsStringsMember"],
3188
3258
  # vpc_configuration: {
3189
3259
  # subnet_ids: ["SubnetId"], # required
3190
3260
  # security_group_ids: ["VpcSecurityGroupId"], # required
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.2.0
4
+ version: 1.3.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Amazon Web Services
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-03-09 00:00:00.000000000 Z
11
+ date: 2020-03-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core