FinSpaceData / Client / update_permission_group

update_permission_group#

FinSpaceData.Client.update_permission_group(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = client.update_permission_group(
    permissionGroupId='string',
    name='string',
    description='string',
    applicationPermissions=[
        'CreateDataset'|'ManageClusters'|'ManageUsersAndGroups'|'ManageAttributeSets'|'ViewAuditData'|'AccessNotebooks'|'GetTemporaryCredentials',
    ],
    clientToken='string'
)
Parameters:

  • permissionGroupId (string) –

    [REQUIRED]

    The unique identifier for the permission group to update.

  • name (string) – The name of the permission group.

  • description (string) – A brief description for the permission group.

  • applicationPermissions (list) –

    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) –

  • clientToken (string) –

    A token that ensures idempotency. This token expires in 10 minutes.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'permissionGroupId': 'string'
}

Response Structure

  • (dict) –

    • permissionGroupId (string) –

      The unique identifier for the updated permission group.

Exceptions

  • FinSpaceData.Client.exceptions.InternalServerException

  • FinSpaceData.Client.exceptions.ValidationException

  • FinSpaceData.Client.exceptions.ThrottlingException

  • FinSpaceData.Client.exceptions.AccessDeniedException

  • FinSpaceData.Client.exceptions.ResourceNotFoundException

  • FinSpaceData.Client.exceptions.ConflictException