Amazon Lookout for Equipment is no longer open to new customers.
Existing customers can continue to use the service as normal.
For capabilities similar to Amazon Lookout for Equipment see our
blog post
ListLabels
Provides a list of labels.
Request Syntax
{
"Equipment": "string",
"FaultCode": "string",
"IntervalEndTime": number,
"IntervalStartTime": number,
"LabelGroupName": "string",
"MaxResults": number,
"NextToken": "string"
}Request Parameters
The request accepts the following data in JSON format.
- Equipment
-
Lists the labels that pertain to a particular piece of equipment.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
[\P{M}\p{M}]{1,200}Required: No
- FaultCode
-
Returns labels with a particular fault code.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[\P{M}\p{M}]{1,100}Required: No
- IntervalEndTime
-
Returns all labels with a start time earlier than the end time given.
Type: Timestamp
Required: No
- IntervalStartTime
-
Returns all the labels with a end time equal to or later than the start time given.
Type: Timestamp
Required: No
- LabelGroupName
-
Returns the name of the label group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^[0-9a-zA-Z_-]{1,200}$Required: Yes
- MaxResults
-
Specifies the maximum number of labels to list.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 500.
Required: No
- NextToken
-
An opaque pagination token indicating where to continue the listing of label groups.
Type: String
Length Constraints: Maximum length of 8192.
Pattern:
\p{ASCII}{0,8192}Required: No
Response Syntax
{
"LabelSummaries": [
{
"CreatedAt": number,
"EndTime": number,
"Equipment": "string",
"FaultCode": "string",
"LabelGroupArn": "string",
"LabelGroupName": "string",
"LabelId": "string",
"Rating": "string",
"StartTime": number
}
],
"NextToken": "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.
- LabelSummaries
-
A summary of the items in the label group.
Note
If you don't supply the
LabelGroupNamerequest parameter, or if you supply the name of a label group that doesn't exist,ListLabelsreturns an empty array inLabelSummaries.Type: Array of LabelSummary objects
- NextToken
-
An opaque pagination token indicating where to continue the listing of datasets.
Type: String
Length Constraints: Maximum length of 8192.
Pattern:
\p{ASCII}{0,8192}
Errors
- AccessDeniedException
-
The request could not be completed because you do not have access to the resource.
HTTP Status Code: 400
- InternalServerException
-
Processing of the request has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
- 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
