aws-sdk-kendra 1.31.0 → 1.35.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7038aaa06fb793e9d6e31cc0c4703220832b7a9c2cdd6e7fae73df18c3dc3fc8
4
- data.tar.gz: 1a109408574701029f28633b7c9332130103c3ceee3a197ca37ed1b3790d81d4
3
+ metadata.gz: 2282d58d249eb1630518c7deac1d5f932458723afba5b268e132e9b82935639f
4
+ data.tar.gz: 5083d471bbd04847ebca1f68975f21c07ac6e863fa8a9dbe712d4d32a3597a4e
5
5
  SHA512:
6
- metadata.gz: 6c422c77076d0b647630c3daf4972454c8980cf62af30974ae3328b28aff8dba8168b73aadad3873dfe11ea97c23f8e1daa99da0acdc4800124fffbe83236413
7
- data.tar.gz: 7798a38719c6685f28e746c99faf0d95996928d5c6ba63e67635fdd78b1370115279f8183eee9a6a95c77ba3ccdff3465ae0948cfe16081a8f35645a455a5b42
6
+ metadata.gz: c28ca33d5d70844f0ec81120878b9c15fe4e518566162000014c101f8e3e106c960d2f027fba735fc450922435406d0fa985fb2fd28e4ad3fa99a951f6e2abee
7
+ data.tar.gz: 67e7157071675757df19b2eed929d09be883a07a7f66a28accf54a7cc492719851fbb08852f1a39fa51253ab457f21a76e59c48e273a6c87cad70b08f9d74be6
data/CHANGELOG.md CHANGED
@@ -1,6 +1,26 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.35.0 (2021-10-06)
5
+ ------------------
6
+
7
+ * Feature - Amazon Kendra now supports integration with AWS SSO
8
+
9
+ 1.34.0 (2021-09-01)
10
+ ------------------
11
+
12
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
13
+
14
+ 1.33.0 (2021-07-30)
15
+ ------------------
16
+
17
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
18
+
19
+ 1.32.0 (2021-07-28)
20
+ ------------------
21
+
22
+ * Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
23
+
4
24
  1.31.0 (2021-07-21)
5
25
  ------------------
6
26
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.31.0
1
+ 1.35.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 use to with an Amazon Kendra index.
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 such as
619
- # document metadata (author, source URI, and so on) and user context
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
@@ -1186,14 +1186,24 @@ module Aws::Kendra
1186
1186
  # ATTRIBUTE\_FILTER
1187
1187
  #
1188
1188
  # : All indexed content is searchable and displayable for all users. If
1189
- # there is an access control list, it is ignored. You can filter on
1190
- # user and group attributes.
1189
+ # you want to filter search results on user context, you can use the
1190
+ # attribute filters of `_user_id` and `_group_ids` or you can provide
1191
+ # user and group information in `UserContext`.
1191
1192
  #
1192
1193
  # USER\_TOKEN
1193
1194
  #
1194
- # : Enables SSO and token-based user access control. All documents with
1195
- # no access control and all documents accessible to the user will be
1196
- # searchable and displayable.
1195
+ # : Enables token-based user access control to filter search results on
1196
+ # user context. All documents with no access control and all documents
1197
+ # accessible to the user will be searchable and displayable.
1198
+ #
1199
+ # @option params [Types::UserGroupResolutionConfiguration] :user_group_resolution_configuration
1200
+ # Enables fetching access levels of groups and users from an AWS Single
1201
+ # Sign-On identity source. To configure this, see
1202
+ # [UserGroupResolutionConfiguration][1].
1203
+ #
1204
+ #
1205
+ #
1206
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html
1197
1207
  #
1198
1208
  # @return [Types::CreateIndexResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
1199
1209
  #
@@ -1234,6 +1244,9 @@ module Aws::Kendra
1234
1244
  # },
1235
1245
  # ],
1236
1246
  # user_context_policy: "ATTRIBUTE_FILTER", # accepts ATTRIBUTE_FILTER, USER_TOKEN
1247
+ # user_group_resolution_configuration: {
1248
+ # user_group_resolution_mode: "AWS_SSO", # required, accepts AWS_SSO, NONE
1249
+ # },
1237
1250
  # })
1238
1251
  #
1239
1252
  # @example Response structure
@@ -1378,7 +1391,7 @@ module Aws::Kendra
1378
1391
  # @option params [String] :client_token
1379
1392
  # A token that you provide to identify the request to create a
1380
1393
  # thesaurus. Multiple calls to the `CreateThesaurus` operation with the
1381
- # same client token will create only one index.
1394
+ # same client token will create only one thesaurus.
1382
1395
  #
1383
1396
  # **A suitable default value is auto-generated.** You should normally
1384
1397
  # not need to pass this option.**
@@ -1979,6 +1992,7 @@ module Aws::Kendra
1979
1992
  # * {Types::DescribeIndexResponse#capacity_units #capacity_units} => Types::CapacityUnitsConfiguration
1980
1993
  # * {Types::DescribeIndexResponse#user_token_configurations #user_token_configurations} => Array<Types::UserTokenConfiguration>
1981
1994
  # * {Types::DescribeIndexResponse#user_context_policy #user_context_policy} => String
1995
+ # * {Types::DescribeIndexResponse#user_group_resolution_configuration #user_group_resolution_configuration} => Types::UserGroupResolutionConfiguration
1982
1996
  #
1983
1997
  # @example Request syntax with placeholder values
1984
1998
  #
@@ -2027,6 +2041,7 @@ module Aws::Kendra
2027
2041
  # resp.user_token_configurations[0].json_token_type_configuration.user_name_attribute_field #=> String
2028
2042
  # resp.user_token_configurations[0].json_token_type_configuration.group_attribute_field #=> String
2029
2043
  # resp.user_context_policy #=> String, one of "ATTRIBUTE_FILTER", "USER_TOKEN"
2044
+ # resp.user_group_resolution_configuration.user_group_resolution_mode #=> String, one of "AWS_SSO", "NONE"
2030
2045
  #
2031
2046
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndex AWS API Documentation
2032
2047
  #
@@ -2316,8 +2331,9 @@ module Aws::Kendra
2316
2331
  # The identifier of the index that contains the data source.
2317
2332
  #
2318
2333
  # @option params [String] :next_token
2319
- # If the result of the previous request to `GetDataSourceSyncJobHistory`
2320
- # was truncated, include the `NextToken` to fetch the next set of jobs.
2334
+ # If the previous response was incomplete (because there is more data to
2335
+ # retrieve), Amazon Kendra returns a pagination token in the response.
2336
+ # You can use this pagination token to retrieve the next set of jobs.
2321
2337
  #
2322
2338
  # @option params [Integer] :max_results
2323
2339
  # The maximum number of synchronization jobs to return in the response.
@@ -2434,8 +2450,9 @@ module Aws::Kendra
2434
2450
  # The index that contains the FAQ lists.
2435
2451
  #
2436
2452
  # @option params [String] :next_token
2437
- # If the result of the previous request to `ListFaqs` was truncated,
2438
- # include the `NextToken` to fetch the next set of FAQs.
2453
+ # If the previous response was incomplete (because there is more data to
2454
+ # retrieve), Amazon Kendra returns a pagination token in the response.
2455
+ # You can use this pagination token to retrieve the next set of FAQs.
2439
2456
  #
2440
2457
  # @option params [Integer] :max_results
2441
2458
  # The maximum number of FAQs to return in the response. If there are
@@ -2491,11 +2508,15 @@ module Aws::Kendra
2491
2508
  # for mapping users to their groups.
2492
2509
  #
2493
2510
  # @option params [String] :next_token
2494
- # The next items in the list of groups that go beyond the maximum.
2511
+ # If the previous response was incomplete (because there is more data to
2512
+ # retrieve), Amazon Kendra returns a pagination token in the response.
2513
+ # You can use this pagination token to retrieve the next set of groups
2514
+ # that are mapped to users before a given ordering or timestamp
2515
+ # identifier.
2495
2516
  #
2496
2517
  # @option params [Integer] :max_results
2497
- # The maximum results shown for a list of groups that are mapped to
2498
- # users before a given ordering or timestamp identifier.
2518
+ # The maximum number of returned groups that are mapped to users before
2519
+ # a given ordering or timestamp identifier.
2499
2520
  #
2500
2521
  # @return [Types::ListGroupsOlderThanOrderingIdResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2501
2522
  #
@@ -2713,13 +2734,16 @@ module Aws::Kendra
2713
2734
  req.send_request(options)
2714
2735
  end
2715
2736
 
2716
- # Maps users to their groups. You can also map sub groups to groups. For
2717
- # example, the group "Company Intellectual Property Teams" includes
2718
- # sub groups "Research" and "Engineering". These sub groups include
2719
- # their own list of users or people who work in these teams. Only users
2720
- # who work in research and engineering, and therefore belong in the
2721
- # intellectual property group, can see top-secret company documents in
2722
- # their search results.
2737
+ # Maps users to their groups so that you only need to provide the user
2738
+ # ID when you issue the query.
2739
+ #
2740
+ # You can also map sub groups to groups. For example, the group
2741
+ # "Company Intellectual Property Teams" includes sub groups
2742
+ # "Research" and "Engineering". These sub groups include their own
2743
+ # list of users or people who work in these teams. Only users who work
2744
+ # in research and engineering, and therefore belong in the intellectual
2745
+ # property group, can see top-secret company documents in their search
2746
+ # results.
2723
2747
  #
2724
2748
  # You map users to their groups when you want to filter search results
2725
2749
  # for different users based on their group’s access to documents. For
@@ -2921,7 +2945,7 @@ module Aws::Kendra
2921
2945
  # the relevance that Amazon Kendra determines for the result.
2922
2946
  #
2923
2947
  # @option params [Types::UserContext] :user_context
2924
- # The user context token.
2948
+ # The user context token or user and group information.
2925
2949
  #
2926
2950
  # @option params [String] :visitor_id
2927
2951
  # Provides an identifier for a specific user. The `VisitorId` should be
@@ -3683,7 +3707,16 @@ module Aws::Kendra
3683
3707
  # The user token configuration.
3684
3708
  #
3685
3709
  # @option params [String] :user_context_policy
3686
- # The user user token context policy.
3710
+ # The user context policy.
3711
+ #
3712
+ # @option params [Types::UserGroupResolutionConfiguration] :user_group_resolution_configuration
3713
+ # Enables fetching access levels of groups and users from an AWS Single
3714
+ # Sign-On identity source. To configure this, see
3715
+ # [UserGroupResolutionConfiguration][1].
3716
+ #
3717
+ #
3718
+ #
3719
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html
3687
3720
  #
3688
3721
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3689
3722
  #
@@ -3737,6 +3770,9 @@ module Aws::Kendra
3737
3770
  # },
3738
3771
  # ],
3739
3772
  # user_context_policy: "ATTRIBUTE_FILTER", # accepts ATTRIBUTE_FILTER, USER_TOKEN
3773
+ # user_group_resolution_configuration: {
3774
+ # user_group_resolution_mode: "AWS_SSO", # required, accepts AWS_SSO, NONE
3775
+ # },
3740
3776
  # })
3741
3777
  #
3742
3778
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateIndex AWS API Documentation
@@ -3967,7 +4003,7 @@ module Aws::Kendra
3967
4003
  params: params,
3968
4004
  config: config)
3969
4005
  context[:gem_name] = 'aws-sdk-kendra'
3970
- context[:gem_version] = '1.31.0'
4006
+ context[:gem_version] = '1.35.0'
3971
4007
  Seahorse::Client::Request.new(handlers, context)
3972
4008
  end
3973
4009
 
@@ -387,6 +387,8 @@ module Aws::Kendra
387
387
  UserAccount = Shapes::StringShape.new(name: 'UserAccount')
388
388
  UserContext = Shapes::StructureShape.new(name: 'UserContext')
389
389
  UserContextPolicy = Shapes::StringShape.new(name: 'UserContextPolicy')
390
+ UserGroupResolutionConfiguration = Shapes::StructureShape.new(name: 'UserGroupResolutionConfiguration')
391
+ UserGroupResolutionMode = Shapes::StringShape.new(name: 'UserGroupResolutionMode')
390
392
  UserId = Shapes::StringShape.new(name: 'UserId')
391
393
  UserNameAttributeField = Shapes::StringShape.new(name: 'UserNameAttributeField')
392
394
  UserTokenConfiguration = Shapes::StructureShape.new(name: 'UserTokenConfiguration')
@@ -615,6 +617,7 @@ module Aws::Kendra
615
617
  CreateIndexRequest.add_member(:tags, Shapes::ShapeRef.new(shape: TagList, location_name: "Tags"))
616
618
  CreateIndexRequest.add_member(:user_token_configurations, Shapes::ShapeRef.new(shape: UserTokenConfigurationList, location_name: "UserTokenConfigurations"))
617
619
  CreateIndexRequest.add_member(:user_context_policy, Shapes::ShapeRef.new(shape: UserContextPolicy, location_name: "UserContextPolicy"))
620
+ CreateIndexRequest.add_member(:user_group_resolution_configuration, Shapes::ShapeRef.new(shape: UserGroupResolutionConfiguration, location_name: "UserGroupResolutionConfiguration"))
618
621
  CreateIndexRequest.struct_class = Types::CreateIndexRequest
619
622
 
620
623
  CreateIndexResponse.add_member(:id, Shapes::ShapeRef.new(shape: IndexId, location_name: "Id"))
@@ -794,6 +797,7 @@ module Aws::Kendra
794
797
  DescribeIndexResponse.add_member(:capacity_units, Shapes::ShapeRef.new(shape: CapacityUnitsConfiguration, location_name: "CapacityUnits"))
795
798
  DescribeIndexResponse.add_member(:user_token_configurations, Shapes::ShapeRef.new(shape: UserTokenConfigurationList, location_name: "UserTokenConfigurations"))
796
799
  DescribeIndexResponse.add_member(:user_context_policy, Shapes::ShapeRef.new(shape: UserContextPolicy, location_name: "UserContextPolicy"))
800
+ DescribeIndexResponse.add_member(:user_group_resolution_configuration, Shapes::ShapeRef.new(shape: UserGroupResolutionConfiguration, location_name: "UserGroupResolutionConfiguration"))
797
801
  DescribeIndexResponse.struct_class = Types::DescribeIndexResponse
798
802
 
799
803
  DescribePrincipalMappingRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
@@ -1466,6 +1470,7 @@ module Aws::Kendra
1466
1470
  UpdateIndexRequest.add_member(:capacity_units, Shapes::ShapeRef.new(shape: CapacityUnitsConfiguration, location_name: "CapacityUnits"))
1467
1471
  UpdateIndexRequest.add_member(:user_token_configurations, Shapes::ShapeRef.new(shape: UserTokenConfigurationList, location_name: "UserTokenConfigurations"))
1468
1472
  UpdateIndexRequest.add_member(:user_context_policy, Shapes::ShapeRef.new(shape: UserContextPolicy, location_name: "UserContextPolicy"))
1473
+ UpdateIndexRequest.add_member(:user_group_resolution_configuration, Shapes::ShapeRef.new(shape: UserGroupResolutionConfiguration, location_name: "UserGroupResolutionConfiguration"))
1469
1474
  UpdateIndexRequest.struct_class = Types::UpdateIndexRequest
1470
1475
 
1471
1476
  UpdateQuerySuggestionsBlockListRequest.add_member(:index_id, Shapes::ShapeRef.new(shape: IndexId, required: true, location_name: "IndexId"))
@@ -1502,6 +1507,9 @@ module Aws::Kendra
1502
1507
  UserContext.add_member(:data_source_groups, Shapes::ShapeRef.new(shape: DataSourceGroups, location_name: "DataSourceGroups"))
1503
1508
  UserContext.struct_class = Types::UserContext
1504
1509
 
1510
+ UserGroupResolutionConfiguration.add_member(:user_group_resolution_mode, Shapes::ShapeRef.new(shape: UserGroupResolutionMode, required: true, location_name: "UserGroupResolutionMode"))
1511
+ UserGroupResolutionConfiguration.struct_class = Types::UserGroupResolutionConfiguration
1512
+
1505
1513
  UserTokenConfiguration.add_member(:jwt_token_type_configuration, Shapes::ShapeRef.new(shape: JwtTokenTypeConfiguration, location_name: "JwtTokenTypeConfiguration"))
1506
1514
  UserTokenConfiguration.add_member(:json_token_type_configuration, Shapes::ShapeRef.new(shape: JsonTokenTypeConfiguration, location_name: "JsonTokenTypeConfiguration"))
1507
1515
  UserTokenConfiguration.struct_class = Types::UserTokenConfiguration
@@ -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, you receive a
132
- # `ValidationException` exception with the message "`AttributeFilter`
133
- # cannot have a length of more than 10".
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 `Integer` or `Long`.
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 `Integer` or
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 `Integer` or `Long`.
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 `Integer` or `Long`.
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
@@ -2182,6 +2182,9 @@ module Aws::Kendra
2182
2182
  # },
2183
2183
  # ],
2184
2184
  # user_context_policy: "ATTRIBUTE_FILTER", # accepts ATTRIBUTE_FILTER, USER_TOKEN
2185
+ # user_group_resolution_configuration: {
2186
+ # user_group_resolution_mode: "AWS_SSO", # required, accepts AWS_SSO, NONE
2187
+ # },
2185
2188
  # }
2186
2189
  #
2187
2190
  # @!attribute [rw] name
@@ -2248,16 +2251,28 @@ module Aws::Kendra
2248
2251
  # ATTRIBUTE\_FILTER
2249
2252
  #
2250
2253
  # : All indexed content is searchable and displayable for all users.
2251
- # If there is an access control list, it is ignored. You can filter
2252
- # on user and group attributes.
2254
+ # If you want to filter search results on user context, you can use
2255
+ # the attribute filters of `_user_id` and `_group_ids` or you can
2256
+ # provide user and group information in `UserContext`.
2253
2257
  #
2254
2258
  # USER\_TOKEN
2255
2259
  #
2256
- # : Enables SSO and token-based user access control. All documents
2257
- # with no access control and all documents accessible to the user
2258
- # will be searchable and displayable.
2260
+ # : Enables token-based user access control to filter search results
2261
+ # on user context. All documents with no access control and all
2262
+ # documents accessible to the user will be searchable and
2263
+ # displayable.
2259
2264
  # @return [String]
2260
2265
  #
2266
+ # @!attribute [rw] user_group_resolution_configuration
2267
+ # Enables fetching access levels of groups and users from an AWS
2268
+ # Single Sign-On identity source. To configure this, see
2269
+ # [UserGroupResolutionConfiguration][1].
2270
+ #
2271
+ #
2272
+ #
2273
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html
2274
+ # @return [Types::UserGroupResolutionConfiguration]
2275
+ #
2261
2276
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/CreateIndexRequest AWS API Documentation
2262
2277
  #
2263
2278
  class CreateIndexRequest < Struct.new(
@@ -2269,7 +2284,8 @@ module Aws::Kendra
2269
2284
  :client_token,
2270
2285
  :tags,
2271
2286
  :user_token_configurations,
2272
- :user_context_policy)
2287
+ :user_context_policy,
2288
+ :user_group_resolution_configuration)
2273
2289
  SENSITIVE = []
2274
2290
  include Aws::Structure
2275
2291
  end
@@ -2443,7 +2459,7 @@ module Aws::Kendra
2443
2459
  # @!attribute [rw] client_token
2444
2460
  # A token that you provide to identify the request to create a
2445
2461
  # thesaurus. Multiple calls to the `CreateThesaurus` operation with
2446
- # the same client token will create only one index.
2462
+ # the same client token will create only one thesaurus.
2447
2463
  #
2448
2464
  # **A suitable default value is auto-generated.** You should normally
2449
2465
  # not need to pass this option.
@@ -3675,6 +3691,12 @@ module Aws::Kendra
3675
3691
  # The user context policy for the Amazon Kendra index.
3676
3692
  # @return [String]
3677
3693
  #
3694
+ # @!attribute [rw] user_group_resolution_configuration
3695
+ # Shows whether you have enabled the configuration for fetching access
3696
+ # levels of groups and users from an AWS Single Sign-On identity
3697
+ # source.
3698
+ # @return [Types::UserGroupResolutionConfiguration]
3699
+ #
3678
3700
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribeIndexResponse AWS API Documentation
3679
3701
  #
3680
3702
  class DescribeIndexResponse < Struct.new(
@@ -3692,7 +3714,8 @@ module Aws::Kendra
3692
3714
  :error_message,
3693
3715
  :capacity_units,
3694
3716
  :user_token_configurations,
3695
- :user_context_policy)
3717
+ :user_context_policy,
3718
+ :user_group_resolution_configuration)
3696
3719
  SENSITIVE = []
3697
3720
  include Aws::Structure
3698
3721
  end
@@ -3829,8 +3852,7 @@ module Aws::Kendra
3829
3852
  # @return [String]
3830
3853
  #
3831
3854
  # @!attribute [rw] created_at
3832
- # Shows the date-time a block list for query suggestions was last
3833
- # created.
3855
+ # Shows the date-time a block list for query suggestions was created.
3834
3856
  # @return [Time]
3835
3857
  #
3836
3858
  # @!attribute [rw] updated_at
@@ -4782,6 +4804,15 @@ module Aws::Kendra
4782
4804
  # users and sub groups for a group. Your sub groups can contain more
4783
4805
  # than 1000 users, but the list of sub groups that belong to a group
4784
4806
  # (and/or users) must be no more than 1000.
4807
+ #
4808
+ # You can download this [example S3 file][1] that uses the correct
4809
+ # format for listing group members. Note, `dataSourceId` is optional.
4810
+ # The value of `type` for a group is always `GROUP` and for a user it
4811
+ # is always `USER`.
4812
+ #
4813
+ #
4814
+ #
4815
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/samples/group_members.zip
4785
4816
  # @return [Types::S3Path]
4786
4817
  #
4787
4818
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/GroupMembers AWS API Documentation
@@ -5107,9 +5138,10 @@ module Aws::Kendra
5107
5138
  # @return [String]
5108
5139
  #
5109
5140
  # @!attribute [rw] next_token
5110
- # If the result of the previous request to
5111
- # `GetDataSourceSyncJobHistory` was truncated, include the `NextToken`
5112
- # to fetch the next set of jobs.
5141
+ # If the previous response was incomplete (because there is more data
5142
+ # to retrieve), Amazon Kendra returns a pagination token in the
5143
+ # response. You can use this pagination token to retrieve the next set
5144
+ # of jobs.
5113
5145
  # @return [String]
5114
5146
  #
5115
5147
  # @!attribute [rw] max_results
@@ -5146,12 +5178,9 @@ module Aws::Kendra
5146
5178
  # @return [Array<Types::DataSourceSyncJob>]
5147
5179
  #
5148
5180
  # @!attribute [rw] next_token
5149
- # The `GetDataSourceSyncJobHistory` operation returns a page of
5150
- # vocabularies at a time. The maximum size of the page is set by the
5151
- # `MaxResults` parameter. If there are more jobs in the list than the
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.
5181
+ # If the response is truncated, Amazon Kendra returns this token that
5182
+ # you can use in the subsequent request to retrieve the next set of
5183
+ # jobs.
5155
5184
  # @return [String]
5156
5185
  #
5157
5186
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListDataSourceSyncJobsResponse AWS API Documentation
@@ -5230,8 +5259,10 @@ module Aws::Kendra
5230
5259
  # @return [String]
5231
5260
  #
5232
5261
  # @!attribute [rw] next_token
5233
- # If the result of the previous request to `ListFaqs` was truncated,
5234
- # include the `NextToken` to fetch the next set of FAQs.
5262
+ # If the previous response was incomplete (because there is more data
5263
+ # to retrieve), Amazon Kendra returns a pagination token in the
5264
+ # response. You can use this pagination token to retrieve the next set
5265
+ # of FAQs.
5235
5266
  # @return [String]
5236
5267
  #
5237
5268
  # @!attribute [rw] max_results
@@ -5251,11 +5282,9 @@ module Aws::Kendra
5251
5282
  end
5252
5283
 
5253
5284
  # @!attribute [rw] next_token
5254
- # The `ListFaqs` operation returns a page of FAQs at a time. The
5255
- # maximum size of the page is set by the `MaxResults` parameter. If
5256
- # there are more jobs in the list than the page size, Amazon Kendra
5257
- # returns the `NextPage` token. Include the token in the next request
5258
- # to the `ListFaqs` operation to return the next page of FAQs.
5285
+ # If the response is truncated, Amazon Kendra returns this token that
5286
+ # you can use in the subsequent request to retrieve the next set of
5287
+ # FAQs.
5259
5288
  # @return [String]
5260
5289
  #
5261
5290
  # @!attribute [rw] faq_summary_items
@@ -5298,12 +5327,16 @@ module Aws::Kendra
5298
5327
  # @return [Integer]
5299
5328
  #
5300
5329
  # @!attribute [rw] next_token
5301
- # The next items in the list of groups that go beyond the maximum.
5330
+ # If the previous response was incomplete (because there is more data
5331
+ # to retrieve), Amazon Kendra returns a pagination token in the
5332
+ # response. You can use this pagination token to retrieve the next set
5333
+ # of groups that are mapped to users before a given ordering or
5334
+ # timestamp identifier.
5302
5335
  # @return [String]
5303
5336
  #
5304
5337
  # @!attribute [rw] max_results
5305
- # The maximum results shown for a list of groups that are mapped to
5306
- # users before a given ordering or timestamp identifier.
5338
+ # The maximum number of returned groups that are mapped to users
5339
+ # before a given ordering or timestamp identifier.
5307
5340
  # @return [Integer]
5308
5341
  #
5309
5342
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListGroupsOlderThanOrderingIdRequest AWS API Documentation
@@ -5324,7 +5357,10 @@ module Aws::Kendra
5324
5357
  # @return [Array<Types::GroupSummary>]
5325
5358
  #
5326
5359
  # @!attribute [rw] next_token
5327
- # The next items in the list of groups that go beyond the maximum.
5360
+ # If the response is truncated, Amazon Kendra returns this token that
5361
+ # you can use in the subsequent request to retrieve the next set of
5362
+ # groups that are mapped to users before a given ordering or timestamp
5363
+ # identifier.
5328
5364
  # @return [String]
5329
5365
  #
5330
5366
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListGroupsOlderThanOrderingIdResponse AWS API Documentation
@@ -5528,7 +5564,8 @@ module Aws::Kendra
5528
5564
  # @return [String]
5529
5565
  #
5530
5566
  # @!attribute [rw] thesaurus_summary_items
5531
- # An array of summary information for one or more thesauruses.
5567
+ # An array of summary information for a thesaurus or multiple
5568
+ # thesauri.
5532
5569
  # @return [Array<Types::ThesaurusSummary>]
5533
5570
  #
5534
5571
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListThesauriResponse AWS API Documentation
@@ -6116,7 +6153,7 @@ module Aws::Kendra
6116
6153
  # @return [Types::SortingConfiguration]
6117
6154
  #
6118
6155
  # @!attribute [rw] user_context
6119
- # The user context token.
6156
+ # The user context token or user and group information.
6120
6157
  # @return [Types::UserContext]
6121
6158
  #
6122
6159
  # @!attribute [rw] visitor_id
@@ -8070,7 +8107,7 @@ module Aws::Kendra
8070
8107
  include Aws::Structure
8071
8108
  end
8072
8109
 
8073
- # An array of summary information for one or more thesauruses.
8110
+ # An array of summary information for a thesaurus or multiple thesauri.
8074
8111
  #
8075
8112
  # @!attribute [rw] id
8076
8113
  # The identifier of the thesaurus.
@@ -8593,6 +8630,9 @@ module Aws::Kendra
8593
8630
  # },
8594
8631
  # ],
8595
8632
  # user_context_policy: "ATTRIBUTE_FILTER", # accepts ATTRIBUTE_FILTER, USER_TOKEN
8633
+ # user_group_resolution_configuration: {
8634
+ # user_group_resolution_mode: "AWS_SSO", # required, accepts AWS_SSO, NONE
8635
+ # },
8596
8636
  # }
8597
8637
  #
8598
8638
  # @!attribute [rw] id
@@ -8631,9 +8671,19 @@ module Aws::Kendra
8631
8671
  # @return [Array<Types::UserTokenConfiguration>]
8632
8672
  #
8633
8673
  # @!attribute [rw] user_context_policy
8634
- # The user user token context policy.
8674
+ # The user context policy.
8635
8675
  # @return [String]
8636
8676
  #
8677
+ # @!attribute [rw] user_group_resolution_configuration
8678
+ # Enables fetching access levels of groups and users from an AWS
8679
+ # Single Sign-On identity source. To configure this, see
8680
+ # [UserGroupResolutionConfiguration][1].
8681
+ #
8682
+ #
8683
+ #
8684
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/API_UserGroupResolutionConfiguration.html
8685
+ # @return [Types::UserGroupResolutionConfiguration]
8686
+ #
8637
8687
  # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UpdateIndexRequest AWS API Documentation
8638
8688
  #
8639
8689
  class UpdateIndexRequest < Struct.new(
@@ -8644,7 +8694,8 @@ module Aws::Kendra
8644
8694
  :document_metadata_configuration_updates,
8645
8695
  :capacity_units,
8646
8696
  :user_token_configurations,
8647
- :user_context_policy)
8697
+ :user_context_policy,
8698
+ :user_group_resolution_configuration)
8648
8699
  SENSITIVE = []
8649
8700
  include Aws::Structure
8650
8701
  end
@@ -8855,6 +8906,11 @@ module Aws::Kendra
8855
8906
 
8856
8907
  # Provides the configuration information of the URLs to crawl.
8857
8908
  #
8909
+ # You can only crawl websites that use the secure communication
8910
+ # protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive
8911
+ # an error when crawling a website, it could be that the website is
8912
+ # blocked from crawling.
8913
+ #
8858
8914
  # *When selecting websites to index, you must adhere to the [Amazon
8859
8915
  # Acceptable Use Policy][1] and all other Amazon terms. Remember that
8860
8916
  # you must only use the Amazon Kendra web crawler to index your own
@@ -8905,7 +8961,8 @@ module Aws::Kendra
8905
8961
  include Aws::Structure
8906
8962
  end
8907
8963
 
8908
- # Provides information about the user context for a Amazon Kendra index.
8964
+ # Provides information about the user context for an Amazon Kendra
8965
+ # index.
8909
8966
  #
8910
8967
  # This is used for filtering search results for different users based on
8911
8968
  # their access to documents.
@@ -8914,8 +8971,8 @@ module Aws::Kendra
8914
8971
  #
8915
8972
  # * User token
8916
8973
  #
8917
- # * User ID, the groups the user belongs to, and the data sources the
8918
- # groups can access
8974
+ # * User ID, the groups the user belongs to, and any data sources the
8975
+ # groups can access.
8919
8976
  #
8920
8977
  # If you provide both, an exception is thrown.
8921
8978
  #
@@ -8965,6 +9022,47 @@ module Aws::Kendra
8965
9022
  include Aws::Structure
8966
9023
  end
8967
9024
 
9025
+ # Provides the configuration information to fetch access levels of
9026
+ # groups and users from an AWS Single Sign-On identity source. This is
9027
+ # useful for setting up user context filtering, where Amazon Kendra
9028
+ # filters search results for different users based on their group's
9029
+ # access to documents. You can also map your users to their groups for
9030
+ # user context filtering using the [PutPrincipalMapping operation][1].
9031
+ #
9032
+ # To set up an AWS SSO identity source in the console to use with Amazon
9033
+ # Kendra, see [Getting started with an AWS SSO identity source][2]. You
9034
+ # must also grant the required permissions to use AWS SSO with Amazon
9035
+ # Kendra. For more information, see [IAM roles for AWS Single
9036
+ # Sign-On][3].
9037
+ #
9038
+ #
9039
+ #
9040
+ # [1]: https://docs.aws.amazon.com/latest/dg/API_PutPrincipalMapping.html
9041
+ # [2]: https://docs.aws.amazon.com/kendra/latest/dg/getting-started-aws-sso.html
9042
+ # [3]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-aws-sso
9043
+ #
9044
+ # @note When making an API call, you may pass UserGroupResolutionConfiguration
9045
+ # data as a hash:
9046
+ #
9047
+ # {
9048
+ # user_group_resolution_mode: "AWS_SSO", # required, accepts AWS_SSO, NONE
9049
+ # }
9050
+ #
9051
+ # @!attribute [rw] user_group_resolution_mode
9052
+ # The identity store provider (mode) you want to use to fetch access
9053
+ # levels of groups and users. AWS Single Sign-On is currently the only
9054
+ # available mode. Your users and groups must exist in an AWS SSO
9055
+ # identity source in order to use this mode.
9056
+ # @return [String]
9057
+ #
9058
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/UserGroupResolutionConfiguration AWS API Documentation
9059
+ #
9060
+ class UserGroupResolutionConfiguration < Struct.new(
9061
+ :user_group_resolution_mode)
9062
+ SENSITIVE = []
9063
+ include Aws::Structure
9064
+ end
9065
+
8968
9066
  # Provides configuration information for a token configuration.
8969
9067
  #
8970
9068
  # @note When making an API call, you may pass UserTokenConfiguration
@@ -9059,6 +9157,11 @@ module Aws::Kendra
9059
9157
  # You can include website subdomains. You can list up to 100 seed URLs
9060
9158
  # and up to three sitemap URLs.
9061
9159
  #
9160
+ # You can only crawl websites that use the secure communication
9161
+ # protocol, Hypertext Transfer Protocol Secure (HTTPS). If you receive
9162
+ # an error when crawling a website, it could be that the website is
9163
+ # blocked from crawling.
9164
+ #
9062
9165
  # *When selecting websites to index, you must adhere to the [Amazon
9063
9166
  # Acceptable Use Policy][1] and all other Amazon terms. Remember that
9064
9167
  # you must only use the Amazon Kendra web crawler to index your own
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-kendra/customizations'
48
48
  # @!group service
49
49
  module Aws::Kendra
50
50
 
51
- GEM_VERSION = '1.31.0'
51
+ GEM_VERSION = '1.35.0'
52
52
 
53
53
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: aws-sdk-kendra
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.31.0
4
+ version: 1.35.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-21 00:00:00.000000000 Z
11
+ date: 2021-10-06 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.112.0
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.112.0
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: '0'
79
+ version: '2.3'
80
80
  required_rubygems_version: !ruby/object:Gem::Requirement
81
81
  requirements:
82
82
  - - ">="