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

*********************
describe_root_folders
*********************



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

  

  Describes the current user's special folders; the ``RootFolder`` and the ``RecycleBin``. ``RootFolder`` is the root of user's files and folders and ``RecycleBin`` is the root of recycled items. This is not a valid action for SigV4 (administrative API) clients.

   

  This action requires an authentication token. To get an authentication token, register an application with Amazon WorkDocs. For more information, see `Authentication and Access Control for User Applications <https://docs.aws.amazon.com/workdocs/latest/developerguide/wd-auth-user.html>`__ in the *Amazon WorkDocs Developer Guide*.

  

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


  **Request Syntax**
  ::

    response = client.describe_root_folders(
        AuthenticationToken='string',
        Limit=123,
        Marker='string'
    )
    
  :type AuthenticationToken: string
  :param AuthenticationToken: **[REQUIRED]** 

    Amazon WorkDocs authentication token.

    

  
  :type Limit: integer
  :param Limit: 

    The maximum number of items to return.

    

  
  :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**

    
    ::

      {
          'Folders': [
              {
                  'Id': 'string',
                  'Name': 'string',
                  'CreatorId': 'string',
                  'ParentFolderId': 'string',
                  'CreatedTimestamp': datetime(2015, 1, 1),
                  'ModifiedTimestamp': datetime(2015, 1, 1),
                  'ResourceState': 'ACTIVE'|'RESTORING'|'RECYCLING'|'RECYCLED',
                  'Signature': 'string',
                  'Labels': [
                      'string',
                  ],
                  'Size': 123,
                  'LatestVersionSize': 123
              },
          ],
          'Marker': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Folders** *(list) --* 

        The user's special folders.

        
        

        - *(dict) --* 

          Describes a folder.

          
          

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

            The ID of the folder.

            
          

          - **Name** *(string) --* 

            The name of the folder.

            
          

          - **CreatorId** *(string) --* 

            The ID of the creator.

            
          

          - **ParentFolderId** *(string) --* 

            The ID of the parent folder.

            
          

          - **CreatedTimestamp** *(datetime) --* 

            The time when the folder was created.

            
          

          - **ModifiedTimestamp** *(datetime) --* 

            The time when the folder was updated.

            
          

          - **ResourceState** *(string) --* 

            The resource state of the folder.

            
          

          - **Signature** *(string) --* 

            The unique identifier created from the subfolders and documents of the folder.

            
          

          - **Labels** *(list) --* 

            List of labels on the folder.

            
            

            - *(string) --* 
        
          

          - **Size** *(integer) --* 

            The size of the folder metadata.

            
          

          - **LatestVersionSize** *(integer) --* 

            The size of the latest version of the folder metadata.

            
      
    
      

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

        The marker for the next set of results.

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

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

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

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

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

  