import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { GetDocumentPathRequest, GetDocumentPathResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link GetDocumentPathCommand}. */ export interface GetDocumentPathCommandInput extends GetDocumentPathRequest { } /** * @public * * The output of {@link GetDocumentPathCommand}. */ export interface GetDocumentPathCommandOutput extends GetDocumentPathResponse, __MetadataBearer { } declare const GetDocumentPathCommand_base: { new (input: GetDocumentPathCommandInput): import("@smithy/core/client").CommandImpl; new (input: GetDocumentPathCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

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.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { WorkDocsClient, GetDocumentPathCommand } from "@aws-sdk/client-workdocs"; // ES Modules import * // const { WorkDocsClient, GetDocumentPathCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import * // import type { WorkDocsClientConfig } from "@aws-sdk/client-workdocs"; * const config = {}; // type is WorkDocsClientConfig * const client = new WorkDocsClient(config); * const input = { // GetDocumentPathRequest * AuthenticationToken: "STRING_VALUE", * DocumentId: "STRING_VALUE", // required * Limit: Number("int"), * Fields: "STRING_VALUE", * Marker: "STRING_VALUE", * }; * const command = new GetDocumentPathCommand(input); * const response = await client.send(command); * // { // GetDocumentPathResponse * // Path: { // ResourcePath * // Components: [ // ResourcePathComponentList * // { // ResourcePathComponent * // Id: "STRING_VALUE", * // Name: "STRING_VALUE", * // }, * // ], * // }, * // }; * * ``` * * @param GetDocumentPathCommandInput - {@link GetDocumentPathCommandInput} * @returns {@link GetDocumentPathCommandOutput} * @see {@link GetDocumentPathCommandInput} for command's `input` shape. * @see {@link GetDocumentPathCommandOutput} for command's `response` shape. * @see {@link WorkDocsClientResolvedConfig | config} for WorkDocsClient's `config` shape. * * @throws {@link EntityNotExistsException} (client fault) *

The resource does not exist.

* * @throws {@link FailedDependencyException} (client fault) *

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.

* * @throws {@link ServiceUnavailableException} (server fault) *

One or more of the dependencies is unavailable.

* * @throws {@link UnauthorizedOperationException} (client fault) *

The operation is not permitted.

* * @throws {@link UnauthorizedResourceAccessException} (client fault) *

The caller does not have access to perform the action on the resource.

* * @throws {@link WorkDocsServiceException} *

Base exception class for all service exceptions from WorkDocs service.

* * * @public */ export declare class GetDocumentPathCommand extends GetDocumentPathCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetDocumentPathRequest; output: GetDocumentPathResponse; }; sdk: { input: GetDocumentPathCommandInput; output: GetDocumentPathCommandOutput; }; }; }