ListLabelGroups
Returns a list of the label groups.
Request Syntax
{
"LabelGroupNameBeginsWith": "string
",
"MaxResults": number
,
"NextToken": "string
"
}
Request Parameters
The request accepts the following data in JSON format.
- LabelGroupNameBeginsWith
-
The beginning of the name of the label groups to be listed.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Pattern:
^[0-9a-zA-Z_-]{1,200}$
Required: No
- MaxResults
-
Specifies the maximum number of label groups 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
{
"LabelGroupSummaries": [
{
"CreatedAt": number,
"LabelGroupArn": "string",
"LabelGroupName": "string",
"UpdatedAt": 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.
- LabelGroupSummaries
-
A summary of the label groups.
Type: Array of LabelGroupSummary objects
- 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}
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: