LookoutEquipment / Client / describe_label

describe_label

LookoutEquipment.Client.describe_label(**kwargs)

Returns the name of the label.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response = client.describe_label(
    LabelGroupName='string',
    LabelId='string'
)
Parameters:

  • LabelGroupName (string) –

    [REQUIRED]

    Returns the name of the group containing the label.

  • LabelId (string) –

    [REQUIRED]

    Returns the ID of the label.

Return type:

dict

Returns:

Response Syntax

{
    'LabelGroupName': 'string',
    'LabelGroupArn': 'string',
    'LabelId': 'string',
    'StartTime': datetime(2015, 1, 1),
    'EndTime': datetime(2015, 1, 1),
    'Rating': 'ANOMALY'|'NO_ANOMALY'|'NEUTRAL',
    'FaultCode': 'string',
    'Notes': 'string',
    'Equipment': 'string',
    'CreatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • LabelGroupName (string) –

      The name of the requested label group.

    • LabelGroupArn (string) –

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

    • LabelId (string) –

      The ID of the requested label.

    • StartTime (datetime) –

      The start time of the requested label.

    • EndTime (datetime) –

      The end time of the requested label.

    • Rating (string) –

      Indicates whether a labeled event represents an anomaly.

    • FaultCode (string) –

      Indicates the type of anomaly associated with the label.

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

    • Notes (string) –

      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.

    • Equipment (string) –

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

    • CreatedAt (datetime) –

      The time at which the label was created.

Exceptions