Skip to content

DescribeLabelResponse

Source code in docs_src/capo_lookoutequipment/types/describe_label_response.py
class DescribeLabelResponse(TypedDict, closed=True):
    label_group_name: NotRequired[
        "capo_lookoutequipment.types.label_group_name.LabelGroupName"
    ]
    """<p> The name of the requested label group. </p>"""
    label_group_arn: NotRequired[
        "capo_lookoutequipment.types.label_group_arn.LabelGroupArn"
    ]
    """<p> The Amazon Resource Name (ARN) of the requested label group. </p>"""
    label_id: NotRequired["capo_lookoutequipment.types.label_id.LabelId"]
    """<p> The ID of the requested label. </p>"""
    start_time: NotRequired["capo_lookoutequipment.types.timestamp.Timestamp"]
    """<p> The start time of the requested label. </p>"""
    end_time: NotRequired["capo_lookoutequipment.types.timestamp.Timestamp"]
    """<p> The end time of the requested label. </p>"""
    rating: NotRequired["capo_lookoutequipment.types.label_rating.LabelRating"]
    """<p> Indicates whether a labeled event represents an anomaly. </p>"""
    fault_code: NotRequired["capo_lookoutequipment.types.fault_code.FaultCode"]
    """<p> Indicates the type of anomaly associated with the label. </p> <p>Data in this field will be retained for service usage. Follow best practices for the security of your data.</p>"""
    notes: NotRequired["capo_lookoutequipment.types.comments.Comments"]
    """<p>Metadata providing additional information about the label.</p> <p>Data in this field will be retained for service usage. Follow best practices for the security of your data.</p>"""
    equipment: NotRequired["capo_lookoutequipment.types.equipment.Equipment"]
    """<p> Indicates that a label pertains to a particular piece of equipment. </p>"""
    created_at: NotRequired["capo_lookoutequipment.types.timestamp.Timestamp"]
    """<p> The time at which the label was created. </p>"""

created_at instance-attribute

created_at: NotRequired[Timestamp]

The time at which the label was created.

end_time instance-attribute

end_time: NotRequired[Timestamp]

The end time of the requested label.

equipment instance-attribute

equipment: NotRequired[Equipment]

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

fault_code instance-attribute

fault_code: NotRequired[FaultCode]

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.

label_group_arn instance-attribute

label_group_arn: NotRequired[LabelGroupArn]

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

label_group_name instance-attribute

label_group_name: NotRequired[LabelGroupName]

The name of the requested label group.

label_id instance-attribute

label_id: NotRequired[LabelId]

The ID of the requested label.

notes instance-attribute

notes: NotRequired[Comments]

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.

rating instance-attribute

rating: NotRequired[LabelRating]

Indicates whether a labeled event represents an anomaly.

start_time instance-attribute

start_time: NotRequired[Timestamp]

The start time of the requested label.