DescribeLabelCommand

Suggest an Edit

Returns the name of the label.

Example Syntax

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

import { LookoutEquipmentClient, DescribeLabelCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import
// const { LookoutEquipmentClient, DescribeLabelCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import
const client = new LookoutEquipmentClient(config);
const input = { // DescribeLabelRequest
  LabelGroupName: "STRING_VALUE", // required
  LabelId: "STRING_VALUE", // required
};
const command = new DescribeLabelCommand(input);
const response = await client.send(command);
// { // DescribeLabelResponse
//   LabelGroupName: "STRING_VALUE",
//   LabelGroupArn: "STRING_VALUE",
//   LabelId: "STRING_VALUE",
//   StartTime: new Date("TIMESTAMP"),
//   EndTime: new Date("TIMESTAMP"),
//   Rating: "ANOMALY" || "NO_ANOMALY" || "NEUTRAL",
//   FaultCode: "STRING_VALUE",
//   Notes: "STRING_VALUE",
//   Equipment: "STRING_VALUE",
//   CreatedAt: new Date("TIMESTAMP"),
// };

DescribeLabelCommand Input

See DescribeLabelCommandInput for more details

Parameter
Type
Description
LabelGroupName
Required
string | undefined

Returns the name of the group containing the label.

LabelId
Required
string | undefined

Returns the ID of the label.

DescribeLabelCommand Output

See DescribeLabelCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
CreatedAt
Date | undefined

The time at which the label was created.

EndTime
Date | undefined

The end time of the requested label.

Equipment
string | undefined

Indicates that a label pertains to a particular piece of equipment.

FaultCode
string | undefined

Indicates the type of anomaly associated with the label.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

LabelGroupArn
string | undefined

The Amazon Resource Name (ARN) of the requested label group.

LabelGroupName
string | undefined

The name of the requested label group.

LabelId
string | undefined

The ID of the requested label.

Notes
string | undefined

Metadata providing additional information about the label.

Data in this field will be retained for service usage. Follow best practices for the security of your data.

Rating
LabelRating | undefined

Indicates whether a labeled event represents an anomaly.

StartTime
Date | undefined

The start time of the requested label.

Throws

Name
Fault
Details
AccessDeniedException
client

The request could not be completed because you do not have access to the 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.