:doc:`CloudWatchLogs <../../logs>` / Client / test_metric_filter

******************
test_metric_filter
******************



.. py:method:: CloudWatchLogs.Client.test_metric_filter(**kwargs)

  

  Tests the filter pattern of a metric filter against a sample of log event messages. You can use this operation to validate the correctness of a metric filter pattern.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/TestMetricFilter>`_  


  **Request Syntax**
  ::

    response = client.test_metric_filter(
        filterPattern='string',
        logEventMessages=[
            'string',
        ]
    )
    
  :type filterPattern: string
  :param filterPattern: **[REQUIRED]** 

    A symbolic description of how CloudWatch Logs should interpret the data in each log event. For example, a log event can contain timestamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.

    

  
  :type logEventMessages: list
  :param logEventMessages: **[REQUIRED]** 

    The log event messages to test.

    

  
    - *(string) --* 

    

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

    
    ::

      {
          'matches': [
              {
                  'eventNumber': 123,
                  'eventMessage': 'string',
                  'extractedValues': {
                      'string': 'string'
                  }
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **matches** *(list) --* 

        The matched events.

        
        

        - *(dict) --* 

          Represents a matched event.

          
          

          - **eventNumber** *(integer) --* 

            The event number.

            
          

          - **eventMessage** *(string) --* 

            The raw event data.

            
          

          - **extractedValues** *(dict) --* 

            The values extracted from the event data by the filter.

            
            

            - *(string) --* 
              

              - *(string) --* 
        
      
      
    
  
  **Exceptions**
  
  *   :py:class:`CloudWatchLogs.Client.exceptions.InvalidParameterException`

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

  