DeleteFolderContentsCommand

Suggest an Edit

Deletes the contents of the specified folder.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { WorkDocsClient, DeleteFolderContentsCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
// const { WorkDocsClient, DeleteFolderContentsCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
const client = new WorkDocsClient(config);
const input = { // DeleteFolderContentsRequest
  AuthenticationToken: "STRING_VALUE",
  FolderId: "STRING_VALUE", // required
};
const command = new DeleteFolderContentsCommand(input);
const response = await client.send(command);
// {};

DeleteFolderContentsCommand Input

See DeleteFolderContentsCommandInput for more details

Parameter
Type
Description
FolderId
Required
string | undefined

The ID of the folder.

AuthenticationToken
string | undefined

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

DeleteFolderContentsCommand Output

See DeleteFolderContentsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
ConflictingOperationException
client

Another operation is in progress on the resource that conflicts with the current operation.

EntityNotExistsException
client

The resource does not exist.

FailedDependencyException
client

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.

ProhibitedStateException
client

The specified document version is not in the INITIALIZED state.

ServiceUnavailableException
server

One or more of the dependencies is unavailable.

UnauthorizedOperationException
client

The operation is not permitted.

UnauthorizedResourceAccessException
client

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

WorkDocsServiceException
Base exception class for all service exceptions from WorkDocs service.