Skip to content

describe_detector 

describe_detector(
    detector_model_name: DetectorModelName,
    *,
    config_overrides: Optional[IoTEventsDataClientConfig] = None,
    key_value: Optional[KeyValue] = None,
) -> DescribeDetectorResponse

Returns information about the specified detector (instance).

Parameters:

  • detector_model_name (DetectorModelName) –

    The name of the detector model whose detectors (instances) you want information about.

  • key_value (Optional[KeyValue], default: None ) –

    A filter used to limit results to detectors (instances) created because of the given key ID.

Raises:

Source code in docs_src/capo_iot_events_data/_services/io_t_events_data.py 
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
def describe_detector(
    self,
    detector_model_name: "capo_iot_events_data.types.detector_model_name.DetectorModelName",
    *,
    config_overrides: Optional[IoTEventsDataClientConfig] = None,
    key_value: Optional["capo_iot_events_data.types.key_value.KeyValue"] = None,
) -> (
    "capo_iot_events_data.types.describe_detector_response.DescribeDetectorResponse"
):
    """<p>Returns information about the specified detector (instance).</p>

    Args:
        detector_model_name: <p>The name of the detector model whose detectors (instances) you want information about.</p>
        key_value: <p>A filter used to limit results to detectors (instances) created because of the given key ID.</p>

    Raises:
        capo_iot_events_data.errors.internal_failure_exception.InternalFailureException: <p>An internal failure occurred.</p>
        capo_iot_events_data.errors.invalid_request_exception.InvalidRequestException: <p>The request was invalid.</p>
        capo_iot_events_data.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource was not found.</p>
        capo_iot_events_data.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
        capo_iot_events_data.errors.throttling_exception.ThrottlingException: <p>The request could not be completed due to throttling.</p>
        capo_iot_events_data.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iot_events_data.types.describe_detector_request.DescribeDetectorRequest]",
    ) -> OperationResponse[
        "capo_iot_events_data.types.describe_detector_response.DescribeDetectorResponse"
    ]:
        import capo_iot_events_data._operations.iot_columbo_data_service.describe_detector

        output, http_response = (
            capo_iot_events_data._operations.iot_columbo_data_service.describe_detector.describe_detector(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeDetector")
    )
    input_: capo_iot_events_data.types.describe_detector_request.DescribeDetectorRequest = {
        "detector_model_name": detector_model_name
    }
    if key_value is not None:
        input_["key_value"] = key_value

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