LookoutEquipment / Client / create_label

create_label

LookoutEquipment.Client.create_label(**kwargs)

Creates a label for an event.

See also: AWS API Documentation

Request Syntax

response = client.create_label(
    LabelGroupName='string',
    StartTime=datetime(2015, 1, 1),
    EndTime=datetime(2015, 1, 1),
    Rating='ANOMALY'|'NO_ANOMALY'|'NEUTRAL',
    FaultCode='string',
    Notes='string',
    Equipment='string',
    ClientToken='string'
)
Parameters:

  • LabelGroupName (string) –

    [REQUIRED]

    The name of a group of labels.

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

  • StartTime (datetime) –

    [REQUIRED]

    The start time of the labeled event.

  • EndTime (datetime) –

    [REQUIRED]

    The end time of the labeled event.

  • Rating (string) –

    [REQUIRED]

    Indicates whether a labeled event represents an anomaly.

  • FaultCode (string) –

    Provides additional information about the label. The fault code must be defined in the FaultCodes attribute of the label group.

    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.

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

  • ClientToken (string) –

    [REQUIRED]

    A unique identifier for the request to create a label. If you do not set the client request token, Lookout for Equipment generates one.

    This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'LabelId': 'string'
}

Response Structure

  • (dict) –

    • LabelId (string) –

      The ID of the label that you have created.

Exceptions

  • LookoutEquipment.Client.exceptions.ValidationException

  • LookoutEquipment.Client.exceptions.ResourceNotFoundException

  • LookoutEquipment.Client.exceptions.ConflictException

  • LookoutEquipment.Client.exceptions.ThrottlingException

  • LookoutEquipment.Client.exceptions.ServiceQuotaExceededException

  • LookoutEquipment.Client.exceptions.AccessDeniedException

  • LookoutEquipment.Client.exceptions.InternalServerException