DeleteLabelGroupCommand

Suggest an Edit

Deletes a group of labels.

Example Syntax

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

import { LookoutEquipmentClient, DeleteLabelGroupCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import
// const { LookoutEquipmentClient, DeleteLabelGroupCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import
const client = new LookoutEquipmentClient(config);
const input = { // DeleteLabelGroupRequest
  LabelGroupName: "STRING_VALUE", // required
};
const command = new DeleteLabelGroupCommand(input);
const response = await client.send(command);
// {};

DeleteLabelGroupCommand Input

See DeleteLabelGroupCommandInput for more details

Parameter
Type
Description
LabelGroupName
Required
string | undefined

The name of the label group that you want to delete. Data in this field will be retained for service usage. Follow best practices for the security of your data.

DeleteLabelGroupCommand Output

See DeleteLabelGroupCommandOutput for details

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

Throws

Name
Fault
Details
AccessDeniedException
client

The request could not be completed because you do not have access to the resource.

ConflictException
client

The request could not be completed due to a conflict with the current state of the target resource.

InternalServerException
server

Processing of the request has failed because of an unknown error, exception or failure.

ResourceNotFoundException
client

The resource requested could not be found. Verify the resource ID and retry your request.

ThrottlingException
client

The request was denied due to request throttling.

ValidationException
client

The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized.

LookoutEquipmentServiceException
Base exception class for all service exceptions from LookoutEquipment service.