aws-sdk-kendra 1.93.0 → 1.94.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 +5 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kendra/client.rb +135 -46
- data/lib/aws-sdk-kendra/client_api.rb +3 -0
- data/lib/aws-sdk-kendra/types.rb +176 -73
- data/lib/aws-sdk-kendra.rb +1 -1
- data/sig/client.rbs +2 -2
- data/sig/types.rbs +6 -3
- 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: 8d062dbab8e381908cae21e4eec6a63caf0ca30ad62436458be67257e064d89f
|
4
|
+
data.tar.gz: 817b058fe5da8a936891042463df8927efccb8adf39671a90e2f358dfff99306
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: bbf306737bf10cda56dab8fe4a542f5cf4508a51a67a3cbecb70bbf4c9716dee44d9fa9fe599325759810c9e28b46d5610631d99f51814dd20f6c10c7f971c50
|
7
|
+
data.tar.gz: 5efab51bd5e91670d84f879f8df6e51ac270cda02b516790eab14d22b24cc22f9f14fe4394c82d035d98d011a563f104e29e9456dfdbff85aaddb343f3be39e2
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,11 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.94.0 (2024-12-04)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - This release adds GenAI Index in Amazon Kendra for Retrieval Augmented Generation (RAG) and intelligent search. With the Kendra GenAI Index, customers get high retrieval accuracy powered by the latest information retrieval technologies and semantic models.
|
8
|
+
|
4
9
|
1.93.0 (2024-11-06)
|
5
10
|
------------------
|
6
11
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.94.0
|
@@ -606,6 +606,7 @@ module Aws::Kendra
|
|
606
606
|
#
|
607
607
|
# resp.failed_documents #=> Array
|
608
608
|
# resp.failed_documents[0].id #=> String
|
609
|
+
# resp.failed_documents[0].data_source_id #=> String
|
609
610
|
# resp.failed_documents[0].error_code #=> String, one of "InternalError", "InvalidRequest"
|
610
611
|
# resp.failed_documents[0].error_message #=> String
|
611
612
|
#
|
@@ -717,6 +718,7 @@ module Aws::Kendra
|
|
717
718
|
#
|
718
719
|
# resp.errors #=> Array
|
719
720
|
# resp.errors[0].document_id #=> String
|
721
|
+
# resp.errors[0].data_source_id #=> String
|
720
722
|
# resp.errors[0].error_code #=> String, one of "InternalError", "InvalidRequest"
|
721
723
|
# resp.errors[0].error_message #=> String
|
722
724
|
# resp.document_status_list #=> Array
|
@@ -912,6 +914,7 @@ module Aws::Kendra
|
|
912
914
|
#
|
913
915
|
# resp.failed_documents #=> Array
|
914
916
|
# resp.failed_documents[0].id #=> String
|
917
|
+
# resp.failed_documents[0].data_source_id #=> String
|
915
918
|
# resp.failed_documents[0].error_code #=> String, one of "InternalError", "InvalidRequest"
|
916
919
|
# resp.failed_documents[0].error_message #=> String
|
917
920
|
#
|
@@ -982,6 +985,11 @@ module Aws::Kendra
|
|
982
985
|
# access control configuration for S3 data sources and documents indexed
|
983
986
|
# using the `BatchPutDocument` API.
|
984
987
|
#
|
988
|
+
# You can't configure access control using
|
989
|
+
# `CreateAccessControlConfiguration` for an Amazon Kendra Gen AI
|
990
|
+
# Enterprise Edition index. Amazon Kendra will return a
|
991
|
+
# `ValidationException` error for a `Gen_AI_ENTERPRISE_EDITION` index.
|
992
|
+
#
|
985
993
|
#
|
986
994
|
#
|
987
995
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html
|
@@ -2018,8 +2026,8 @@ module Aws::Kendra
|
|
2018
2026
|
#
|
2019
2027
|
# @option params [required, String] :role_arn
|
2020
2028
|
# The Amazon Resource Name (ARN) of an IAM role with permission to
|
2021
|
-
# access the S3 bucket that contains the
|
2022
|
-
# [IAM access roles for Amazon Kendra][1].
|
2029
|
+
# access the S3 bucket that contains the FAQ file. For more information,
|
2030
|
+
# see [IAM access roles for Amazon Kendra][1].
|
2023
2031
|
#
|
2024
2032
|
#
|
2025
2033
|
#
|
@@ -2242,14 +2250,15 @@ module Aws::Kendra
|
|
2242
2250
|
# @option params [String] :edition
|
2243
2251
|
# The Amazon Kendra edition to use for the index. Choose
|
2244
2252
|
# `DEVELOPER_EDITION` for indexes intended for development, testing, or
|
2245
|
-
# proof of concept. Use `ENTERPRISE_EDITION` for production.
|
2246
|
-
#
|
2253
|
+
# proof of concept. Use `ENTERPRISE_EDITION` for production. Use
|
2254
|
+
# `GEN_AI_ENTERPRISE_EDITION` for creating generative AI applications.
|
2255
|
+
# Once you set the edition for an index, it can't be changed.
|
2247
2256
|
#
|
2248
2257
|
# The `Edition` parameter is optional. If you don't supply a value, the
|
2249
2258
|
# default is `ENTERPRISE_EDITION`.
|
2250
2259
|
#
|
2251
|
-
# For more information on quota limits for Enterprise
|
2252
|
-
#
|
2260
|
+
# For more information on quota limits for Gen AI Enterprise Edition,
|
2261
|
+
# Enterprise Edition, and Developer Edition indices, see [Quotas][1].
|
2253
2262
|
#
|
2254
2263
|
#
|
2255
2264
|
#
|
@@ -2289,9 +2298,19 @@ module Aws::Kendra
|
|
2289
2298
|
# @option params [Array<Types::UserTokenConfiguration>] :user_token_configurations
|
2290
2299
|
# The user token configuration.
|
2291
2300
|
#
|
2301
|
+
# If you're using an Amazon Kendra Gen AI Enterprise Edition index and
|
2302
|
+
# you try to use `UserTokenConfigurations` to configure user context
|
2303
|
+
# policy, Amazon Kendra returns a `ValidationException` error.
|
2304
|
+
#
|
2292
2305
|
# @option params [String] :user_context_policy
|
2293
2306
|
# The user context policy.
|
2294
2307
|
#
|
2308
|
+
# If you're using an Amazon Kendra Gen AI Enterprise Edition index, you
|
2309
|
+
# can only use `ATTRIBUTE_FILTER` to filter search results by user
|
2310
|
+
# context. If you're using an Amazon Kendra Gen AI Enterprise Edition
|
2311
|
+
# index and you try to use `USER_TOKEN` to configure user context
|
2312
|
+
# policy, Amazon Kendra returns a `ValidationException` error.
|
2313
|
+
#
|
2295
2314
|
# ATTRIBUTE\_FILTER
|
2296
2315
|
#
|
2297
2316
|
# : All indexed content is searchable and displayable for all users. If
|
@@ -2311,6 +2330,9 @@ module Aws::Kendra
|
|
2311
2330
|
# useful for user context filtering, where search results are filtered
|
2312
2331
|
# based on the user or their group access to documents.
|
2313
2332
|
#
|
2333
|
+
# If you're using an Amazon Kendra Gen AI Enterprise Edition index,
|
2334
|
+
# `UserGroupResolutionConfiguration` isn't supported.
|
2335
|
+
#
|
2314
2336
|
#
|
2315
2337
|
#
|
2316
2338
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html
|
@@ -2323,7 +2345,7 @@ module Aws::Kendra
|
|
2323
2345
|
#
|
2324
2346
|
# resp = client.create_index({
|
2325
2347
|
# name: "IndexName", # required
|
2326
|
-
# edition: "DEVELOPER_EDITION", # accepts DEVELOPER_EDITION, ENTERPRISE_EDITION
|
2348
|
+
# edition: "DEVELOPER_EDITION", # accepts DEVELOPER_EDITION, ENTERPRISE_EDITION, GEN_AI_ENTERPRISE_EDITION
|
2327
2349
|
# role_arn: "RoleArn", # required
|
2328
2350
|
# server_side_encryption_configuration: {
|
2329
2351
|
# kms_key_id: "KmsKeyId",
|
@@ -2664,7 +2686,7 @@ module Aws::Kendra
|
|
2664
2686
|
req.send_request(options)
|
2665
2687
|
end
|
2666
2688
|
|
2667
|
-
# Removes
|
2689
|
+
# Removes a FAQ from an index.
|
2668
2690
|
#
|
2669
2691
|
# @option params [required, String] :id
|
2670
2692
|
# The identifier of the FAQ you want to remove.
|
@@ -2715,8 +2737,8 @@ module Aws::Kendra
|
|
2715
2737
|
req.send_request(options)
|
2716
2738
|
end
|
2717
2739
|
|
2718
|
-
# Deletes a group so that all users
|
2719
|
-
#
|
2740
|
+
# Deletes a group so that all users that belong to the group can no
|
2741
|
+
# longer access documents only available to that group.
|
2720
2742
|
#
|
2721
2743
|
# For example, after deleting the group "Summer Interns", all interns
|
2722
2744
|
# who belonged to that group no longer see intern-only documents in
|
@@ -3521,7 +3543,7 @@ module Aws::Kendra
|
|
3521
3543
|
req.send_request(options)
|
3522
3544
|
end
|
3523
3545
|
|
3524
|
-
# Gets information about
|
3546
|
+
# Gets information about a FAQ.
|
3525
3547
|
#
|
3526
3548
|
# @option params [required, String] :id
|
3527
3549
|
# The identifier of the FAQ you want to get information on.
|
@@ -3667,7 +3689,7 @@ module Aws::Kendra
|
|
3667
3689
|
#
|
3668
3690
|
# resp.name #=> String
|
3669
3691
|
# resp.id #=> String
|
3670
|
-
# resp.edition #=> String, one of "DEVELOPER_EDITION", "ENTERPRISE_EDITION"
|
3692
|
+
# resp.edition #=> String, one of "DEVELOPER_EDITION", "ENTERPRISE_EDITION", "GEN_AI_ENTERPRISE_EDITION"
|
3671
3693
|
# resp.role_arn #=> String
|
3672
3694
|
# resp.server_side_encryption_configuration.kms_key_id #=> String
|
3673
3695
|
# resp.status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING", "SYSTEM_UPDATING"
|
@@ -4651,10 +4673,10 @@ module Aws::Kendra
|
|
4651
4673
|
req.send_request(options)
|
4652
4674
|
end
|
4653
4675
|
|
4654
|
-
# Gets a list of
|
4676
|
+
# Gets a list of FAQs associated with an index.
|
4655
4677
|
#
|
4656
4678
|
# @option params [required, String] :index_id
|
4657
|
-
# The index
|
4679
|
+
# The index for the FAQs.
|
4658
4680
|
#
|
4659
4681
|
# @option params [String] :next_token
|
4660
4682
|
# If the previous response was incomplete (because there is more data to
|
@@ -4841,7 +4863,7 @@ module Aws::Kendra
|
|
4841
4863
|
# resp.index_configuration_summary_items #=> Array
|
4842
4864
|
# resp.index_configuration_summary_items[0].name #=> String
|
4843
4865
|
# resp.index_configuration_summary_items[0].id #=> String
|
4844
|
-
# resp.index_configuration_summary_items[0].edition #=> String, one of "DEVELOPER_EDITION", "ENTERPRISE_EDITION"
|
4866
|
+
# resp.index_configuration_summary_items[0].edition #=> String, one of "DEVELOPER_EDITION", "ENTERPRISE_EDITION", "GEN_AI_ENTERPRISE_EDITION"
|
4845
4867
|
# resp.index_configuration_summary_items[0].created_at #=> Time
|
4846
4868
|
# resp.index_configuration_summary_items[0].updated_at #=> Time
|
4847
4869
|
# resp.index_configuration_summary_items[0].status #=> String, one of "CREATING", "ACTIVE", "DELETING", "FAILED", "UPDATING", "SYSTEM_UPDATING"
|
@@ -4923,12 +4945,20 @@ module Aws::Kendra
|
|
4923
4945
|
req.send_request(options)
|
4924
4946
|
end
|
4925
4947
|
|
4926
|
-
# Gets a list of tags associated with a
|
4927
|
-
#
|
4948
|
+
# Gets a list of tags associated with a resource. Indexes, FAQs, data
|
4949
|
+
# sources, and other resources can have tags associated with them.
|
4928
4950
|
#
|
4929
4951
|
# @option params [required, String] :resource_arn
|
4930
|
-
# The Amazon Resource Name (ARN) of the index, FAQ,
|
4931
|
-
# get a list of tags for.
|
4952
|
+
# The Amazon Resource Name (ARN) of the index, FAQ, data source, or
|
4953
|
+
# other resource to get a list of tags for. For example, the ARN of an
|
4954
|
+
# index is constructed as follows:
|
4955
|
+
# *arn:aws:kendra:your-region:your-account-id:index/index-id* For
|
4956
|
+
# information on how to construct an ARN for all types of Amazon Kendra
|
4957
|
+
# resources, see [Resource types][1].
|
4958
|
+
#
|
4959
|
+
#
|
4960
|
+
#
|
4961
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonkendra.html#amazonkendra-resources-for-iam-policies
|
4932
4962
|
#
|
4933
4963
|
# @return [Types::ListTagsForResourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4934
4964
|
#
|
@@ -5044,10 +5074,10 @@ module Aws::Kendra
|
|
5044
5074
|
# The identifier of the group you want to map its users to.
|
5045
5075
|
#
|
5046
5076
|
# @option params [required, Types::GroupMembers] :group_members
|
5047
|
-
# The list that contains your users
|
5048
|
-
# group.
|
5077
|
+
# The list that contains your users that belong the same group. This can
|
5078
|
+
# include sub groups that belong to a group.
|
5049
5079
|
#
|
5050
|
-
# For example, the group "Company" includes the user "CEO" and the
|
5080
|
+
# For example, the group "Company A" includes the user "CEO" and the
|
5051
5081
|
# sub groups "Research", "Engineering", and "Sales and Marketing".
|
5052
5082
|
#
|
5053
5083
|
# If you have more than 1000 users and/or sub groups for a single group,
|
@@ -5057,7 +5087,7 @@ module Aws::Kendra
|
|
5057
5087
|
# users) must be no more than 1000.
|
5058
5088
|
#
|
5059
5089
|
# @option params [Integer] :ordering_id
|
5060
|
-
# The timestamp identifier you specify to ensure Amazon Kendra
|
5090
|
+
# The timestamp identifier you specify to ensure Amazon Kendra doesn't
|
5061
5091
|
# override the latest `PUT` action with previous actions. The highest
|
5062
5092
|
# number ID, which is the ordering ID, is the latest action you want to
|
5063
5093
|
# process and apply on top of other actions with lower number IDs. This
|
@@ -5074,9 +5104,8 @@ module Aws::Kendra
|
|
5074
5104
|
# the action was received by Amazon Kendra.
|
5075
5105
|
#
|
5076
5106
|
# @option params [String] :role_arn
|
5077
|
-
# The Amazon Resource Name (ARN) of
|
5078
|
-
# file that contains your list of users
|
5079
|
-
# group.
|
5107
|
+
# The Amazon Resource Name (ARN) of an IAM role that has access to the
|
5108
|
+
# S3 file that contains your list of users that belong to a group.
|
5080
5109
|
#
|
5081
5110
|
# For more information, see [IAM roles for Amazon Kendra][1].
|
5082
5111
|
#
|
@@ -5156,6 +5185,12 @@ module Aws::Kendra
|
|
5156
5185
|
# a maximum of four results are returned. If you filter result type to
|
5157
5186
|
# only answers, a maximum of three results are returned.
|
5158
5187
|
#
|
5188
|
+
# If you're using an Amazon Kendra Gen AI Enterprise Edition index, you
|
5189
|
+
# can only use `ATTRIBUTE_FILTER` to filter search results by user
|
5190
|
+
# context. If you're using an Amazon Kendra Gen AI Enterprise Edition
|
5191
|
+
# index and you try to use `USER_TOKEN` to configure user context
|
5192
|
+
# policy, Amazon Kendra returns a `ValidationException` error.
|
5193
|
+
#
|
5159
5194
|
#
|
5160
5195
|
#
|
5161
5196
|
# [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_Retrieve.html
|
@@ -5186,6 +5221,12 @@ module Aws::Kendra
|
|
5186
5221
|
# filtering rules that a document must satisfy to be included in the
|
5187
5222
|
# query results.
|
5188
5223
|
#
|
5224
|
+
# <note markdown="1"> For Amazon Kendra Gen AI Enterprise Edition indices use
|
5225
|
+
# `AttributeFilter` to enable document filtering for end users using
|
5226
|
+
# `_email_id` or include public documents (`_email_id=null`).
|
5227
|
+
#
|
5228
|
+
# </note>
|
5229
|
+
#
|
5189
5230
|
# @option params [Array<Types::Facet>] :facets
|
5190
5231
|
# An array of documents fields/attributes for faceted search. Amazon
|
5191
5232
|
# Kendra returns a count for each field key specified. This helps your
|
@@ -5603,6 +5644,12 @@ module Aws::Kendra
|
|
5603
5644
|
# single capacity unit and the default base capacity for an index, see
|
5604
5645
|
# [Adjusting capacity][3].
|
5605
5646
|
#
|
5647
|
+
# If you're using an Amazon Kendra Gen AI Enterprise Edition index, you
|
5648
|
+
# can only use `ATTRIBUTE_FILTER` to filter search results by user
|
5649
|
+
# context. If you're using an Amazon Kendra Gen AI Enterprise Edition
|
5650
|
+
# index and you try to use `USER_TOKEN` to configure user context
|
5651
|
+
# policy, Amazon Kendra returns a `ValidationException` error.
|
5652
|
+
#
|
5606
5653
|
#
|
5607
5654
|
#
|
5608
5655
|
# [1]: https://docs.aws.amazon.com/kendra/latest/APIReference/API_Query.html
|
@@ -5636,6 +5683,12 @@ module Aws::Kendra
|
|
5636
5683
|
# filtering rules that a document must satisfy to be included in the
|
5637
5684
|
# query results.
|
5638
5685
|
#
|
5686
|
+
# <note markdown="1"> For Amazon Kendra Gen AI Enterprise Edition indices use
|
5687
|
+
# `AttributeFilter` to enable document filtering for end users using
|
5688
|
+
# `_email_id` or include public documents (`_email_id=null`).
|
5689
|
+
#
|
5690
|
+
# </note>
|
5691
|
+
#
|
5639
5692
|
# @option params [Array<String>] :requested_document_attributes
|
5640
5693
|
# A list of document fields/attributes to include in the response. You
|
5641
5694
|
# can limit the response to include certain document fields. By default,
|
@@ -5930,17 +5983,26 @@ module Aws::Kendra
|
|
5930
5983
|
req.send_request(options)
|
5931
5984
|
end
|
5932
5985
|
|
5933
|
-
# Adds the specified tag to the specified index, FAQ,
|
5934
|
-
# resource. If the tag already exists, the existing value is
|
5935
|
-
# with the new value.
|
5986
|
+
# Adds the specified tag to the specified index, FAQ, data source, or
|
5987
|
+
# other resource. If the tag already exists, the existing value is
|
5988
|
+
# replaced with the new value.
|
5936
5989
|
#
|
5937
5990
|
# @option params [required, String] :resource_arn
|
5938
|
-
# The Amazon Resource Name (ARN) of the index, FAQ,
|
5939
|
-
# tag.
|
5991
|
+
# The Amazon Resource Name (ARN) of the index, FAQ, data source, or
|
5992
|
+
# other resource to add a tag. For example, the ARN of an index is
|
5993
|
+
# constructed as follows:
|
5994
|
+
# *arn:aws:kendra:your-region:your-account-id:index/index-id* For
|
5995
|
+
# information on how to construct an ARN for all types of Amazon Kendra
|
5996
|
+
# resources, see [Resource types][1].
|
5997
|
+
#
|
5998
|
+
#
|
5999
|
+
#
|
6000
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonkendra.html#amazonkendra-resources-for-iam-policies
|
5940
6001
|
#
|
5941
6002
|
# @option params [required, Array<Types::Tag>] :tags
|
5942
|
-
# A list of tag keys to add to the index, FAQ,
|
5943
|
-
# already exists, the existing value is replaced with
|
6003
|
+
# A list of tag keys to add to the index, FAQ, data source, or other
|
6004
|
+
# resource. If a tag already exists, the existing value is replaced with
|
6005
|
+
# the new value.
|
5944
6006
|
#
|
5945
6007
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5946
6008
|
#
|
@@ -5965,15 +6027,24 @@ module Aws::Kendra
|
|
5965
6027
|
req.send_request(options)
|
5966
6028
|
end
|
5967
6029
|
|
5968
|
-
# Removes a tag from an index, FAQ, or
|
6030
|
+
# Removes a tag from an index, FAQ, data source, or other resource.
|
5969
6031
|
#
|
5970
6032
|
# @option params [required, String] :resource_arn
|
5971
|
-
# The Amazon Resource Name (ARN) of the index, FAQ,
|
5972
|
-
# remove
|
6033
|
+
# The Amazon Resource Name (ARN) of the index, FAQ, data source, or
|
6034
|
+
# other resource to remove a tag. For example, the ARN of an index is
|
6035
|
+
# constructed as follows:
|
6036
|
+
# *arn:aws:kendra:your-region:your-account-id:index/index-id* For
|
6037
|
+
# information on how to construct an ARN for all types of Amazon Kendra
|
6038
|
+
# resources, see [Resource types][1].
|
6039
|
+
#
|
6040
|
+
#
|
6041
|
+
#
|
6042
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonkendra.html#amazonkendra-resources-for-iam-policies
|
5973
6043
|
#
|
5974
6044
|
# @option params [required, Array<String>] :tag_keys
|
5975
|
-
# A list of tag keys to remove from the index, FAQ,
|
5976
|
-
# tag key
|
6045
|
+
# A list of tag keys to remove from the index, FAQ, data source, or
|
6046
|
+
# other resource. If a tag key doesn't exist for the resource, it is
|
6047
|
+
# ignored.
|
5977
6048
|
#
|
5978
6049
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5979
6050
|
#
|
@@ -6018,6 +6089,11 @@ module Aws::Kendra
|
|
6018
6089
|
# Kendra currently only supports access control configuration for S3
|
6019
6090
|
# data sources and documents indexed using the `BatchPutDocument` API.
|
6020
6091
|
#
|
6092
|
+
# You can't configure access control using
|
6093
|
+
# `CreateAccessControlConfiguration` for an Amazon Kendra Gen AI
|
6094
|
+
# Enterprise Edition index. Amazon Kendra will return a
|
6095
|
+
# `ValidationException` error for a `Gen_AI_ENTERPRISE_EDITION` index.
|
6096
|
+
#
|
6021
6097
|
#
|
6022
6098
|
#
|
6023
6099
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_BatchPutDocument.html
|
@@ -6120,9 +6196,9 @@ module Aws::Kendra
|
|
6120
6196
|
# The sync schedule you want to update for the data source connector.
|
6121
6197
|
#
|
6122
6198
|
# @option params [String] :role_arn
|
6123
|
-
# The Amazon Resource Name (ARN) of
|
6124
|
-
# data source and required resources. For more information,
|
6125
|
-
# roles for Amazon Kendra][1].
|
6199
|
+
# The Amazon Resource Name (ARN) of an IAM role with permission to
|
6200
|
+
# access the data source and required resources. For more information,
|
6201
|
+
# see [IAM roles for Amazon Kendra][1].
|
6126
6202
|
#
|
6127
6203
|
#
|
6128
6204
|
#
|
@@ -6883,10 +6959,10 @@ module Aws::Kendra
|
|
6883
6959
|
# The identifier of the index for your Amazon Kendra experience.
|
6884
6960
|
#
|
6885
6961
|
# @option params [String] :role_arn
|
6886
|
-
# The Amazon Resource Name (ARN) of
|
6887
|
-
# `Query` API, `QuerySuggestions` API, `SubmitFeedback` API,
|
6888
|
-
# Identity Center that stores your
|
6889
|
-
# information, see [IAM roles for Amazon Kendra][1].
|
6962
|
+
# The Amazon Resource Name (ARN) of an IAM role with permission to
|
6963
|
+
# access the `Query` API, `QuerySuggestions` API, `SubmitFeedback` API,
|
6964
|
+
# and IAM Identity Center that stores your users and groups information.
|
6965
|
+
# For more information, see [IAM roles for Amazon Kendra][1].
|
6890
6966
|
#
|
6891
6967
|
#
|
6892
6968
|
#
|
@@ -7047,15 +7123,28 @@ module Aws::Kendra
|
|
7047
7123
|
# @option params [Array<Types::UserTokenConfiguration>] :user_token_configurations
|
7048
7124
|
# The user token configuration.
|
7049
7125
|
#
|
7126
|
+
# If you're using an Amazon Kendra Gen AI Enterprise Edition index and
|
7127
|
+
# you try to use `UserTokenConfigurations` to configure user context
|
7128
|
+
# policy, Amazon Kendra returns a `ValidationException` error.
|
7129
|
+
#
|
7050
7130
|
# @option params [String] :user_context_policy
|
7051
7131
|
# The user context policy.
|
7052
7132
|
#
|
7133
|
+
# If you're using an Amazon Kendra Gen AI Enterprise Edition index, you
|
7134
|
+
# can only use `ATTRIBUTE_FILTER` to filter search results by user
|
7135
|
+
# context. If you're using an Amazon Kendra Gen AI Enterprise Edition
|
7136
|
+
# index and you try to use `USER_TOKEN` to configure user context
|
7137
|
+
# policy, Amazon Kendra returns a `ValidationException` error.
|
7138
|
+
#
|
7053
7139
|
# @option params [Types::UserGroupResolutionConfiguration] :user_group_resolution_configuration
|
7054
7140
|
# Gets users and groups from IAM Identity Center identity source. To
|
7055
7141
|
# configure this, see [UserGroupResolutionConfiguration][1]. This is
|
7056
7142
|
# useful for user context filtering, where search results are filtered
|
7057
7143
|
# based on the user or their group access to documents.
|
7058
7144
|
#
|
7145
|
+
# If you're using an Amazon Kendra Gen AI Enterprise Edition index,
|
7146
|
+
# `UserGroupResolutionConfiguration` isn't supported.
|
7147
|
+
#
|
7059
7148
|
#
|
7060
7149
|
#
|
7061
7150
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html
|
@@ -7369,7 +7458,7 @@ module Aws::Kendra
|
|
7369
7458
|
tracer: tracer
|
7370
7459
|
)
|
7371
7460
|
context[:gem_name] = 'aws-sdk-kendra'
|
7372
|
-
context[:gem_version] = '1.
|
7461
|
+
context[:gem_version] = '1.94.0'
|
7373
7462
|
Seahorse::Client::Request.new(handlers, context)
|
7374
7463
|
end
|
7375
7464
|
|
@@ -712,6 +712,7 @@ module Aws::Kendra
|
|
712
712
|
BatchDeleteDocumentResponse.struct_class = Types::BatchDeleteDocumentResponse
|
713
713
|
|
714
714
|
BatchDeleteDocumentResponseFailedDocument.add_member(:id, Shapes::ShapeRef.new(shape: DocumentId, location_name: "Id"))
|
715
|
+
BatchDeleteDocumentResponseFailedDocument.add_member(:data_source_id, Shapes::ShapeRef.new(shape: DataSourceId, location_name: "DataSourceId"))
|
715
716
|
BatchDeleteDocumentResponseFailedDocument.add_member(:error_code, Shapes::ShapeRef.new(shape: ErrorCode, location_name: "ErrorCode"))
|
716
717
|
BatchDeleteDocumentResponseFailedDocument.add_member(:error_message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "ErrorMessage"))
|
717
718
|
BatchDeleteDocumentResponseFailedDocument.struct_class = Types::BatchDeleteDocumentResponseFailedDocument
|
@@ -741,6 +742,7 @@ module Aws::Kendra
|
|
741
742
|
BatchGetDocumentStatusResponse.struct_class = Types::BatchGetDocumentStatusResponse
|
742
743
|
|
743
744
|
BatchGetDocumentStatusResponseError.add_member(:document_id, Shapes::ShapeRef.new(shape: DocumentId, location_name: "DocumentId"))
|
745
|
+
BatchGetDocumentStatusResponseError.add_member(:data_source_id, Shapes::ShapeRef.new(shape: DataSourceId, location_name: "DataSourceId"))
|
744
746
|
BatchGetDocumentStatusResponseError.add_member(:error_code, Shapes::ShapeRef.new(shape: ErrorCode, location_name: "ErrorCode"))
|
745
747
|
BatchGetDocumentStatusResponseError.add_member(:error_message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "ErrorMessage"))
|
746
748
|
BatchGetDocumentStatusResponseError.struct_class = Types::BatchGetDocumentStatusResponseError
|
@@ -757,6 +759,7 @@ module Aws::Kendra
|
|
757
759
|
BatchPutDocumentResponse.struct_class = Types::BatchPutDocumentResponse
|
758
760
|
|
759
761
|
BatchPutDocumentResponseFailedDocument.add_member(:id, Shapes::ShapeRef.new(shape: DocumentId, location_name: "Id"))
|
762
|
+
BatchPutDocumentResponseFailedDocument.add_member(:data_source_id, Shapes::ShapeRef.new(shape: DataSourceId, location_name: "DataSourceId"))
|
760
763
|
BatchPutDocumentResponseFailedDocument.add_member(:error_code, Shapes::ShapeRef.new(shape: ErrorCode, location_name: "ErrorCode"))
|
761
764
|
BatchPutDocumentResponseFailedDocument.add_member(:error_message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "ErrorMessage"))
|
762
765
|
BatchPutDocumentResponseFailedDocument.struct_class = Types::BatchPutDocumentResponseFailedDocument
|
data/lib/aws-sdk-kendra/types.rb
CHANGED
@@ -350,21 +350,21 @@ module Aws::Kendra
|
|
350
350
|
# `EqualsTo` operation to filter results or documents with
|
351
351
|
# "Department" equals to "HR".
|
352
352
|
#
|
353
|
-
# You can use `AndAllFilters` and `
|
353
|
+
# You can use `AndAllFilters` and `OrAllFilters` in combination with
|
354
354
|
# each other or with other operations such as `EqualsTo`. For example:
|
355
355
|
#
|
356
356
|
# `AndAllFilters`
|
357
357
|
#
|
358
358
|
# * `EqualsTo`: "Department", "HR"
|
359
359
|
#
|
360
|
-
# * `
|
360
|
+
# * `OrAllFilters`
|
361
361
|
#
|
362
362
|
# * `ContainsAny`: "Project Name", \["new hires", "new hiring"\]
|
363
363
|
#
|
364
364
|
# ^
|
365
365
|
#
|
366
366
|
# This example filters results or documents that belong to the HR
|
367
|
-
# department
|
367
|
+
# department `AND` belong to projects that contain "new hires" `OR`
|
368
368
|
# "new hiring" in the project name (must use `ContainAny` with
|
369
369
|
# `StringListValue`). This example is filtering with a depth of 2.
|
370
370
|
#
|
@@ -633,7 +633,8 @@ module Aws::Kendra
|
|
633
633
|
# @return [Integer]
|
634
634
|
#
|
635
635
|
# @!attribute [rw] credentials
|
636
|
-
#
|
636
|
+
# The Amazon Resource Name (ARN) of an Secrets Manager secret. You
|
637
|
+
# create a secret to store your credentials in [Secrets Manager][1]
|
637
638
|
#
|
638
639
|
# You use a secret if basic authentication credentials are required to
|
639
640
|
# connect to a website. The secret stores your credentials of user
|
@@ -698,6 +699,11 @@ module Aws::Kendra
|
|
698
699
|
# index.
|
699
700
|
# @return [String]
|
700
701
|
#
|
702
|
+
# @!attribute [rw] data_source_id
|
703
|
+
# The identifier of the data source connector that the document
|
704
|
+
# belongs to.
|
705
|
+
# @return [String]
|
706
|
+
#
|
701
707
|
# @!attribute [rw] error_code
|
702
708
|
# The error code for why the document couldn't be removed from the
|
703
709
|
# index.
|
@@ -712,6 +718,7 @@ module Aws::Kendra
|
|
712
718
|
#
|
713
719
|
class BatchDeleteDocumentResponseFailedDocument < Struct.new(
|
714
720
|
:id,
|
721
|
+
:data_source_id,
|
715
722
|
:error_code,
|
716
723
|
:error_message)
|
717
724
|
SENSITIVE = []
|
@@ -834,6 +841,11 @@ module Aws::Kendra
|
|
834
841
|
# The identifier of the document whose status could not be retrieved.
|
835
842
|
# @return [String]
|
836
843
|
#
|
844
|
+
# @!attribute [rw] data_source_id
|
845
|
+
# The identifier of the data source connector that the failed document
|
846
|
+
# belongs to.
|
847
|
+
# @return [String]
|
848
|
+
#
|
837
849
|
# @!attribute [rw] error_code
|
838
850
|
# Indicates the source of the error.
|
839
851
|
# @return [String]
|
@@ -848,6 +860,7 @@ module Aws::Kendra
|
|
848
860
|
#
|
849
861
|
class BatchGetDocumentStatusResponseError < Struct.new(
|
850
862
|
:document_id,
|
863
|
+
:data_source_id,
|
851
864
|
:error_code,
|
852
865
|
:error_message)
|
853
866
|
SENSITIVE = []
|
@@ -941,6 +954,11 @@ module Aws::Kendra
|
|
941
954
|
# The identifier of the document.
|
942
955
|
# @return [String]
|
943
956
|
#
|
957
|
+
# @!attribute [rw] data_source_id
|
958
|
+
# The identifier of the data source connector that the failed document
|
959
|
+
# belongs to.
|
960
|
+
# @return [String]
|
961
|
+
#
|
944
962
|
# @!attribute [rw] error_code
|
945
963
|
# The type of error that caused the document to fail to be indexed.
|
946
964
|
# @return [String]
|
@@ -953,6 +971,7 @@ module Aws::Kendra
|
|
953
971
|
#
|
954
972
|
class BatchPutDocumentResponseFailedDocument < Struct.new(
|
955
973
|
:id,
|
974
|
+
:data_source_id,
|
956
975
|
:error_code,
|
957
976
|
:error_message)
|
958
977
|
SENSITIVE = []
|
@@ -1782,11 +1801,11 @@ module Aws::Kendra
|
|
1782
1801
|
# @return [String]
|
1783
1802
|
#
|
1784
1803
|
# @!attribute [rw] secret_arn
|
1785
|
-
# The Amazon Resource Name (ARN) of
|
1786
|
-
#
|
1787
|
-
# information, see [Using a Database Data Source][1].
|
1788
|
-
# information about Secrets Manager, see [ What Is Secrets
|
1789
|
-
# in the
|
1804
|
+
# The Amazon Resource Name (ARN) of an Secrets Manager secret that
|
1805
|
+
# stores the credentials. The credentials should be a user-password
|
1806
|
+
# pair. For more information, see [Using a Database Data Source][1].
|
1807
|
+
# For more information about Secrets Manager, see [ What Is Secrets
|
1808
|
+
# Manager][2] in the *Secrets Manager* user guide.
|
1790
1809
|
#
|
1791
1810
|
#
|
1792
1811
|
#
|
@@ -2162,8 +2181,8 @@ module Aws::Kendra
|
|
2162
2181
|
#
|
2163
2182
|
# @!attribute [rw] role_arn
|
2164
2183
|
# The Amazon Resource Name (ARN) of an IAM role with permission to
|
2165
|
-
# access the S3 bucket that contains the
|
2166
|
-
# see [IAM access roles for Amazon Kendra][1].
|
2184
|
+
# access the S3 bucket that contains the FAQ file. For more
|
2185
|
+
# information, see [IAM access roles for Amazon Kendra][1].
|
2167
2186
|
#
|
2168
2187
|
#
|
2169
2188
|
#
|
@@ -2339,14 +2358,15 @@ module Aws::Kendra
|
|
2339
2358
|
# @!attribute [rw] edition
|
2340
2359
|
# The Amazon Kendra edition to use for the index. Choose
|
2341
2360
|
# `DEVELOPER_EDITION` for indexes intended for development, testing,
|
2342
|
-
# or proof of concept. Use `ENTERPRISE_EDITION` for production.
|
2343
|
-
#
|
2361
|
+
# or proof of concept. Use `ENTERPRISE_EDITION` for production. Use
|
2362
|
+
# `GEN_AI_ENTERPRISE_EDITION` for creating generative AI applications.
|
2363
|
+
# Once you set the edition for an index, it can't be changed.
|
2344
2364
|
#
|
2345
2365
|
# The `Edition` parameter is optional. If you don't supply a value,
|
2346
2366
|
# the default is `ENTERPRISE_EDITION`.
|
2347
2367
|
#
|
2348
|
-
# For more information on quota limits for Enterprise
|
2349
|
-
#
|
2368
|
+
# For more information on quota limits for Gen AI Enterprise Edition,
|
2369
|
+
# Enterprise Edition, and Developer Edition indices, see [Quotas][1].
|
2350
2370
|
#
|
2351
2371
|
#
|
2352
2372
|
#
|
@@ -2391,11 +2411,21 @@ module Aws::Kendra
|
|
2391
2411
|
#
|
2392
2412
|
# @!attribute [rw] user_token_configurations
|
2393
2413
|
# The user token configuration.
|
2414
|
+
#
|
2415
|
+
# If you're using an Amazon Kendra Gen AI Enterprise Edition index
|
2416
|
+
# and you try to use `UserTokenConfigurations` to configure user
|
2417
|
+
# context policy, Amazon Kendra returns a `ValidationException` error.
|
2394
2418
|
# @return [Array<Types::UserTokenConfiguration>]
|
2395
2419
|
#
|
2396
2420
|
# @!attribute [rw] user_context_policy
|
2397
2421
|
# The user context policy.
|
2398
2422
|
#
|
2423
|
+
# If you're using an Amazon Kendra Gen AI Enterprise Edition index,
|
2424
|
+
# you can only use `ATTRIBUTE_FILTER` to filter search results by user
|
2425
|
+
# context. If you're using an Amazon Kendra Gen AI Enterprise Edition
|
2426
|
+
# index and you try to use `USER_TOKEN` to configure user context
|
2427
|
+
# policy, Amazon Kendra returns a `ValidationException` error.
|
2428
|
+
#
|
2399
2429
|
# ATTRIBUTE\_FILTER
|
2400
2430
|
#
|
2401
2431
|
# : All indexed content is searchable and displayable for all users.
|
@@ -2417,6 +2447,9 @@ module Aws::Kendra
|
|
2417
2447
|
# useful for user context filtering, where search results are filtered
|
2418
2448
|
# based on the user or their group access to documents.
|
2419
2449
|
#
|
2450
|
+
# If you're using an Amazon Kendra Gen AI Enterprise Edition index,
|
2451
|
+
# `UserGroupResolutionConfiguration` isn't supported.
|
2452
|
+
#
|
2420
2453
|
#
|
2421
2454
|
#
|
2422
2455
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html
|
@@ -2644,11 +2677,11 @@ module Aws::Kendra
|
|
2644
2677
|
# @return [Types::HookConfiguration]
|
2645
2678
|
#
|
2646
2679
|
# @!attribute [rw] role_arn
|
2647
|
-
# The Amazon Resource Name (ARN) of
|
2680
|
+
# The Amazon Resource Name (ARN) of an IAM role with permission to run
|
2648
2681
|
# `PreExtractionHookConfiguration` and
|
2649
2682
|
# `PostExtractionHookConfiguration` for altering document metadata and
|
2650
2683
|
# content during the document ingestion process. For more information,
|
2651
|
-
# see [IAM roles for Amazon Kendra][1].
|
2684
|
+
# see [an IAM roles for Amazon Kendra][1].
|
2652
2685
|
#
|
2653
2686
|
#
|
2654
2687
|
#
|
@@ -3495,8 +3528,8 @@ module Aws::Kendra
|
|
3495
3528
|
# @return [String]
|
3496
3529
|
#
|
3497
3530
|
# @!attribute [rw] role_arn
|
3498
|
-
# The Amazon Resource Name (ARN) of the role with permission to
|
3499
|
-
# the data source and required resources.
|
3531
|
+
# The Amazon Resource Name (ARN) of the IAM role with permission to
|
3532
|
+
# access the data source and required resources.
|
3500
3533
|
# @return [String]
|
3501
3534
|
#
|
3502
3535
|
# @!attribute [rw] error_message
|
@@ -3617,9 +3650,10 @@ module Aws::Kendra
|
|
3617
3650
|
# @return [String]
|
3618
3651
|
#
|
3619
3652
|
# @!attribute [rw] role_arn
|
3620
|
-
#
|
3621
|
-
# access `Query` API, `QuerySuggestions` API, `SubmitFeedback`
|
3622
|
-
# and IAM Identity Center that stores your
|
3653
|
+
# The Amazon Resource Name (ARN) of the IAM role with permission to
|
3654
|
+
# access the `Query` API, `QuerySuggestions` API, `SubmitFeedback`
|
3655
|
+
# API, and IAM Identity Center that stores your users and groups
|
3656
|
+
# information.
|
3623
3657
|
# @return [String]
|
3624
3658
|
#
|
3625
3659
|
# @!attribute [rw] error_message
|
@@ -3695,8 +3729,8 @@ module Aws::Kendra
|
|
3695
3729
|
# @return [String]
|
3696
3730
|
#
|
3697
3731
|
# @!attribute [rw] role_arn
|
3698
|
-
# The Amazon Resource Name (ARN) of the role that provides access
|
3699
|
-
# the S3 bucket containing the
|
3732
|
+
# The Amazon Resource Name (ARN) of the IAM role that provides access
|
3733
|
+
# to the S3 bucket containing the FAQ file.
|
3700
3734
|
# @return [String]
|
3701
3735
|
#
|
3702
3736
|
# @!attribute [rw] error_message
|
@@ -3705,7 +3739,7 @@ module Aws::Kendra
|
|
3705
3739
|
# @return [String]
|
3706
3740
|
#
|
3707
3741
|
# @!attribute [rw] file_format
|
3708
|
-
# The file format used
|
3742
|
+
# The file format used for the FAQ file.
|
3709
3743
|
# @return [String]
|
3710
3744
|
#
|
3711
3745
|
# @!attribute [rw] language_code
|
@@ -5212,11 +5246,10 @@ module Aws::Kendra
|
|
5212
5246
|
end
|
5213
5247
|
|
5214
5248
|
# Provides statistical information about the FAQ questions and answers
|
5215
|
-
#
|
5249
|
+
# for an index.
|
5216
5250
|
#
|
5217
5251
|
# @!attribute [rw] indexed_question_answers_count
|
5218
|
-
# The total number of FAQ questions and answers
|
5219
|
-
# index.
|
5252
|
+
# The total number of FAQ questions and answers for an index.
|
5220
5253
|
# @return [Integer]
|
5221
5254
|
#
|
5222
5255
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/FaqStatistics AWS API Documentation
|
@@ -6265,14 +6298,14 @@ module Aws::Kendra
|
|
6265
6298
|
include Aws::Structure
|
6266
6299
|
end
|
6267
6300
|
|
6268
|
-
# A list of users
|
6269
|
-
#
|
6270
|
-
#
|
6301
|
+
# A list of users that belong to a group. This is useful for user
|
6302
|
+
# context filtering, where search results are filtered based on the user
|
6303
|
+
# or their group access to documents.
|
6271
6304
|
#
|
6272
6305
|
# @!attribute [rw] member_groups
|
6273
|
-
# A list of
|
6274
|
-
# groups "Research", "Engineering",
|
6275
|
-
# all belong to the group "Company".
|
6306
|
+
# A list of users that belong to a group. This can also include sub
|
6307
|
+
# groups. For example, the sub groups "Research", "Engineering",
|
6308
|
+
# and "Sales and Marketing" all belong to the group "Company A".
|
6276
6309
|
# @return [Array<Types::MemberGroup>]
|
6277
6310
|
#
|
6278
6311
|
# @!attribute [rw] member_users
|
@@ -6452,9 +6485,9 @@ module Aws::Kendra
|
|
6452
6485
|
# @return [Types::DocumentAttributeCondition]
|
6453
6486
|
#
|
6454
6487
|
# @!attribute [rw] lambda_arn
|
6455
|
-
# The Amazon Resource Name (ARN) of
|
6456
|
-
# Lambda function during ingestion. For more information, see [
|
6457
|
-
# roles for Amazon Kendra][1].
|
6488
|
+
# The Amazon Resource Name (ARN) of an IAM role with permission to run
|
6489
|
+
# a Lambda function during ingestion. For more information, see [an
|
6490
|
+
# IAM roles for Amazon Kendra][1].
|
6458
6491
|
#
|
6459
6492
|
#
|
6460
6493
|
#
|
@@ -7137,7 +7170,7 @@ module Aws::Kendra
|
|
7137
7170
|
end
|
7138
7171
|
|
7139
7172
|
# @!attribute [rw] index_id
|
7140
|
-
# The index
|
7173
|
+
# The index for the FAQs.
|
7141
7174
|
# @return [String]
|
7142
7175
|
#
|
7143
7176
|
# @!attribute [rw] next_token
|
@@ -7170,7 +7203,7 @@ module Aws::Kendra
|
|
7170
7203
|
# @return [String]
|
7171
7204
|
#
|
7172
7205
|
# @!attribute [rw] faq_summary_items
|
7173
|
-
# information about the FAQs
|
7206
|
+
# Summary information about the FAQs for a specified index.
|
7174
7207
|
# @return [Array<Types::FaqSummary>]
|
7175
7208
|
#
|
7176
7209
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListFaqsResponse AWS API Documentation
|
@@ -7390,8 +7423,16 @@ module Aws::Kendra
|
|
7390
7423
|
end
|
7391
7424
|
|
7392
7425
|
# @!attribute [rw] resource_arn
|
7393
|
-
# The Amazon Resource Name (ARN) of the index, FAQ,
|
7394
|
-
# get a list of tags for.
|
7426
|
+
# The Amazon Resource Name (ARN) of the index, FAQ, data source, or
|
7427
|
+
# other resource to get a list of tags for. For example, the ARN of an
|
7428
|
+
# index is constructed as follows:
|
7429
|
+
# *arn:aws:kendra:your-region:your-account-id:index/index-id* For
|
7430
|
+
# information on how to construct an ARN for all types of Amazon
|
7431
|
+
# Kendra resources, see [Resource types][1].
|
7432
|
+
#
|
7433
|
+
#
|
7434
|
+
#
|
7435
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonkendra.html#amazonkendra-resources-for-iam-policies
|
7395
7436
|
# @return [String]
|
7396
7437
|
#
|
7397
7438
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListTagsForResourceRequest AWS API Documentation
|
@@ -7403,7 +7444,8 @@ module Aws::Kendra
|
|
7403
7444
|
end
|
7404
7445
|
|
7405
7446
|
# @!attribute [rw] tags
|
7406
|
-
# A list of tags associated with the index, FAQ,
|
7447
|
+
# A list of tags associated with the index, FAQ, data source, or other
|
7448
|
+
# resource.
|
7407
7449
|
# @return [Array<Types::Tag>]
|
7408
7450
|
#
|
7409
7451
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListTagsForResourceResponse AWS API Documentation
|
@@ -7608,7 +7650,7 @@ module Aws::Kendra
|
|
7608
7650
|
# @!attribute [rw] one_drive_user_list
|
7609
7651
|
# A list of users whose documents should be indexed. Specify the user
|
7610
7652
|
# names in email format, for example, `username@tenantdomain`. If you
|
7611
|
-
# need to index the documents of more than
|
7653
|
+
# need to index the documents of more than 10 users, use the
|
7612
7654
|
# `OneDriveUserS3Path` field to specify the location of a file
|
7613
7655
|
# containing a list of users.
|
7614
7656
|
# @return [Array<String>]
|
@@ -7729,7 +7771,8 @@ module Aws::Kendra
|
|
7729
7771
|
# @return [Integer]
|
7730
7772
|
#
|
7731
7773
|
# @!attribute [rw] credentials
|
7732
|
-
#
|
7774
|
+
# The Amazon Resource Name (ARN) of an Secrets Manager secret. You
|
7775
|
+
# create a secret to store your credentials in [Secrets Manager][1]
|
7733
7776
|
#
|
7734
7777
|
# The credentials are optional. You use a secret if web proxy
|
7735
7778
|
# credentials are required to connect to a website host. Amazon Kendra
|
@@ -7773,11 +7816,11 @@ module Aws::Kendra
|
|
7773
7816
|
# @return [String]
|
7774
7817
|
#
|
7775
7818
|
# @!attribute [rw] group_members
|
7776
|
-
# The list that contains your users
|
7777
|
-
# group.
|
7819
|
+
# The list that contains your users that belong the same group. This
|
7820
|
+
# can include sub groups that belong to a group.
|
7778
7821
|
#
|
7779
|
-
# For example, the group "Company" includes the user "CEO" and
|
7780
|
-
# sub groups "Research", "Engineering", and "Sales and
|
7822
|
+
# For example, the group "Company A" includes the user "CEO" and
|
7823
|
+
# the sub groups "Research", "Engineering", and "Sales and
|
7781
7824
|
# Marketing".
|
7782
7825
|
#
|
7783
7826
|
# If you have more than 1000 users and/or sub groups for a single
|
@@ -7788,8 +7831,8 @@ module Aws::Kendra
|
|
7788
7831
|
# @return [Types::GroupMembers]
|
7789
7832
|
#
|
7790
7833
|
# @!attribute [rw] ordering_id
|
7791
|
-
# The timestamp identifier you specify to ensure Amazon Kendra
|
7792
|
-
#
|
7834
|
+
# The timestamp identifier you specify to ensure Amazon Kendra
|
7835
|
+
# doesn't override the latest `PUT` action with previous actions. The
|
7793
7836
|
# highest number ID, which is the ordering ID, is the latest action
|
7794
7837
|
# you want to process and apply on top of other actions with lower
|
7795
7838
|
# number IDs. This prevents previous actions with lower number IDs
|
@@ -7807,9 +7850,8 @@ module Aws::Kendra
|
|
7807
7850
|
# @return [Integer]
|
7808
7851
|
#
|
7809
7852
|
# @!attribute [rw] role_arn
|
7810
|
-
# The Amazon Resource Name (ARN) of
|
7811
|
-
# file that contains your list of users
|
7812
|
-
# group.
|
7853
|
+
# The Amazon Resource Name (ARN) of an IAM role that has access to the
|
7854
|
+
# S3 file that contains your list of users that belong to a group.
|
7813
7855
|
#
|
7814
7856
|
# For more information, see [IAM roles for Amazon Kendra][1].
|
7815
7857
|
#
|
@@ -7858,6 +7900,12 @@ module Aws::Kendra
|
|
7858
7900
|
# The `AttributeFilter` parameter means you can create a set of
|
7859
7901
|
# filtering rules that a document must satisfy to be included in the
|
7860
7902
|
# query results.
|
7903
|
+
#
|
7904
|
+
# <note markdown="1"> For Amazon Kendra Gen AI Enterprise Edition indices use
|
7905
|
+
# `AttributeFilter` to enable document filtering for end users using
|
7906
|
+
# `_email_id` or include public documents (`_email_id=null`).
|
7907
|
+
#
|
7908
|
+
# </note>
|
7861
7909
|
# @return [Types::AttributeFilter]
|
7862
7910
|
#
|
7863
7911
|
# @!attribute [rw] facets
|
@@ -8497,6 +8545,12 @@ module Aws::Kendra
|
|
8497
8545
|
# The `AttributeFilter` parameter means you can create a set of
|
8498
8546
|
# filtering rules that a document must satisfy to be included in the
|
8499
8547
|
# query results.
|
8548
|
+
#
|
8549
|
+
# <note markdown="1"> For Amazon Kendra Gen AI Enterprise Edition indices use
|
8550
|
+
# `AttributeFilter` to enable document filtering for end users using
|
8551
|
+
# `_email_id` or include public documents (`_email_id=null`).
|
8552
|
+
#
|
8553
|
+
# </note>
|
8500
8554
|
# @return [Types::AttributeFilter]
|
8501
8555
|
#
|
8502
8556
|
# @!attribute [rw] requested_document_attributes
|
@@ -10235,13 +10289,14 @@ module Aws::Kendra
|
|
10235
10289
|
include Aws::Structure
|
10236
10290
|
end
|
10237
10291
|
|
10238
|
-
# A
|
10239
|
-
#
|
10240
|
-
# space, and any of the following symbols: \_ . :
|
10292
|
+
# A key-value pair that identifies or categorizes an index, FAQ, data
|
10293
|
+
# source, or other resource. TA tag key and value can consist of Unicode
|
10294
|
+
# letters, digits, white space, and any of the following symbols: \_ . :
|
10295
|
+
# / = + - @.
|
10241
10296
|
#
|
10242
10297
|
# @!attribute [rw] key
|
10243
10298
|
# The key for the tag. Keys are not case sensitive and must be unique
|
10244
|
-
# for the index, FAQ, or
|
10299
|
+
# for the index, FAQ, data source, or other resource.
|
10245
10300
|
# @return [String]
|
10246
10301
|
#
|
10247
10302
|
# @!attribute [rw] value
|
@@ -10259,14 +10314,22 @@ module Aws::Kendra
|
|
10259
10314
|
end
|
10260
10315
|
|
10261
10316
|
# @!attribute [rw] resource_arn
|
10262
|
-
# The Amazon Resource Name (ARN) of the index, FAQ,
|
10263
|
-
# tag.
|
10317
|
+
# The Amazon Resource Name (ARN) of the index, FAQ, data source, or
|
10318
|
+
# other resource to add a tag. For example, the ARN of an index is
|
10319
|
+
# constructed as follows:
|
10320
|
+
# *arn:aws:kendra:your-region:your-account-id:index/index-id* For
|
10321
|
+
# information on how to construct an ARN for all types of Amazon
|
10322
|
+
# Kendra resources, see [Resource types][1].
|
10323
|
+
#
|
10324
|
+
#
|
10325
|
+
#
|
10326
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonkendra.html#amazonkendra-resources-for-iam-policies
|
10264
10327
|
# @return [String]
|
10265
10328
|
#
|
10266
10329
|
# @!attribute [rw] tags
|
10267
|
-
# A list of tag keys to add to the index, FAQ,
|
10268
|
-
# tag already exists, the existing value is replaced
|
10269
|
-
# value.
|
10330
|
+
# A list of tag keys to add to the index, FAQ, data source, or other
|
10331
|
+
# resource. If a tag already exists, the existing value is replaced
|
10332
|
+
# with the new value.
|
10270
10333
|
# @return [Array<Types::Tag>]
|
10271
10334
|
#
|
10272
10335
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/TagResourceRequest AWS API Documentation
|
@@ -10410,13 +10473,22 @@ module Aws::Kendra
|
|
10410
10473
|
end
|
10411
10474
|
|
10412
10475
|
# @!attribute [rw] resource_arn
|
10413
|
-
# The Amazon Resource Name (ARN) of the index, FAQ,
|
10414
|
-
# remove
|
10476
|
+
# The Amazon Resource Name (ARN) of the index, FAQ, data source, or
|
10477
|
+
# other resource to remove a tag. For example, the ARN of an index is
|
10478
|
+
# constructed as follows:
|
10479
|
+
# *arn:aws:kendra:your-region:your-account-id:index/index-id* For
|
10480
|
+
# information on how to construct an ARN for all types of Amazon
|
10481
|
+
# Kendra resources, see [Resource types][1].
|
10482
|
+
#
|
10483
|
+
#
|
10484
|
+
#
|
10485
|
+
# [1]: https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonkendra.html#amazonkendra-resources-for-iam-policies
|
10415
10486
|
# @return [String]
|
10416
10487
|
#
|
10417
10488
|
# @!attribute [rw] tag_keys
|
10418
|
-
# A list of tag keys to remove from the index, FAQ,
|
10419
|
-
# a tag key
|
10489
|
+
# A list of tag keys to remove from the index, FAQ, data source, or
|
10490
|
+
# other resource. If a tag key doesn't exist for the resource, it is
|
10491
|
+
# ignored.
|
10420
10492
|
# @return [Array<String>]
|
10421
10493
|
#
|
10422
10494
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UntagResourceRequest AWS API Documentation
|
@@ -10518,9 +10590,9 @@ module Aws::Kendra
|
|
10518
10590
|
# @return [String]
|
10519
10591
|
#
|
10520
10592
|
# @!attribute [rw] role_arn
|
10521
|
-
# The Amazon Resource Name (ARN) of
|
10522
|
-
# the data source and required resources. For more information,
|
10523
|
-
# [IAM roles for Amazon Kendra][1].
|
10593
|
+
# The Amazon Resource Name (ARN) of an IAM role with permission to
|
10594
|
+
# access the data source and required resources. For more information,
|
10595
|
+
# see [IAM roles for Amazon Kendra][1].
|
10524
10596
|
#
|
10525
10597
|
#
|
10526
10598
|
#
|
@@ -10583,10 +10655,11 @@ module Aws::Kendra
|
|
10583
10655
|
# @return [String]
|
10584
10656
|
#
|
10585
10657
|
# @!attribute [rw] role_arn
|
10586
|
-
# The Amazon Resource Name (ARN) of
|
10587
|
-
# `Query` API, `QuerySuggestions` API, `SubmitFeedback`
|
10588
|
-
# Identity Center that stores your
|
10589
|
-
# more information, see [IAM roles for Amazon
|
10658
|
+
# The Amazon Resource Name (ARN) of an IAM role with permission to
|
10659
|
+
# access the `Query` API, `QuerySuggestions` API, `SubmitFeedback`
|
10660
|
+
# API, and IAM Identity Center that stores your users and groups
|
10661
|
+
# information. For more information, see [IAM roles for Amazon
|
10662
|
+
# Kendra][1].
|
10590
10663
|
#
|
10591
10664
|
#
|
10592
10665
|
#
|
@@ -10725,10 +10798,20 @@ module Aws::Kendra
|
|
10725
10798
|
#
|
10726
10799
|
# @!attribute [rw] user_token_configurations
|
10727
10800
|
# The user token configuration.
|
10801
|
+
#
|
10802
|
+
# If you're using an Amazon Kendra Gen AI Enterprise Edition index
|
10803
|
+
# and you try to use `UserTokenConfigurations` to configure user
|
10804
|
+
# context policy, Amazon Kendra returns a `ValidationException` error.
|
10728
10805
|
# @return [Array<Types::UserTokenConfiguration>]
|
10729
10806
|
#
|
10730
10807
|
# @!attribute [rw] user_context_policy
|
10731
10808
|
# The user context policy.
|
10809
|
+
#
|
10810
|
+
# If you're using an Amazon Kendra Gen AI Enterprise Edition index,
|
10811
|
+
# you can only use `ATTRIBUTE_FILTER` to filter search results by user
|
10812
|
+
# context. If you're using an Amazon Kendra Gen AI Enterprise Edition
|
10813
|
+
# index and you try to use `USER_TOKEN` to configure user context
|
10814
|
+
# policy, Amazon Kendra returns a `ValidationException` error.
|
10732
10815
|
# @return [String]
|
10733
10816
|
#
|
10734
10817
|
# @!attribute [rw] user_group_resolution_configuration
|
@@ -10737,6 +10820,9 @@ module Aws::Kendra
|
|
10737
10820
|
# useful for user context filtering, where search results are filtered
|
10738
10821
|
# based on the user or their group access to documents.
|
10739
10822
|
#
|
10823
|
+
# If you're using an Amazon Kendra Gen AI Enterprise Edition index,
|
10824
|
+
# `UserGroupResolutionConfiguration` isn't supported.
|
10825
|
+
#
|
10740
10826
|
#
|
10741
10827
|
#
|
10742
10828
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html
|
@@ -10990,6 +11076,16 @@ module Aws::Kendra
|
|
10990
11076
|
#
|
10991
11077
|
# If you provide both, an exception is thrown.
|
10992
11078
|
#
|
11079
|
+
# If you're using an Amazon Kendra Gen AI Enterprise Edition index, you
|
11080
|
+
# can use `UserId`, `Groups`, and `DataSourceGroups` to filter content.
|
11081
|
+
# If you set the `UserId` to a particular user ID, it also includes all
|
11082
|
+
# public documents.
|
11083
|
+
#
|
11084
|
+
# Amazon Kendra Gen AI Enterprise Edition indices don't support token
|
11085
|
+
# based document filtering. If you're using an Amazon Kendra Gen AI
|
11086
|
+
# Enterprise Edition index, Amazon Kendra returns a
|
11087
|
+
# `ValidationException` error if the `Token` field has a non-null value.
|
11088
|
+
#
|
10993
11089
|
# @!attribute [rw] token
|
10994
11090
|
# The user context token for filtering search results for a user. It
|
10995
11091
|
# must be a JWT or a JSON token.
|
@@ -11040,6 +11136,9 @@ module Aws::Kendra
|
|
11040
11136
|
# source. You must create your index in the management account for the
|
11041
11137
|
# organization in order to use `UserGroupResolutionConfiguration`.
|
11042
11138
|
#
|
11139
|
+
# If you're using an Amazon Kendra Gen AI Enterprise Edition index,
|
11140
|
+
# `UserGroupResolutionConfiguration` isn't supported.
|
11141
|
+
#
|
11043
11142
|
#
|
11044
11143
|
#
|
11045
11144
|
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_PutPrincipalMapping.html
|
@@ -11089,6 +11188,10 @@ module Aws::Kendra
|
|
11089
11188
|
|
11090
11189
|
# Provides the configuration information for a token.
|
11091
11190
|
#
|
11191
|
+
# If you're using an Amazon Kendra Gen AI Enterprise Edition index and
|
11192
|
+
# you try to use `UserTokenConfigurations` to configure user context
|
11193
|
+
# policy, Amazon Kendra returns a `ValidationException` error.
|
11194
|
+
#
|
11092
11195
|
# @!attribute [rw] jwt_token_type_configuration
|
11093
11196
|
# Information about the JWT token type configuration.
|
11094
11197
|
# @return [Types::JwtTokenTypeConfiguration]
|
data/lib/aws-sdk-kendra.rb
CHANGED
data/sig/client.rbs
CHANGED
@@ -1109,7 +1109,7 @@ module Aws
|
|
1109
1109
|
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Kendra/Client.html#create_index-instance_method
|
1110
1110
|
def create_index: (
|
1111
1111
|
name: ::String,
|
1112
|
-
?edition: ("DEVELOPER_EDITION" | "ENTERPRISE_EDITION"),
|
1112
|
+
?edition: ("DEVELOPER_EDITION" | "ENTERPRISE_EDITION" | "GEN_AI_ENTERPRISE_EDITION"),
|
1113
1113
|
role_arn: ::String,
|
1114
1114
|
?server_side_encryption_configuration: {
|
1115
1115
|
kms_key_id: ::String?
|
@@ -1363,7 +1363,7 @@ module Aws
|
|
1363
1363
|
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeIndexResponse]
|
1364
1364
|
def name: () -> ::String
|
1365
1365
|
def id: () -> ::String
|
1366
|
-
def edition: () -> ("DEVELOPER_EDITION" | "ENTERPRISE_EDITION")
|
1366
|
+
def edition: () -> ("DEVELOPER_EDITION" | "ENTERPRISE_EDITION" | "GEN_AI_ENTERPRISE_EDITION")
|
1367
1367
|
def role_arn: () -> ::String
|
1368
1368
|
def server_side_encryption_configuration: () -> Types::ServerSideEncryptionConfiguration
|
1369
1369
|
def status: () -> ("CREATING" | "ACTIVE" | "DELETING" | "FAILED" | "UPDATING" | "SYSTEM_UPDATING")
|
data/sig/types.rbs
CHANGED
@@ -141,6 +141,7 @@ module Aws::Kendra
|
|
141
141
|
|
142
142
|
class BatchDeleteDocumentResponseFailedDocument
|
143
143
|
attr_accessor id: ::String
|
144
|
+
attr_accessor data_source_id: ::String
|
144
145
|
attr_accessor error_code: ("InternalError" | "InvalidRequest")
|
145
146
|
attr_accessor error_message: ::String
|
146
147
|
SENSITIVE: []
|
@@ -178,6 +179,7 @@ module Aws::Kendra
|
|
178
179
|
|
179
180
|
class BatchGetDocumentStatusResponseError
|
180
181
|
attr_accessor document_id: ::String
|
182
|
+
attr_accessor data_source_id: ::String
|
181
183
|
attr_accessor error_code: ("InternalError" | "InvalidRequest")
|
182
184
|
attr_accessor error_message: ::String
|
183
185
|
SENSITIVE: []
|
@@ -198,6 +200,7 @@ module Aws::Kendra
|
|
198
200
|
|
199
201
|
class BatchPutDocumentResponseFailedDocument
|
200
202
|
attr_accessor id: ::String
|
203
|
+
attr_accessor data_source_id: ::String
|
201
204
|
attr_accessor error_code: ("InternalError" | "InvalidRequest")
|
202
205
|
attr_accessor error_message: ::String
|
203
206
|
SENSITIVE: []
|
@@ -454,7 +457,7 @@ module Aws::Kendra
|
|
454
457
|
|
455
458
|
class CreateIndexRequest
|
456
459
|
attr_accessor name: ::String
|
457
|
-
attr_accessor edition: ("DEVELOPER_EDITION" | "ENTERPRISE_EDITION")
|
460
|
+
attr_accessor edition: ("DEVELOPER_EDITION" | "ENTERPRISE_EDITION" | "GEN_AI_ENTERPRISE_EDITION")
|
458
461
|
attr_accessor role_arn: ::String
|
459
462
|
attr_accessor server_side_encryption_configuration: Types::ServerSideEncryptionConfiguration
|
460
463
|
attr_accessor description: ::String
|
@@ -765,7 +768,7 @@ module Aws::Kendra
|
|
765
768
|
class DescribeIndexResponse
|
766
769
|
attr_accessor name: ::String
|
767
770
|
attr_accessor id: ::String
|
768
|
-
attr_accessor edition: ("DEVELOPER_EDITION" | "ENTERPRISE_EDITION")
|
771
|
+
attr_accessor edition: ("DEVELOPER_EDITION" | "ENTERPRISE_EDITION" | "GEN_AI_ENTERPRISE_EDITION")
|
769
772
|
attr_accessor role_arn: ::String
|
770
773
|
attr_accessor server_side_encryption_configuration: Types::ServerSideEncryptionConfiguration
|
771
774
|
attr_accessor status: ("CREATING" | "ACTIVE" | "DELETING" | "FAILED" | "UPDATING" | "SYSTEM_UPDATING")
|
@@ -1252,7 +1255,7 @@ module Aws::Kendra
|
|
1252
1255
|
class IndexConfigurationSummary
|
1253
1256
|
attr_accessor name: ::String
|
1254
1257
|
attr_accessor id: ::String
|
1255
|
-
attr_accessor edition: ("DEVELOPER_EDITION" | "ENTERPRISE_EDITION")
|
1258
|
+
attr_accessor edition: ("DEVELOPER_EDITION" | "ENTERPRISE_EDITION" | "GEN_AI_ENTERPRISE_EDITION")
|
1256
1259
|
attr_accessor created_at: ::Time
|
1257
1260
|
attr_accessor updated_at: ::Time
|
1258
1261
|
attr_accessor status: ("CREATING" | "ACTIVE" | "DELETING" | "FAILED" | "UPDATING" | "SYSTEM_UPDATING")
|
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.94.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-
|
11
|
+
date: 2024-12-04 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|