aws-sdk-kendra 1.32.0 → 1.36.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 +4 -4
- data/CHANGELOG.md +20 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-kendra/client.rb +103 -28
- data/lib/aws-sdk-kendra/client_api.rb +16 -0
- data/lib/aws-sdk-kendra/types.rb +246 -53
- data/lib/aws-sdk-kendra.rb +1 -1
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 172f57c667ef88d9f793c504de5c32fef9259ccf52a9864ce68007141e067807
|
4
|
+
data.tar.gz: b02997a43d46884fe6955b18cb7e880a50f8148ee59d85d186bf095d72eff62d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0751fb9977310e9553f28f91fc7f282194e587a5a6df48829a902ff8df0a8492b5ffa4d7e7592f508ba2d11bd75e55ef23b7225e1e0b3aee77d1e9cffcbf819b
|
7
|
+
data.tar.gz: 22f1e2bd9a6251f4ebc5eca281e99bd9a08272071865c0659c4cb706eaeffe81a3e695b78e3837d84825e759ed47a852c5e6ed1445085c55362a3636a4d17ae1
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,26 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.36.0 (2021-10-07)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Amazon Kendra now supports indexing and querying documents in different languages.
|
8
|
+
|
9
|
+
1.35.0 (2021-10-06)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Amazon Kendra now supports integration with AWS SSO
|
13
|
+
|
14
|
+
1.34.0 (2021-09-01)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.33.0 (2021-07-30)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
23
|
+
|
4
24
|
1.32.0 (2021-07-28)
|
5
25
|
------------------
|
6
26
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.36.0
|
@@ -612,12 +612,12 @@ module Aws::Kendra
|
|
612
612
|
req.send_request(options)
|
613
613
|
end
|
614
614
|
|
615
|
-
# Creates a data source that you
|
615
|
+
# Creates a data source that you want to use with an Amazon Kendra
|
616
|
+
# index.
|
616
617
|
#
|
617
618
|
# You specify a name, data source connector type and description for
|
618
|
-
# your data source. You also specify configuration information
|
619
|
-
#
|
620
|
-
# information.
|
619
|
+
# your data source. You also specify configuration information for the
|
620
|
+
# data source connector.
|
621
621
|
#
|
622
622
|
# `CreateDataSource` is a synchronous operation. The operation returns
|
623
623
|
# 200 if the data source was successfully created. Otherwise, an
|
@@ -685,6 +685,16 @@ module Aws::Kendra
|
|
685
685
|
# **A suitable default value is auto-generated.** You should normally
|
686
686
|
# not need to pass this option.**
|
687
687
|
#
|
688
|
+
# @option params [String] :language_code
|
689
|
+
# The code for a language. This allows you to support a language for all
|
690
|
+
# documents when creating the data source. English is supported by
|
691
|
+
# default. For more information on supported languages, including their
|
692
|
+
# codes, see [Adding documents in languages other than English][1].
|
693
|
+
#
|
694
|
+
#
|
695
|
+
#
|
696
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html
|
697
|
+
#
|
688
698
|
# @return [Types::CreateDataSourceResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
689
699
|
#
|
690
700
|
# * {Types::CreateDataSourceResponse#id #id} => String
|
@@ -1017,6 +1027,7 @@ module Aws::Kendra
|
|
1017
1027
|
# },
|
1018
1028
|
# ],
|
1019
1029
|
# client_token: "ClientTokenName",
|
1030
|
+
# language_code: "LanguageCode",
|
1020
1031
|
# })
|
1021
1032
|
#
|
1022
1033
|
# @example Response structure
|
@@ -1083,6 +1094,16 @@ module Aws::Kendra
|
|
1083
1094
|
# **A suitable default value is auto-generated.** You should normally
|
1084
1095
|
# not need to pass this option.**
|
1085
1096
|
#
|
1097
|
+
# @option params [String] :language_code
|
1098
|
+
# The code for a language. This allows you to support a language for the
|
1099
|
+
# FAQ document. English is supported by default. For more information on
|
1100
|
+
# supported languages, including their codes, see [Adding documents in
|
1101
|
+
# languages other than English][1].
|
1102
|
+
#
|
1103
|
+
#
|
1104
|
+
#
|
1105
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html
|
1106
|
+
#
|
1086
1107
|
# @return [Types::CreateFaqResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1087
1108
|
#
|
1088
1109
|
# * {Types::CreateFaqResponse#id #id} => String
|
@@ -1106,6 +1127,7 @@ module Aws::Kendra
|
|
1106
1127
|
# ],
|
1107
1128
|
# file_format: "CSV", # accepts CSV, CSV_WITH_HEADER, JSON
|
1108
1129
|
# client_token: "ClientTokenName",
|
1130
|
+
# language_code: "LanguageCode",
|
1109
1131
|
# })
|
1110
1132
|
#
|
1111
1133
|
# @example Response structure
|
@@ -1186,14 +1208,24 @@ module Aws::Kendra
|
|
1186
1208
|
# ATTRIBUTE\_FILTER
|
1187
1209
|
#
|
1188
1210
|
# : All indexed content is searchable and displayable for all users. If
|
1189
|
-
#
|
1190
|
-
#
|
1211
|
+
# you want to filter search results on user context, you can use the
|
1212
|
+
# attribute filters of `_user_id` and `_group_ids` or you can provide
|
1213
|
+
# user and group information in `UserContext`.
|
1191
1214
|
#
|
1192
1215
|
# USER\_TOKEN
|
1193
1216
|
#
|
1194
|
-
# : Enables
|
1195
|
-
# no access control and all documents
|
1196
|
-
# searchable and displayable.
|
1217
|
+
# : Enables token-based user access control to filter search results on
|
1218
|
+
# user context. All documents with no access control and all documents
|
1219
|
+
# accessible to the user will be searchable and displayable.
|
1220
|
+
#
|
1221
|
+
# @option params [Types::UserGroupResolutionConfiguration] :user_group_resolution_configuration
|
1222
|
+
# Enables fetching access levels of groups and users from an AWS Single
|
1223
|
+
# Sign-On identity source. To configure this, see
|
1224
|
+
# [UserGroupResolutionConfiguration][1].
|
1225
|
+
#
|
1226
|
+
#
|
1227
|
+
#
|
1228
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html
|
1197
1229
|
#
|
1198
1230
|
# @return [Types::CreateIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1199
1231
|
#
|
@@ -1234,6 +1266,9 @@ module Aws::Kendra
|
|
1234
1266
|
# },
|
1235
1267
|
# ],
|
1236
1268
|
# user_context_policy: "ATTRIBUTE_FILTER", # accepts ATTRIBUTE_FILTER, USER_TOKEN
|
1269
|
+
# user_group_resolution_configuration: {
|
1270
|
+
# user_group_resolution_mode: "AWS_SSO", # required, accepts AWS_SSO, NONE
|
1271
|
+
# },
|
1237
1272
|
# })
|
1238
1273
|
#
|
1239
1274
|
# @example Response structure
|
@@ -1378,7 +1413,7 @@ module Aws::Kendra
|
|
1378
1413
|
# @option params [String] :client_token
|
1379
1414
|
# A token that you provide to identify the request to create a
|
1380
1415
|
# thesaurus. Multiple calls to the `CreateThesaurus` operation with the
|
1381
|
-
# same client token will create only one
|
1416
|
+
# same client token will create only one thesaurus.
|
1382
1417
|
#
|
1383
1418
|
# **A suitable default value is auto-generated.** You should normally
|
1384
1419
|
# not need to pass this option.**
|
@@ -1655,6 +1690,7 @@ module Aws::Kendra
|
|
1655
1690
|
# * {Types::DescribeDataSourceResponse#schedule #schedule} => String
|
1656
1691
|
# * {Types::DescribeDataSourceResponse#role_arn #role_arn} => String
|
1657
1692
|
# * {Types::DescribeDataSourceResponse#error_message #error_message} => String
|
1693
|
+
# * {Types::DescribeDataSourceResponse#language_code #language_code} => String
|
1658
1694
|
#
|
1659
1695
|
# @example Request syntax with placeholder values
|
1660
1696
|
#
|
@@ -1894,6 +1930,7 @@ module Aws::Kendra
|
|
1894
1930
|
# resp.schedule #=> String
|
1895
1931
|
# resp.role_arn #=> String
|
1896
1932
|
# resp.error_message #=> String
|
1933
|
+
# resp.language_code #=> String
|
1897
1934
|
#
|
1898
1935
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeDataSource AWS API Documentation
|
1899
1936
|
#
|
@@ -1925,6 +1962,7 @@ module Aws::Kendra
|
|
1925
1962
|
# * {Types::DescribeFaqResponse#role_arn #role_arn} => String
|
1926
1963
|
# * {Types::DescribeFaqResponse#error_message #error_message} => String
|
1927
1964
|
# * {Types::DescribeFaqResponse#file_format #file_format} => String
|
1965
|
+
# * {Types::DescribeFaqResponse#language_code #language_code} => String
|
1928
1966
|
#
|
1929
1967
|
# @example Request syntax with placeholder values
|
1930
1968
|
#
|
@@ -1947,6 +1985,7 @@ module Aws::Kendra
|
|
1947
1985
|
# resp.role_arn #=> String
|
1948
1986
|
# resp.error_message #=> String
|
1949
1987
|
# resp.file_format #=> String, one of "CSV", "CSV_WITH_HEADER", "JSON"
|
1988
|
+
# resp.language_code #=> String
|
1950
1989
|
#
|
1951
1990
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeFaq AWS API Documentation
|
1952
1991
|
#
|
@@ -1979,6 +2018,7 @@ module Aws::Kendra
|
|
1979
2018
|
# * {Types::DescribeIndexResponse#capacity_units #capacity_units} => Types::CapacityUnitsConfiguration
|
1980
2019
|
# * {Types::DescribeIndexResponse#user_token_configurations #user_token_configurations} => Array<Types::UserTokenConfiguration>
|
1981
2020
|
# * {Types::DescribeIndexResponse#user_context_policy #user_context_policy} => String
|
2021
|
+
# * {Types::DescribeIndexResponse#user_group_resolution_configuration #user_group_resolution_configuration} => Types::UserGroupResolutionConfiguration
|
1982
2022
|
#
|
1983
2023
|
# @example Request syntax with placeholder values
|
1984
2024
|
#
|
@@ -2027,6 +2067,7 @@ module Aws::Kendra
|
|
2027
2067
|
# resp.user_token_configurations[0].json_token_type_configuration.user_name_attribute_field #=> String
|
2028
2068
|
# resp.user_token_configurations[0].json_token_type_configuration.group_attribute_field #=> String
|
2029
2069
|
# resp.user_context_policy #=> String, one of "ATTRIBUTE_FILTER", "USER_TOKEN"
|
2070
|
+
# resp.user_group_resolution_configuration.user_group_resolution_mode #=> String, one of "AWS_SSO", "NONE"
|
2030
2071
|
#
|
2031
2072
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndex AWS API Documentation
|
2032
2073
|
#
|
@@ -2316,8 +2357,9 @@ module Aws::Kendra
|
|
2316
2357
|
# The identifier of the index that contains the data source.
|
2317
2358
|
#
|
2318
2359
|
# @option params [String] :next_token
|
2319
|
-
# If the
|
2320
|
-
#
|
2360
|
+
# If the previous response was incomplete (because there is more data to
|
2361
|
+
# retrieve), Amazon Kendra returns a pagination token in the response.
|
2362
|
+
# You can use this pagination token to retrieve the next set of jobs.
|
2321
2363
|
#
|
2322
2364
|
# @option params [Integer] :max_results
|
2323
2365
|
# The maximum number of synchronization jobs to return in the response.
|
@@ -2417,6 +2459,7 @@ module Aws::Kendra
|
|
2417
2459
|
# resp.summary_items[0].created_at #=> Time
|
2418
2460
|
# resp.summary_items[0].updated_at #=> Time
|
2419
2461
|
# resp.summary_items[0].status #=> String, one of "CREATING", "DELETING", "FAILED", "UPDATING", "ACTIVE"
|
2462
|
+
# resp.summary_items[0].language_code #=> String
|
2420
2463
|
# resp.next_token #=> String
|
2421
2464
|
#
|
2422
2465
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSources AWS API Documentation
|
@@ -2434,8 +2477,9 @@ module Aws::Kendra
|
|
2434
2477
|
# The index that contains the FAQ lists.
|
2435
2478
|
#
|
2436
2479
|
# @option params [String] :next_token
|
2437
|
-
# If the
|
2438
|
-
#
|
2480
|
+
# If the previous response was incomplete (because there is more data to
|
2481
|
+
# retrieve), Amazon Kendra returns a pagination token in the response.
|
2482
|
+
# You can use this pagination token to retrieve the next set of FAQs.
|
2439
2483
|
#
|
2440
2484
|
# @option params [Integer] :max_results
|
2441
2485
|
# The maximum number of FAQs to return in the response. If there are
|
@@ -2465,6 +2509,7 @@ module Aws::Kendra
|
|
2465
2509
|
# resp.faq_summary_items[0].created_at #=> Time
|
2466
2510
|
# resp.faq_summary_items[0].updated_at #=> Time
|
2467
2511
|
# resp.faq_summary_items[0].file_format #=> String, one of "CSV", "CSV_WITH_HEADER", "JSON"
|
2512
|
+
# resp.faq_summary_items[0].language_code #=> String
|
2468
2513
|
#
|
2469
2514
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListFaqs AWS API Documentation
|
2470
2515
|
#
|
@@ -2491,11 +2536,15 @@ module Aws::Kendra
|
|
2491
2536
|
# for mapping users to their groups.
|
2492
2537
|
#
|
2493
2538
|
# @option params [String] :next_token
|
2494
|
-
#
|
2539
|
+
# If the previous response was incomplete (because there is more data to
|
2540
|
+
# retrieve), Amazon Kendra returns a pagination token in the response.
|
2541
|
+
# You can use this pagination token to retrieve the next set of groups
|
2542
|
+
# that are mapped to users before a given ordering or timestamp
|
2543
|
+
# identifier.
|
2495
2544
|
#
|
2496
2545
|
# @option params [Integer] :max_results
|
2497
|
-
# The maximum
|
2498
|
-
#
|
2546
|
+
# The maximum number of returned groups that are mapped to users before
|
2547
|
+
# a given ordering or timestamp identifier.
|
2499
2548
|
#
|
2500
2549
|
# @return [Types::ListGroupsOlderThanOrderingIdResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2501
2550
|
#
|
@@ -2713,13 +2762,16 @@ module Aws::Kendra
|
|
2713
2762
|
req.send_request(options)
|
2714
2763
|
end
|
2715
2764
|
|
2716
|
-
# Maps users to their groups
|
2717
|
-
#
|
2718
|
-
#
|
2719
|
-
#
|
2720
|
-
#
|
2721
|
-
#
|
2722
|
-
#
|
2765
|
+
# Maps users to their groups so that you only need to provide the user
|
2766
|
+
# ID when you issue the query.
|
2767
|
+
#
|
2768
|
+
# You can also map sub groups to groups. For example, the group
|
2769
|
+
# "Company Intellectual Property Teams" includes sub groups
|
2770
|
+
# "Research" and "Engineering". These sub groups include their own
|
2771
|
+
# list of users or people who work in these teams. Only users who work
|
2772
|
+
# in research and engineering, and therefore belong in the intellectual
|
2773
|
+
# property group, can see top-secret company documents in their search
|
2774
|
+
# results.
|
2723
2775
|
#
|
2724
2776
|
# You map users to their groups when you want to filter search results
|
2725
2777
|
# for different users based on their group’s access to documents. For
|
@@ -2921,7 +2973,7 @@ module Aws::Kendra
|
|
2921
2973
|
# the relevance that Amazon Kendra determines for the result.
|
2922
2974
|
#
|
2923
2975
|
# @option params [Types::UserContext] :user_context
|
2924
|
-
# The user context token.
|
2976
|
+
# The user context token or user and group information.
|
2925
2977
|
#
|
2926
2978
|
# @option params [String] :visitor_id
|
2927
2979
|
# Provides an identifier for a specific user. The `VisitorId` should be
|
@@ -3096,7 +3148,7 @@ module Aws::Kendra
|
|
3096
3148
|
# resp.result_items[0].document_attributes[0].value.string_list_value[0] #=> String
|
3097
3149
|
# resp.result_items[0].document_attributes[0].value.long_value #=> Integer
|
3098
3150
|
# resp.result_items[0].document_attributes[0].value.date_value #=> Time
|
3099
|
-
# resp.result_items[0].score_attributes.score_confidence #=> String, one of "VERY_HIGH", "HIGH", "MEDIUM", "LOW"
|
3151
|
+
# resp.result_items[0].score_attributes.score_confidence #=> String, one of "VERY_HIGH", "HIGH", "MEDIUM", "LOW", "NOT_AVAILABLE"
|
3100
3152
|
# resp.result_items[0].feedback_token #=> String
|
3101
3153
|
# resp.facet_results #=> Array
|
3102
3154
|
# resp.facet_results[0].document_attribute_key #=> String
|
@@ -3319,6 +3371,16 @@ module Aws::Kendra
|
|
3319
3371
|
# The Amazon Resource Name (ARN) of the new role to use when the data
|
3320
3372
|
# source is accessing resources on your behalf.
|
3321
3373
|
#
|
3374
|
+
# @option params [String] :language_code
|
3375
|
+
# The code for a language. This allows you to support a language for all
|
3376
|
+
# documents when updating the data source. English is supported by
|
3377
|
+
# default. For more information on supported languages, including their
|
3378
|
+
# codes, see [Adding documents in languages other than English][1].
|
3379
|
+
#
|
3380
|
+
#
|
3381
|
+
#
|
3382
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html
|
3383
|
+
#
|
3322
3384
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3323
3385
|
#
|
3324
3386
|
# @example Request syntax with placeholder values
|
@@ -3642,6 +3704,7 @@ module Aws::Kendra
|
|
3642
3704
|
# description: "Description",
|
3643
3705
|
# schedule: "ScanSchedule",
|
3644
3706
|
# role_arn: "RoleArn",
|
3707
|
+
# language_code: "LanguageCode",
|
3645
3708
|
# })
|
3646
3709
|
#
|
3647
3710
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateDataSource AWS API Documentation
|
@@ -3683,7 +3746,16 @@ module Aws::Kendra
|
|
3683
3746
|
# The user token configuration.
|
3684
3747
|
#
|
3685
3748
|
# @option params [String] :user_context_policy
|
3686
|
-
# The user
|
3749
|
+
# The user context policy.
|
3750
|
+
#
|
3751
|
+
# @option params [Types::UserGroupResolutionConfiguration] :user_group_resolution_configuration
|
3752
|
+
# Enables fetching access levels of groups and users from an AWS Single
|
3753
|
+
# Sign-On identity source. To configure this, see
|
3754
|
+
# [UserGroupResolutionConfiguration][1].
|
3755
|
+
#
|
3756
|
+
#
|
3757
|
+
#
|
3758
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html
|
3687
3759
|
#
|
3688
3760
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3689
3761
|
#
|
@@ -3737,6 +3809,9 @@ module Aws::Kendra
|
|
3737
3809
|
# },
|
3738
3810
|
# ],
|
3739
3811
|
# user_context_policy: "ATTRIBUTE_FILTER", # accepts ATTRIBUTE_FILTER, USER_TOKEN
|
3812
|
+
# user_group_resolution_configuration: {
|
3813
|
+
# user_group_resolution_mode: "AWS_SSO", # required, accepts AWS_SSO, NONE
|
3814
|
+
# },
|
3740
3815
|
# })
|
3741
3816
|
#
|
3742
3817
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateIndex AWS API Documentation
|
@@ -3967,7 +4042,7 @@ module Aws::Kendra
|
|
3967
4042
|
params: params,
|
3968
4043
|
config: config)
|
3969
4044
|
context[:gem_name] = 'aws-sdk-kendra'
|
3970
|
-
context[:gem_version] = '1.
|
4045
|
+
context[:gem_version] = '1.36.0'
|
3971
4046
|
Seahorse::Client::Request.new(handlers, context)
|
3972
4047
|
end
|
3973
4048
|
|
@@ -210,6 +210,7 @@ module Aws::Kendra
|
|
210
210
|
JwtTokenTypeConfiguration = Shapes::StructureShape.new(name: 'JwtTokenTypeConfiguration')
|
211
211
|
KeyLocation = Shapes::StringShape.new(name: 'KeyLocation')
|
212
212
|
KmsKeyId = Shapes::StringShape.new(name: 'KmsKeyId')
|
213
|
+
LanguageCode = Shapes::StringShape.new(name: 'LanguageCode')
|
213
214
|
ListDataSourceSyncJobsRequest = Shapes::StructureShape.new(name: 'ListDataSourceSyncJobsRequest')
|
214
215
|
ListDataSourceSyncJobsResponse = Shapes::StructureShape.new(name: 'ListDataSourceSyncJobsResponse')
|
215
216
|
ListDataSourcesRequest = Shapes::StructureShape.new(name: 'ListDataSourcesRequest')
|
@@ -387,6 +388,8 @@ module Aws::Kendra
|
|
387
388
|
UserAccount = Shapes::StringShape.new(name: 'UserAccount')
|
388
389
|
UserContext = Shapes::StructureShape.new(name: 'UserContext')
|
389
390
|
UserContextPolicy = Shapes::StringShape.new(name: 'UserContextPolicy')
|
391
|
+
UserGroupResolutionConfiguration = Shapes::StructureShape.new(name: 'UserGroupResolutionConfiguration')
|
392
|
+
UserGroupResolutionMode = Shapes::StringShape.new(name: 'UserGroupResolutionMode')
|
390
393
|
UserId = Shapes::StringShape.new(name: 'UserId')
|
391
394
|
UserNameAttributeField = Shapes::StringShape.new(name: 'UserNameAttributeField')
|
392
395
|
UserTokenConfiguration = Shapes::StructureShape.new(name: 'UserTokenConfiguration')
|
@@ -588,6 +591,7 @@ module Aws::Kendra
|
|
588
591
|
CreateDataSourceRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "RoleArn"))
|
589
592
|
CreateDataSourceRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
590
593
|
CreateDataSourceRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientTokenName, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
|
594
|
+
CreateDataSourceRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, location_name: "LanguageCode"))
|
591
595
|
CreateDataSourceRequest.struct_class = Types::CreateDataSourceRequest
|
592
596
|
|
593
597
|
CreateDataSourceResponse.add_member(:id, Shapes::ShapeRef.new(shape: DataSourceId, required: true, location_name: "Id"))
|
@@ -601,6 +605,7 @@ module Aws::Kendra
|
|
601
605
|
CreateFaqRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
602
606
|
CreateFaqRequest.add_member(:file_format, Shapes::ShapeRef.new(shape: FaqFileFormat, location_name: "FileFormat"))
|
603
607
|
CreateFaqRequest.add_member(:client_token, Shapes::ShapeRef.new(shape: ClientTokenName, location_name: "ClientToken", metadata: {"idempotencyToken"=>true}))
|
608
|
+
CreateFaqRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, location_name: "LanguageCode"))
|
604
609
|
CreateFaqRequest.struct_class = Types::CreateFaqRequest
|
605
610
|
|
606
611
|
CreateFaqResponse.add_member(:id, Shapes::ShapeRef.new(shape: FaqId, location_name: "Id"))
|
@@ -615,6 +620,7 @@ module Aws::Kendra
|
|
615
620
|
CreateIndexRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
|
616
621
|
CreateIndexRequest.add_member(:user_token_configurations, Shapes::ShapeRef.new(shape: UserTokenConfigurationList, location_name: "UserTokenConfigurations"))
|
617
622
|
CreateIndexRequest.add_member(:user_context_policy, Shapes::ShapeRef.new(shape: UserContextPolicy, location_name: "UserContextPolicy"))
|
623
|
+
CreateIndexRequest.add_member(:user_group_resolution_configuration, Shapes::ShapeRef.new(shape: UserGroupResolutionConfiguration, location_name: "UserGroupResolutionConfiguration"))
|
618
624
|
CreateIndexRequest.struct_class = Types::CreateIndexRequest
|
619
625
|
|
620
626
|
CreateIndexResponse.add_member(:id, Shapes::ShapeRef.new(shape: IndexId, location_name: "Id"))
|
@@ -670,6 +676,7 @@ module Aws::Kendra
|
|
670
676
|
DataSourceSummary.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreatedAt"))
|
671
677
|
DataSourceSummary.add_member(:updated_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "UpdatedAt"))
|
672
678
|
DataSourceSummary.add_member(:status, Shapes::ShapeRef.new(shape: DataSourceStatus, location_name: "Status"))
|
679
|
+
DataSourceSummary.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, location_name: "LanguageCode"))
|
673
680
|
DataSourceSummary.struct_class = Types::DataSourceSummary
|
674
681
|
|
675
682
|
DataSourceSummaryList.member = Shapes::ShapeRef.new(shape: DataSourceSummary)
|
@@ -757,6 +764,7 @@ module Aws::Kendra
|
|
757
764
|
DescribeDataSourceResponse.add_member(:schedule, Shapes::ShapeRef.new(shape: ScanSchedule, location_name: "Schedule"))
|
758
765
|
DescribeDataSourceResponse.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "RoleArn"))
|
759
766
|
DescribeDataSourceResponse.add_member(:error_message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "ErrorMessage"))
|
767
|
+
DescribeDataSourceResponse.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, location_name: "LanguageCode"))
|
760
768
|
DescribeDataSourceResponse.struct_class = Types::DescribeDataSourceResponse
|
761
769
|
|
762
770
|
DescribeFaqRequest.add_member(:id, Shapes::ShapeRef.new(shape: FaqId, required: true, location_name: "Id"))
|
@@ -774,6 +782,7 @@ module Aws::Kendra
|
|
774
782
|
DescribeFaqResponse.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "RoleArn"))
|
775
783
|
DescribeFaqResponse.add_member(:error_message, Shapes::ShapeRef.new(shape: ErrorMessage, location_name: "ErrorMessage"))
|
776
784
|
DescribeFaqResponse.add_member(:file_format, Shapes::ShapeRef.new(shape: FaqFileFormat, location_name: "FileFormat"))
|
785
|
+
DescribeFaqResponse.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, location_name: "LanguageCode"))
|
777
786
|
DescribeFaqResponse.struct_class = Types::DescribeFaqResponse
|
778
787
|
|
779
788
|
DescribeIndexRequest.add_member(:id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "Id"))
|
@@ -794,6 +803,7 @@ module Aws::Kendra
|
|
794
803
|
DescribeIndexResponse.add_member(:capacity_units, Shapes::ShapeRef.new(shape: CapacityUnitsConfiguration, location_name: "CapacityUnits"))
|
795
804
|
DescribeIndexResponse.add_member(:user_token_configurations, Shapes::ShapeRef.new(shape: UserTokenConfigurationList, location_name: "UserTokenConfigurations"))
|
796
805
|
DescribeIndexResponse.add_member(:user_context_policy, Shapes::ShapeRef.new(shape: UserContextPolicy, location_name: "UserContextPolicy"))
|
806
|
+
DescribeIndexResponse.add_member(:user_group_resolution_configuration, Shapes::ShapeRef.new(shape: UserGroupResolutionConfiguration, location_name: "UserGroupResolutionConfiguration"))
|
797
807
|
DescribeIndexResponse.struct_class = Types::DescribeIndexResponse
|
798
808
|
|
799
809
|
DescribePrincipalMappingRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
|
@@ -946,6 +956,7 @@ module Aws::Kendra
|
|
946
956
|
FaqSummary.add_member(:created_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "CreatedAt"))
|
947
957
|
FaqSummary.add_member(:updated_at, Shapes::ShapeRef.new(shape: Timestamp, location_name: "UpdatedAt"))
|
948
958
|
FaqSummary.add_member(:file_format, Shapes::ShapeRef.new(shape: FaqFileFormat, location_name: "FileFormat"))
|
959
|
+
FaqSummary.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, location_name: "LanguageCode"))
|
949
960
|
FaqSummary.struct_class = Types::FaqSummary
|
950
961
|
|
951
962
|
FaqSummaryItems.member = Shapes::ShapeRef.new(shape: FaqSummary)
|
@@ -1456,6 +1467,7 @@ module Aws::Kendra
|
|
1456
1467
|
UpdateDataSourceRequest.add_member(:description, Shapes::ShapeRef.new(shape: Description, location_name: "Description"))
|
1457
1468
|
UpdateDataSourceRequest.add_member(:schedule, Shapes::ShapeRef.new(shape: ScanSchedule, location_name: "Schedule"))
|
1458
1469
|
UpdateDataSourceRequest.add_member(:role_arn, Shapes::ShapeRef.new(shape: RoleArn, location_name: "RoleArn"))
|
1470
|
+
UpdateDataSourceRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, location_name: "LanguageCode"))
|
1459
1471
|
UpdateDataSourceRequest.struct_class = Types::UpdateDataSourceRequest
|
1460
1472
|
|
1461
1473
|
UpdateIndexRequest.add_member(:id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "Id"))
|
@@ -1466,6 +1478,7 @@ module Aws::Kendra
|
|
1466
1478
|
UpdateIndexRequest.add_member(:capacity_units, Shapes::ShapeRef.new(shape: CapacityUnitsConfiguration, location_name: "CapacityUnits"))
|
1467
1479
|
UpdateIndexRequest.add_member(:user_token_configurations, Shapes::ShapeRef.new(shape: UserTokenConfigurationList, location_name: "UserTokenConfigurations"))
|
1468
1480
|
UpdateIndexRequest.add_member(:user_context_policy, Shapes::ShapeRef.new(shape: UserContextPolicy, location_name: "UserContextPolicy"))
|
1481
|
+
UpdateIndexRequest.add_member(:user_group_resolution_configuration, Shapes::ShapeRef.new(shape: UserGroupResolutionConfiguration, location_name: "UserGroupResolutionConfiguration"))
|
1469
1482
|
UpdateIndexRequest.struct_class = Types::UpdateIndexRequest
|
1470
1483
|
|
1471
1484
|
UpdateQuerySuggestionsBlockListRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
|
@@ -1502,6 +1515,9 @@ module Aws::Kendra
|
|
1502
1515
|
UserContext.add_member(:data_source_groups, Shapes::ShapeRef.new(shape: DataSourceGroups, location_name: "DataSourceGroups"))
|
1503
1516
|
UserContext.struct_class = Types::UserContext
|
1504
1517
|
|
1518
|
+
UserGroupResolutionConfiguration.add_member(:user_group_resolution_mode, Shapes::ShapeRef.new(shape: UserGroupResolutionMode, required: true, location_name: "UserGroupResolutionMode"))
|
1519
|
+
UserGroupResolutionConfiguration.struct_class = Types::UserGroupResolutionConfiguration
|
1520
|
+
|
1505
1521
|
UserTokenConfiguration.add_member(:jwt_token_type_configuration, Shapes::ShapeRef.new(shape: JwtTokenTypeConfiguration, location_name: "JwtTokenTypeConfiguration"))
|
1506
1522
|
UserTokenConfiguration.add_member(:json_token_type_configuration, Shapes::ShapeRef.new(shape: JsonTokenTypeConfiguration, location_name: "JsonTokenTypeConfiguration"))
|
1507
1523
|
UserTokenConfiguration.struct_class = Types::UserTokenConfiguration
|
data/lib/aws-sdk-kendra/types.rb
CHANGED
@@ -128,9 +128,10 @@ module Aws::Kendra
|
|
128
128
|
# exception with the message "`AttributeFilter` cannot have a depth of
|
129
129
|
# more than 2."
|
130
130
|
#
|
131
|
-
# If you use more than 10 attribute filters
|
132
|
-
# `
|
133
|
-
# cannot have a length of more than
|
131
|
+
# If you use more than 10 attribute filters in a given list for
|
132
|
+
# `AndAllFilters` or `OrAllFilters`, you receive a `ValidationException`
|
133
|
+
# with the message "`AttributeFilter` cannot have a length of more than
|
134
|
+
# 10".
|
134
135
|
#
|
135
136
|
# @note When making an API call, you may pass AttributeFilter
|
136
137
|
# data as a hash:
|
@@ -461,23 +462,22 @@ module Aws::Kendra
|
|
461
462
|
#
|
462
463
|
# @!attribute [rw] greater_than
|
463
464
|
# Performs a greater than operation on two document attributes. Use
|
464
|
-
# with a document attribute of type `
|
465
|
+
# with a document attribute of type `Date` or `Long`.
|
465
466
|
# @return [Types::DocumentAttribute]
|
466
467
|
#
|
467
468
|
# @!attribute [rw] greater_than_or_equals
|
468
469
|
# Performs a greater or equals than operation on two document
|
469
|
-
# attributes. Use with a document attribute of type `
|
470
|
-
# `Long`.
|
470
|
+
# attributes. Use with a document attribute of type `Date` or `Long`.
|
471
471
|
# @return [Types::DocumentAttribute]
|
472
472
|
#
|
473
473
|
# @!attribute [rw] less_than
|
474
474
|
# Performs a less than operation on two document attributes. Use with
|
475
|
-
# a document attribute of type `
|
475
|
+
# a document attribute of type `Date` or `Long`.
|
476
476
|
# @return [Types::DocumentAttribute]
|
477
477
|
#
|
478
478
|
# @!attribute [rw] less_than_or_equals
|
479
479
|
# Performs a less than or equals operation on two document attributes.
|
480
|
-
# Use with a document attribute of type `
|
480
|
+
# Use with a document attribute of type `Date` or `Long`.
|
481
481
|
# @return [Types::DocumentAttribute]
|
482
482
|
#
|
483
483
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/AttributeFilter AWS API Documentation
|
@@ -1939,6 +1939,7 @@ module Aws::Kendra
|
|
1939
1939
|
# },
|
1940
1940
|
# ],
|
1941
1941
|
# client_token: "ClientTokenName",
|
1942
|
+
# language_code: "LanguageCode",
|
1942
1943
|
# }
|
1943
1944
|
#
|
1944
1945
|
# @!attribute [rw] name
|
@@ -2013,6 +2014,18 @@ module Aws::Kendra
|
|
2013
2014
|
# not need to pass this option.
|
2014
2015
|
# @return [String]
|
2015
2016
|
#
|
2017
|
+
# @!attribute [rw] language_code
|
2018
|
+
# The code for a language. This allows you to support a language for
|
2019
|
+
# all documents when creating the data source. English is supported by
|
2020
|
+
# default. For more information on supported languages, including
|
2021
|
+
# their codes, see [Adding documents in languages other than
|
2022
|
+
# English][1].
|
2023
|
+
#
|
2024
|
+
#
|
2025
|
+
#
|
2026
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html
|
2027
|
+
# @return [String]
|
2028
|
+
#
|
2016
2029
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateDataSourceRequest AWS API Documentation
|
2017
2030
|
#
|
2018
2031
|
class CreateDataSourceRequest < Struct.new(
|
@@ -2024,7 +2037,8 @@ module Aws::Kendra
|
|
2024
2037
|
:schedule,
|
2025
2038
|
:role_arn,
|
2026
2039
|
:tags,
|
2027
|
-
:client_token
|
2040
|
+
:client_token,
|
2041
|
+
:language_code)
|
2028
2042
|
SENSITIVE = []
|
2029
2043
|
include Aws::Structure
|
2030
2044
|
end
|
@@ -2061,6 +2075,7 @@ module Aws::Kendra
|
|
2061
2075
|
# ],
|
2062
2076
|
# file_format: "CSV", # accepts CSV, CSV_WITH_HEADER, JSON
|
2063
2077
|
# client_token: "ClientTokenName",
|
2078
|
+
# language_code: "LanguageCode",
|
2064
2079
|
# }
|
2065
2080
|
#
|
2066
2081
|
# @!attribute [rw] index_id
|
@@ -2119,6 +2134,17 @@ module Aws::Kendra
|
|
2119
2134
|
# not need to pass this option.
|
2120
2135
|
# @return [String]
|
2121
2136
|
#
|
2137
|
+
# @!attribute [rw] language_code
|
2138
|
+
# The code for a language. This allows you to support a language for
|
2139
|
+
# the FAQ document. English is supported by default. For more
|
2140
|
+
# information on supported languages, including their codes, see
|
2141
|
+
# [Adding documents in languages other than English][1].
|
2142
|
+
#
|
2143
|
+
#
|
2144
|
+
#
|
2145
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html
|
2146
|
+
# @return [String]
|
2147
|
+
#
|
2122
2148
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateFaqRequest AWS API Documentation
|
2123
2149
|
#
|
2124
2150
|
class CreateFaqRequest < Struct.new(
|
@@ -2129,7 +2155,8 @@ module Aws::Kendra
|
|
2129
2155
|
:role_arn,
|
2130
2156
|
:tags,
|
2131
2157
|
:file_format,
|
2132
|
-
:client_token
|
2158
|
+
:client_token,
|
2159
|
+
:language_code)
|
2133
2160
|
SENSITIVE = []
|
2134
2161
|
include Aws::Structure
|
2135
2162
|
end
|
@@ -2182,6 +2209,9 @@ module Aws::Kendra
|
|
2182
2209
|
# },
|
2183
2210
|
# ],
|
2184
2211
|
# user_context_policy: "ATTRIBUTE_FILTER", # accepts ATTRIBUTE_FILTER, USER_TOKEN
|
2212
|
+
# user_group_resolution_configuration: {
|
2213
|
+
# user_group_resolution_mode: "AWS_SSO", # required, accepts AWS_SSO, NONE
|
2214
|
+
# },
|
2185
2215
|
# }
|
2186
2216
|
#
|
2187
2217
|
# @!attribute [rw] name
|
@@ -2248,16 +2278,28 @@ module Aws::Kendra
|
|
2248
2278
|
# ATTRIBUTE\_FILTER
|
2249
2279
|
#
|
2250
2280
|
# : All indexed content is searchable and displayable for all users.
|
2251
|
-
# If
|
2252
|
-
#
|
2281
|
+
# If you want to filter search results on user context, you can use
|
2282
|
+
# the attribute filters of `_user_id` and `_group_ids` or you can
|
2283
|
+
# provide user and group information in `UserContext`.
|
2253
2284
|
#
|
2254
2285
|
# USER\_TOKEN
|
2255
2286
|
#
|
2256
|
-
# : Enables
|
2257
|
-
# with no access control and all
|
2258
|
-
# will be searchable and
|
2287
|
+
# : Enables token-based user access control to filter search results
|
2288
|
+
# on user context. All documents with no access control and all
|
2289
|
+
# documents accessible to the user will be searchable and
|
2290
|
+
# displayable.
|
2259
2291
|
# @return [String]
|
2260
2292
|
#
|
2293
|
+
# @!attribute [rw] user_group_resolution_configuration
|
2294
|
+
# Enables fetching access levels of groups and users from an AWS
|
2295
|
+
# Single Sign-On identity source. To configure this, see
|
2296
|
+
# [UserGroupResolutionConfiguration][1].
|
2297
|
+
#
|
2298
|
+
#
|
2299
|
+
#
|
2300
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html
|
2301
|
+
# @return [Types::UserGroupResolutionConfiguration]
|
2302
|
+
#
|
2261
2303
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateIndexRequest AWS API Documentation
|
2262
2304
|
#
|
2263
2305
|
class CreateIndexRequest < Struct.new(
|
@@ -2269,7 +2311,8 @@ module Aws::Kendra
|
|
2269
2311
|
:client_token,
|
2270
2312
|
:tags,
|
2271
2313
|
:user_token_configurations,
|
2272
|
-
:user_context_policy
|
2314
|
+
:user_context_policy,
|
2315
|
+
:user_group_resolution_configuration)
|
2273
2316
|
SENSITIVE = []
|
2274
2317
|
include Aws::Structure
|
2275
2318
|
end
|
@@ -2443,7 +2486,7 @@ module Aws::Kendra
|
|
2443
2486
|
# @!attribute [rw] client_token
|
2444
2487
|
# A token that you provide to identify the request to create a
|
2445
2488
|
# thesaurus. Multiple calls to the `CreateThesaurus` operation with
|
2446
|
-
# the same client token will create only one
|
2489
|
+
# the same client token will create only one thesaurus.
|
2447
2490
|
#
|
2448
2491
|
# **A suitable default value is auto-generated.** You should normally
|
2449
2492
|
# not need to pass this option.
|
@@ -2919,6 +2962,17 @@ module Aws::Kendra
|
|
2919
2962
|
# source is ready to use.
|
2920
2963
|
# @return [String]
|
2921
2964
|
#
|
2965
|
+
# @!attribute [rw] language_code
|
2966
|
+
# The code for a language. This shows a supported language for all
|
2967
|
+
# documents in the data source. English is supported by default. For
|
2968
|
+
# more information on supported languages, including their codes, see
|
2969
|
+
# [Adding documents in languages other than English][1].
|
2970
|
+
#
|
2971
|
+
#
|
2972
|
+
#
|
2973
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html
|
2974
|
+
# @return [String]
|
2975
|
+
#
|
2922
2976
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DataSourceSummary AWS API Documentation
|
2923
2977
|
#
|
2924
2978
|
class DataSourceSummary < Struct.new(
|
@@ -2927,7 +2981,8 @@ module Aws::Kendra
|
|
2927
2981
|
:type,
|
2928
2982
|
:created_at,
|
2929
2983
|
:updated_at,
|
2930
|
-
:status
|
2984
|
+
:status,
|
2985
|
+
:language_code)
|
2931
2986
|
SENSITIVE = []
|
2932
2987
|
include Aws::Structure
|
2933
2988
|
end
|
@@ -3475,6 +3530,17 @@ module Aws::Kendra
|
|
3475
3530
|
# fail.
|
3476
3531
|
# @return [String]
|
3477
3532
|
#
|
3533
|
+
# @!attribute [rw] language_code
|
3534
|
+
# The code for a language. This shows a supported language for all
|
3535
|
+
# documents in the data source. English is supported by default. For
|
3536
|
+
# more information on supported languages, including their codes, see
|
3537
|
+
# [Adding documents in languages other than English][1].
|
3538
|
+
#
|
3539
|
+
#
|
3540
|
+
#
|
3541
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html
|
3542
|
+
# @return [String]
|
3543
|
+
#
|
3478
3544
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeDataSourceResponse AWS API Documentation
|
3479
3545
|
#
|
3480
3546
|
class DescribeDataSourceResponse < Struct.new(
|
@@ -3489,7 +3555,8 @@ module Aws::Kendra
|
|
3489
3555
|
:status,
|
3490
3556
|
:schedule,
|
3491
3557
|
:role_arn,
|
3492
|
-
:error_message
|
3558
|
+
:error_message,
|
3559
|
+
:language_code)
|
3493
3560
|
SENSITIVE = []
|
3494
3561
|
include Aws::Structure
|
3495
3562
|
end
|
@@ -3566,6 +3633,17 @@ module Aws::Kendra
|
|
3566
3633
|
# The file format used by the input files for the FAQ.
|
3567
3634
|
# @return [String]
|
3568
3635
|
#
|
3636
|
+
# @!attribute [rw] language_code
|
3637
|
+
# The code for a language. This shows a supported language for the FAQ
|
3638
|
+
# document. English is supported by default. For more information on
|
3639
|
+
# supported languages, including their codes, see [Adding documents in
|
3640
|
+
# languages other than English][1].
|
3641
|
+
#
|
3642
|
+
#
|
3643
|
+
#
|
3644
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html
|
3645
|
+
# @return [String]
|
3646
|
+
#
|
3569
3647
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeFaqResponse AWS API Documentation
|
3570
3648
|
#
|
3571
3649
|
class DescribeFaqResponse < Struct.new(
|
@@ -3579,7 +3657,8 @@ module Aws::Kendra
|
|
3579
3657
|
:status,
|
3580
3658
|
:role_arn,
|
3581
3659
|
:error_message,
|
3582
|
-
:file_format
|
3660
|
+
:file_format,
|
3661
|
+
:language_code)
|
3583
3662
|
SENSITIVE = []
|
3584
3663
|
include Aws::Structure
|
3585
3664
|
end
|
@@ -3675,6 +3754,12 @@ module Aws::Kendra
|
|
3675
3754
|
# The user context policy for the Amazon Kendra index.
|
3676
3755
|
# @return [String]
|
3677
3756
|
#
|
3757
|
+
# @!attribute [rw] user_group_resolution_configuration
|
3758
|
+
# Shows whether you have enabled the configuration for fetching access
|
3759
|
+
# levels of groups and users from an AWS Single Sign-On identity
|
3760
|
+
# source.
|
3761
|
+
# @return [Types::UserGroupResolutionConfiguration]
|
3762
|
+
#
|
3678
3763
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndexResponse AWS API Documentation
|
3679
3764
|
#
|
3680
3765
|
class DescribeIndexResponse < Struct.new(
|
@@ -3692,7 +3777,8 @@ module Aws::Kendra
|
|
3692
3777
|
:error_message,
|
3693
3778
|
:capacity_units,
|
3694
3779
|
:user_token_configurations,
|
3695
|
-
:user_context_policy
|
3780
|
+
:user_context_policy,
|
3781
|
+
:user_group_resolution_configuration)
|
3696
3782
|
SENSITIVE = []
|
3697
3783
|
include Aws::Structure
|
3698
3784
|
end
|
@@ -3829,8 +3915,7 @@ module Aws::Kendra
|
|
3829
3915
|
# @return [String]
|
3830
3916
|
#
|
3831
3917
|
# @!attribute [rw] created_at
|
3832
|
-
# Shows the date-time a block list for query suggestions was
|
3833
|
-
# created.
|
3918
|
+
# Shows the date-time a block list for query suggestions was created.
|
3834
3919
|
# @return [Time]
|
3835
3920
|
#
|
3836
3921
|
# @!attribute [rw] updated_at
|
@@ -4573,6 +4658,18 @@ module Aws::Kendra
|
|
4573
4658
|
# The file type used to create the FAQ.
|
4574
4659
|
# @return [String]
|
4575
4660
|
#
|
4661
|
+
# @!attribute [rw] language_code
|
4662
|
+
# The code for a language. This shows a supported language for the FAQ
|
4663
|
+
# document as part of the summary information for FAQs. English is
|
4664
|
+
# supported by default. For more information on supported languages,
|
4665
|
+
# including their codes, see [Adding documents in languages other than
|
4666
|
+
# English][1].
|
4667
|
+
#
|
4668
|
+
#
|
4669
|
+
#
|
4670
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html
|
4671
|
+
# @return [String]
|
4672
|
+
#
|
4576
4673
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/FaqSummary AWS API Documentation
|
4577
4674
|
#
|
4578
4675
|
class FaqSummary < Struct.new(
|
@@ -4581,7 +4678,8 @@ module Aws::Kendra
|
|
4581
4678
|
:status,
|
4582
4679
|
:created_at,
|
4583
4680
|
:updated_at,
|
4584
|
-
:file_format
|
4681
|
+
:file_format,
|
4682
|
+
:language_code)
|
4585
4683
|
SENSITIVE = []
|
4586
4684
|
include Aws::Structure
|
4587
4685
|
end
|
@@ -4782,6 +4880,15 @@ module Aws::Kendra
|
|
4782
4880
|
# users and sub groups for a group. Your sub groups can contain more
|
4783
4881
|
# than 1000 users, but the list of sub groups that belong to a group
|
4784
4882
|
# (and/or users) must be no more than 1000.
|
4883
|
+
#
|
4884
|
+
# You can download this [example S3 file][1] that uses the correct
|
4885
|
+
# format for listing group members. Note, `dataSourceId` is optional.
|
4886
|
+
# The value of `type` for a group is always `GROUP` and for a user it
|
4887
|
+
# is always `USER`.
|
4888
|
+
#
|
4889
|
+
#
|
4890
|
+
#
|
4891
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/samples/group_members.zip
|
4785
4892
|
# @return [Types::S3Path]
|
4786
4893
|
#
|
4787
4894
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GroupMembers AWS API Documentation
|
@@ -5107,9 +5214,10 @@ module Aws::Kendra
|
|
5107
5214
|
# @return [String]
|
5108
5215
|
#
|
5109
5216
|
# @!attribute [rw] next_token
|
5110
|
-
# If the
|
5111
|
-
#
|
5112
|
-
# to
|
5217
|
+
# If the previous response was incomplete (because there is more data
|
5218
|
+
# to retrieve), Amazon Kendra returns a pagination token in the
|
5219
|
+
# response. You can use this pagination token to retrieve the next set
|
5220
|
+
# of jobs.
|
5113
5221
|
# @return [String]
|
5114
5222
|
#
|
5115
5223
|
# @!attribute [rw] max_results
|
@@ -5146,12 +5254,9 @@ module Aws::Kendra
|
|
5146
5254
|
# @return [Array<Types::DataSourceSyncJob>]
|
5147
5255
|
#
|
5148
5256
|
# @!attribute [rw] next_token
|
5149
|
-
#
|
5150
|
-
#
|
5151
|
-
#
|
5152
|
-
# page size, Amazon Kendra returns the NextPage token. Include the
|
5153
|
-
# token in the next request to the `GetDataSourceSyncJobHistory`
|
5154
|
-
# operation to return in the next page of jobs.
|
5257
|
+
# If the response is truncated, Amazon Kendra returns this token that
|
5258
|
+
# you can use in the subsequent request to retrieve the next set of
|
5259
|
+
# jobs.
|
5155
5260
|
# @return [String]
|
5156
5261
|
#
|
5157
5262
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourceSyncJobsResponse AWS API Documentation
|
@@ -5230,8 +5335,10 @@ module Aws::Kendra
|
|
5230
5335
|
# @return [String]
|
5231
5336
|
#
|
5232
5337
|
# @!attribute [rw] next_token
|
5233
|
-
# If the
|
5234
|
-
#
|
5338
|
+
# If the previous response was incomplete (because there is more data
|
5339
|
+
# to retrieve), Amazon Kendra returns a pagination token in the
|
5340
|
+
# response. You can use this pagination token to retrieve the next set
|
5341
|
+
# of FAQs.
|
5235
5342
|
# @return [String]
|
5236
5343
|
#
|
5237
5344
|
# @!attribute [rw] max_results
|
@@ -5251,11 +5358,9 @@ module Aws::Kendra
|
|
5251
5358
|
end
|
5252
5359
|
|
5253
5360
|
# @!attribute [rw] next_token
|
5254
|
-
#
|
5255
|
-
#
|
5256
|
-
#
|
5257
|
-
# returns the `NextPage` token. Include the token in the next request
|
5258
|
-
# to the `ListFaqs` operation to return the next page of FAQs.
|
5361
|
+
# If the response is truncated, Amazon Kendra returns this token that
|
5362
|
+
# you can use in the subsequent request to retrieve the next set of
|
5363
|
+
# FAQs.
|
5259
5364
|
# @return [String]
|
5260
5365
|
#
|
5261
5366
|
# @!attribute [rw] faq_summary_items
|
@@ -5298,12 +5403,16 @@ module Aws::Kendra
|
|
5298
5403
|
# @return [Integer]
|
5299
5404
|
#
|
5300
5405
|
# @!attribute [rw] next_token
|
5301
|
-
#
|
5406
|
+
# If the previous response was incomplete (because there is more data
|
5407
|
+
# to retrieve), Amazon Kendra returns a pagination token in the
|
5408
|
+
# response. You can use this pagination token to retrieve the next set
|
5409
|
+
# of groups that are mapped to users before a given ordering or
|
5410
|
+
# timestamp identifier.
|
5302
5411
|
# @return [String]
|
5303
5412
|
#
|
5304
5413
|
# @!attribute [rw] max_results
|
5305
|
-
# The maximum
|
5306
|
-
#
|
5414
|
+
# The maximum number of returned groups that are mapped to users
|
5415
|
+
# before a given ordering or timestamp identifier.
|
5307
5416
|
# @return [Integer]
|
5308
5417
|
#
|
5309
5418
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListGroupsOlderThanOrderingIdRequest AWS API Documentation
|
@@ -5324,7 +5433,10 @@ module Aws::Kendra
|
|
5324
5433
|
# @return [Array<Types::GroupSummary>]
|
5325
5434
|
#
|
5326
5435
|
# @!attribute [rw] next_token
|
5327
|
-
#
|
5436
|
+
# If the response is truncated, Amazon Kendra returns this token that
|
5437
|
+
# you can use in the subsequent request to retrieve the next set of
|
5438
|
+
# groups that are mapped to users before a given ordering or timestamp
|
5439
|
+
# identifier.
|
5328
5440
|
# @return [String]
|
5329
5441
|
#
|
5330
5442
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListGroupsOlderThanOrderingIdResponse AWS API Documentation
|
@@ -5528,7 +5640,8 @@ module Aws::Kendra
|
|
5528
5640
|
# @return [String]
|
5529
5641
|
#
|
5530
5642
|
# @!attribute [rw] thesaurus_summary_items
|
5531
|
-
# An array of summary information for
|
5643
|
+
# An array of summary information for a thesaurus or multiple
|
5644
|
+
# thesauri.
|
5532
5645
|
# @return [Array<Types::ThesaurusSummary>]
|
5533
5646
|
#
|
5534
5647
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListThesauriResponse AWS API Documentation
|
@@ -6116,7 +6229,7 @@ module Aws::Kendra
|
|
6116
6229
|
# @return [Types::SortingConfiguration]
|
6117
6230
|
#
|
6118
6231
|
# @!attribute [rw] user_context
|
6119
|
-
# The user context token.
|
6232
|
+
# The user context token or user and group information.
|
6120
6233
|
# @return [Types::UserContext]
|
6121
6234
|
#
|
6122
6235
|
# @!attribute [rw] visitor_id
|
@@ -8070,7 +8183,7 @@ module Aws::Kendra
|
|
8070
8183
|
include Aws::Structure
|
8071
8184
|
end
|
8072
8185
|
|
8073
|
-
# An array of summary information for
|
8186
|
+
# An array of summary information for a thesaurus or multiple thesauri.
|
8074
8187
|
#
|
8075
8188
|
# @!attribute [rw] id
|
8076
8189
|
# The identifier of the thesaurus.
|
@@ -8495,6 +8608,7 @@ module Aws::Kendra
|
|
8495
8608
|
# description: "Description",
|
8496
8609
|
# schedule: "ScanSchedule",
|
8497
8610
|
# role_arn: "RoleArn",
|
8611
|
+
# language_code: "LanguageCode",
|
8498
8612
|
# }
|
8499
8613
|
#
|
8500
8614
|
# @!attribute [rw] id
|
@@ -8528,6 +8642,18 @@ module Aws::Kendra
|
|
8528
8642
|
# source is accessing resources on your behalf.
|
8529
8643
|
# @return [String]
|
8530
8644
|
#
|
8645
|
+
# @!attribute [rw] language_code
|
8646
|
+
# The code for a language. This allows you to support a language for
|
8647
|
+
# all documents when updating the data source. English is supported by
|
8648
|
+
# default. For more information on supported languages, including
|
8649
|
+
# their codes, see [Adding documents in languages other than
|
8650
|
+
# English][1].
|
8651
|
+
#
|
8652
|
+
#
|
8653
|
+
#
|
8654
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/in-adding-languages.html
|
8655
|
+
# @return [String]
|
8656
|
+
#
|
8531
8657
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateDataSourceRequest AWS API Documentation
|
8532
8658
|
#
|
8533
8659
|
class UpdateDataSourceRequest < Struct.new(
|
@@ -8537,7 +8663,8 @@ module Aws::Kendra
|
|
8537
8663
|
:configuration,
|
8538
8664
|
:description,
|
8539
8665
|
:schedule,
|
8540
|
-
:role_arn
|
8666
|
+
:role_arn,
|
8667
|
+
:language_code)
|
8541
8668
|
SENSITIVE = []
|
8542
8669
|
include Aws::Structure
|
8543
8670
|
end
|
@@ -8593,6 +8720,9 @@ module Aws::Kendra
|
|
8593
8720
|
# },
|
8594
8721
|
# ],
|
8595
8722
|
# user_context_policy: "ATTRIBUTE_FILTER", # accepts ATTRIBUTE_FILTER, USER_TOKEN
|
8723
|
+
# user_group_resolution_configuration: {
|
8724
|
+
# user_group_resolution_mode: "AWS_SSO", # required, accepts AWS_SSO, NONE
|
8725
|
+
# },
|
8596
8726
|
# }
|
8597
8727
|
#
|
8598
8728
|
# @!attribute [rw] id
|
@@ -8631,9 +8761,19 @@ module Aws::Kendra
|
|
8631
8761
|
# @return [Array<Types::UserTokenConfiguration>]
|
8632
8762
|
#
|
8633
8763
|
# @!attribute [rw] user_context_policy
|
8634
|
-
# The user
|
8764
|
+
# The user context policy.
|
8635
8765
|
# @return [String]
|
8636
8766
|
#
|
8767
|
+
# @!attribute [rw] user_group_resolution_configuration
|
8768
|
+
# Enables fetching access levels of groups and users from an AWS
|
8769
|
+
# Single Sign-On identity source. To configure this, see
|
8770
|
+
# [UserGroupResolutionConfiguration][1].
|
8771
|
+
#
|
8772
|
+
#
|
8773
|
+
#
|
8774
|
+
# [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html
|
8775
|
+
# @return [Types::UserGroupResolutionConfiguration]
|
8776
|
+
#
|
8637
8777
|
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateIndexRequest AWS API Documentation
|
8638
8778
|
#
|
8639
8779
|
class UpdateIndexRequest < Struct.new(
|
@@ -8644,7 +8784,8 @@ module Aws::Kendra
|
|
8644
8784
|
:document_metadata_configuration_updates,
|
8645
8785
|
:capacity_units,
|
8646
8786
|
:user_token_configurations,
|
8647
|
-
:user_context_policy
|
8787
|
+
:user_context_policy,
|
8788
|
+
:user_group_resolution_configuration)
|
8648
8789
|
SENSITIVE = []
|
8649
8790
|
include Aws::Structure
|
8650
8791
|
end
|
@@ -8855,6 +8996,11 @@ module Aws::Kendra
|
|
8855
8996
|
|
8856
8997
|
# Provides the configuration information of the URLs to crawl.
|
8857
8998
|
#
|
8999
|
+
# You can only crawl websites that use the secure communication
|
9000
|
+
# protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive
|
9001
|
+
# an error when crawling a website, it could be that the website is
|
9002
|
+
# blocked from crawling.
|
9003
|
+
#
|
8858
9004
|
# *When selecting websites to index, you must adhere to the [Amazon
|
8859
9005
|
# Acceptable Use Policy][1] and all other Amazon terms. Remember that
|
8860
9006
|
# you must only use the Amazon Kendra web crawler to index your own
|
@@ -8905,7 +9051,8 @@ module Aws::Kendra
|
|
8905
9051
|
include Aws::Structure
|
8906
9052
|
end
|
8907
9053
|
|
8908
|
-
# Provides information about the user context for
|
9054
|
+
# Provides information about the user context for an Amazon Kendra
|
9055
|
+
# index.
|
8909
9056
|
#
|
8910
9057
|
# This is used for filtering search results for different users based on
|
8911
9058
|
# their access to documents.
|
@@ -8914,8 +9061,8 @@ module Aws::Kendra
|
|
8914
9061
|
#
|
8915
9062
|
# * User token
|
8916
9063
|
#
|
8917
|
-
# * User ID, the groups the user belongs to, and
|
8918
|
-
# groups can access
|
9064
|
+
# * User ID, the groups the user belongs to, and any data sources the
|
9065
|
+
# groups can access.
|
8919
9066
|
#
|
8920
9067
|
# If you provide both, an exception is thrown.
|
8921
9068
|
#
|
@@ -8965,6 +9112,47 @@ module Aws::Kendra
|
|
8965
9112
|
include Aws::Structure
|
8966
9113
|
end
|
8967
9114
|
|
9115
|
+
# Provides the configuration information to fetch access levels of
|
9116
|
+
# groups and users from an AWS Single Sign-On identity source. This is
|
9117
|
+
# useful for setting up user context filtering, where Amazon Kendra
|
9118
|
+
# filters search results for different users based on their group's
|
9119
|
+
# access to documents. You can also map your users to their groups for
|
9120
|
+
# user context filtering using the [PutPrincipalMapping operation][1].
|
9121
|
+
#
|
9122
|
+
# To set up an AWS SSO identity source in the console to use with Amazon
|
9123
|
+
# Kendra, see [Getting started with an AWS SSO identity source][2]. You
|
9124
|
+
# must also grant the required permissions to use AWS SSO with Amazon
|
9125
|
+
# Kendra. For more information, see [IAM roles for AWS Single
|
9126
|
+
# Sign-On][3].
|
9127
|
+
#
|
9128
|
+
#
|
9129
|
+
#
|
9130
|
+
# [1]: https://docs.aws.amazon.com/latest/dg/API_PutPrincipalMapping.html
|
9131
|
+
# [2]: https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html
|
9132
|
+
# [3]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-aws-sso
|
9133
|
+
#
|
9134
|
+
# @note When making an API call, you may pass UserGroupResolutionConfiguration
|
9135
|
+
# data as a hash:
|
9136
|
+
#
|
9137
|
+
# {
|
9138
|
+
# user_group_resolution_mode: "AWS_SSO", # required, accepts AWS_SSO, NONE
|
9139
|
+
# }
|
9140
|
+
#
|
9141
|
+
# @!attribute [rw] user_group_resolution_mode
|
9142
|
+
# The identity store provider (mode) you want to use to fetch access
|
9143
|
+
# levels of groups and users. AWS Single Sign-On is currently the only
|
9144
|
+
# available mode. Your users and groups must exist in an AWS SSO
|
9145
|
+
# identity source in order to use this mode.
|
9146
|
+
# @return [String]
|
9147
|
+
#
|
9148
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UserGroupResolutionConfiguration AWS API Documentation
|
9149
|
+
#
|
9150
|
+
class UserGroupResolutionConfiguration < Struct.new(
|
9151
|
+
:user_group_resolution_mode)
|
9152
|
+
SENSITIVE = []
|
9153
|
+
include Aws::Structure
|
9154
|
+
end
|
9155
|
+
|
8968
9156
|
# Provides configuration information for a token configuration.
|
8969
9157
|
#
|
8970
9158
|
# @note When making an API call, you may pass UserTokenConfiguration
|
@@ -9059,6 +9247,11 @@ module Aws::Kendra
|
|
9059
9247
|
# You can include website subdomains. You can list up to 100 seed URLs
|
9060
9248
|
# and up to three sitemap URLs.
|
9061
9249
|
#
|
9250
|
+
# You can only crawl websites that use the secure communication
|
9251
|
+
# protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive
|
9252
|
+
# an error when crawling a website, it could be that the website is
|
9253
|
+
# blocked from crawling.
|
9254
|
+
#
|
9062
9255
|
# *When selecting websites to index, you must adhere to the [Amazon
|
9063
9256
|
# Acceptable Use Policy][1] and all other Amazon terms. Remember that
|
9064
9257
|
# you must only use the Amazon Kendra web crawler to index your own
|
data/lib/aws-sdk-kendra.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-kendra
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.36.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: 2021-07
|
11
|
+
date: 2021-10-07 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.
|
22
|
+
version: 3.120.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.
|
32
|
+
version: 3.120.0
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: aws-sigv4
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|
@@ -76,7 +76,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
76
76
|
requirements:
|
77
77
|
- - ">="
|
78
78
|
- !ruby/object:Gem::Version
|
79
|
-
version: '
|
79
|
+
version: '2.3'
|
80
80
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
81
81
|
requirements:
|
82
82
|
- - ">="
|