aws-sdk-kendra 1.29.0 → 1.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c889eb178ba263dd3756480d36ad4d306d3955f0b13020a0aee248544186098b
-  data.tar.gz: cf3504f318fbf4b6b517c2ba8d938ba1705ec551d4825717482b8a154dcef3e8
+  metadata.gz: 0ebe1496353f4d08d15ade8d9c2dfee74b9766285ce574ecec5c4042c05f13bd
+  data.tar.gz: 6455f17819e188b6767cb354b9dae504a933f77db5b528a0341ea2e64184adea
 SHA512:
-  metadata.gz: b1c09536c3b61f6f2e46d8dda754a43bb6ad5e1c981b76edc902cdba4ea97fc0d79b4f0df25eca1675ab10f858a342a5b524394b7204d5d0d47e74fb9b599650
-  data.tar.gz: 19610c0498b6eb771d4ddd9357a938056f1ac68720a540bfb9c3421017aaaae0629813cf5e8f4faf9a80c67de30fbdef912b09e752b89f2c4bc65b45f83e4e35
+  metadata.gz: 7256531ac5a6b58d2cc16301377a6583f0f44fc77672a15f9e58d66adc044a3bb828d19735064a46a5a3754279e776e0d6cb15f96251dd39f0bc20b95a975b72
+  data.tar.gz: ed4f321f7b7590a0fbb3a255ce759801ceed9fc87c588be3632e18567cdf7bb15437ab8a213b7f3545453a971111cee031c4801312aa46c69ef50992357c4daa

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.30.0 (2021-07-12)
+------------------
+
+* Feature - Amazon Kendra now supports Principal Store
+
 1.29.0 (2021-06-30)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.29.0
+1.30.0

data/lib/aws-sdk-kendra.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-kendra/customizations'
 # @!group service
 module Aws::Kendra
 
-  GEM_VERSION = '1.29.0'
+  GEM_VERSION = '1.30.0'
 
 end

data/lib/aws-sdk-kendra/client.rb

@@ -341,8 +341,9 @@ module Aws::Kendra
     # been added with the `BatchPutDocument` operation.
     #
     # The documents are deleted asynchronously. You can see the progress of
-    # the deletion by using AWS CloudWatch. Any error messages related to
-    # the processing of the batch are sent to you CloudWatch log.
+    # the deletion by using Amazon Web Services CloudWatch. Any error
+    # messages related to the processing of the batch are sent to you
+    # CloudWatch log.
     #
     # @option params [required, String] :index_id
     #   The identifier of the index that contains the documents to delete.
@@ -472,8 +473,9 @@ module Aws::Kendra
     # control list to the documents added to the index.
     #
     # The documents are indexed asynchronously. You can see the progress of
-    # the batch using AWS CloudWatch. Any error messages related to
-    # processing the batch are sent to your AWS CloudWatch log.
+    # the batch using Amazon Web Services CloudWatch. Any error messages
+    # related to processing the batch are sent to your Amazon Web Services
+    # CloudWatch log.
     #
     # @option params [required, String] :index_id
     #   The identifier of the index to add the documents to. You need to
@@ -546,6 +548,19 @@ module Aws::Kendra
     #             name: "PrincipalName", # required
     #             type: "USER", # required, accepts USER, GROUP
     #             access: "ALLOW", # required, accepts ALLOW, DENY
+    #             data_source_id: "DataSourceId",
+    #           },
+    #         ],
+    #         hierarchical_access_control_list: [
+    #           {
+    #             principal_list: [ # required
+    #               {
+    #                 name: "PrincipalName", # required
+    #                 type: "USER", # required, accepts USER, GROUP
+    #                 access: "ALLOW", # required, accepts ALLOW, DENY
+    #                 data_source_id: "DataSourceId",
+    #               },
+    #             ],
     #           },
     #         ],
     #         content_type: "PDF", # accepts PDF, HTML, MS_WORD, PLAIN_TEXT, PPT
@@ -1114,22 +1129,15 @@ module Aws::Kendra
     #   The `Edition` parameter is optional. If you don't supply a value, the
     #   default is `ENTERPRISE_EDITION`.
     #
-    #   For more information on quota limits for enterprise and developer
-    #   editions, see [Quotas][1].
-    #
-    #
-    #
-    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/quotas.html
-    #
     # @option params [required, String] :role_arn
-    #   An AWS Identity and Access Management (IAM) role that gives Amazon
-    #   Kendra permissions to access your Amazon CloudWatch logs and metrics.
-    #   This is also the role used when you use the `BatchPutDocument`
-    #   operation to index documents from an Amazon S3 bucket.
+    #   An Identity and Access Management(IAM) role that gives Amazon Kendra
+    #   permissions to access your Amazon CloudWatch logs and metrics. This is
+    #   also the role used when you use the `BatchPutDocument` operation to
+    #   index documents from an Amazon S3 bucket.
     #
     # @option params [Types::ServerSideEncryptionConfiguration] :server_side_encryption_configuration
-    #   The identifier of the AWS KMS customer managed key (CMK) to use to
-    #   encrypt data indexed by Amazon Kendra. Amazon Kendra doesn't support
+    #   The identifier of the KMScustomer managed key (CMK) to use to encrypt
+    #   data indexed by Amazon Kendra. Amazon Kendra doesn't support
     #   asymmetric CMKs.
     #
     # @option params [String] :description
@@ -1476,6 +1484,78 @@ module Aws::Kendra
       req.send_request(options)
     end
 
+    # Deletes a group so that all users and sub groups that belong to the
+    # group can no longer access documents only available to that group.
+    #
+    # For example, after deleting the group "Summer Interns", all interns
+    # who belonged to that group no longer see intern-only documents in
+    # their search results.
+    #
+    # If you want to delete or replace users or sub groups of a group, you
+    # need to use the `PutPrincipalMapping` operation. For example, if a
+    # user in the group "Engineering" leaves the engineering team and
+    # another user takes their place, you provide an updated list of users
+    # or sub groups that belong to the "Engineering" group when calling
+    # `PutPrincipalMapping`. You can update your internal list of users or
+    # sub groups and input this list when calling `PutPrincipalMapping`.
+    #
+    # @option params [required, String] :index_id
+    #   The identifier of the index you want to delete a group from.
+    #
+    # @option params [String] :data_source_id
+    #   The identifier of the data source you want to delete a group from.
+    #
+    #   This is useful if a group is tied to multiple data sources and you
+    #   want to delete a group from accessing documents in a certain data
+    #   source. For example, the groups "Research", "Engineering", and
+    #   "Sales and Marketing" are all tied to the company's documents
+    #   stored in the data sources Confluence and Salesforce. You want to
+    #   delete "Research" and "Engineering" groups from Salesforce, so
+    #   that these groups cannot access customer-related documents stored in
+    #   Salesforce. Only "Sales and Marketing" should access documents in
+    #   the Salesforce data source.
+    #
+    # @option params [required, String] :group_id
+    #   The identifier of the group you want to delete.
+    #
+    # @option params [Integer] :ordering_id
+    #   The timestamp identifier you specify to ensure Amazon Kendra does not
+    #   override the latest `DELETE` action with previous actions. The highest
+    #   number ID, which is the ordering ID, is the latest action you want to
+    #   process and apply on top of other actions with lower number IDs. This
+    #   prevents previous actions with lower number IDs from possibly
+    #   overriding the latest action.
+    #
+    #   The ordering ID can be the UNIX time of the last update you made to a
+    #   group members list. You would then provide this list when calling
+    #   `PutPrincipalMapping`. This ensures your `DELETE` action for that
+    #   updated group with the latest members list doesn't get overwritten by
+    #   earlier `DELETE` actions for the same group which are yet to be
+    #   processed.
+    #
+    #   The default ordering ID is the current UNIX time in milliseconds that
+    #   the action was received by Amazon Kendra.
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.delete_principal_mapping({
+    #     index_id: "IndexId", # required
+    #     data_source_id: "DataSourceId",
+    #     group_id: "GroupId", # required
+    #     ordering_id: 1,
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DeletePrincipalMapping AWS API Documentation
+    #
+    # @overload delete_principal_mapping(params = {})
+    # @param [Hash] params ({})
+    def delete_principal_mapping(params = {}, options = {})
+      req = build_request(:delete_principal_mapping, params)
+      req.send_request(options)
+    end
+
     # Deletes a block list used for query suggestions for an index.
     #
     # A deleted block list might not take effect right away. Amazon Kendra
@@ -1925,6 +2005,61 @@ module Aws::Kendra
       req.send_request(options)
     end
 
+    # Describes the processing of `PUT` and `DELETE` actions for mapping
+    # users to their groups. This includes information on the status of
+    # actions currently processing or yet to be processed, when actions were
+    # last updated, when actions were received by Amazon Kendra, the latest
+    # action that should process and apply after other actions, and useful
+    # error messages if an action could not be processed.
+    #
+    # @option params [required, String] :index_id
+    #   The identifier of the index required to check the processing of `PUT`
+    #   and `DELETE` actions for mapping users to their groups.
+    #
+    # @option params [String] :data_source_id
+    #   The identifier of the data source to check the processing of `PUT` and
+    #   `DELETE` actions for mapping users to their groups.
+    #
+    # @option params [required, String] :group_id
+    #   The identifier of the group required to check the processing of `PUT`
+    #   and `DELETE` actions for mapping users to their groups.
+    #
+    # @return [Types::DescribePrincipalMappingResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DescribePrincipalMappingResponse#index_id #index_id} => String
+    #   * {Types::DescribePrincipalMappingResponse#data_source_id #data_source_id} => String
+    #   * {Types::DescribePrincipalMappingResponse#group_id #group_id} => String
+    #   * {Types::DescribePrincipalMappingResponse#group_ordering_id_summaries #group_ordering_id_summaries} => Array<Types::GroupOrderingIdSummary>
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.describe_principal_mapping({
+    #     index_id: "IndexId", # required
+    #     data_source_id: "DataSourceId",
+    #     group_id: "GroupId", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.index_id #=> String
+    #   resp.data_source_id #=> String
+    #   resp.group_id #=> String
+    #   resp.group_ordering_id_summaries #=> Array
+    #   resp.group_ordering_id_summaries[0].status #=> String, one of "FAILED", "SUCCEEDED", "PROCESSING", "DELETING", "DELETED"
+    #   resp.group_ordering_id_summaries[0].last_updated_at #=> Time
+    #   resp.group_ordering_id_summaries[0].received_at #=> Time
+    #   resp.group_ordering_id_summaries[0].ordering_id #=> Integer
+    #   resp.group_ordering_id_summaries[0].failure_reason #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/DescribePrincipalMapping AWS API Documentation
+    #
+    # @overload describe_principal_mapping(params = {})
+    # @param [Hash] params ({})
+    def describe_principal_mapping(params = {}, options = {})
+      req = build_request(:describe_principal_mapping, params)
+      req.send_request(options)
+    end
+
     # Describes a block list used for query suggestions for an index.
     #
     # This is used to check the current settings that are applied to a block
@@ -2308,6 +2443,59 @@ module Aws::Kendra
       req.send_request(options)
     end
 
+    # Provides a list of groups that are mapped to users before a given
+    # ordering or timestamp identifier.
+    #
+    # @option params [required, String] :index_id
+    #   The identifier of the index for getting a list of groups mapped to
+    #   users before a given ordering or timestamp identifier.
+    #
+    # @option params [String] :data_source_id
+    #   The identifier of the data source for getting a list of groups mapped
+    #   to users before a given ordering timestamp identifier.
+    #
+    # @option params [required, Integer] :ordering_id
+    #   The timestamp identifier used for the latest `PUT` or `DELETE` action
+    #   for mapping users to their groups.
+    #
+    # @option params [String] :next_token
+    #   The next items in the list of groups that go beyond the maximum.
+    #
+    # @option params [Integer] :max_results
+    #   The maximum results shown for a list of groups that are mapped to
+    #   users before a given ordering or timestamp identifier.
+    #
+    # @return [Types::ListGroupsOlderThanOrderingIdResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListGroupsOlderThanOrderingIdResponse#groups_summaries #groups_summaries} => Array<Types::GroupSummary>
+    #   * {Types::ListGroupsOlderThanOrderingIdResponse#next_token #next_token} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_groups_older_than_ordering_id({
+    #     index_id: "IndexId", # required
+    #     data_source_id: "DataSourceId",
+    #     ordering_id: 1, # required
+    #     next_token: "NextToken",
+    #     max_results: 1,
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.groups_summaries #=> Array
+    #   resp.groups_summaries[0].group_id #=> String
+    #   resp.groups_summaries[0].ordering_id #=> Integer
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/ListGroupsOlderThanOrderingId AWS API Documentation
+    #
+    # @overload list_groups_older_than_ordering_id(params = {})
+    # @param [Hash] params ({})
+    def list_groups_older_than_ordering_id(params = {}, options = {})
+      req = build_request(:list_groups_older_than_ordering_id, params)
+      req.send_request(options)
+    end
+
     # Lists the Amazon Kendra indexes that you have created.
     #
     # @option params [String] :next_token
@@ -2493,6 +2681,123 @@ module Aws::Kendra
       req.send_request(options)
     end
 
+    # Maps users to their groups. You can also map sub groups to groups. For
+    # example, the group "Company Intellectual Property Teams" includes
+    # sub groups "Research" and "Engineering". These sub groups include
+    # their own list of users or people who work in these teams. Only users
+    # who work in research and engineering, and therefore belong in the
+    # intellectual property group, can see top-secret company documents in
+    # their search results.
+    #
+    # You map users to their groups when you want to filter search results
+    # for different users based on their group’s access to documents. For
+    # more information on filtering search results for different users, see
+    # [Filtering on user context][1].
+    #
+    # If more than five `PUT` actions for a group are currently processing,
+    # a validation exception is thrown.
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/kendra/latest/dg/user-context-filter.html
+    #
+    # @option params [required, String] :index_id
+    #   The identifier of the index you want to map users to their groups.
+    #
+    # @option params [String] :data_source_id
+    #   The identifier of the data source you want to map users to their
+    #   groups.
+    #
+    #   This is useful if a group is tied to multiple data sources, but you
+    #   only want the group to access documents of a certain data source. For
+    #   example, the groups "Research", "Engineering", and "Sales and
+    #   Marketing" are all tied to the company's documents stored in the
+    #   data sources Confluence and Salesforce. However, "Sales and
+    #   Marketing" team only needs access to customer-related documents
+    #   stored in Salesforce.
+    #
+    # @option params [required, String] :group_id
+    #   The identifier of the group you want to map its users to.
+    #
+    # @option params [required, Types::GroupMembers] :group_members
+    #   The list that contains your users or sub groups that belong the same
+    #   group.
+    #
+    #   For example, the group "Company" includes the user "CEO" and the
+    #   sub groups "Research", "Engineering", and "Sales and Marketing".
+    #
+    #   If you have more than 1000 users and/or sub groups for a single group,
+    #   you need to provide the path to the S3 file that lists your users and
+    #   sub groups for a group. Your sub groups can contain more than 1000
+    #   users, but the list of sub groups that belong to a group (and/or
+    #   users) must be no more than 1000.
+    #
+    # @option params [Integer] :ordering_id
+    #   The timestamp identifier you specify to ensure Amazon Kendra does not
+    #   override the latest `PUT` action with previous actions. The highest
+    #   number ID, which is the ordering ID, is the latest action you want to
+    #   process and apply on top of other actions with lower number IDs. This
+    #   prevents previous actions with lower number IDs from possibly
+    #   overriding the latest action.
+    #
+    #   The ordering ID can be the UNIX time of the last update you made to a
+    #   group members list. You would then provide this list when calling
+    #   `PutPrincipalMapping`. This ensures your `PUT` action for that updated
+    #   group with the latest members list doesn't get overwritten by earlier
+    #   `PUT` actions for the same group which are yet to be processed.
+    #
+    #   The default ordering ID is the current UNIX time in milliseconds that
+    #   the action was received by Amazon Kendra.
+    #
+    # @option params [String] :role_arn
+    #   The Amazon Resource Name (ARN) of a role that has access to the S3
+    #   file that contains your list of users or sub groups that belong to a
+    #   group.
+    #
+    #   For more information, see [IAM roles for Amazon Kendra][1].
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html#iam-roles-ds
+    #
+    # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.put_principal_mapping({
+    #     index_id: "IndexId", # required
+    #     data_source_id: "DataSourceId",
+    #     group_id: "GroupId", # required
+    #     group_members: { # required
+    #       member_groups: [
+    #         {
+    #           group_id: "GroupId", # required
+    #           data_source_id: "DataSourceId",
+    #         },
+    #       ],
+    #       member_users: [
+    #         {
+    #           user_id: "UserId", # required
+    #         },
+    #       ],
+    #       s3_pathfor_group_members: {
+    #         bucket: "S3BucketName", # required
+    #         key: "S3ObjectKey", # required
+    #       },
+    #     },
+    #     ordering_id: 1,
+    #     role_arn: "RoleArn",
+    #   })
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/kendra-2019-02-03/PutPrincipalMapping AWS API Documentation
+    #
+    # @overload put_principal_mapping(params = {})
+    # @param [Hash] params ({})
+    def put_principal_mapping(params = {}, options = {})
+      req = build_request(:put_principal_mapping, params)
+      req.send_request(options)
+    end
+
     # Searches an active index. Use this API to search your documents using
     # query. The `Query` operation enables to do faceted search and to
     # filter results based on document attributes.
@@ -2711,6 +3016,14 @@ module Aws::Kendra
     #     },
     #     user_context: {
     #       token: "Token",
+    #       user_id: "PrincipalName",
+    #       groups: ["PrincipalName"],
+    #       data_source_groups: [
+    #         {
+    #           group_id: "PrincipalName", # required
+    #           data_source_id: "DataSourceId", # required
+    #         },
+    #       ],
     #     },
     #     visitor_id: "VisitorId",
     #   })
@@ -3608,7 +3921,7 @@ module Aws::Kendra
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-kendra'
-      context[:gem_version] = '1.29.0'
+      context[:gem_version] = '1.30.0'
       Seahorse::Client::Request.new(handlers, context)
     end