aws-sdk-finspacedata 1.14.0 → 1.17.0

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

@@ -23,6 +23,82 @@ module Aws::FinSpaceData
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass AssociateUserToPermissionGroupRequest
+    #   data as a hash:
+    #
+    #       {
+    #         permission_group_id: "PermissionGroupId", # required
+    #         user_id: "UserId", # required
+    #         client_token: "ClientToken",
+    #       }
+    #
+    # @!attribute [rw] permission_group_id
+    #   The unique identifier for the permission group.
+    #   @return [String]
+    #
+    # @!attribute [rw] user_id
+    #   The unique identifier for the user.
+    #   @return [String]
+    #
+    # @!attribute [rw] 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 [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/AssociateUserToPermissionGroupRequest AWS API Documentation
+    #
+    class AssociateUserToPermissionGroupRequest < Struct.new(
+      :permission_group_id,
+      :user_id,
+      :client_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] status_code
+    #   The returned status code of the response.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/AssociateUserToPermissionGroupResponse AWS API Documentation
+    #
+    class AssociateUserToPermissionGroupResponse < Struct.new(
+      :status_code)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # The credentials required to access the external Dataview from the S3
+    # location.
+    #
+    # @!attribute [rw] access_key_id
+    #   The unique identifier for the security credentials.
+    #   @return [String]
+    #
+    # @!attribute [rw] secret_access_key
+    #   The secret access key that can be used to sign requests.
+    #   @return [String]
+    #
+    # @!attribute [rw] session_token
+    #   The token that users must pass to use the credentials.
+    #   @return [String]
+    #
+    # @!attribute [rw] expiration
+    #   The Epoch time when the current credentials expire.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/AwsCredentials AWS API Documentation
+    #
+    class AwsCredentials < Struct.new(
+      :access_key_id,
+      :secret_access_key,
+      :session_token,
+      :expiration)
+      SENSITIVE = [:secret_access_key, :session_token]
+      include Aws::Structure
+    end
+
     # The structure with error messages.
     #
     # @!attribute [rw] error_message
@@ -585,13 +661,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.
     #
@@ -769,7 +852,7 @@ module Aws::FinSpaceData
     #   @return [String]
     #
     # @!attribute [rw] s3_destination_export_file_format
-    #   Data view export file format.
+    #   Dataview export file format.
     #
     #   * `PARQUET` – Parquet export file format.
     #
@@ -1154,6 +1237,52 @@ module Aws::FinSpaceData
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass DisassociateUserFromPermissionGroupRequest
+    #   data as a hash:
+    #
+    #       {
+    #         permission_group_id: "PermissionGroupId", # required
+    #         user_id: "UserId", # required
+    #         client_token: "ClientToken",
+    #       }
+    #
+    # @!attribute [rw] permission_group_id
+    #   The unique identifier for the permission group.
+    #   @return [String]
+    #
+    # @!attribute [rw] user_id
+    #   The unique identifier for the user.
+    #   @return [String]
+    #
+    # @!attribute [rw] 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 [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DisassociateUserFromPermissionGroupRequest AWS API Documentation
+    #
+    class DisassociateUserFromPermissionGroupRequest < Struct.new(
+      :permission_group_id,
+      :user_id,
+      :client_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] status_code
+    #   The returned status code of the response.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/DisassociateUserFromPermissionGroupResponse AWS API Documentation
+    #
+    class DisassociateUserFromPermissionGroupResponse < Struct.new(
+      :status_code)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass EnableUserRequest
     #   data as a hash:
     #
@@ -1533,6 +1662,80 @@ module Aws::FinSpaceData
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass GetExternalDataViewAccessDetailsRequest
+    #   data as a hash:
+    #
+    #       {
+    #         data_view_id: "DataViewId", # required
+    #         dataset_id: "DatasetId", # required
+    #       }
+    #
+    # @!attribute [rw] data_view_id
+    #   The unique identifier for the Dataview that you want to access.
+    #   @return [String]
+    #
+    # @!attribute [rw] dataset_id
+    #   The unique identifier for the Dataset.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetExternalDataViewAccessDetailsRequest AWS API Documentation
+    #
+    class GetExternalDataViewAccessDetailsRequest < Struct.new(
+      :data_view_id,
+      :dataset_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] credentials
+    #   The credentials required to access the external Dataview from the S3
+    #   location.
+    #   @return [Types::AwsCredentials]
+    #
+    # @!attribute [rw] s3_location
+    #   The location where the external Dataview is stored.
+    #   @return [Types::S3Location]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetExternalDataViewAccessDetailsResponse AWS API Documentation
+    #
+    class GetExternalDataViewAccessDetailsResponse < Struct.new(
+      :credentials,
+      :s3_location)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @note When making an API call, you may pass GetPermissionGroupRequest
+    #   data as a hash:
+    #
+    #       {
+    #         permission_group_id: "PermissionGroupId", # required
+    #       }
+    #
+    # @!attribute [rw] permission_group_id
+    #   The unique identifier for the permission group.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetPermissionGroupRequest AWS API Documentation
+    #
+    class GetPermissionGroupRequest < Struct.new(
+      :permission_group_id)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] permission_group
+    #   The structure for a permission group.
+    #   @return [Types::PermissionGroup]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetPermissionGroupResponse AWS API Documentation
+    #
+    class GetPermissionGroupResponse < Struct.new(
+      :permission_group)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Request for GetProgrammaticAccessCredentials operation
     #
     # @note When making an API call, you may pass GetProgrammaticAccessCredentialsRequest
@@ -1634,7 +1837,7 @@ module Aws::FinSpaceData
     #   ^
     #
     #   * `APP_USER` – A user with specific permissions in FinSpace. The
-    #     users are assigned permissions by adding them to a permissions
+    #     users are assigned permissions by adding them to a permission
     #     group.
     #
     #   ^
@@ -1929,6 +2132,54 @@ module Aws::FinSpaceData
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass ListPermissionGroupsByUserRequest
+    #   data as a hash:
+    #
+    #       {
+    #         user_id: "UserId", # required
+    #         next_token: "PaginationToken",
+    #         max_results: 1, # required
+    #       }
+    #
+    # @!attribute [rw] user_id
+    #   The unique identifier for the user.
+    #   @return [String]
+    #
+    # @!attribute [rw] next_token
+    #   A token that indicates where a results page should begin.
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of results per page.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListPermissionGroupsByUserRequest AWS API Documentation
+    #
+    class ListPermissionGroupsByUserRequest < Struct.new(
+      :user_id,
+      :next_token,
+      :max_results)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] permission_groups
+    #   A list of returned permission groups.
+    #   @return [Array<Types::PermissionGroupByUser>]
+    #
+    # @!attribute [rw] next_token
+    #   A token that indicates where a results page should begin.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListPermissionGroupsByUserResponse AWS API Documentation
+    #
+    class ListPermissionGroupsByUserResponse < Struct.new(
+      :permission_groups,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass ListPermissionGroupsRequest
     #   data as a hash:
     #
@@ -1971,6 +2222,54 @@ module Aws::FinSpaceData
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass ListUsersByPermissionGroupRequest
+    #   data as a hash:
+    #
+    #       {
+    #         permission_group_id: "PermissionGroupId", # required
+    #         next_token: "PaginationToken",
+    #         max_results: 1, # required
+    #       }
+    #
+    # @!attribute [rw] permission_group_id
+    #   The unique identifier for the permission group.
+    #   @return [String]
+    #
+    # @!attribute [rw] next_token
+    #   A token that indicates where a results page should begin.
+    #   @return [String]
+    #
+    # @!attribute [rw] max_results
+    #   The maximum number of results per page.
+    #   @return [Integer]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListUsersByPermissionGroupRequest AWS API Documentation
+    #
+    class ListUsersByPermissionGroupRequest < Struct.new(
+      :permission_group_id,
+      :next_token,
+      :max_results)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] users
+    #   Lists details of all users in a specific permission group.
+    #   @return [Array<Types::UserByPermissionGroup>]
+    #
+    # @!attribute [rw] next_token
+    #   A token that indicates where a results page should begin.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/ListUsersByPermissionGroupResponse AWS API Documentation
+    #
+    class ListUsersByPermissionGroupResponse < Struct.new(
+      :users,
+      :next_token)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass ListUsersRequest
     #   data as a hash:
     #
@@ -2031,13 +2330,20 @@ module Aws::FinSpaceData
     #   Indicates 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.
     #
@@ -2060,6 +2366,19 @@ module Aws::FinSpaceData
     #   is determined as epoch time in milliseconds.
     #   @return [Integer]
     #
+    # @!attribute [rw] membership_status
+    #   Indicates the status of the user account within a permission group.
+    #
+    #   * `ADDITION_IN_PROGRESS` – The user account is currently being added
+    #     to the permission group.
+    #
+    #   * `ADDITION_SUCCESS` – The user account is successfully added to the
+    #     permission group.
+    #
+    #   * `REMOVAL_IN_PROGRESS` – The user is currently being removed from
+    #     the permission group.
+    #   @return [String]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/PermissionGroup AWS API Documentation
     #
     class PermissionGroup < Struct.new(
@@ -2068,11 +2387,45 @@ module Aws::FinSpaceData
       :description,
       :application_permissions,
       :create_time,
-      :last_modified_time)
+      :last_modified_time,
+      :membership_status)
       SENSITIVE = [:name, :description]
       include Aws::Structure
     end
 
+    # The structure of a permission group associated with a user account.
+    #
+    # @!attribute [rw] permission_group_id
+    #   The unique identifier for the permission group.
+    #   @return [String]
+    #
+    # @!attribute [rw] name
+    #   The name of the permission group.
+    #   @return [String]
+    #
+    # @!attribute [rw] membership_status
+    #   Indicates the status of the user account within a permission group.
+    #
+    #   * `ADDITION_IN_PROGRESS` – The user account is currently being added
+    #     to the permission group.
+    #
+    #   * `ADDITION_SUCCESS` – The user account is successfully added to the
+    #     permission group.
+    #
+    #   * `REMOVAL_IN_PROGRESS` – The user is currently being removed from
+    #     the permission group.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/PermissionGroupByUser AWS API Documentation
+    #
+    class PermissionGroupByUser < Struct.new(
+      :permission_group_id,
+      :name,
+      :membership_status)
+      SENSITIVE = [:name]
+      include Aws::Structure
+    end
+
     # Permission group parameters for Dataset permissions.
     #
     # Here is an example of how you could specify the
@@ -2191,7 +2544,7 @@ module Aws::FinSpaceData
     #
     # * `AddDatasetData`
     #
-    # * `CreateSnapshot`
+    # * `CreateDataView`
     #
     # * `EditDatasetMetadata`
     #
@@ -2223,6 +2576,26 @@ module Aws::FinSpaceData
       include Aws::Structure
     end
 
+    # The location of an external Dataview in an S3 bucket.
+    #
+    # @!attribute [rw] bucket
+    #   The name of the S3 bucket.
+    #   @return [String]
+    #
+    # @!attribute [rw] key
+    #   The path of the folder, within the S3 bucket that contains the
+    #   Dataset.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/S3Location AWS API Documentation
+    #
+    class S3Location < Struct.new(
+      :bucket,
+      :key)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Definition for a schema on a tabular Dataset.
     #
     # @note When making an API call, you may pass SchemaDefinition
@@ -2530,13 +2903,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.
     #
@@ -2604,7 +2984,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
+    #     users are assigned permissions by adding them to a permission
     #     group.
     #   @return [String]
     #
@@ -2702,7 +3082,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
+    #     users are assigned permissions by adding them to a permission
     #     group.
     #   @return [String]
     #
@@ -2768,6 +3148,88 @@ module Aws::FinSpaceData
       include Aws::Structure
     end
 
+    # The structure of a user account associated with a permission group.
+    #
+    # @!attribute [rw] user_id
+    #   The unique identifier for the user.
+    #   @return [String]
+    #
+    # @!attribute [rw] status
+    #   The current status of the user account.
+    #
+    #   * `CREATING` – The user account creation is in progress.
+    #
+    #   * `ENABLED` – The user account is created and is currently active.
+    #
+    #   * `DISABLED` – The user account is currently inactive.
+    #   @return [String]
+    #
+    # @!attribute [rw] first_name
+    #   The first name of the user.
+    #   @return [String]
+    #
+    # @!attribute [rw] last_name
+    #   The last name of the user.
+    #   @return [String]
+    #
+    # @!attribute [rw] email_address
+    #   The email address of the user. The email address serves as a unique
+    #   identifier for each user and cannot be changed after it's created.
+    #   @return [String]
+    #
+    # @!attribute [rw] type
+    #   Indicates the type of user.
+    #
+    #   * `SUPER_USER` – A user with permission to all the functionality and
+    #     data in FinSpace.
+    #
+    #   * `APP_USER` – A user with specific permissions in FinSpace. The
+    #     users are assigned permissions by adding them to a permission
+    #     group.
+    #   @return [String]
+    #
+    # @!attribute [rw] api_access
+    #   Indicates whether the user can access FinSpace API operations.
+    #
+    #   * `ENABLED` – The user has permissions to use the API operations.
+    #
+    #   * `DISABLED` – The user does not have permissions to use any API
+    #     operations.
+    #   @return [String]
+    #
+    # @!attribute [rw] api_access_principal_arn
+    #   The IAM ARN identifier that is attached to FinSpace API calls.
+    #   @return [String]
+    #
+    # @!attribute [rw] membership_status
+    #   Indicates the status of the user account within a permission group.
+    #
+    #   * `ADDITION_IN_PROGRESS` – The user account is currently being added
+    #     to the permission group.
+    #
+    #   * `ADDITION_SUCCESS` – The user account is successfully added to the
+    #     permission group.
+    #
+    #   * `REMOVAL_IN_PROGRESS` – The user is currently being removed from
+    #     the permission group.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/UserByPermissionGroup AWS API Documentation
+    #
+    class UserByPermissionGroup < Struct.new(
+      :user_id,
+      :status,
+      :first_name,
+      :last_name,
+      :email_address,
+      :type,
+      :api_access,
+      :api_access_principal_arn,
+      :membership_status)
+      SENSITIVE = [:first_name, :last_name, :email_address]
+      include Aws::Structure
+    end
+
     # The input fails to satisfy the constraints specified by an AWS
     # service.
     #

data/lib/aws-sdk-finspacedata.rb

@@ -28,7 +28,7 @@ require_relative 'aws-sdk-finspacedata/customizations'
 # structure.
 #
 #     fin_space_data = Aws::FinSpaceData::Client.new
-#     resp = fin_space_data.create_changeset(params)
+#     resp = fin_space_data.associate_user_to_permission_group(params)
 #
 # See {Client} for more information.
 #
@@ -48,6 +48,6 @@ require_relative 'aws-sdk-finspacedata/customizations'
 # @!group service
 module Aws::FinSpaceData
 
-  GEM_VERSION = '1.14.0'
+  GEM_VERSION = '1.17.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-finspacedata
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 1.17.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-28 00:00:00.000000000 Z
+date: 2022-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core