:doc:`FinSpaceData <../../finspace-data>` / Client / get_permission_group

********************
get_permission_group
********************



.. py:method:: FinSpaceData.Client.get_permission_group(**kwargs)

  

  Retrieves the details of a specific permission group.

  

  .. danger::

        This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.


  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/finspace-2020-07-13/GetPermissionGroup>`_  


  **Request Syntax**
  ::

    response = client.get_permission_group(
        permissionGroupId='string'
    )
    
  :type permissionGroupId: string
  :param permissionGroupId: **[REQUIRED]** 

    The unique identifier for the permission group.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'permissionGroup': {
              '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'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **permissionGroup** *(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 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.
          

          
    
  
  **Exceptions**
  
  *   :py:class:`FinSpaceData.Client.exceptions.InternalServerException`

  
  *   :py:class:`FinSpaceData.Client.exceptions.ValidationException`

  
  *   :py:class:`FinSpaceData.Client.exceptions.ThrottlingException`

  
  *   :py:class:`FinSpaceData.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`FinSpaceData.Client.exceptions.ResourceNotFoundException`

  