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

*************
get_resources
*************



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

  

  Retrieves a collection of resources, including folders and documents. The only ``CollectionType`` supported is ``SHARED_WITH_ME``.

  

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


  **Request Syntax**
  ::

    response = client.get_resources(
        AuthenticationToken='string',
        UserId='string',
        CollectionType='SHARED_WITH_ME',
        Limit=123,
        Marker='string'
    )
    
  :type AuthenticationToken: string
  :param AuthenticationToken: 

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

    

  
  :type UserId: string
  :param UserId: 

    The user ID for the resource collection. This is a required field for accessing the API operation using IAM credentials.

    

  
  :type CollectionType: string
  :param CollectionType: 

    The collection type.

    

  
  :type Limit: integer
  :param Limit: 

    The maximum number of resources to return.

    

  
  :type Marker: string
  :param Marker: 

    The marker for the next set of results. This marker was received 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
              },
          ],
          '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',
                  ]
              },
          ],
          'Marker': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The folders 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 collection.

        
        

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

      - **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.UnauthorizedResourceAccessException`

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

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

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

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

  