FinSpaceData / Paginator / ListPermissionGroups

ListPermissionGroups#

class FinSpaceData.Paginator.ListPermissionGroups#

paginator = client.get_paginator('list_permission_groups')

paginate(**kwargs)#

Creates an iterator that will paginate through responses from FinSpaceData.Client.list_permission_groups().

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

MaxItems (integer) –

The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
PageSize (integer) –

The size of each page.
StartingToken (string) –

A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'permissionGroups': [
        {
            'permissionGroupId': 'string',
            'name': 'string',
            'description': 'string',
            'applicationPermissions': [
                'CreateDataset'|'ManageClusters'|'ManageUsersAndGroups'|'ManageAttributeSets'|'ViewAuditData'|'AccessNotebooks'|'GetTemporaryCredentials',
            ],
            'createTime': 123,
            'lastModifiedTime': 123,
            'membershipStatus': 'ADDITION_IN_PROGRESS'|'ADDITION_SUCCESS'|'REMOVAL_IN_PROGRESS'
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- permissionGroups (list) –
  
  A list of all the permission groups.
  - (dict) –
    
    The structure for a permission group.
    - permissionGroupId (string) –
      
      The unique identifier for the permission group.
    - name (string) –
      
      The name of the permission group.
    - description (string) –
      
      A brief description for the permission group.
    - applicationPermissions (list) –
      
      Indicates the permissions that are granted to a specific group for accessing the FinSpace application.
      
      Warning
      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.
      - (string) –
    - createTime (integer) –
      
      The timestamp at which the group was created in FinSpace. The value is determined as epoch time in milliseconds.
    - lastModifiedTime (integer) –
      
      Describes the last time the permission group was updated. The value is determined as epoch time in milliseconds.
    - membershipStatus (string) –
      
      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.
- NextToken (string) –
  
  A token to resume pagination.