- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
ListLabelGroupsCommand
Returns a list of the label groups.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { LookoutEquipmentClient, ListLabelGroupsCommand } from "@aws-sdk/client-lookoutequipment"; // ES Modules import
// const { LookoutEquipmentClient, ListLabelGroupsCommand } = require("@aws-sdk/client-lookoutequipment"); // CommonJS import
const client = new LookoutEquipmentClient(config);
const input = { // ListLabelGroupsRequest
LabelGroupNameBeginsWith: "STRING_VALUE",
NextToken: "STRING_VALUE",
MaxResults: Number("int"),
};
const command = new ListLabelGroupsCommand(input);
const response = await client.send(command);
// { // ListLabelGroupsResponse
// NextToken: "STRING_VALUE",
// LabelGroupSummaries: [ // LabelGroupSummaries
// { // LabelGroupSummary
// LabelGroupName: "STRING_VALUE",
// LabelGroupArn: "STRING_VALUE",
// CreatedAt: new Date("TIMESTAMP"),
// UpdatedAt: new Date("TIMESTAMP"),
// },
// ],
// };
ListLabelGroupsCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
LabelGroupNameBeginsWith | string | undefined | The beginning of the name of the label groups to be listed. |
MaxResults | number | undefined | Specifies the maximum number of label groups to list. |
NextToken | string | undefined | An opaque pagination token indicating where to continue the listing of label groups. |
ListLabelGroupsCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
LabelGroupSummaries | LabelGroupSummary[] | undefined | A summary of the label groups. |
NextToken | string | undefined | An opaque pagination token indicating where to continue the listing of label groups. |
Throws
Name | Fault | Details |
|---|
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. |