import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeFolderContentsRequest, DescribeFolderContentsResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DescribeFolderContentsCommand}. */ export interface DescribeFolderContentsCommandInput extends DescribeFolderContentsRequest { } /** * @public * * The output of {@link DescribeFolderContentsCommand}. */ export interface DescribeFolderContentsCommandOutput extends DescribeFolderContentsResponse, __MetadataBearer { } declare const DescribeFolderContentsCommand_base: { new (input: DescribeFolderContentsCommandInput): import("@smithy/core/client").CommandImpl; new (input: DescribeFolderContentsCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Describes the contents of the specified folder, including its documents and * subfolders.

*

By default, Amazon WorkDocs returns the first 100 active document and folder * metadata items. If there are more results, the response includes a marker that you can * use to request the next set of results. You can also request initialized * documents.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { WorkDocsClient, DescribeFolderContentsCommand } from "@aws-sdk/client-workdocs"; // ES Modules import * // const { WorkDocsClient, DescribeFolderContentsCommand } = 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 = { // DescribeFolderContentsRequest * AuthenticationToken: "STRING_VALUE", * FolderId: "STRING_VALUE", // required * Sort: "DATE" || "NAME", * Order: "ASCENDING" || "DESCENDING", * Limit: Number("int"), * Marker: "STRING_VALUE", * Type: "ALL" || "DOCUMENT" || "FOLDER", * Include: "STRING_VALUE", * }; * const command = new DescribeFolderContentsCommand(input); * const response = await client.send(command); * // { // DescribeFolderContentsResponse * // Folders: [ // FolderMetadataList * // { // FolderMetadata * // Id: "STRING_VALUE", * // Name: "STRING_VALUE", * // CreatorId: "STRING_VALUE", * // ParentFolderId: "STRING_VALUE", * // CreatedTimestamp: new Date("TIMESTAMP"), * // ModifiedTimestamp: new Date("TIMESTAMP"), * // ResourceState: "ACTIVE" || "RESTORING" || "RECYCLING" || "RECYCLED", * // Signature: "STRING_VALUE", * // Labels: [ // SharedLabels * // "STRING_VALUE", * // ], * // Size: Number("long"), * // LatestVersionSize: Number("long"), * // }, * // ], * // Documents: [ // DocumentMetadataList * // { // DocumentMetadata * // Id: "STRING_VALUE", * // CreatorId: "STRING_VALUE", * // ParentFolderId: "STRING_VALUE", * // CreatedTimestamp: new Date("TIMESTAMP"), * // ModifiedTimestamp: new Date("TIMESTAMP"), * // LatestVersionMetadata: { // DocumentVersionMetadata * // Id: "STRING_VALUE", * // Name: "STRING_VALUE", * // ContentType: "STRING_VALUE", * // Size: Number("long"), * // Signature: "STRING_VALUE", * // Status: "INITIALIZED" || "ACTIVE", * // CreatedTimestamp: new Date("TIMESTAMP"), * // ModifiedTimestamp: new Date("TIMESTAMP"), * // ContentCreatedTimestamp: new Date("TIMESTAMP"), * // ContentModifiedTimestamp: new Date("TIMESTAMP"), * // CreatorId: "STRING_VALUE", * // Thumbnail: { // DocumentThumbnailUrlMap * // "": "STRING_VALUE", * // }, * // Source: { // DocumentSourceUrlMap * // "": "STRING_VALUE", * // }, * // }, * // ResourceState: "ACTIVE" || "RESTORING" || "RECYCLING" || "RECYCLED", * // Labels: [ * // "STRING_VALUE", * // ], * // }, * // ], * // Marker: "STRING_VALUE", * // }; * * ``` * * @param DescribeFolderContentsCommandInput - {@link DescribeFolderContentsCommandInput} * @returns {@link DescribeFolderContentsCommandOutput} * @see {@link DescribeFolderContentsCommandInput} for command's `input` shape. * @see {@link DescribeFolderContentsCommandOutput} 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 InvalidArgumentException} (client fault) *

The pagination marker or limit fields are not valid.

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

The specified document version is not in the INITIALIZED state.

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

One or more of the dependencies is unavailable.

* * @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 DescribeFolderContentsCommand extends DescribeFolderContentsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeFolderContentsRequest; output: DescribeFolderContentsResponse; }; sdk: { input: DescribeFolderContentsCommandInput; output: DescribeFolderContentsCommandOutput; }; }; }