list_labels ¶

def list_labels(
    self,
    label_group_name: "capo_lookoutequipment.types.label_group_name.LabelGroupName",
    *,
    config_overrides: Optional[LookoutEquipmentClientConfig] = None,
    interval_start_time: Optional[
        "capo_lookoutequipment.types.timestamp.Timestamp"
    ] = None,
    interval_end_time: Optional[
        "capo_lookoutequipment.types.timestamp.Timestamp"
    ] = None,
    fault_code: Optional["capo_lookoutequipment.types.fault_code.FaultCode"] = None,
    equipment: Optional["capo_lookoutequipment.types.equipment.Equipment"] = None,
    next_token: Optional["capo_lookoutequipment.types.next_token.NextToken"] = None,
    max_results: Optional[
        "capo_lookoutequipment.types.max_results.MaxResults"
    ] = None,
) -> "capo_lookoutequipment.types.list_labels_response.ListLabelsResponse":
    """<p> Provides a list of labels. </p>

    Args:
        label_group_name: <p> Returns the name of the label group. </p>
        interval_start_time: <p> Returns all the labels with a end time equal to or later than the start time given. </p>
        interval_end_time: <p> Returns all labels with a start time earlier than the end time given. </p>
        fault_code: <p> Returns labels with a particular fault code. </p>
        equipment: <p> Lists the labels that pertain to a particular piece of equipment. </p>
        next_token: <p> An opaque pagination token indicating where to continue the listing of label groups. </p>
        max_results: <p> Specifies the maximum number of labels to list. </p>

    Raises:
        capo_lookoutequipment.errors.access_denied_exception.AccessDeniedException: <p>The request could not be completed because you do not have access to the resource. </p>
        capo_lookoutequipment.errors.internal_server_exception.InternalServerException: <p> Processing of the request has failed because of an unknown error, exception or failure. </p>
        capo_lookoutequipment.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_lookoutequipment.errors.validation_exception.ValidationException: <p> The input fails to satisfy constraints specified by Amazon Lookout for Equipment or a related Amazon Web Services service that's being utilized. </p>
        capo_lookoutequipment.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_lookoutequipment.types.list_labels_request.ListLabelsRequest]",
    ) -> OperationResponse[
        "capo_lookoutequipment.types.list_labels_response.ListLabelsResponse"
    ]:
        import capo_lookoutequipment._operations.aws_lookout_equipment_frontend_service.list_labels

        output, http_response = (
            capo_lookoutequipment._operations.aws_lookout_equipment_frontend_service.list_labels.list_labels(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListLabels")
    )
    input_: capo_lookoutequipment.types.list_labels_request.ListLabelsRequest = {
        "label_group_name": label_group_name
    }
    if interval_start_time is not None:
        input_["interval_start_time"] = interval_start_time
    if interval_end_time is not None:
        input_["interval_end_time"] = interval_end_time
    if fault_code is not None:
        input_["fault_code"] = fault_code
    if equipment is not None:
        input_["equipment"] = equipment
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output