:doc:`ApplicationInsights <../../application-insights>` / Client / describe_log_pattern

********************
describe_log_pattern
********************



.. py:method:: ApplicationInsights.Client.describe_log_pattern(**kwargs)

  

  Describe a specific log pattern from a ``LogPatternSet``.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/application-insights-2018-11-25/DescribeLogPattern>`_  


  **Request Syntax**
  ::

    response = client.describe_log_pattern(
        ResourceGroupName='string',
        PatternSetName='string',
        PatternName='string',
        AccountId='string'
    )
    
  :type ResourceGroupName: string
  :param ResourceGroupName: **[REQUIRED]** 

    The name of the resource group.

    

  
  :type PatternSetName: string
  :param PatternSetName: **[REQUIRED]** 

    The name of the log pattern set.

    

  
  :type PatternName: string
  :param PatternName: **[REQUIRED]** 

    The name of the log pattern.

    

  
  :type AccountId: string
  :param AccountId: 

    The Amazon Web Services account ID for the resource group owner.

    

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

    
    ::

      {
          'ResourceGroupName': 'string',
          'AccountId': 'string',
          'LogPattern': {
              'PatternSetName': 'string',
              'PatternName': 'string',
              'Pattern': 'string',
              'Rank': 123
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ResourceGroupName** *(string) --* 

        The name of the resource group.

        
      

      - **AccountId** *(string) --* 

        The Amazon Web Services account ID for the resource group owner.

        
      

      - **LogPattern** *(dict) --* 

        The successfully created log pattern.

        
        

        - **PatternSetName** *(string) --* 

          The name of the log pattern. A log pattern name can contain as many as 30 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.

          
        

        - **PatternName** *(string) --* 

          The name of the log pattern. A log pattern name can contain as many as 50 characters, and it cannot be empty. The characters can be Unicode letters, digits, or one of the following symbols: period, dash, underscore.

          
        

        - **Pattern** *(string) --* 

          A regular expression that defines the log pattern. A log pattern can contain as many as 50 characters, and it cannot be empty. The pattern must be DFA compatible. Patterns that utilize forward lookahead or backreference constructions are not supported.

          
        

        - **Rank** *(integer) --* 

          Rank of the log pattern. Must be a value between ``1`` and ``1,000,000``. The patterns are sorted by rank, so we recommend that you set your highest priority patterns with the lowest rank. A pattern of rank ``1`` will be the first to get matched to a log line. A pattern of rank ``1,000,000`` will be last to get matched. When you configure custom log patterns from the console, a ``Low`` severity pattern translates to a ``750,000`` rank. A ``Medium`` severity pattern translates to a ``500,000`` rank. And a ``High`` severity pattern translates to a ``250,000`` rank. Rank values less than ``1`` or greater than ``1,000,000`` are reserved for Amazon Web Services provided patterns.

          
    
  
  **Exceptions**
  
  *   :py:class:`ApplicationInsights.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`ApplicationInsights.Client.exceptions.ValidationException`

  
  *   :py:class:`ApplicationInsights.Client.exceptions.InternalServerException`

  