:doc:`WorkDocs <../../workdocs>` / Paginator / DescribeRootFolders

*******************
DescribeRootFolders
*******************



.. py:class:: WorkDocs.Paginator.DescribeRootFolders

  ::

    
    paginator = client.get_paginator('describe_root_folders')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`WorkDocs.Client.describe_root_folders`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          AuthenticationToken='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type AuthenticationToken: string
    :param AuthenticationToken: **[REQUIRED]** 

      Amazon WorkDocs authentication token.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      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.

        

      
    
    
    :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
                },
            ],
            'NextToken': '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.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    