ListLabelsCommand

Suggest an Edit

Provides a list of labels.

Example Syntax

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

import { LookoutEquipmentClient, ListLabelsCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import
// const { LookoutEquipmentClient, ListLabelsCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import
const client = new LookoutEquipmentClient(config);
const input = { // ListLabelsRequest
  LabelGroupName: "STRING_VALUE", // required
  IntervalStartTime: new Date("TIMESTAMP"),
  IntervalEndTime: new Date("TIMESTAMP"),
  FaultCode: "STRING_VALUE",
  Equipment: "STRING_VALUE",
  NextToken: "STRING_VALUE",
  MaxResults: Number("int"),
};
const command = new ListLabelsCommand(input);
const response = await client.send(command);
// { // ListLabelsResponse
//   NextToken: "STRING_VALUE",
//   LabelSummaries: [ // LabelSummaries
//     { // LabelSummary
//       LabelGroupName: "STRING_VALUE",
//       LabelId: "STRING_VALUE",
//       LabelGroupArn: "STRING_VALUE",
//       StartTime: new Date("TIMESTAMP"),
//       EndTime: new Date("TIMESTAMP"),
//       Rating: "ANOMALY" || "NO_ANOMALY" || "NEUTRAL",
//       FaultCode: "STRING_VALUE",
//       Equipment: "STRING_VALUE",
//       CreatedAt: new Date("TIMESTAMP"),
//     },
//   ],
// };

ListLabelsCommand Input

See ListLabelsCommandInput for more details

Parameter
Type
Description
LabelGroupName
Required
string | undefined

Returns the name of the label group.

Equipment
string | undefined

Lists the labels that pertain to a particular piece of equipment.

FaultCode
string | undefined

Returns labels with a particular fault code.

IntervalEndTime
Date | undefined

Returns all labels with a start time earlier than the end time given.

IntervalStartTime
Date | undefined

Returns all the labels with a end time equal to or later than the start time given.

MaxResults
number | undefined

Specifies the maximum number of labels to list.

NextToken
string | undefined

An opaque pagination token indicating where to continue the listing of label groups.

ListLabelsCommand Output

See ListLabelsCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
LabelSummaries
LabelSummary[] | undefined

A summary of the items in the label group.

If you don't supply the LabelGroupName request parameter, or if you supply the name of a label group that doesn't exist, ListLabels returns an empty array in LabelSummaries.

NextToken
string | undefined

An opaque pagination token indicating where to continue the listing of datasets.

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.

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.