:doc:`WorkDocs <../../workdocs>` / Client / describe_resource_permissions

*****************************
describe_resource_permissions
*****************************



.. py:method:: WorkDocs.Client.describe_resource_permissions(**kwargs)

  

  Describes the permissions of a specified resource.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/workdocs-2016-05-01/DescribeResourcePermissions>`_  


  **Request Syntax**
  ::

    response = client.describe_resource_permissions(
        AuthenticationToken='string',
        ResourceId='string',
        PrincipalId='string',
        Limit=123,
        Marker='string'
    )
    
  :type AuthenticationToken: string
  :param AuthenticationToken: 

    Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

    

  
  :type ResourceId: string
  :param ResourceId: **[REQUIRED]** 

    The ID of the resource.

    

  
  :type PrincipalId: string
  :param PrincipalId: 

    The ID of the principal to filter permissions by.

    

  
  :type Limit: integer
  :param Limit: 

    The maximum number of items to return with this call.

    

  
  :type Marker: string
  :param Marker: 

    The marker for the next set of results. (You received this marker from a previous call)

    

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

    
    ::

      {
          'Principals': [
              {
                  'Id': 'string',
                  'Type': 'USER'|'GROUP'|'INVITE'|'ANONYMOUS'|'ORGANIZATION',
                  'Roles': [
                      {
                          'Role': 'VIEWER'|'CONTRIBUTOR'|'OWNER'|'COOWNER',
                          'Type': 'DIRECT'|'INHERITED'
                      },
                  ]
              },
          ],
          'Marker': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Principals** *(list) --* 

        The principals.

        
        

        - *(dict) --* 

          Describes a resource.

          
          

          - **Id** *(string) --* 

            The ID of the resource.

            
          

          - **Type** *(string) --* 

            The type of resource.

            
          

          - **Roles** *(list) --* 

            The permission information for the resource.

            
            

            - *(dict) --* 

              Describes the permissions.

              
              

              - **Role** *(string) --* 

                The role of the user.

                
              

              - **Type** *(string) --* 

                The type of permissions.

                
          
        
      
    
      

      - **Marker** *(string) --* 

        The marker to use when requesting the next set of results. If there are no additional results, the string is empty.

        
  
  **Exceptions**
  
  *   :py:class:`WorkDocs.Client.exceptions.InvalidArgumentException`

  
  *   :py:class:`WorkDocs.Client.exceptions.UnauthorizedOperationException`

  
  *   :py:class:`WorkDocs.Client.exceptions.UnauthorizedResourceAccessException`

  
  *   :py:class:`WorkDocs.Client.exceptions.FailedDependencyException`

  
  *   :py:class:`WorkDocs.Client.exceptions.ServiceUnavailableException`

  