Skip to content

start_detector_model_analysis

start_detector_model_analysis(
    detector_model_definition: DetectorModelDefinition,
    *,
    config_overrides: Optional[IoTEventsClientConfig] = None,
) -> StartDetectorModelAnalysisResponse

Performs an analysis of your detector model. For more information, see Troubleshooting a detector model in the AWS IoT Events Developer Guide.

Raises:

Source code in docs_src/capo_iot_events/_services/io_t_events.py
def start_detector_model_analysis(
    self,
    detector_model_definition: "capo_iot_events.types.detector_model_definition.DetectorModelDefinition",
    *,
    config_overrides: Optional[IoTEventsClientConfig] = None,
) -> "capo_iot_events.types.start_detector_model_analysis_response.StartDetectorModelAnalysisResponse":
    """<p>Performs an analysis of your detector model. For more information, see <a href="https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-analyze-api.html">Troubleshooting a detector model</a> in the <i>AWS IoT Events Developer Guide</i>.</p>

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

    def _handler(
        req: "OperationRequest[capo_iot_events.types.start_detector_model_analysis_request.StartDetectorModelAnalysisRequest]",
    ) -> OperationResponse[
        "capo_iot_events.types.start_detector_model_analysis_response.StartDetectorModelAnalysisResponse"
    ]:
        import capo_iot_events._operations.iot_columbo_service.start_detector_model_analysis

        output, http_response = (
            capo_iot_events._operations.iot_columbo_service.start_detector_model_analysis.start_detector_model_analysis(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("StartDetectorModelAnalysis")
    )
    input_: capo_iot_events.types.start_detector_model_analysis_request.StartDetectorModelAnalysisRequest = {
        "detector_model_definition": detector_model_definition
    }

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