permission_groups

Creates, updates, deletes, gets or lists a permission_groups resource.

Overview

Name	permission_groups
Type	Resource
Id	aws.finspace_data.permission_groups

Fields

The following fields are returned by SELECT queries:

list_permission_groups

Name	Datatype	Description
name	string	The name of the permission group. (pattern: <code>.\S.</code>)
application_permissions	array	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. 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. ViewAuditData – Group members can view audit data. AccessNotebooks – Group members will have access to FinSpace notebooks. GetTemporaryCredentials – Group members can get temporary API credentials.
create_time	integer (int64)	Milliseconds since UTC epoch
description	string	A brief description for the permission group. (pattern: <code>[\s\S]*</code>)
last_modified_time	integer (int64)	Milliseconds since UTC epoch
membership_status	string	Indicates the status of the user within a permission group. ADDITION_IN_PROGRESS – The user is currently being added to the permission group. ADDITION_SUCCESS – The user is successfully added to the permission group. REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group. (ADDITION_IN_PROGRESS, ADDITION_SUCCESS, REMOVAL_IN_PROGRESS)
permission_group_id	string	The unique identifier for the permission group. (pattern: <code>.\S.</code>)

get_permission_group

Name	Datatype	Description
name	string	The name of the permission group. (pattern: <code>.\S.</code>)
application_permissions	array	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. 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. ViewAuditData – Group members can view audit data. AccessNotebooks – Group members will have access to FinSpace notebooks. GetTemporaryCredentials – Group members can get temporary API credentials.
create_time	integer (int64)	Milliseconds since UTC epoch
description	string	A brief description for the permission group. (pattern: <code>[\s\S]*</code>)
last_modified_time	integer (int64)	Milliseconds since UTC epoch
membership_status	string	Indicates the status of the user within a permission group. ADDITION_IN_PROGRESS – The user is currently being added to the permission group. ADDITION_SUCCESS – The user is successfully added to the permission group. REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group. (ADDITION_IN_PROGRESS, ADDITION_SUCCESS, REMOVAL_IN_PROGRESS)
permission_group_id	string	The unique identifier for the permission group. (pattern: <code>.\S.</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_permission_groups	select	maxResults, region	nextToken	Lists all available permission groups in FinSpace.
get_permission_group	select	permission_group_id, region		Retrieves the details of a specific permission group.
create_permission_group	insert	region, name, applicationPermissions		Creates a group of permissions for various actions that a user can perform in FinSpace.
associate_user_to_permission_group	update	permission_group_id, user_id, region		Adds a user to a permission group to grant permissions for actions a user can perform in FinSpace.
update_permission_group	update	permission_group_id, region		Modifies the details of a permission group. You cannot modify a permissionGroupID.
delete_permission_group	delete	permission_group_id, region	clientToken	Deletes a permission group. This action is irreversible.
disassociate_user_from_permission_group	exec	permission_group_id, user_id, region	clientToken	Removes a user from a permission group.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
maxResults	integer	The maximum number of results per page.
permission_group_id	string	The unique identifier for the permission group.
region	string	AWS region (default: us-east-1)
user_id	string	The unique identifier for the user.
clientToken	string	A token that ensures idempotency. This token expires in 10 minutes.
nextToken	string	A token that indicates where a results page should begin.

SELECT examples

list_permission_groups

Lists all available permission groups in FinSpace.

SELECT
name,
application_permissions,
create_time,
description,
last_modified_time,
membership_status,
permission_group_id
FROM aws.finspace_data.permission_groups
WHERE maxResults = '{{ maxResults }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
;

get_permission_group

Retrieves the details of a specific permission group.

SELECT
name,
application_permissions,
create_time,
description,
last_modified_time,
membership_status,
permission_group_id
FROM aws.finspace_data.permission_groups
WHERE permission_group_id = '{{ permission_group_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_permission_group

Creates a group of permissions for various actions that a user can perform in FinSpace.

INSERT INTO aws.finspace_data.permission_groups (
name,
description,
applicationPermissions,
clientToken,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ description }}',
'{{ applicationPermissions }}' /* required */,
'{{ clientToken }}',
'{{ region }}'
RETURNING
permission_group_id
;

Manifest

# Description fields are for documentation purposes
- name: permission_groups
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the permission_groups resource.
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: applicationPermissions
    value:
      - "{{ applicationPermissions }}"
  - name: clientToken
    value: "{{ clientToken }}"
    description: |
      Idempotence Token for API operations

UPDATE examples

associate_user_to_permission_group

Adds a user to a permission group to grant permissions for actions a user can perform in FinSpace.

UPDATE aws.finspace_data.permission_groups
SET 
clientToken = '{{ clientToken }}'
WHERE 
permission_group_id = '{{ permission_group_id }}' --required
AND user_id = '{{ user_id }}' --required
AND region = '{{ region }}' --required
RETURNING
status_code;

update_permission_group

Modifies the details of a permission group. You cannot modify a permissionGroupID.

UPDATE aws.finspace_data.permission_groups
SET 
name = '{{ name }}',
description = '{{ description }}',
applicationPermissions = '{{ applicationPermissions }}',
clientToken = '{{ clientToken }}'
WHERE 
permission_group_id = '{{ permission_group_id }}' --required
AND region = '{{ region }}' --required
RETURNING
permission_group_id;

DELETE examples

delete_permission_group

Deletes a permission group. This action is irreversible.

DELETE FROM aws.finspace_data.permission_groups
WHERE permission_group_id = '{{ permission_group_id }}' --required
AND region = '{{ region }}' --required
AND clientToken = '{{ clientToken }}'
;

Lifecycle Methods

disassociate_user_from_permission_group

Removes a user from a permission group.

EXEC aws.finspace_data.permission_groups.disassociate_user_from_permission_group 
@permission_group_id='{{ permission_group_id }}' --required, 
@user_id='{{ user_id }}' --required, 
@region='{{ region }}' --required, 
@clientToken='{{ clientToken }}'
;