Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeLabelGroup

Returns information about the label group.

Request Syntax


{
   "LabelGroupName": "string"
}

Request Parameters

The request accepts the following data in JSON format.

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

Response Syntax


{
   "CreatedAt": number,
   "FaultCodes": [ "string" ],
   "LabelGroupArn": "string",
   "LabelGroupName": "string",
   "UpdatedAt": number
}

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.

CreatedAt

The time at which the label group was created.

Type: Timestamp

FaultCodes

Codes indicating the type of anomaly associated with the labels in the lagbel group.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 50 items.

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

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

LabelGroupArn

The Amazon Resource Name (ARN) of the label group.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\-]*:[0-9]{12}:label-group\/.+

LabelGroupName

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}$

UpdatedAt

The time at which the label group was updated.

Type: Timestamp

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

ResourceNotFoundException

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

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