:doc:`IoTEvents <../../iotevents>` / Client / describe_detector_model_analysis

********************************
describe_detector_model_analysis
********************************



.. py:method:: IoTEvents.Client.describe_detector_model_analysis(**kwargs)

  

  Retrieves runtime information about a detector model analysis.

   

  .. note::

    

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

    

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iotevents-2018-07-27/DescribeDetectorModelAnalysis>`_  


  **Request Syntax**
  ::

    response = client.describe_detector_model_analysis(
        analysisId='string'
    )
    
  :type analysisId: string
  :param analysisId: **[REQUIRED]** 

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

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'status': 'RUNNING'|'COMPLETE'|'FAILED'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **status** *(string) --* 

        The status of the analysis activity. The status can be one of the following values:

         

        
        * ``RUNNING`` - AWS IoT Events is analyzing your detector model. This process can take several minutes to complete.
         
        * ``COMPLETE`` - AWS IoT Events finished analyzing your detector model.
         
        * ``FAILED`` - AWS IoT Events couldn't analyze your detector model. Try again later.
        

        
  
  **Exceptions**
  
  *   :py:class:`IoTEvents.Client.exceptions.InvalidRequestException`

  
  *   :py:class:`IoTEvents.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`IoTEvents.Client.exceptions.ThrottlingException`

  
  *   :py:class:`IoTEvents.Client.exceptions.InternalFailureException`

  
  *   :py:class:`IoTEvents.Client.exceptions.ServiceUnavailableException`

  