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

*****************
get_document_path
*****************



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

  

  Retrieves the path information (the hierarchy from the root folder) for the requested document.

   

  By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested document and only includes the IDs of the parent folders in the path. You can limit the maximum number of levels. You can also request the names of the parent folders.

  

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


  **Request Syntax**
  ::

    response = client.get_document_path(
        AuthenticationToken='string',
        DocumentId='string',
        Limit=123,
        Fields='string',
        Marker='string'
    )
    
  :type AuthenticationToken: string
  :param AuthenticationToken: 

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

    

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

    The ID of the document.

    

  
  :type Limit: integer
  :param Limit: 

    The maximum number of levels in the hierarchy to return.

    

  
  :type Fields: string
  :param Fields: 

    A comma-separated list of values. Specify ``NAME`` to include the names of the parent folders.

    

  
  :type Marker: string
  :param Marker: 

    This value is not supported.

    

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

    
    ::

      {
          'Path': {
              'Components': [
                  {
                      'Id': 'string',
                      'Name': 'string'
                  },
              ]
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Path** *(dict) --* 

        The path information.

        
        

        - **Components** *(list) --* 

          The components of the resource path.

          
          

          - *(dict) --* 

            Describes the resource path.

            
            

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

              The ID of the resource path.

              
            

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

              The name of the resource path.

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

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

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

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

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

  