Skip to content

describe_detector_model_analysis 

describe_detector_model_analysis(
    analysis_id: AnalysisId, *, config_overrides: Optional[IoTEventsClientConfig] = None
) -> DescribeDetectorModelAnalysisResponse

Retrieves runtime information about a detector model analysis.

After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.

Parameters:

  • analysis_id (AnalysisId) –

    The ID of the analysis result that you want to retrieve.

Raises:

Source code in docs_src/capo_iot_events/_services/io_t_events.py 
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
def describe_detector_model_analysis(
    self,
    analysis_id: "capo_iot_events.types.analysis_id.AnalysisId",
    *,
    config_overrides: Optional[IoTEventsClientConfig] = None,
) -> "capo_iot_events.types.describe_detector_model_analysis_response.DescribeDetectorModelAnalysisResponse":
    """<p>Retrieves runtime information about a detector model analysis.</p> <note> <p>After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.</p> </note>

    Args:
        analysis_id: <p>The ID of the analysis result that you want to retrieve.</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.resource_not_found_exception.ResourceNotFoundException: <p>The resource was not found.</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.describe_detector_model_analysis_request.DescribeDetectorModelAnalysisRequest]",
    ) -> OperationResponse[
        "capo_iot_events.types.describe_detector_model_analysis_response.DescribeDetectorModelAnalysisResponse"
    ]:
        import capo_iot_events._operations.iot_columbo_service.describe_detector_model_analysis

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeDetectorModelAnalysis")
    )
    input_: capo_iot_events.types.describe_detector_model_analysis_request.DescribeDetectorModelAnalysisRequest = {
        "analysis_id": analysis_id
    }

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