AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginGetDocumentPath and EndGetDocumentPath.

Namespace: Amazon.WorkDocs
Assembly: AWSSDK.WorkDocs.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<GetDocumentPathResponse> GetDocumentPathAsync(
         GetDocumentPathRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.WorkDocs.Model.GetDocumentPathRequest

Container for the necessary parameters to execute the GetDocumentPath service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the GetDocumentPath service method, as returned by WorkDocs.

Exceptions

ExceptionCondition
EntityNotExistsException The resource does not exist.
FailedDependencyException The Directory Service cannot reach an on-premises instance. Or a dependency under the control of the organization is failing, such as a connected Active Directory.
ServiceUnavailableException One or more of the dependencies is unavailable.
UnauthorizedOperationException The operation is not permitted.
UnauthorizedResourceAccessException The caller does not have access to perform the action on the resource.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also