:doc:`ForecastService <../../forecast>` / Client / describe_monitor

****************
describe_monitor
****************



.. py:method:: ForecastService.Client.describe_monitor(**kwargs)

  

  Describes a monitor resource. In addition to listing the properties provided in the  CreateMonitor request, this operation lists the following properties:

   

  
  * ``Baseline``
   
  * ``CreationTime``
   
  * ``LastEvaluationTime``
   
  * ``LastEvaluationState``
   
  * ``LastModificationTime``
   
  * ``Message``
   
  * ``Status``
  

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/forecast-2018-06-26/DescribeMonitor>`_  


  **Request Syntax**
  ::

    response = client.describe_monitor(
        MonitorArn='string'
    )
    
  :type MonitorArn: string
  :param MonitorArn: **[REQUIRED]** 

    The Amazon Resource Name (ARN) of the monitor resource to describe.

    

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

    
    ::

      {
          'MonitorName': 'string',
          'MonitorArn': 'string',
          'ResourceArn': 'string',
          'Status': 'string',
          'LastEvaluationTime': datetime(2015, 1, 1),
          'LastEvaluationState': 'string',
          'Baseline': {
              'PredictorBaseline': {
                  'BaselineMetrics': [
                      {
                          'Name': 'string',
                          'Value': 123.0
                      },
                  ]
              }
          },
          'Message': 'string',
          'CreationTime': datetime(2015, 1, 1),
          'LastModificationTime': datetime(2015, 1, 1),
          'EstimatedEvaluationTimeRemainingInMinutes': 123
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **MonitorName** *(string) --* 

        The name of the monitor.

        
      

      - **MonitorArn** *(string) --* 

        The Amazon Resource Name (ARN) of the monitor resource described.

        
      

      - **ResourceArn** *(string) --* 

        The Amazon Resource Name (ARN) of the auto predictor being monitored.

        
      

      - **Status** *(string) --* 

        The status of the monitor resource.

        
      

      - **LastEvaluationTime** *(datetime) --* 

        The timestamp of the latest evaluation completed by the monitor.

        
      

      - **LastEvaluationState** *(string) --* 

        The state of the monitor's latest evaluation.

        
      

      - **Baseline** *(dict) --* 

        Metrics you can use as a baseline for comparison purposes. Use these values you interpret monitoring results for an auto predictor.

        
        

        - **PredictorBaseline** *(dict) --* 

          The initial `accuracy metrics <https://docs.aws.amazon.com/forecast/latest/dg/metrics.html>`__ for the predictor you are monitoring. Use these metrics as a baseline for comparison purposes as you use your predictor and the metrics change.

          
          

          - **BaselineMetrics** *(list) --* 

            The initial `accuracy metrics <https://docs.aws.amazon.com/forecast/latest/dg/metrics.html>`__ for the predictor. Use these metrics as a baseline for comparison purposes as you use your predictor and the metrics change.

            
            

            - *(dict) --* 

              An individual metric that you can use for comparison as you evaluate your monitoring results.

              
              

              - **Name** *(string) --* 

                The name of the metric.

                
              

              - **Value** *(float) --* 

                The value for the metric.

                
          
        
      
    
      

      - **Message** *(string) --* 

        An error message, if any, for the monitor.

        
      

      - **CreationTime** *(datetime) --* 

        The timestamp for when the monitor resource was created.

        
      

      - **LastModificationTime** *(datetime) --* 

        The timestamp of the latest modification to the monitor.

        
      

      - **EstimatedEvaluationTimeRemainingInMinutes** *(integer) --* 

        The estimated number of minutes remaining before the monitor resource finishes its current evaluation.

        
  
  **Exceptions**
  
  *   :py:class:`ForecastService.Client.exceptions.InvalidInputException`

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

  