aws-sdk-finspacedata 1.14.0 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc37e43188756001ea9bbe8239045a029bf1a0cb213d17ef5bdd6184b062ce89
-  data.tar.gz: d523192f89687964fe3894b929f68a2291344b0d56b46c841a631fde05c1a7ce
+  metadata.gz: dcbebb6db6faba8e5da5ffe0b4d13289ce68d505e48ce3fcc3b50dc9c06bdfca
+  data.tar.gz: aa0365c9ee24b059a3151532778f3fcfe4a133ea6e74faeb5e7696c9bddbddb2
 SHA512:
-  metadata.gz: 2c98cd7309d34cfd47afb507c9bf93ec89a3d6ed3d758248c65eec3e978cb928ecfc3cd3db83e057cfeb1eb95a03859ef1bf4e2b04ea7236aeb10c183dbc5b53
-  data.tar.gz: 06e1ffd927f57535fa9856cd178e8f55e52de85bbb5c39def76c2efe26f4d50d380eb7df92846b04c1e791c98fdc06a957927e20badda122f1d7d093e3d81b78
+  metadata.gz: '01188ba7914670643dad9d50f01d92c1f0b4ef6470239b913f04eeab1670be8b078e7a7a23f4d6dd801f0848be437b80c470ca8a0f9f3743ba7cd6a887b971a9'
+  data.tar.gz: 7cc3a23d78adc5b4ffd86607d558429a0d38f57ce95a66aa916a5a1fcd65d18bd35c3d1267751638031f6b3d47feed7c9270871bdaac3087abd9881c4a958fc1

data/CHANGELOG.md

@@ -1,6 +1,21 @@
 Unreleased Changes
 ------------------
 
+1.17.0 (2022-06-28)
+------------------
+
+* Feature - Release new API GetExternalDataViewAccessDetails
+
+1.16.0 (2022-06-15)
+------------------
+
+* Feature - This release adds a new set of APIs, GetPermissionGroup, DisassociateUserFromPermissionGroup, AssociateUserToPermissionGroup, ListPermissionGroupsByUser, ListUsersByPermissionGroup.
+
+1.15.0 (2022-05-12)
+------------------
+
+* Feature - We've now deprecated CreateSnapshot permission for creating a data view, instead use CreateDataView permission.
+
 1.14.0 (2022-02-28)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.14.0
+1.17.0

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

@@ -353,6 +353,46 @@ module Aws::FinSpaceData
 
     # @!group API Operations
 
+    # Adds a user account to a permission group to grant permissions for
+    # actions a user can perform in FinSpace.
+    #
+    # @option params [required, String] :permission_group_id
+    #   The unique identifier for the permission group.
+    #
+    # @option params [required, String] :user_id
+    #   The unique identifier for the user.
+    #
+    # @option params [String] :client_token
+    #   A token that ensures idempotency. This token expires in 10 minutes.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.**
+    #
+    # @return [Types::AssociateUserToPermissionGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::AssociateUserToPermissionGroupResponse#status_code #status_code} => Integer
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.associate_user_to_permission_group({
+    #     permission_group_id: "PermissionGroupId", # required
+    #     user_id: "UserId", # required
+    #     client_token: "ClientToken",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.status_code #=> Integer
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/AssociateUserToPermissionGroup AWS API Documentation
+    #
+    # @overload associate_user_to_permission_group(params = {})
+    # @param [Hash] params ({})
+    def associate_user_to_permission_group(params = {}, options = {})
+      req = build_request(:associate_user_to_permission_group, params)
+      req.send_request(options)
+    end
+
     # Creates a new Changeset in a FinSpace Dataset.
     #
     # @option params [String] :client_token
@@ -627,13 +667,20 @@ module Aws::FinSpaceData
     #   The option to indicate FinSpace application permissions that are
     #   granted to a specific group.
     #
+    #   When assigning application permissions, be aware that the permission
+    #   `ManageUsersAndGroups` allows users to grant themselves or others
+    #   access to any functionality in their FinSpace environment's
+    #   application. It should only be granted to trusted users.
+    #
     #   * `CreateDataset` – Group members can create new datasets.
     #
     #   * `ManageClusters` – Group members can manage Apache Spark clusters
     #     from FinSpace notebooks.
     #
     #   * `ManageUsersAndGroups` – Group members can manage users and
-    #     permission groups.
+    #     permission groups. This is a privileged permission that allows users
+    #     to grant themselves or others access to any functionality in the
+    #     application. It should only be granted to trusted users.
     #
     #   * `ManageAttributeSets` – Group members can manage attribute sets.
     #
@@ -857,6 +904,45 @@ module Aws::FinSpaceData
       req.send_request(options)
     end
 
+    # Removes a user account from a permission group.
+    #
+    # @option params [required, String] :permission_group_id
+    #   The unique identifier for the permission group.
+    #
+    # @option params [required, String] :user_id
+    #   The unique identifier for the user.
+    #
+    # @option params [String] :client_token
+    #   A token that ensures idempotency. This token expires in 10 minutes.
+    #
+    #   **A suitable default value is auto-generated.** You should normally
+    #   not need to pass this option.**
+    #
+    # @return [Types::DisassociateUserFromPermissionGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::DisassociateUserFromPermissionGroupResponse#status_code #status_code} => Integer
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.disassociate_user_from_permission_group({
+    #     permission_group_id: "PermissionGroupId", # required
+    #     user_id: "UserId", # required
+    #     client_token: "ClientToken",
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.status_code #=> Integer
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DisassociateUserFromPermissionGroup AWS API Documentation
+    #
+    # @overload disassociate_user_from_permission_group(params = {})
+    # @param [Hash] params ({})
+    def disassociate_user_from_permission_group(params = {}, options = {})
+      req = build_request(:disassociate_user_from_permission_group, params)
+      req.send_request(options)
+    end
+
     # Allows the specified user to access the FinSpace web application and
     # API.
     #
@@ -1064,6 +1150,85 @@ module Aws::FinSpaceData
       req.send_request(options)
     end
 
+    # Returns the credentials to access the external Dataview from an S3
+    # location. To call this API:
+    #
+    # * You must retrieve the programmatic credentials.
+    #
+    # * You must be a member of a FinSpace user group, where the dataset
+    #   that you want to access has `Read Dataset Data` permissions.
+    #
+    # @option params [required, String] :data_view_id
+    #   The unique identifier for the Dataview that you want to access.
+    #
+    # @option params [required, String] :dataset_id
+    #   The unique identifier for the Dataset.
+    #
+    # @return [Types::GetExternalDataViewAccessDetailsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetExternalDataViewAccessDetailsResponse#credentials #credentials} => Types::AwsCredentials
+    #   * {Types::GetExternalDataViewAccessDetailsResponse#s3_location #s3_location} => Types::S3Location
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_external_data_view_access_details({
+    #     data_view_id: "DataViewId", # required
+    #     dataset_id: "DatasetId", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.credentials.access_key_id #=> String
+    #   resp.credentials.secret_access_key #=> String
+    #   resp.credentials.session_token #=> String
+    #   resp.credentials.expiration #=> Integer
+    #   resp.s3_location.bucket #=> String
+    #   resp.s3_location.key #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetExternalDataViewAccessDetails AWS API Documentation
+    #
+    # @overload get_external_data_view_access_details(params = {})
+    # @param [Hash] params ({})
+    def get_external_data_view_access_details(params = {}, options = {})
+      req = build_request(:get_external_data_view_access_details, params)
+      req.send_request(options)
+    end
+
+    # Retrieves the details of a specific permission group.
+    #
+    # @option params [required, String] :permission_group_id
+    #   The unique identifier for the permission group.
+    #
+    # @return [Types::GetPermissionGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetPermissionGroupResponse#permission_group #permission_group} => Types::PermissionGroup
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_permission_group({
+    #     permission_group_id: "PermissionGroupId", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.permission_group.permission_group_id #=> String
+    #   resp.permission_group.name #=> String
+    #   resp.permission_group.description #=> String
+    #   resp.permission_group.application_permissions #=> Array
+    #   resp.permission_group.application_permissions[0] #=> String, one of "CreateDataset", "ManageClusters", "ManageUsersAndGroups", "ManageAttributeSets", "ViewAuditData", "AccessNotebooks", "GetTemporaryCredentials"
+    #   resp.permission_group.create_time #=> Integer
+    #   resp.permission_group.last_modified_time #=> Integer
+    #   resp.permission_group.membership_status #=> String, one of "ADDITION_IN_PROGRESS", "ADDITION_SUCCESS", "REMOVAL_IN_PROGRESS"
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetPermissionGroup AWS API Documentation
+    #
+    # @overload get_permission_group(params = {})
+    # @param [Hash] params ({})
+    def get_permission_group(params = {}, options = {})
+      req = build_request(:get_permission_group, params)
+      req.send_request(options)
+    end
+
     # Request programmatic credentials to use with FinSpace SDK.
     #
     # @option params [Integer] :duration_in_minutes
@@ -1394,6 +1559,7 @@ module Aws::FinSpaceData
     #   resp.permission_groups[0].application_permissions[0] #=> String, one of "CreateDataset", "ManageClusters", "ManageUsersAndGroups", "ManageAttributeSets", "ViewAuditData", "AccessNotebooks", "GetTemporaryCredentials"
     #   resp.permission_groups[0].create_time #=> Integer
     #   resp.permission_groups[0].last_modified_time #=> Integer
+    #   resp.permission_groups[0].membership_status #=> String, one of "ADDITION_IN_PROGRESS", "ADDITION_SUCCESS", "REMOVAL_IN_PROGRESS"
     #   resp.next_token #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListPermissionGroups AWS API Documentation
@@ -1405,6 +1571,48 @@ module Aws::FinSpaceData
       req.send_request(options)
     end
 
+    # Lists all the permission groups that are associated with a specific
+    # user account.
+    #
+    # @option params [required, String] :user_id
+    #   The unique identifier for the user.
+    #
+    # @option params [String] :next_token
+    #   A token that indicates where a results page should begin.
+    #
+    # @option params [required, Integer] :max_results
+    #   The maximum number of results per page.
+    #
+    # @return [Types::ListPermissionGroupsByUserResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListPermissionGroupsByUserResponse#permission_groups #permission_groups} => Array<Types::PermissionGroupByUser>
+    #   * {Types::ListPermissionGroupsByUserResponse#next_token #next_token} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_permission_groups_by_user({
+    #     user_id: "UserId", # required
+    #     next_token: "PaginationToken",
+    #     max_results: 1, # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.permission_groups #=> Array
+    #   resp.permission_groups[0].permission_group_id #=> String
+    #   resp.permission_groups[0].name #=> String
+    #   resp.permission_groups[0].membership_status #=> String, one of "ADDITION_IN_PROGRESS", "ADDITION_SUCCESS", "REMOVAL_IN_PROGRESS"
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListPermissionGroupsByUser AWS API Documentation
+    #
+    # @overload list_permission_groups_by_user(params = {})
+    # @param [Hash] params ({})
+    def list_permission_groups_by_user(params = {}, options = {})
+      req = build_request(:list_permission_groups_by_user, params)
+      req.send_request(options)
+    end
+
     # Lists all available user accounts in FinSpace.
     #
     # @option params [String] :next_token
@@ -1454,6 +1662,53 @@ module Aws::FinSpaceData
       req.send_request(options)
     end
 
+    # Lists details of all the users in a specific permission group.
+    #
+    # @option params [required, String] :permission_group_id
+    #   The unique identifier for the permission group.
+    #
+    # @option params [String] :next_token
+    #   A token that indicates where a results page should begin.
+    #
+    # @option params [required, Integer] :max_results
+    #   The maximum number of results per page.
+    #
+    # @return [Types::ListUsersByPermissionGroupResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::ListUsersByPermissionGroupResponse#users #users} => Array<Types::UserByPermissionGroup>
+    #   * {Types::ListUsersByPermissionGroupResponse#next_token #next_token} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.list_users_by_permission_group({
+    #     permission_group_id: "PermissionGroupId", # required
+    #     next_token: "PaginationToken",
+    #     max_results: 1, # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.users #=> Array
+    #   resp.users[0].user_id #=> String
+    #   resp.users[0].status #=> String, one of "CREATING", "ENABLED", "DISABLED"
+    #   resp.users[0].first_name #=> String
+    #   resp.users[0].last_name #=> String
+    #   resp.users[0].email_address #=> String
+    #   resp.users[0].type #=> String, one of "SUPER_USER", "APP_USER"
+    #   resp.users[0].api_access #=> String, one of "ENABLED", "DISABLED"
+    #   resp.users[0].api_access_principal_arn #=> String
+    #   resp.users[0].membership_status #=> String, one of "ADDITION_IN_PROGRESS", "ADDITION_SUCCESS", "REMOVAL_IN_PROGRESS"
+    #   resp.next_token #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListUsersByPermissionGroup AWS API Documentation
+    #
+    # @overload list_users_by_permission_group(params = {})
+    # @param [Hash] params ({})
+    def list_users_by_permission_group(params = {}, options = {})
+      req = build_request(:list_users_by_permission_group, params)
+      req.send_request(options)
+    end
+
     # Resets the password for a specified user ID and generates a temporary
     # one. Only a superuser can reset password for other users. Resetting
     # the password immediately invalidates the previous password associated
@@ -1683,13 +1938,20 @@ module Aws::FinSpaceData
     #   The permissions that are granted to a specific group for accessing the
     #   FinSpace application.
     #
+    #   When assigning application permissions, be aware that the permission
+    #   `ManageUsersAndGroups` allows users to grant themselves or others
+    #   access to any functionality in their FinSpace environment's
+    #   application. It should only be granted to trusted users.
+    #
     #   * `CreateDataset` – Group members can create new datasets.
     #
     #   * `ManageClusters` – Group members can manage Apache Spark clusters
     #     from FinSpace notebooks.
     #
     #   * `ManageUsersAndGroups` – Group members can manage users and
-    #     permission groups.
+    #     permission groups. This is a privileged permission that allows users
+    #     to grant themselves or others access to any functionality in the
+    #     application. It should only be granted to trusted users.
     #
     #   * `ManageAttributeSets` – Group members can manage attribute sets.
     #
@@ -1747,7 +2009,7 @@ module Aws::FinSpaceData
     #     data in FinSpace.
     #
     #   * `APP_USER` – A user with specific permissions in FinSpace. The users
-    #     are assigned permissions by adding them to a permissions group.
+    #     are assigned permissions by adding them to a permission group.
     #
     # @option params [String] :first_name
     #   The first name of the user.
@@ -1818,7 +2080,7 @@ module Aws::FinSpaceData
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-finspacedata'
-      context[:gem_version] = '1.14.0'
+      context[:gem_version] = '1.17.0'
       Seahorse::Client::Request.new(handlers, context)
     end