v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1433170151.6 KB

Creates a label for an event.

post/#X-Amz-Target=AWSLookoutEquipmentFrontendService.CreateLabel

Headers

X-Amz-Target'AWSLookoutEquipmentFrontendService.CreateLabel' required

Request body

LabelGroupNamestring required
<p> The name of a group of labels. </p> <p>Data in this field will be retained for service usage. Follow best practices for the security of your data. </p>
StartTimestring date-time required

The start time of the labeled event.

EndTimestring date-time required

The end time of the labeled event.

Rating'ANOMALY' | 'NO_ANOMALY' | 'NEUTRAL' required

Indicates whether a labeled event represents an anomaly.

FaultCodestring
<p> Provides additional information about the label. The fault code must be defined in the FaultCodes attribute of the label group.</p> <p>Data in this field will be retained for service usage. Follow best practices for the security of your data. </p>
Notesstring
<p> Metadata providing additional information about the label. </p> <p>Data in this field will be retained for service usage. Follow best practices for the security of your data.</p>
Equipmentstring
<p> Indicates that a label pertains to a particular piece of equipment. </p> <p>Data in this field will be retained for service usage. Follow best practices for the security of your data.</p>
ClientTokenstring required

A unique identifier for the request to create a label. If you do not set the client request token, Lookout for Equipment generates one.

Response

Success

LabelIdstring

The ID of the label that you have created.