WorkDocs / Client / get_folder_path

get_folder_path#

WorkDocs.Client.get_folder_path(**kwargs)#

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

By default, Amazon WorkDocs returns a maximum of 100 levels upwards from the requested folder 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 parent folder names.

See also: AWS API Documentation

Request Syntax

response = client.get_folder_path(
    AuthenticationToken='string',
    FolderId='string',
    Limit=123,
    Fields='string',
    Marker='string'
)
Parameters:

  • AuthenticationToken (string) – Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.

  • FolderId (string) –

    [REQUIRED]

    The ID of the folder.

  • Limit (integer) – The maximum number of levels in the hierarchy to return.

  • Fields (string) – A comma-separated list of values. Specify “NAME” to include the names of the parent folders.

  • Marker (string) – This value is not supported.

Return type:

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

  • WorkDocs.Client.exceptions.EntityNotExistsException

  • WorkDocs.Client.exceptions.UnauthorizedOperationException

  • WorkDocs.Client.exceptions.UnauthorizedResourceAccessException

  • WorkDocs.Client.exceptions.FailedDependencyException

  • WorkDocs.Client.exceptions.ServiceUnavailableException