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

**********
get_folder
**********



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

  

  Retrieves the metadata of the specified folder.

  

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


  **Request Syntax**
  ::

    response = client.get_folder(
        AuthenticationToken='string',
        FolderId='string',
        IncludeCustomMetadata=True|False
    )
    
  :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 IncludeCustomMetadata: boolean
  :param IncludeCustomMetadata: 

    Set to TRUE to include custom metadata in the response.

    

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

    
    ::

      {
          'Metadata': {
              '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
          },
          'CustomMetadata': {
              'string': 'string'
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Metadata** *(dict) --* 

        The metadata of the 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.

          
    
      

      - **CustomMetadata** *(dict) --* 

        The custom metadata on the folder.

        
        

        - *(string) --* 
          

          - *(string) --* 
    
  
  
  **Exceptions**
  
  *   :py:class:`WorkDocs.Client.exceptions.EntityNotExistsException`

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

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

  