aws-sdk-kendra 1.29.0 → 1.30.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: c889eb178ba263dd3756480d36ad4d306d3955f0b13020a0aee248544186098b
4
- data.tar.gz: cf3504f318fbf4b6b517c2ba8d938ba1705ec551d4825717482b8a154dcef3e8
3
+ metadata.gz: 0ebe1496353f4d08d15ade8d9c2dfee74b9766285ce574ecec5c4042c05f13bd
4
+ data.tar.gz: 6455f17819e188b6767cb354b9dae504a933f77db5b528a0341ea2e64184adea
5
5
  SHA512:
6
- metadata.gz: b1c09536c3b61f6f2e46d8dda754a43bb6ad5e1c981b76edc902cdba4ea97fc0d79b4f0df25eca1675ab10f858a342a5b524394b7204d5d0d47e74fb9b599650
7
- data.tar.gz: 19610c0498b6eb771d4ddd9357a938056f1ac68720a540bfb9c3421017aaaae0629813cf5e8f4faf9a80c67de30fbdef912b09e752b89f2c4bc65b45f83e4e35
6
+ metadata.gz: 7256531ac5a6b58d2cc16301377a6583f0f44fc77672a15f9e58d66adc044a3bb828d19735064a46a5a3754279e776e0d6cb15f96251dd39f0bc20b95a975b72
7
+ data.tar.gz: ed4f321f7b7590a0fbb3a255ce759801ceed9fc87c588be3632e18567cdf7bb15437ab8a213b7f3545453a971111cee031c4801312aa46c69ef50992357c4daa
data/CHANGELOG.md CHANGED
@@ -1,6 +1,11 @@
1
1
  Unreleased Changes
2
2
  ------------------
3
3
 
4
+ 1.30.0 (2021-07-12)
5
+ ------------------
6
+
7
+ * Feature - Amazon Kendra now supports Principal Store
8
+
4
9
  1.29.0 (2021-06-30)
5
10
  ------------------
6
11
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 1.29.0
1
+ 1.30.0
@@ -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.29.0'
51
+ GEM_VERSION = '1.30.0'
52
52
 
53
53
  end
@@ -341,8 +341,9 @@ module Aws::Kendra
341
341
  # been added with the `BatchPutDocument` operation.
342
342
  #
343
343
  # The documents are deleted asynchronously. You can see the progress of
344
- # the deletion by using AWS CloudWatch. Any error messages related to
345
- # the processing of the batch are sent to you CloudWatch log.
344
+ # the deletion by using Amazon Web Services CloudWatch. Any error
345
+ # messages related to the processing of the batch are sent to you
346
+ # CloudWatch log.
346
347
  #
347
348
  # @option params [required, String] :index_id
348
349
  # The identifier of the index that contains the documents to delete.
@@ -472,8 +473,9 @@ module Aws::Kendra
472
473
  # control list to the documents added to the index.
473
474
  #
474
475
  # The documents are indexed asynchronously. You can see the progress of
475
- # the batch using AWS CloudWatch. Any error messages related to
476
- # processing the batch are sent to your AWS CloudWatch log.
476
+ # the batch using Amazon Web Services CloudWatch. Any error messages
477
+ # related to processing the batch are sent to your Amazon Web Services
478
+ # CloudWatch log.
477
479
  #
478
480
  # @option params [required, String] :index_id
479
481
  # The identifier of the index to add the documents to. You need to
@@ -546,6 +548,19 @@ module Aws::Kendra
546
548
  # name: "PrincipalName", # required
547
549
  # type: "USER", # required, accepts USER, GROUP
548
550
  # access: "ALLOW", # required, accepts ALLOW, DENY
551
+ # data_source_id: "DataSourceId",
552
+ # },
553
+ # ],
554
+ # hierarchical_access_control_list: [
555
+ # {
556
+ # principal_list: [ # required
557
+ # {
558
+ # name: "PrincipalName", # required
559
+ # type: "USER", # required, accepts USER, GROUP
560
+ # access: "ALLOW", # required, accepts ALLOW, DENY
561
+ # data_source_id: "DataSourceId",
562
+ # },
563
+ # ],
549
564
  # },
550
565
  # ],
551
566
  # content_type: "PDF", # accepts PDF, HTML, MS_WORD, PLAIN_TEXT, PPT
@@ -1114,22 +1129,15 @@ module Aws::Kendra
1114
1129
  # The `Edition` parameter is optional. If you don't supply a value, the
1115
1130
  # default is `ENTERPRISE_EDITION`.
1116
1131
  #
1117
- # For more information on quota limits for enterprise and developer
1118
- # editions, see [Quotas][1].
1119
- #
1120
- #
1121
- #
1122
- # [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
1123
- #
1124
1132
  # @option params [required, String] :role_arn
1125
- # An AWS Identity and Access Management (IAM) role that gives Amazon
1126
- # Kendra permissions to access your Amazon CloudWatch logs and metrics.
1127
- # This is also the role used when you use the `BatchPutDocument`
1128
- # operation to index documents from an Amazon S3 bucket.
1133
+ # An Identity and Access Management(IAM) role that gives Amazon Kendra
1134
+ # permissions to access your Amazon CloudWatch logs and metrics. This is
1135
+ # also the role used when you use the `BatchPutDocument` operation to
1136
+ # index documents from an Amazon S3 bucket.
1129
1137
  #
1130
1138
  # @option params [Types::ServerSideEncryptionConfiguration] :server_side_encryption_configuration
1131
- # The identifier of the AWS KMS customer managed key (CMK) to use to
1132
- # encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support
1139
+ # The identifier of the KMScustomer managed key (CMK) to use to encrypt
1140
+ # data indexed by Amazon Kendra. Amazon Kendra doesn't support
1133
1141
  # asymmetric CMKs.
1134
1142
  #
1135
1143
  # @option params [String] :description
@@ -1476,6 +1484,78 @@ module Aws::Kendra
1476
1484
  req.send_request(options)
1477
1485
  end
1478
1486
 
1487
+ # Deletes a group so that all users and sub groups that belong to the
1488
+ # group can no longer access documents only available to that group.
1489
+ #
1490
+ # For example, after deleting the group "Summer Interns", all interns
1491
+ # who belonged to that group no longer see intern-only documents in
1492
+ # their search results.
1493
+ #
1494
+ # If you want to delete or replace users or sub groups of a group, you
1495
+ # need to use the `PutPrincipalMapping` operation. For example, if a
1496
+ # user in the group "Engineering" leaves the engineering team and
1497
+ # another user takes their place, you provide an updated list of users
1498
+ # or sub groups that belong to the "Engineering" group when calling
1499
+ # `PutPrincipalMapping`. You can update your internal list of users or
1500
+ # sub groups and input this list when calling `PutPrincipalMapping`.
1501
+ #
1502
+ # @option params [required, String] :index_id
1503
+ # The identifier of the index you want to delete a group from.
1504
+ #
1505
+ # @option params [String] :data_source_id
1506
+ # The identifier of the data source you want to delete a group from.
1507
+ #
1508
+ # This is useful if a group is tied to multiple data sources and you
1509
+ # want to delete a group from accessing documents in a certain data
1510
+ # source. For example, the groups "Research", "Engineering", and
1511
+ # "Sales and Marketing" are all tied to the company's documents
1512
+ # stored in the data sources Confluence and Salesforce. You want to
1513
+ # delete "Research" and "Engineering" groups from Salesforce, so
1514
+ # that these groups cannot access customer-related documents stored in
1515
+ # Salesforce. Only "Sales and Marketing" should access documents in
1516
+ # the Salesforce data source.
1517
+ #
1518
+ # @option params [required, String] :group_id
1519
+ # The identifier of the group you want to delete.
1520
+ #
1521
+ # @option params [Integer] :ordering_id
1522
+ # The timestamp identifier you specify to ensure Amazon Kendra does not
1523
+ # override the latest `DELETE` action with previous actions. The highest
1524
+ # number ID, which is the ordering ID, is the latest action you want to
1525
+ # process and apply on top of other actions with lower number IDs. This
1526
+ # prevents previous actions with lower number IDs from possibly
1527
+ # overriding the latest action.
1528
+ #
1529
+ # The ordering ID can be the UNIX time of the last update you made to a
1530
+ # group members list. You would then provide this list when calling
1531
+ # `PutPrincipalMapping`. This ensures your `DELETE` action for that
1532
+ # updated group with the latest members list doesn't get overwritten by
1533
+ # earlier `DELETE` actions for the same group which are yet to be
1534
+ # processed.
1535
+ #
1536
+ # The default ordering ID is the current UNIX time in milliseconds that
1537
+ # the action was received by Amazon Kendra.
1538
+ #
1539
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
1540
+ #
1541
+ # @example Request syntax with placeholder values
1542
+ #
1543
+ # resp = client.delete_principal_mapping({
1544
+ # index_id: "IndexId", # required
1545
+ # data_source_id: "DataSourceId",
1546
+ # group_id: "GroupId", # required
1547
+ # ordering_id: 1,
1548
+ # })
1549
+ #
1550
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeletePrincipalMapping AWS API Documentation
1551
+ #
1552
+ # @overload delete_principal_mapping(params = {})
1553
+ # @param [Hash] params ({})
1554
+ def delete_principal_mapping(params = {}, options = {})
1555
+ req = build_request(:delete_principal_mapping, params)
1556
+ req.send_request(options)
1557
+ end
1558
+
1479
1559
  # Deletes a block list used for query suggestions for an index.
1480
1560
  #
1481
1561
  # A deleted block list might not take effect right away. Amazon Kendra
@@ -1925,6 +2005,61 @@ module Aws::Kendra
1925
2005
  req.send_request(options)
1926
2006
  end
1927
2007
 
2008
+ # Describes the processing of `PUT` and `DELETE` actions for mapping
2009
+ # users to their groups. This includes information on the status of
2010
+ # actions currently processing or yet to be processed, when actions were
2011
+ # last updated, when actions were received by Amazon Kendra, the latest
2012
+ # action that should process and apply after other actions, and useful
2013
+ # error messages if an action could not be processed.
2014
+ #
2015
+ # @option params [required, String] :index_id
2016
+ # The identifier of the index required to check the processing of `PUT`
2017
+ # and `DELETE` actions for mapping users to their groups.
2018
+ #
2019
+ # @option params [String] :data_source_id
2020
+ # The identifier of the data source to check the processing of `PUT` and
2021
+ # `DELETE` actions for mapping users to their groups.
2022
+ #
2023
+ # @option params [required, String] :group_id
2024
+ # The identifier of the group required to check the processing of `PUT`
2025
+ # and `DELETE` actions for mapping users to their groups.
2026
+ #
2027
+ # @return [Types::DescribePrincipalMappingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2028
+ #
2029
+ # * {Types::DescribePrincipalMappingResponse#index_id #index_id} => String
2030
+ # * {Types::DescribePrincipalMappingResponse#data_source_id #data_source_id} => String
2031
+ # * {Types::DescribePrincipalMappingResponse#group_id #group_id} => String
2032
+ # * {Types::DescribePrincipalMappingResponse#group_ordering_id_summaries #group_ordering_id_summaries} => Array<Types::GroupOrderingIdSummary>
2033
+ #
2034
+ # @example Request syntax with placeholder values
2035
+ #
2036
+ # resp = client.describe_principal_mapping({
2037
+ # index_id: "IndexId", # required
2038
+ # data_source_id: "DataSourceId",
2039
+ # group_id: "GroupId", # required
2040
+ # })
2041
+ #
2042
+ # @example Response structure
2043
+ #
2044
+ # resp.index_id #=> String
2045
+ # resp.data_source_id #=> String
2046
+ # resp.group_id #=> String
2047
+ # resp.group_ordering_id_summaries #=> Array
2048
+ # resp.group_ordering_id_summaries[0].status #=> String, one of "FAILED", "SUCCEEDED", "PROCESSING", "DELETING", "DELETED"
2049
+ # resp.group_ordering_id_summaries[0].last_updated_at #=> Time
2050
+ # resp.group_ordering_id_summaries[0].received_at #=> Time
2051
+ # resp.group_ordering_id_summaries[0].ordering_id #=> Integer
2052
+ # resp.group_ordering_id_summaries[0].failure_reason #=> String
2053
+ #
2054
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribePrincipalMapping AWS API Documentation
2055
+ #
2056
+ # @overload describe_principal_mapping(params = {})
2057
+ # @param [Hash] params ({})
2058
+ def describe_principal_mapping(params = {}, options = {})
2059
+ req = build_request(:describe_principal_mapping, params)
2060
+ req.send_request(options)
2061
+ end
2062
+
1928
2063
  # Describes a block list used for query suggestions for an index.
1929
2064
  #
1930
2065
  # This is used to check the current settings that are applied to a block
@@ -2308,6 +2443,59 @@ module Aws::Kendra
2308
2443
  req.send_request(options)
2309
2444
  end
2310
2445
 
2446
+ # Provides a list of groups that are mapped to users before a given
2447
+ # ordering or timestamp identifier.
2448
+ #
2449
+ # @option params [required, String] :index_id
2450
+ # The identifier of the index for getting a list of groups mapped to
2451
+ # users before a given ordering or timestamp identifier.
2452
+ #
2453
+ # @option params [String] :data_source_id
2454
+ # The identifier of the data source for getting a list of groups mapped
2455
+ # to users before a given ordering timestamp identifier.
2456
+ #
2457
+ # @option params [required, Integer] :ordering_id
2458
+ # The timestamp identifier used for the latest `PUT` or `DELETE` action
2459
+ # for mapping users to their groups.
2460
+ #
2461
+ # @option params [String] :next_token
2462
+ # The next items in the list of groups that go beyond the maximum.
2463
+ #
2464
+ # @option params [Integer] :max_results
2465
+ # The maximum results shown for a list of groups that are mapped to
2466
+ # users before a given ordering or timestamp identifier.
2467
+ #
2468
+ # @return [Types::ListGroupsOlderThanOrderingIdResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2469
+ #
2470
+ # * {Types::ListGroupsOlderThanOrderingIdResponse#groups_summaries #groups_summaries} => Array<Types::GroupSummary>
2471
+ # * {Types::ListGroupsOlderThanOrderingIdResponse#next_token #next_token} => String
2472
+ #
2473
+ # @example Request syntax with placeholder values
2474
+ #
2475
+ # resp = client.list_groups_older_than_ordering_id({
2476
+ # index_id: "IndexId", # required
2477
+ # data_source_id: "DataSourceId",
2478
+ # ordering_id: 1, # required
2479
+ # next_token: "NextToken",
2480
+ # max_results: 1,
2481
+ # })
2482
+ #
2483
+ # @example Response structure
2484
+ #
2485
+ # resp.groups_summaries #=> Array
2486
+ # resp.groups_summaries[0].group_id #=> String
2487
+ # resp.groups_summaries[0].ordering_id #=> Integer
2488
+ # resp.next_token #=> String
2489
+ #
2490
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListGroupsOlderThanOrderingId AWS API Documentation
2491
+ #
2492
+ # @overload list_groups_older_than_ordering_id(params = {})
2493
+ # @param [Hash] params ({})
2494
+ def list_groups_older_than_ordering_id(params = {}, options = {})
2495
+ req = build_request(:list_groups_older_than_ordering_id, params)
2496
+ req.send_request(options)
2497
+ end
2498
+
2311
2499
  # Lists the Amazon Kendra indexes that you have created.
2312
2500
  #
2313
2501
  # @option params [String] :next_token
@@ -2493,6 +2681,123 @@ module Aws::Kendra
2493
2681
  req.send_request(options)
2494
2682
  end
2495
2683
 
2684
+ # Maps users to their groups. You can also map sub groups to groups. For
2685
+ # example, the group "Company Intellectual Property Teams" includes
2686
+ # sub groups "Research" and "Engineering". These sub groups include
2687
+ # their own list of users or people who work in these teams. Only users
2688
+ # who work in research and engineering, and therefore belong in the
2689
+ # intellectual property group, can see top-secret company documents in
2690
+ # their search results.
2691
+ #
2692
+ # You map users to their groups when you want to filter search results
2693
+ # for different users based on their group’s access to documents. For
2694
+ # more information on filtering search results for different users, see
2695
+ # [Filtering on user context][1].
2696
+ #
2697
+ # If more than five `PUT` actions for a group are currently processing,
2698
+ # a validation exception is thrown.
2699
+ #
2700
+ #
2701
+ #
2702
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html
2703
+ #
2704
+ # @option params [required, String] :index_id
2705
+ # The identifier of the index you want to map users to their groups.
2706
+ #
2707
+ # @option params [String] :data_source_id
2708
+ # The identifier of the data source you want to map users to their
2709
+ # groups.
2710
+ #
2711
+ # This is useful if a group is tied to multiple data sources, but you
2712
+ # only want the group to access documents of a certain data source. For
2713
+ # example, the groups "Research", "Engineering", and "Sales and
2714
+ # Marketing" are all tied to the company's documents stored in the
2715
+ # data sources Confluence and Salesforce. However, "Sales and
2716
+ # Marketing" team only needs access to customer-related documents
2717
+ # stored in Salesforce.
2718
+ #
2719
+ # @option params [required, String] :group_id
2720
+ # The identifier of the group you want to map its users to.
2721
+ #
2722
+ # @option params [required, Types::GroupMembers] :group_members
2723
+ # The list that contains your users or sub groups that belong the same
2724
+ # group.
2725
+ #
2726
+ # For example, the group "Company" includes the user "CEO" and the
2727
+ # sub groups "Research", "Engineering", and "Sales and Marketing".
2728
+ #
2729
+ # If you have more than 1000 users and/or sub groups for a single group,
2730
+ # you need to provide the path to the S3 file that lists your users and
2731
+ # sub groups for a group. Your sub groups can contain more than 1000
2732
+ # users, but the list of sub groups that belong to a group (and/or
2733
+ # users) must be no more than 1000.
2734
+ #
2735
+ # @option params [Integer] :ordering_id
2736
+ # The timestamp identifier you specify to ensure Amazon Kendra does not
2737
+ # override the latest `PUT` action with previous actions. The highest
2738
+ # number ID, which is the ordering ID, is the latest action you want to
2739
+ # process and apply on top of other actions with lower number IDs. This
2740
+ # prevents previous actions with lower number IDs from possibly
2741
+ # overriding the latest action.
2742
+ #
2743
+ # The ordering ID can be the UNIX time of the last update you made to a
2744
+ # group members list. You would then provide this list when calling
2745
+ # `PutPrincipalMapping`. This ensures your `PUT` action for that updated
2746
+ # group with the latest members list doesn't get overwritten by earlier
2747
+ # `PUT` actions for the same group which are yet to be processed.
2748
+ #
2749
+ # The default ordering ID is the current UNIX time in milliseconds that
2750
+ # the action was received by Amazon Kendra.
2751
+ #
2752
+ # @option params [String] :role_arn
2753
+ # The Amazon Resource Name (ARN) of a role that has access to the S3
2754
+ # file that contains your list of users or sub groups that belong to a
2755
+ # group.
2756
+ #
2757
+ # For more information, see [IAM roles for Amazon Kendra][1].
2758
+ #
2759
+ #
2760
+ #
2761
+ # [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds
2762
+ #
2763
+ # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
2764
+ #
2765
+ # @example Request syntax with placeholder values
2766
+ #
2767
+ # resp = client.put_principal_mapping({
2768
+ # index_id: "IndexId", # required
2769
+ # data_source_id: "DataSourceId",
2770
+ # group_id: "GroupId", # required
2771
+ # group_members: { # required
2772
+ # member_groups: [
2773
+ # {
2774
+ # group_id: "GroupId", # required
2775
+ # data_source_id: "DataSourceId",
2776
+ # },
2777
+ # ],
2778
+ # member_users: [
2779
+ # {
2780
+ # user_id: "UserId", # required
2781
+ # },
2782
+ # ],
2783
+ # s3_pathfor_group_members: {
2784
+ # bucket: "S3BucketName", # required
2785
+ # key: "S3ObjectKey", # required
2786
+ # },
2787
+ # },
2788
+ # ordering_id: 1,
2789
+ # role_arn: "RoleArn",
2790
+ # })
2791
+ #
2792
+ # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/PutPrincipalMapping AWS API Documentation
2793
+ #
2794
+ # @overload put_principal_mapping(params = {})
2795
+ # @param [Hash] params ({})
2796
+ def put_principal_mapping(params = {}, options = {})
2797
+ req = build_request(:put_principal_mapping, params)
2798
+ req.send_request(options)
2799
+ end
2800
+
2496
2801
  # Searches an active index. Use this API to search your documents using
2497
2802
  # query. The `Query` operation enables to do faceted search and to
2498
2803
  # filter results based on document attributes.
@@ -2711,6 +3016,14 @@ module Aws::Kendra
2711
3016
  # },
2712
3017
  # user_context: {
2713
3018
  # token: "Token",
3019
+ # user_id: "PrincipalName",
3020
+ # groups: ["PrincipalName"],
3021
+ # data_source_groups: [
3022
+ # {
3023
+ # group_id: "PrincipalName", # required
3024
+ # data_source_id: "DataSourceId", # required
3025
+ # },
3026
+ # ],
2714
3027
  # },
2715
3028
  # visitor_id: "VisitorId",
2716
3029
  # })
@@ -3608,7 +3921,7 @@ module Aws::Kendra
3608
3921
  params: params,
3609
3922
  config: config)
3610
3923
  context[:gem_name] = 'aws-sdk-kendra'
3611
- context[:gem_version] = '1.29.0'
3924
+ context[:gem_version] = '1.30.0'
3612
3925
  Seahorse::Client::Request.new(handlers, context)
3613
3926
  end
3614
3927