LookoutEquipment / Client / list_labels

list_labels

LookoutEquipment.Client.list_labels(**kwargs)

Provides a list of labels.

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.list_labels(
    LabelGroupName='string',
    IntervalStartTime=datetime(2015, 1, 1),
    IntervalEndTime=datetime(2015, 1, 1),
    FaultCode='string',
    Equipment='string',
    NextToken='string',
    MaxResults=123
)
Parameters:

  • LabelGroupName (string) –

    [REQUIRED]

    Returns the name of the label group.

  • IntervalStartTime (datetime) – Returns all the labels with a end time equal to or later than the start time given.

  • IntervalEndTime (datetime) – Returns all labels with a start time earlier than the end time given.

  • FaultCode (string) – Returns labels with a particular fault code.

  • Equipment (string) – Lists the labels that pertain to a particular piece of equipment.

  • NextToken (string) – An opaque pagination token indicating where to continue the listing of label groups.

  • MaxResults (integer) – Specifies the maximum number of labels to list.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • NextToken (string) –

      An opaque pagination token indicating where to continue the listing of datasets.

    • LabelSummaries (list) –

      A summary of the items in the label group.

      Note

      If you don’t supply the LabelGroupName request parameter, or if you supply the name of a label group that doesn’t exist, ListLabels returns an empty array in LabelSummaries.

      • (dict) –

        Information about the label.

        • LabelGroupName (string) –

          The name of the label group.

        • LabelId (string) –

          The ID of the label.

        • LabelGroupArn (string) –

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

        • StartTime (datetime) –

          The timestamp indicating the start of the label.

        • EndTime (datetime) –

          The timestamp indicating the end of the 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.

        • Equipment (string) –

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

        • CreatedAt (datetime) –

          The time at which the label was created.

Exceptions