DeleteLabelsCommand

Suggest an Edit

Deletes the specified list of labels from a resource.

Example Syntax

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

import { WorkDocsClient, DeleteLabelsCommand } from "@aws-sdk/client-workdocs"; // ES Modules import
// const { WorkDocsClient, DeleteLabelsCommand } = require("@aws-sdk/client-workdocs"); // CommonJS import
const client = new WorkDocsClient(config);
const input = { // DeleteLabelsRequest
  ResourceId: "STRING_VALUE", // required
  AuthenticationToken: "STRING_VALUE",
  Labels: [ // SharedLabels
    "STRING_VALUE",
  ],
  DeleteAll: true || false,
};
const command = new DeleteLabelsCommand(input);
const response = await client.send(command);
// {};

DeleteLabelsCommand Input

See DeleteLabelsCommandInput for more details

Parameter
Type
Description
ResourceId
Required
string | undefined

The ID of the resource.

AuthenticationToken
string | undefined

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

DeleteAll
boolean | undefined

Flag to request removal of all labels from the specified resource.

Labels
string[] | undefined

List of labels to delete from the resource.

DeleteLabelsCommand Output

See DeleteLabelsCommandOutput for details

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

Throws

Name
Fault
Details
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.