aws-sdk-kendra 1.77.0 → 1.79.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
  SHA256:
3
- metadata.gz: 0a2b91c1fb4ff425aa163833db0f8e56751f7600b95c39f8a47abae66039ad33
4
- data.tar.gz: c2551d513a55a5929e60be4bac5f574b1bef6327e224cbf24a6b2d76a5f8816d
3
+ metadata.gz: 1008bfe50cafae87ebe36c5fc8bd34ad8d30bebc420cbdb03e15969894e58c40
4
+ data.tar.gz: c5f8e621a545426dc5c5533b7f1c5aca55173f509524ec3a4f4ed2d39a12de86
5
5
  SHA512:
6
- metadata.gz: f127dfbdfc31fbc0d6c281c175a55af445345a94a6be6d5a3fbaac48906c57701b921d458f699e2cf74b36be022b258ae069b1039873dfcf644980a115ee6125
7
- data.tar.gz: b21070e8e3af900d379331dcf07d8915a12cd1b4f36cc50b80bbf5c5258bbb938762ab0294d24ab2a4a6b654e599b5fb8b0ae5a2fe0c471ddb2c12d253397c71
6
+ metadata.gz: 7e0674110e6ce363e69dfd5ba31234dcd92010d66ee1360ac96c13cdb88c168dce16b9cae6fa7a1fa4a99a84e6402cc5de1a51a7059819c91dedef3093d3d800
7
+ data.tar.gz: 6abe2ce028eac4fb02f11720c4609ec4ec88645895c143bb6b4d459439343e60d91e2ba9b15d5b8774c41523bb6a304c5055489159aeb45ad728262acaf60e1c
data/CHANGELOG.md CHANGED
@@ -1,6 +1,16 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.79.0 (2024-04-25)
5
+ ------------------
6
+
7
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
8
+
9
+ 1.78.0 (2024-03-22)
10
+ ------------------
11
+
12
+ * Feature - Documentation update, March 2024. Corrects some docs for Amazon Kendra.
13
+
4
14
  1.77.0 (2024-01-26)
5
15
  ------------------
6
16
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.77.0
1
+ 1.79.0
@@ -22,6 +22,7 @@ require 'aws-sdk-core/plugins/endpoint_pattern.rb'
22
22
  require 'aws-sdk-core/plugins/response_paging.rb'
23
23
  require 'aws-sdk-core/plugins/stub_responses.rb'
24
24
  require 'aws-sdk-core/plugins/idempotency_token.rb'
25
+ require 'aws-sdk-core/plugins/invocation_id.rb'
25
26
  require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
26
27
  require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
27
28
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
@@ -72,6 +73,7 @@ module Aws::Kendra
72
73
  add_plugin(Aws::Plugins::ResponsePaging)
73
74
  add_plugin(Aws::Plugins::StubResponses)
74
75
  add_plugin(Aws::Plugins::IdempotencyToken)
76
+ add_plugin(Aws::Plugins::InvocationId)
75
77
  add_plugin(Aws::Plugins::JsonvalueConverter)
76
78
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
77
79
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
@@ -196,10 +198,17 @@ module Aws::Kendra
196
198
  # When set to 'true' the request body will not be compressed
197
199
  # for supported operations.
198
200
  #
199
- # @option options [String] :endpoint
200
- # The client endpoint is normally constructed from the `:region`
201
- # option. You should only configure an `:endpoint` when connecting
202
- # to test or custom endpoints. This should be a valid HTTP(S) URI.
201
+ # @option options [String, URI::HTTPS, URI::HTTP] :endpoint
202
+ # Normally you should not configure the `:endpoint` option
203
+ # directly. This is normally constructed from the `:region`
204
+ # option. Configuring `:endpoint` is normally reserved for
205
+ # connecting to test or custom endpoints. The endpoint should
206
+ # be a URI formatted like:
207
+ #
208
+ # 'http://example.com'
209
+ # 'https://example.com'
210
+ # 'http://example.com:123'
211
+ #
203
212
  #
204
213
  # @option options [Integer] :endpoint_cache_max_entries (1000)
205
214
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -347,50 +356,65 @@ module Aws::Kendra
347
356
  # @option options [Aws::Kendra::EndpointProvider] :endpoint_provider
348
357
  # The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::Kendra::EndpointParameters`
349
358
  #
350
- # @option options [URI::HTTP,String] :http_proxy A proxy to send
351
- # requests through. Formatted like 'http://proxy.com:123'.
352
- #
353
- # @option options [Float] :http_open_timeout (15) The number of
354
- # seconds to wait when opening a HTTP session before raising a
355
- # `Timeout::Error`.
356
- #
357
- # @option options [Float] :http_read_timeout (60) The default
358
- # number of seconds to wait for response data. This value can
359
- # safely be set per-request on the session.
360
- #
361
- # @option options [Float] :http_idle_timeout (5) The number of
362
- # seconds a connection is allowed to sit idle before it is
363
- # considered stale. Stale connections are closed and removed
364
- # from the pool before making a request.
365
- #
366
- # @option options [Float] :http_continue_timeout (1) The number of
367
- # seconds to wait for a 100-continue response before sending the
368
- # request body. This option has no effect unless the request has
369
- # "Expect" header set to "100-continue". Defaults to `nil` which
370
- # disables this behaviour. This value can safely be set per
371
- # request on the session.
372
- #
373
- # @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
374
- # in seconds.
375
- #
376
- # @option options [Boolean] :http_wire_trace (false) When `true`,
377
- # HTTP debug output will be sent to the `:logger`.
359
+ # @option options [Float] :http_continue_timeout (1)
360
+ # The number of seconds to wait for a 100-continue response before sending the
361
+ # request body. This option has no effect unless the request has "Expect"
362
+ # header set to "100-continue". Defaults to `nil` which disables this
363
+ # behaviour. This value can safely be set per request on the session.
364
+ #
365
+ # @option options [Float] :http_idle_timeout (5)
366
+ # The number of seconds a connection is allowed to sit idle before it
367
+ # is considered stale. Stale connections are closed and removed from the
368
+ # pool before making a request.
369
+ #
370
+ # @option options [Float] :http_open_timeout (15)
371
+ # The default number of seconds to wait for response data.
372
+ # This value can safely be set per-request on the session.
373
+ #
374
+ # @option options [URI::HTTP,String] :http_proxy
375
+ # A proxy to send requests through. Formatted like 'http://proxy.com:123'.
376
+ #
377
+ # @option options [Float] :http_read_timeout (60)
378
+ # The default number of seconds to wait for response data.
379
+ # This value can safely be set per-request on the session.
380
+ #
381
+ # @option options [Boolean] :http_wire_trace (false)
382
+ # When `true`, HTTP debug output will be sent to the `:logger`.
383
+ #
384
+ # @option options [Proc] :on_chunk_received
385
+ # When a Proc object is provided, it will be used as callback when each chunk
386
+ # of the response body is received. It provides three arguments: the chunk,
387
+ # the number of bytes received, and the total number of
388
+ # bytes in the response (or nil if the server did not send a `content-length`).
389
+ #
390
+ # @option options [Proc] :on_chunk_sent
391
+ # When a Proc object is provided, it will be used as callback when each chunk
392
+ # of the request body is sent. It provides three arguments: the chunk,
393
+ # the number of bytes read from the body, and the total number of
394
+ # bytes in the body.
395
+ #
396
+ # @option options [Boolean] :raise_response_errors (true)
397
+ # When `true`, response errors are raised.
398
+ #
399
+ # @option options [String] :ssl_ca_bundle
400
+ # Full path to the SSL certificate authority bundle file that should be used when
401
+ # verifying peer certificates. If you do not pass `:ssl_ca_bundle` or
402
+ # `:ssl_ca_directory` the the system default will be used if available.
403
+ #
404
+ # @option options [String] :ssl_ca_directory
405
+ # Full path of the directory that contains the unbundled SSL certificate
406
+ # authority files for verifying peer certificates. If you do
407
+ # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the system
408
+ # default will be used if available.
378
409
  #
379
- # @option options [Boolean] :ssl_verify_peer (true) When `true`,
380
- # SSL peer certificates are verified when establishing a
381
- # connection.
410
+ # @option options [String] :ssl_ca_store
411
+ # Sets the X509::Store to verify peer certificate.
382
412
  #
383
- # @option options [String] :ssl_ca_bundle Full path to the SSL
384
- # certificate authority bundle file that should be used when
385
- # verifying peer certificates. If you do not pass
386
- # `:ssl_ca_bundle` or `:ssl_ca_directory` the the system default
387
- # will be used if available.
413
+ # @option options [Float] :ssl_timeout
414
+ # Sets the SSL timeout in seconds
388
415
  #
389
- # @option options [String] :ssl_ca_directory Full path of the
390
- # directory that contains the unbundled SSL certificate
391
- # authority files for verifying peer certificates. If you do
392
- # not pass `:ssl_ca_bundle` or `:ssl_ca_directory` the the
393
- # system default will be used if available.
416
+ # @option options [Boolean] :ssl_verify_peer (true)
417
+ # When `true`, SSL peer certificates are verified when establishing a connection.
394
418
  #
395
419
  def initialize(*args)
396
420
  super
@@ -2251,7 +2275,9 @@ module Aws::Kendra
2251
2275
  #
2252
2276
  # @option params [Types::UserGroupResolutionConfiguration] :user_group_resolution_configuration
2253
2277
  # Gets users and groups from IAM Identity Center identity source. To
2254
- # configure this, see [UserGroupResolutionConfiguration][1].
2278
+ # configure this, see [UserGroupResolutionConfiguration][1]. This is
2279
+ # useful for user context filtering, where search results are filtered
2280
+ # based on the user or their group access to documents.
2255
2281
  #
2256
2282
  #
2257
2283
  #
@@ -2632,10 +2658,10 @@ module Aws::Kendra
2632
2658
  req.send_request(options)
2633
2659
  end
2634
2660
 
2635
- # Deletes an existing Amazon Kendra index. An exception is not thrown if
2636
- # the index is already being deleted. While the index is being deleted,
2637
- # the `Status` field returned by a call to the `DescribeIndex` API is
2638
- # set to `DELETING`.
2661
+ # Deletes an Amazon Kendra index. An exception is not thrown if the
2662
+ # index is already being deleted. While the index is being deleted, the
2663
+ # `Status` field returned by a call to the `DescribeIndex` API is set to
2664
+ # `DELETING`.
2639
2665
  #
2640
2666
  # @option params [required, String] :id
2641
2667
  # The identifier of the index you want to delete.
@@ -2764,7 +2790,7 @@ module Aws::Kendra
2764
2790
  req.send_request(options)
2765
2791
  end
2766
2792
 
2767
- # Deletes an existing Amazon Kendra thesaurus.
2793
+ # Deletes an Amazon Kendra thesaurus.
2768
2794
  #
2769
2795
  # @option params [required, String] :id
2770
2796
  # The identifier of the thesaurus you want to delete.
@@ -3575,7 +3601,7 @@ module Aws::Kendra
3575
3601
  req.send_request(options)
3576
3602
  end
3577
3603
 
3578
- # Gets information about an existing Amazon Kendra index.
3604
+ # Gets information about an Amazon Kendra index.
3579
3605
  #
3580
3606
  # @option params [required, String] :id
3581
3607
  # The identifier of the index you want to get information on.
@@ -3833,7 +3859,7 @@ module Aws::Kendra
3833
3859
  req.send_request(options)
3834
3860
  end
3835
3861
 
3836
- # Gets information about an existing Amazon Kendra thesaurus.
3862
+ # Gets information about an Amazon Kendra thesaurus.
3837
3863
  #
3838
3864
  # @option params [required, String] :id
3839
3865
  # The identifier of the thesaurus you want to get information on.
@@ -5109,7 +5135,14 @@ module Aws::Kendra
5109
5135
  # The input query text for the search. Amazon Kendra truncates queries
5110
5136
  # at 30 token words, which excludes punctuation and stop words.
5111
5137
  # Truncation still applies if you use Boolean or more advanced, complex
5112
- # queries.
5138
+ # queries. For example, `Timeoff AND October AND Category:HR` is counted
5139
+ # as 3 tokens: `timeoff`, `october`, `hr`. For more information, see
5140
+ # [Searching with advanced query syntax][1] in the Amazon Kendra
5141
+ # Developer Guide.
5142
+ #
5143
+ #
5144
+ #
5145
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax
5113
5146
  #
5114
5147
  # @option params [Types::AttributeFilter] :attribute_filter
5115
5148
  # Filters search results by document fields/attributes. You can only
@@ -5552,7 +5585,14 @@ module Aws::Kendra
5552
5585
  # The input query text to retrieve relevant passages for the search.
5553
5586
  # Amazon Kendra truncates queries at 30 token words, which excludes
5554
5587
  # punctuation and stop words. Truncation still applies if you use
5555
- # Boolean or more advanced, complex queries.
5588
+ # Boolean or more advanced, complex queries. For example, `Timeoff AND
5589
+ # October AND Category:HR` is counted as 3 tokens: `timeoff`, `october`,
5590
+ # `hr`. For more information, see [Searching with advanced query
5591
+ # syntax][1] in the Amazon Kendra Developer Guide.
5592
+ #
5593
+ #
5594
+ #
5595
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax
5556
5596
  #
5557
5597
  # @option params [Types::AttributeFilter] :attribute_filter
5558
5598
  # Filters search results by document fields/attributes. You can only
@@ -6017,7 +6057,7 @@ module Aws::Kendra
6017
6057
  req.send_request(options)
6018
6058
  end
6019
6059
 
6020
- # Updates an existing Amazon Kendra data source connector.
6060
+ # Updates an Amazon Kendra data source connector.
6021
6061
  #
6022
6062
  # @option params [required, String] :id
6023
6063
  # The identifier of the data source connector you want to update.
@@ -6942,13 +6982,13 @@ module Aws::Kendra
6942
6982
  req.send_request(options)
6943
6983
  end
6944
6984
 
6945
- # Updates an existing Amazon Kendra index.
6985
+ # Updates an Amazon Kendra index.
6946
6986
  #
6947
6987
  # @option params [required, String] :id
6948
6988
  # The identifier of the index you want to update.
6949
6989
  #
6950
6990
  # @option params [String] :name
6951
- # The name of the index you want to update.
6991
+ # A new name for the index.
6952
6992
  #
6953
6993
  # @option params [String] :role_arn
6954
6994
  # An Identity and Access Management (IAM) role that gives Amazon Kendra
@@ -6979,9 +7019,10 @@ module Aws::Kendra
6979
7019
  # The user context policy.
6980
7020
  #
6981
7021
  # @option params [Types::UserGroupResolutionConfiguration] :user_group_resolution_configuration
6982
- # Enables fetching access levels of groups and users from an IAM
6983
- # Identity Center identity source. To configure this, see
6984
- # [UserGroupResolutionConfiguration][1].
7022
+ # Gets users and groups from IAM Identity Center identity source. To
7023
+ # configure this, see [UserGroupResolutionConfiguration][1]. This is
7024
+ # useful for user context filtering, where search results are filtered
7025
+ # based on the user or their group access to documents.
6985
7026
  #
6986
7027
  #
6987
7028
  #
@@ -7291,7 +7332,7 @@ module Aws::Kendra
7291
7332
  params: params,
7292
7333
  config: config)
7293
7334
  context[:gem_name] = 'aws-sdk-kendra'
7294
- context[:gem_version] = '1.77.0'
7335
+ context[:gem_version] = '1.79.0'
7295
7336
  Seahorse::Client::Request.new(handlers, context)
7296
7337
  end
7297
7338
 
@@ -2413,7 +2413,9 @@ module Aws::Kendra
2413
2413
  #
2414
2414
  # @!attribute [rw] user_group_resolution_configuration
2415
2415
  # Gets users and groups from IAM Identity Center identity source. To
2416
- # configure this, see [UserGroupResolutionConfiguration][1].
2416
+ # configure this, see [UserGroupResolutionConfiguration][1]. This is
2417
+ # useful for user context filtering, where search results are filtered
2418
+ # based on the user or their group access to documents.
2417
2419
  #
2418
2420
  #
2419
2421
  #
@@ -2670,6 +2672,26 @@ module Aws::Kendra
2670
2672
  # @!attribute [rw] s3_configuration
2671
2673
  # Provides the configuration information to connect to an Amazon S3
2672
2674
  # bucket as your data source.
2675
+ #
2676
+ # <note markdown="1"> Amazon Kendra now supports an upgraded Amazon S3 connector.
2677
+ #
2678
+ # You must now use the [TemplateConfiguration][1] object instead of
2679
+ # the `S3DataSourceConfiguration` object to configure your connector.
2680
+ #
2681
+ # Connectors configured using the older console and API architecture
2682
+ # will continue to function as configured. However, you won't be able
2683
+ # to edit or update them. If you want to edit or update your connector
2684
+ # configuration, you must create a new connector.
2685
+ #
2686
+ # We recommended migrating your connector workflow to the upgraded
2687
+ # version. Support for connectors configured using the older
2688
+ # architecture is scheduled to end by June 2024.
2689
+ #
2690
+ # </note>
2691
+ #
2692
+ #
2693
+ #
2694
+ # [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html
2673
2695
  # @return [Types::S3DataSourceConfiguration]
2674
2696
  #
2675
2697
  # @!attribute [rw] share_point_configuration
@@ -2720,11 +2742,51 @@ module Aws::Kendra
2720
2742
  # @!attribute [rw] fsx_configuration
2721
2743
  # Provides the configuration information to connect to Amazon FSx as
2722
2744
  # your data source.
2745
+ #
2746
+ # <note markdown="1"> Amazon Kendra now supports an upgraded Amazon FSx Windows connector.
2747
+ #
2748
+ # You must now use the [TemplateConfiguration][1] object instead of
2749
+ # the `FsxConfiguration` object to configure your connector.
2750
+ #
2751
+ # Connectors configured using the older console and API architecture
2752
+ # will continue to function as configured. However, you won't be able
2753
+ # to edit or update them. If you want to edit or update your connector
2754
+ # configuration, you must create a new connector.
2755
+ #
2756
+ # We recommended migrating your connector workflow to the upgraded
2757
+ # version. Support for connectors configured using the older
2758
+ # architecture is scheduled to end by June 2024.
2759
+ #
2760
+ # </note>
2761
+ #
2762
+ #
2763
+ #
2764
+ # [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html
2723
2765
  # @return [Types::FsxConfiguration]
2724
2766
  #
2725
2767
  # @!attribute [rw] slack_configuration
2726
2768
  # Provides the configuration information to connect to Slack as your
2727
2769
  # data source.
2770
+ #
2771
+ # <note markdown="1"> Amazon Kendra now supports an upgraded Slack connector.
2772
+ #
2773
+ # You must now use the [TemplateConfiguration][1] object instead of
2774
+ # the `SlackConfiguration` object to configure your connector.
2775
+ #
2776
+ # Connectors configured using the older console and API architecture
2777
+ # will continue to function as configured. However, you won't be able
2778
+ # to edit or update them. If you want to edit or update your connector
2779
+ # configuration, you must create a new connector.
2780
+ #
2781
+ # We recommended migrating your connector workflow to the upgraded
2782
+ # version. Support for connectors configured using the older
2783
+ # architecture is scheduled to end by June 2024.
2784
+ #
2785
+ # </note>
2786
+ #
2787
+ #
2788
+ #
2789
+ # [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html
2728
2790
  # @return [Types::SlackConfiguration]
2729
2791
  #
2730
2792
  # @!attribute [rw] box_configuration
@@ -2745,16 +2807,38 @@ module Aws::Kendra
2745
2807
  # @!attribute [rw] git_hub_configuration
2746
2808
  # Provides the configuration information to connect to GitHub as your
2747
2809
  # data source.
2810
+ #
2811
+ # <note markdown="1"> Amazon Kendra now supports an upgraded GitHub connector.
2812
+ #
2813
+ # You must now use the [TemplateConfiguration][1] object instead of
2814
+ # the `GitHubConfiguration` object to configure your connector.
2815
+ #
2816
+ # Connectors configured using the older console and API architecture
2817
+ # will continue to function as configured. However, you won’t be able
2818
+ # to edit or update them. If you want to edit or update your connector
2819
+ # configuration, you must create a new connector.
2820
+ #
2821
+ # We recommended migrating your connector workflow to the upgraded
2822
+ # version. Support for connectors configured using the older
2823
+ # architecture is scheduled to end by June 2024.
2824
+ #
2825
+ # </note>
2826
+ #
2827
+ #
2828
+ #
2829
+ # [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html
2748
2830
  # @return [Types::GitHubConfiguration]
2749
2831
  #
2750
2832
  # @!attribute [rw] alfresco_configuration
2751
2833
  # Provides the configuration information to connect to Alfresco as
2752
2834
  # your data source.
2753
2835
  #
2754
- # Support for `AlfrescoConfiguration` ended May 2023. We recommend
2836
+ # <note markdown="1"> Support for `AlfrescoConfiguration` ended May 2023. We recommend
2755
2837
  # migrating to or using the Alfresco data source template schema /
2756
2838
  # [TemplateConfiguration][1] API.
2757
2839
  #
2840
+ # </note>
2841
+ #
2758
2842
  #
2759
2843
  #
2760
2844
  # [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html
@@ -3780,11 +3864,11 @@ module Aws::Kendra
3780
3864
  #
3781
3865
  # @!attribute [rw] role_arn
3782
3866
  # The Amazon Resource Name (ARN) of the IAM role that gives Amazon
3783
- # Kendra permission to write to your Amazon Cloudwatch logs.
3867
+ # Kendra permission to write to your Amazon CloudWatch logs.
3784
3868
  # @return [String]
3785
3869
  #
3786
3870
  # @!attribute [rw] server_side_encryption_configuration
3787
- # The identifier of the KMScustomer master key (CMK) that is used to
3871
+ # The identifier of the KMS customer master key (CMK) that is used to
3788
3872
  # encrypt your data. Amazon Kendra doesn't support asymmetric CMKs.
3789
3873
  # @return [Types::ServerSideEncryptionConfiguration]
3790
3874
  #
@@ -3803,7 +3887,7 @@ module Aws::Kendra
3803
3887
  # @return [Time]
3804
3888
  #
3805
3889
  # @!attribute [rw] updated_at
3806
- # The Unix when the index was last updated.
3890
+ # The Unix timestamp when the index was last updated.
3807
3891
  # @return [Time]
3808
3892
  #
3809
3893
  # @!attribute [rw] document_metadata_configurations
@@ -3845,9 +3929,10 @@ module Aws::Kendra
3845
3929
  # @return [String]
3846
3930
  #
3847
3931
  # @!attribute [rw] user_group_resolution_configuration
3848
- # Whether you have enabled the configuration for fetching access
3849
- # levels of groups and users from an IAM Identity Center identity
3850
- # source.
3932
+ # Whether you have enabled IAM Identity Center identity source for
3933
+ # your users and groups. This is useful for user context filtering,
3934
+ # where search results are filtered based on the user or their group
3935
+ # access to documents.
3851
3936
  # @return [Types::UserGroupResolutionConfiguration]
3852
3937
  #
3853
3938
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndexResponse AWS API Documentation
@@ -5513,6 +5598,26 @@ module Aws::Kendra
5513
5598
  # Provides the configuration information to connect to Amazon FSx as
5514
5599
  # your data source.
5515
5600
  #
5601
+ # <note markdown="1"> Amazon Kendra now supports an upgraded Amazon FSx Windows connector.
5602
+ #
5603
+ # You must now use the [TemplateConfiguration][1] object instead of the
5604
+ # `FsxConfiguration` object to configure your connector.
5605
+ #
5606
+ # Connectors configured using the older console and API architecture
5607
+ # will continue to function as configured. However, you won't be able
5608
+ # to edit or update them. If you want to edit or update your connector
5609
+ # configuration, you must create a new connector.
5610
+ #
5611
+ # We recommended migrating your connector workflow to the upgraded
5612
+ # version. Support for connectors configured using the older
5613
+ # architecture is scheduled to end by June 2024.
5614
+ #
5615
+ # </note>
5616
+ #
5617
+ #
5618
+ #
5619
+ # [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html
5620
+ #
5516
5621
  # @!attribute [rw] file_system_id
5517
5622
  # The identifier of the Amazon FSx file system.
5518
5623
  #
@@ -5764,6 +5869,26 @@ module Aws::Kendra
5764
5869
  # Provides the configuration information to connect to GitHub as your
5765
5870
  # data source.
5766
5871
  #
5872
+ # <note markdown="1"> Amazon Kendra now supports an upgraded GitHub connector.
5873
+ #
5874
+ # You must now use the [TemplateConfiguration][1] object instead of the
5875
+ # `GitHubConfiguration` object to configure your connector.
5876
+ #
5877
+ # Connectors configured using the older console and API architecture
5878
+ # will continue to function as configured. However, you won’t be able to
5879
+ # edit or update them. If you want to edit or update your connector
5880
+ # configuration, you must create a new connector.
5881
+ #
5882
+ # We recommended migrating your connector workflow to the upgraded
5883
+ # version. Support for connectors configured using the older
5884
+ # architecture is scheduled to end by June 2024.
5885
+ #
5886
+ # </note>
5887
+ #
5888
+ #
5889
+ #
5890
+ # [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html
5891
+ #
5767
5892
  # @!attribute [rw] saa_s_configuration
5768
5893
  # Configuration information to connect to GitHub Enterprise Cloud
5769
5894
  # (SaaS).
@@ -7378,7 +7503,7 @@ module Aws::Kendra
7378
7503
  #
7379
7504
  # @!attribute [rw] organization_name
7380
7505
  # The name of the organization of the GitHub Enterprise Server
7381
- # (in-premise) account you want to connect to. You can find your
7506
+ # (on-premises) account you want to connect to. You can find your
7382
7507
  # organization name by logging into GitHub desktop and selecting
7383
7508
  # **Your organizations** under your profile picture dropdown.
7384
7509
  # @return [String]
@@ -7714,7 +7839,14 @@ module Aws::Kendra
7714
7839
  # The input query text for the search. Amazon Kendra truncates queries
7715
7840
  # at 30 token words, which excludes punctuation and stop words.
7716
7841
  # Truncation still applies if you use Boolean or more advanced,
7717
- # complex queries.
7842
+ # complex queries. For example, `Timeoff AND October AND Category:HR`
7843
+ # is counted as 3 tokens: `timeoff`, `october`, `hr`. For more
7844
+ # information, see [Searching with advanced query syntax][1] in the
7845
+ # Amazon Kendra Developer Guide.
7846
+ #
7847
+ #
7848
+ #
7849
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax
7718
7850
  # @return [String]
7719
7851
  #
7720
7852
  # @!attribute [rw] attribute_filter
@@ -7912,7 +8044,10 @@ module Aws::Kendra
7912
8044
  # document that satisfies the query.
7913
8045
  #
7914
8046
  # @!attribute [rw] id
7915
- # The identifier for the query result.
8047
+ # The unique identifier for the query result item id (`Id`) and the
8048
+ # query result item document id (`DocumentId`) combined. The value of
8049
+ # this field changes with every request, even when you have the same
8050
+ # documents.
7916
8051
  # @return [String]
7917
8052
  #
7918
8053
  # @!attribute [rw] type
@@ -8195,8 +8330,7 @@ module Aws::Kendra
8195
8330
  # Indicates that this field determines how "fresh" a document is.
8196
8331
  # For example, if document 1 was created on November 5, and document 2
8197
8332
  # was created on October 31, document 1 is "fresher" than document
8198
- # 2. You can only set the `Freshness` field on one `DATE` type field.
8199
- # Only applies to `DATE` fields.
8333
+ # 2. Only applies to `DATE` fields.
8200
8334
  # @return [Boolean]
8201
8335
  #
8202
8336
  # @!attribute [rw] importance
@@ -8228,13 +8362,13 @@ module Aws::Kendra
8228
8362
  # better. For example, in a task tracking application, a priority 1
8229
8363
  # task is more important than a priority 5 task.
8230
8364
  #
8231
- # Only applies to `LONG` and `DOUBLE` fields.
8365
+ # Only applies to `LONG` fields.
8232
8366
  # @return [String]
8233
8367
  #
8234
8368
  # @!attribute [rw] value_importance_map
8235
8369
  # A list of values that should be given a different boost when they
8236
8370
  # appear in the result list. For example, if you are boosting a field
8237
- # called "department," query terms that match the department field
8371
+ # called "department", query terms that match the department field
8238
8372
  # are boosted in the result. However, you can add entries from the
8239
8373
  # department field to boost documents with those values higher.
8240
8374
  #
@@ -8344,7 +8478,14 @@ module Aws::Kendra
8344
8478
  # The input query text to retrieve relevant passages for the search.
8345
8479
  # Amazon Kendra truncates queries at 30 token words, which excludes
8346
8480
  # punctuation and stop words. Truncation still applies if you use
8347
- # Boolean or more advanced, complex queries.
8481
+ # Boolean or more advanced, complex queries. For example, `Timeoff AND
8482
+ # October AND Category:HR` is counted as 3 tokens: `timeoff`,
8483
+ # `october`, `hr`. For more information, see [Searching with advanced
8484
+ # query syntax][1] in the Amazon Kendra Developer Guide.
8485
+ #
8486
+ #
8487
+ #
8488
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/searching-example.html#searching-index-query-syntax
8348
8489
  # @return [String]
8349
8490
  #
8350
8491
  # @!attribute [rw] attribute_filter
@@ -8485,6 +8626,26 @@ module Aws::Kendra
8485
8626
  # Provides the configuration information to connect to an Amazon S3
8486
8627
  # bucket.
8487
8628
  #
8629
+ # <note markdown="1"> Amazon Kendra now supports an upgraded Amazon S3 connector.
8630
+ #
8631
+ # You must now use the [TemplateConfiguration][1] object instead of the
8632
+ # `S3DataSourceConfiguration` object to configure your connector.
8633
+ #
8634
+ # Connectors configured using the older console and API architecture
8635
+ # will continue to function as configured. However, you won't be able
8636
+ # to edit or update them. If you want to edit or update your connector
8637
+ # configuration, you must create a new connector.
8638
+ #
8639
+ # We recommended migrating your connector workflow to the upgraded
8640
+ # version. Support for connectors configured using the older
8641
+ # architecture is scheduled to end by June 2024.
8642
+ #
8643
+ # </note>
8644
+ #
8645
+ #
8646
+ #
8647
+ # [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html
8648
+ #
8488
8649
  # @!attribute [rw] bucket_name
8489
8650
  # The name of the bucket that contains the documents.
8490
8651
  # @return [String]
@@ -8495,21 +8656,37 @@ module Aws::Kendra
8495
8656
  # @return [Array<String>]
8496
8657
  #
8497
8658
  # @!attribute [rw] inclusion_patterns
8498
- # A list of glob patterns for documents that should be indexed. If a
8499
- # document that matches an inclusion pattern also matches an exclusion
8500
- # pattern, the document is not indexed.
8659
+ # A list of glob patterns (patterns that can expand a wildcard pattern
8660
+ # into a list of path names that match the given pattern) for certain
8661
+ # file names and file types to include in your index. If a document
8662
+ # matches both an inclusion and exclusion prefix or pattern, the
8663
+ # exclusion prefix takes precendence and the document is not indexed.
8664
+ # Examples of glob patterns include:
8665
+ #
8666
+ # * */myapp/config/**—All files inside config directory.
8667
+ #
8668
+ # * ***/*.png*—All .png files in all directories.
8669
+ #
8670
+ # * ***/*.\\\{png, ico, md\\}*—All .png, .ico or .md files in all
8671
+ # directories.
8501
8672
  #
8502
- # Some [examples][1] are:
8673
+ # * */myapp/src/**/*.ts*—All .ts files inside src directory (and
8674
+ # all its subdirectories).
8503
8675
  #
8504
- # * **.txt* will include all text files in a directory (files with
8505
- # the extension .txt).
8676
+ # * ***/!(*.module).ts*—All .ts files but not .module.ts
8506
8677
  #
8507
- # * ***/*.txt* will include all text files in a directory and its
8508
- # subdirectories.
8678
+ # * **.png , *.jpg*—All PNG and JPEG image files in a directory
8679
+ # (files with the extensions .png and .jpg).
8509
8680
  #
8510
- # * **tax** will include all files in a directory that contain
8511
- # 'tax' in the file name, such as 'tax', 'taxes',
8512
- # 'income\_tax'.
8681
+ # * **internal**—All files in a directory that contain 'internal'
8682
+ # in the file name, such as 'internal', 'internal\_only',
8683
+ # 'company\_internal'.
8684
+ #
8685
+ # * ***/*internal**—All internal-related files in a directory and
8686
+ # its subdirectories.
8687
+ #
8688
+ # For more examples, see [Use of Exclude and Include Filters][1] in
8689
+ # the Amazon Web Services CLI Command Reference.
8513
8690
  #
8514
8691
  #
8515
8692
  #
@@ -8517,21 +8694,37 @@ module Aws::Kendra
8517
8694
  # @return [Array<String>]
8518
8695
  #
8519
8696
  # @!attribute [rw] exclusion_patterns
8520
- # A list of glob patterns for documents that should not be indexed. If
8521
- # a document that matches an inclusion prefix or inclusion pattern
8522
- # also matches an exclusion pattern, the document is not indexed.
8697
+ # A list of glob patterns (patterns that can expand a wildcard pattern
8698
+ # into a list of path names that match the given pattern) for certain
8699
+ # file names and file types to exclude from your index. If a document
8700
+ # matches both an inclusion and exclusion prefix or pattern, the
8701
+ # exclusion prefix takes precendence and the document is not indexed.
8702
+ # Examples of glob patterns include:
8703
+ #
8704
+ # * */myapp/config/**—All files inside config directory.
8705
+ #
8706
+ # * ***/*.png*—All .png files in all directories.
8707
+ #
8708
+ # * ***/*.\\\{png, ico, md\\}*—All .png, .ico or .md files in all
8709
+ # directories.
8710
+ #
8711
+ # * */myapp/src/**/*.ts*—All .ts files inside src directory (and
8712
+ # all its subdirectories).
8523
8713
  #
8524
- # Some [examples][1] are:
8714
+ # * ***/!(*.module).ts*—All .ts files but not .module.ts
8525
8715
  #
8526
- # * **.png , *.jpg* will exclude all PNG and JPEG image files in a
8527
- # directory (files with the extensions .png and .jpg).
8716
+ # * **.png , *.jpg*—All PNG and JPEG image files in a directory
8717
+ # (files with the extensions .png and .jpg).
8528
8718
  #
8529
- # * **internal** will exclude all files in a directory that contain
8530
- # 'internal' in the file name, such as 'internal',
8531
- # 'internal\_only', 'company\_internal'.
8719
+ # * **internal**—All files in a directory that contain 'internal'
8720
+ # in the file name, such as 'internal', 'internal\_only',
8721
+ # 'company\_internal'.
8532
8722
  #
8533
- # * ***/*internal** will exclude all internal-related files in a
8534
- # directory and its subdirectories.
8723
+ # * ***/*internal**—All internal-related files in a directory and
8724
+ # its subdirectories.
8725
+ #
8726
+ # For more examples, see [Use of Exclude and Include Filters][1] in
8727
+ # the Amazon Web Services CLI Command Reference.
8535
8728
  #
8536
8729
  #
8537
8730
  #
@@ -9435,6 +9628,26 @@ module Aws::Kendra
9435
9628
  # Provides the configuration information to connect to Slack as your
9436
9629
  # data source.
9437
9630
  #
9631
+ # <note markdown="1"> Amazon Kendra now supports an upgraded Slack connector.
9632
+ #
9633
+ # You must now use the [TemplateConfiguration][1] object instead of the
9634
+ # `SlackConfiguration` object to configure your connector.
9635
+ #
9636
+ # Connectors configured using the older console and API architecture
9637
+ # will continue to function as configured. However, you won’t be able to
9638
+ # edit or update them. If you want to edit or update your connector
9639
+ # configuration, you must create a new connector.
9640
+ #
9641
+ # We recommended migrating your connector workflow to the upgraded
9642
+ # version. Support for connectors configured using the older
9643
+ # architecture is scheduled to end by June 2024.
9644
+ #
9645
+ # </note>
9646
+ #
9647
+ #
9648
+ #
9649
+ # [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_TemplateConfiguration.html
9650
+ #
9438
9651
  # @!attribute [rw] team_id
9439
9652
  # The identifier of the team in the Slack workspace. For example,
9440
9653
  # *T0123456789*.
@@ -10481,7 +10694,7 @@ module Aws::Kendra
10481
10694
  # @return [String]
10482
10695
  #
10483
10696
  # @!attribute [rw] name
10484
- # The name of the index you want to update.
10697
+ # A new name for the index.
10485
10698
  # @return [String]
10486
10699
  #
10487
10700
  # @!attribute [rw] role_arn
@@ -10519,9 +10732,10 @@ module Aws::Kendra
10519
10732
  # @return [String]
10520
10733
  #
10521
10734
  # @!attribute [rw] user_group_resolution_configuration
10522
- # Enables fetching access levels of groups and users from an IAM
10523
- # Identity Center identity source. To configure this, see
10524
- # [UserGroupResolutionConfiguration][1].
10735
+ # Gets users and groups from IAM Identity Center identity source. To
10736
+ # configure this, see [UserGroupResolutionConfiguration][1]. This is
10737
+ # useful for user context filtering, where search results are filtered
10738
+ # based on the user or their group access to documents.
10525
10739
  #
10526
10740
  #
10527
10741
  #
@@ -52,6 +52,6 @@ require_relative 'aws-sdk-kendra/customizations'
52
52
  # @!group service
53
53
  module Aws::Kendra
54
54
 
55
- GEM_VERSION = '1.77.0'
55
+ GEM_VERSION = '1.79.0'
56
56
 
57
57
  end
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.77.0
4
+ version: 1.79.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: 2024-01-26 00:00:00.000000000 Z
11
+ date: 2024-04-25 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: aws-sdk-core
@@ -19,7 +19,7 @@ dependencies:
19
19
  version: '3'
20
20
  - - ">="
21
21
  - !ruby/object:Gem::Version
22
- version: 3.191.0
22
+ version: 3.193.0
23
23
  type: :runtime
24
24
  prerelease: false
25
25
  version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
29
29
  version: '3'
30
30
  - - ">="
31
31
  - !ruby/object:Gem::Version
32
- version: 3.191.0
32
+ version: 3.193.0
33
33
  - !ruby/object:Gem::Dependency
34
34
  name: aws-sigv4
35
35
  requirement: !ruby/object:Gem::Requirement