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

**********************
DescribeFolderContents
**********************



.. py:class:: WorkDocs.Paginator.DescribeFolderContents

  ::

    
    paginator = client.get_paginator('describe_folder_contents')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          AuthenticationToken='string',
          FolderId='string',
          Sort='DATE'|'NAME',
          Order='ASCENDING'|'DESCENDING',
          Type='ALL'|'DOCUMENT'|'FOLDER',
          Include='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type AuthenticationToken: string
    :param AuthenticationToken: 

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

      

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

      The ID of the folder.

      

    
    :type Sort: string
    :param Sort: 

      The sorting criteria.

      

    
    :type Order: string
    :param Order: 

      The order for the contents of the folder.

      

    
    :type Type: string
    :param Type: 

      The type of items.

      

    
    :type Include: string
    :param Include: 

      The contents to include. Specify "INITIALIZED" to include initialized documents.

      

    
    :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
                },
            ],
            'Documents': [
                {
                    'Id': 'string',
                    'CreatorId': 'string',
                    'ParentFolderId': 'string',
                    'CreatedTimestamp': datetime(2015, 1, 1),
                    'ModifiedTimestamp': datetime(2015, 1, 1),
                    'LatestVersionMetadata': {
                        'Id': 'string',
                        'Name': 'string',
                        'ContentType': 'string',
                        'Size': 123,
                        'Signature': 'string',
                        'Status': 'INITIALIZED'|'ACTIVE',
                        'CreatedTimestamp': datetime(2015, 1, 1),
                        'ModifiedTimestamp': datetime(2015, 1, 1),
                        'ContentCreatedTimestamp': datetime(2015, 1, 1),
                        'ContentModifiedTimestamp': datetime(2015, 1, 1),
                        'CreatorId': 'string',
                        'Thumbnail': {
                            'string': 'string'
                        },
                        'Source': {
                            'string': 'string'
                        }
                    },
                    'ResourceState': 'ACTIVE'|'RESTORING'|'RECYCLING'|'RECYCLED',
                    'Labels': [
                        'string',
                    ]
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

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

          The subfolders in the specified folder.

          
          

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

              
        
      
        

        - **Documents** *(list) --* 

          The documents in the specified folder.

          
          

          - *(dict) --* 

            Describes the document.

            
            

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

              The ID of the document.

              
            

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

              The ID of the creator.

              
            

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

              The ID of the parent folder.

              
            

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

              The time when the document was created.

              
            

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

              The time when the document was updated.

              
            

            - **LatestVersionMetadata** *(dict) --* 

              The latest version of the document.

              
              

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

                The ID of the version.

                
              

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

                The name of the version.

                
              

              - **ContentType** *(string) --* 

                The content type of the document.

                
              

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

                The size of the document, in bytes.

                
              

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

                The signature of the document.

                
              

              - **Status** *(string) --* 

                The status of the document.

                
              

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

                The timestamp when the document was first uploaded.

                
              

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

                The timestamp when the document was last uploaded.

                
              

              - **ContentCreatedTimestamp** *(datetime) --* 

                The timestamp when the content of the document was originally created.

                
              

              - **ContentModifiedTimestamp** *(datetime) --* 

                The timestamp when the content of the document was modified.

                
              

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

                The ID of the creator.

                
              

              - **Thumbnail** *(dict) --* 

                The thumbnail of the document.

                
                

                - *(string) --* 
                  

                  - *(string) --* 
            
          
              

              - **Source** *(dict) --* 

                The source of the document.

                
                

                - *(string) --* 
                  

                  - *(string) --* 
            
          
          
            

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

              The resource state.

              
            

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

              List of labels on the document.

              
              

              - *(string) --* 
          
        
      
        

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

          A token to resume pagination.

          
    