Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

CreateLabel

Creates a label for an event.

Request Syntax


{
   "ClientToken": "string",
   "EndTime": number,
   "Equipment": "string",
   "FaultCode": "string",
   "LabelGroupName": "string",
   "Notes": "string",
   "Rating": "string",
   "StartTime": number
}

Request Parameters

The request accepts the following data in JSON format.

ClientToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: \p{ASCII}{1,256}

Required: Yes

EndTime

The end time of the labeled event.

Type: Timestamp

Required: Yes

Equipment

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

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: [\P{M}\p{M}]{1,200}

Required: No

FaultCode

Provides additional information about the label. The fault code must be defined in the FaultCodes attribute of the label group.

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [\P{M}\p{M}]{1,100}

Required: No

LabelGroupName

The name of a group of labels.

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 200.

Pattern: ^[0-9a-zA-Z_-]{1,200}$

Required: Yes

Notes

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 2560.

Pattern: [\P{M}\p{M}]{1,2560}

Required: No

Rating

Indicates whether a labeled event represents an anomaly.

Type: String

Valid Values: ANOMALY | NO_ANOMALY | NEUTRAL

Required: Yes

StartTime

The start time of the labeled event.

Type: Timestamp

Required: Yes

Response Syntax


{
   "LabelId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

LabelId

The ID of the label that you have created.

Type: String

Length Constraints: Maximum length of 32.

Pattern: [A-Fa-f0-9]{0,32}

Errors

AccessDeniedException

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

HTTP Status Code: 400

ConflictException

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

HTTP Status Code: 400

InternalServerException

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

HTTP Status Code: 500

ResourceNotFoundException

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

HTTP Status Code: 400

ServiceQuotaExceededException

Resource limitations have been exceeded.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 400

ValidationException

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

HTTP Status Code: 400