Skip to content

ListLabelsRequest

Source code in docs_src/capo_lookoutequipment/types/list_labels_request.py
class ListLabelsRequest(TypedDict, closed=True):
    label_group_name: "capo_lookoutequipment.types.label_group_name.LabelGroupName"
    """<p> Returns the name of the label group. </p>"""
    interval_start_time: NotRequired["capo_lookoutequipment.types.timestamp.Timestamp"]
    """<p> Returns all the labels with a end time equal to or later than the start time given. </p>"""
    interval_end_time: NotRequired["capo_lookoutequipment.types.timestamp.Timestamp"]
    """<p> Returns all labels with a start time earlier than the end time given. </p>"""
    fault_code: NotRequired["capo_lookoutequipment.types.fault_code.FaultCode"]
    """<p> Returns labels with a particular fault code. </p>"""
    equipment: NotRequired["capo_lookoutequipment.types.equipment.Equipment"]
    """<p> Lists the labels that pertain to a particular piece of equipment. </p>"""
    next_token: NotRequired["capo_lookoutequipment.types.next_token.NextToken"]
    """<p> An opaque pagination token indicating where to continue the listing of label groups. </p>"""
    max_results: NotRequired["capo_lookoutequipment.types.max_results.MaxResults"]
    """<p> Specifies the maximum number of labels to list. </p>"""

equipment instance-attribute

equipment: NotRequired[Equipment]

Lists the labels that pertain to a particular piece of equipment.

fault_code instance-attribute

fault_code: NotRequired[FaultCode]

Returns labels with a particular fault code.

interval_end_time instance-attribute

interval_end_time: NotRequired[Timestamp]

Returns all labels with a start time earlier than the end time given.

interval_start_time instance-attribute

interval_start_time: NotRequired[Timestamp]

Returns all the labels with a end time equal to or later than the start time given.

label_group_name instance-attribute

label_group_name: LabelGroupName

Returns the name of the label group.

max_results instance-attribute

max_results: NotRequired[MaxResults]

Specifies the maximum number of labels to list.

next_token instance-attribute

next_token: NotRequired[NextToken]

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