:doc:`WAF <../../waf>` / Client / get_sql_injection_match_set

***************************
get_sql_injection_match_set
***************************



.. py:method:: WAF.Client.get_sql_injection_match_set(**kwargs)

  

  .. note::

    

    This is **AWS WAF Classic** documentation. For more information, see `AWS WAF Classic <https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html>`__ in the developer guide.

     

    **For the latest version of AWS WAF**, use the AWS WAFV2 API and see the `AWS WAF Developer Guide <https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html>`__. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

    

   

  Returns the  SqlInjectionMatchSet that is specified by ``SqlInjectionMatchSetId``.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/waf-2015-08-24/GetSqlInjectionMatchSet>`_  


  **Request Syntax**
  ::

    response = client.get_sql_injection_match_set(
        SqlInjectionMatchSetId='string'
    )
    
  :type SqlInjectionMatchSetId: string
  :param SqlInjectionMatchSetId: **[REQUIRED]** 

    The ``SqlInjectionMatchSetId`` of the  SqlInjectionMatchSet that you want to get. ``SqlInjectionMatchSetId`` is returned by  CreateSqlInjectionMatchSet and by  ListSqlInjectionMatchSets.

    

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

    
    ::

      {
          'SqlInjectionMatchSet': {
              'SqlInjectionMatchSetId': 'string',
              'Name': 'string',
              'SqlInjectionMatchTuples': [
                  {
                      'FieldToMatch': {
                          'Type': 'URI'|'QUERY_STRING'|'HEADER'|'METHOD'|'BODY'|'SINGLE_QUERY_ARG'|'ALL_QUERY_ARGS',
                          'Data': 'string'
                      },
                      'TextTransformation': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
                  },
              ]
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 

      The response to a  GetSqlInjectionMatchSet request.

      
      

      - **SqlInjectionMatchSet** *(dict) --* 

        Information about the  SqlInjectionMatchSet that you specified in the ``GetSqlInjectionMatchSet`` request. For more information, see the following topics:

         

        
        *  SqlInjectionMatchSet: Contains ``Name``, ``SqlInjectionMatchSetId``, and an array of ``SqlInjectionMatchTuple`` objects
         
        *  SqlInjectionMatchTuple: Each ``SqlInjectionMatchTuple`` object contains ``FieldToMatch`` and ``TextTransformation``
         
        *  FieldToMatch: Contains ``Data`` and ``Type``
        

        
        

        - **SqlInjectionMatchSetId** *(string) --* 

          A unique identifier for a ``SqlInjectionMatchSet``. You use ``SqlInjectionMatchSetId`` to get information about a ``SqlInjectionMatchSet`` (see  GetSqlInjectionMatchSet), update a ``SqlInjectionMatchSet`` (see  UpdateSqlInjectionMatchSet), insert a ``SqlInjectionMatchSet`` into a ``Rule`` or delete one from a ``Rule`` (see  UpdateRule), and delete a ``SqlInjectionMatchSet`` from AWS WAF (see  DeleteSqlInjectionMatchSet).

           

          ``SqlInjectionMatchSetId`` is returned by  CreateSqlInjectionMatchSet and by  ListSqlInjectionMatchSets.

          
        

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

          The name, if any, of the ``SqlInjectionMatchSet``.

          
        

        - **SqlInjectionMatchTuples** *(list) --* 

          Specifies the parts of web requests that you want to inspect for snippets of malicious SQL code.

          
          

          - *(dict) --* 

            .. note::

              

              This is **AWS WAF Classic** documentation. For more information, see `AWS WAF Classic <https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html>`__ in the developer guide.

               

              **For the latest version of AWS WAF**, use the AWS WAFV2 API and see the `AWS WAF Developer Guide <https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html>`__. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

              

             

            Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.

            
            

            - **FieldToMatch** *(dict) --* 

              Specifies where in a web request to look for snippets of malicious SQL code.

              
              

              - **Type** *(string) --* 

                The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

                 

                
                * ``HEADER``: A specified request header, for example, the value of the ``User-Agent`` or ``Referer`` header. If you choose ``HEADER`` for the type, specify the name of the header in ``Data``.
                 
                * ``METHOD``: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: ``DELETE``, ``GET``, ``HEAD``, ``OPTIONS``, ``PATCH``, ``POST``, and ``PUT``.
                 
                * ``QUERY_STRING``: A query string, which is the part of a URL that appears after a ``?`` character, if any.
                 
                * ``URI``: The part of a web request that identifies a resource, for example, ``/images/daily-ad.jpg``.
                 
                * ``BODY``: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the first ``8192`` bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see  CreateSizeConstraintSet.
                 
                * ``SINGLE_QUERY_ARG``: The parameter in the query string that you will inspect, such as *UserName* or *SalesRegion*. The maximum length for ``SINGLE_QUERY_ARG`` is 30 characters.
                 
                * ``ALL_QUERY_ARGS``: Similar to ``SINGLE_QUERY_ARG``, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in ``TargetString``.
                

                
              

              - **Data** *(string) --* 

                When the value of ``Type`` is ``HEADER``, enter the name of the header that you want AWS WAF to search, for example, ``User-Agent`` or ``Referer``. The name of the header is not case sensitive.

                 

                When the value of ``Type`` is ``SINGLE_QUERY_ARG``, enter the name of the parameter that you want AWS WAF to search, for example, ``UserName`` or ``SalesRegion``. The parameter name is not case sensitive.

                 

                If the value of ``Type`` is any other value, omit ``Data``.

                
          
            

            - **TextTransformation** *(string) --* 

              Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on ``FieldToMatch`` before inspecting it for a match.

               

              You can only specify a single type of TextTransformation.

               

              **CMD_LINE**

               

              When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

               

              
              * Delete the following characters: \ " ' ^
               
              * Delete spaces before the following characters: / (
               
              * Replace the following characters with a space: , ;
               
              * Replace multiple spaces with one space
               
              * Convert uppercase letters (A-Z) to lowercase (a-z)
              

               

              **COMPRESS_WHITE_SPACE**

               

              Use this option to replace the following characters with a space character (decimal 32):

               

              
              * \f, formfeed, decimal 12
               
              * \t, tab, decimal 9
               
              * \n, newline, decimal 10
               
              * \r, carriage return, decimal 13
               
              * \v, vertical tab, decimal 11
               
              * non-breaking space, decimal 160
              

               

              ``COMPRESS_WHITE_SPACE`` also replaces multiple spaces with one space.

               

              **HTML_ENTITY_DECODE**

               

              Use this option to replace HTML-encoded characters with unencoded characters. ``HTML_ENTITY_DECODE`` performs the following operations:

               

              
              * Replaces ``(ampersand)quot;`` with ``"``
               
              * Replaces ``(ampersand)nbsp;`` with a non-breaking space, decimal 160
               
              * Replaces ``(ampersand)lt;`` with a "less than" symbol
               
              * Replaces ``(ampersand)gt;`` with ``>``
               
              * Replaces characters that are represented in hexadecimal format, ``(ampersand)#xhhhh;``, with the corresponding characters
               
              * Replaces characters that are represented in decimal format, ``(ampersand)#nnnn;``, with the corresponding characters
              

               

              **LOWERCASE**

               

              Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

               

              **URL_DECODE**

               

              Use this option to decode a URL-encoded value.

               

              **NONE**

               

              Specify ``NONE`` if you don't want to perform any text transformations.

              
        
      
    
  
  **Exceptions**
  
  *   :py:class:`WAF.Client.exceptions.WAFInternalErrorException`

  
  *   :py:class:`WAF.Client.exceptions.WAFInvalidAccountException`

  
  *   :py:class:`WAF.Client.exceptions.WAFNonexistentItemException`

  

  **Examples**

  The following example returns the details of a SQL injection match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
  ::

    response = client.get_sql_injection_match_set(
        SqlInjectionMatchSetId='example1ds3t-46da-4fdb-b8d5-abc321j569j5',
    )
    
    print(response)

  
  Expected Output:
  ::

    {
        'SqlInjectionMatchSet': {
            'Name': 'MySQLInjectionMatchSet',
            'SqlInjectionMatchSetId': 'example1ds3t-46da-4fdb-b8d5-abc321j569j5',
            'SqlInjectionMatchTuples': [
                {
                    'FieldToMatch': {
                        'Type': 'QUERY_STRING',
                    },
                    'TextTransformation': 'URL_DECODE',
                },
            ],
        },
        'ResponseMetadata': {
            '...': '...',
        },
    }

  