:doc:`WAFRegional <../../waf-regional>` / Client / get_regex_pattern_set

*********************
get_regex_pattern_set
*********************



.. py:method:: WAFRegional.Client.get_regex_pattern_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  RegexPatternSet specified by ``RegexPatternSetId``.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/GetRegexPatternSet>`_  


  **Request Syntax**
  ::

    response = client.get_regex_pattern_set(
        RegexPatternSetId='string'
    )
    
  :type RegexPatternSetId: string
  :param RegexPatternSetId: **[REQUIRED]** 

    The ``RegexPatternSetId`` of the  RegexPatternSet that you want to get. ``RegexPatternSetId`` is returned by  CreateRegexPatternSet and by  ListRegexPatternSets.

    

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

    
    ::

      {
          'RegexPatternSet': {
              'RegexPatternSetId': 'string',
              'Name': 'string',
              'RegexPatternStrings': [
                  'string',
              ]
          }
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **RegexPatternSet** *(dict) --* 

        Information about the  RegexPatternSet that you specified in the ``GetRegexPatternSet`` request, including the identifier of the pattern set and the regular expression patterns you want AWS WAF to search for.

        
        

        - **RegexPatternSetId** *(string) --* 

          The identifier for the ``RegexPatternSet``. You use ``RegexPatternSetId`` to get information about a ``RegexPatternSet``, update a ``RegexPatternSet``, remove a ``RegexPatternSet`` from a ``RegexMatchSet``, and delete a ``RegexPatternSet`` from AWS WAF.

           

          ``RegexMatchSetId`` is returned by  CreateRegexPatternSet and by  ListRegexPatternSets.

          
        

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

          A friendly name or description of the  RegexPatternSet. You can't change ``Name`` after you create a ``RegexPatternSet``.

          
        

        - **RegexPatternStrings** *(list) --* 

          Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as ``B[a@]dB[o0]t``.

          
          

          - *(string) --* 
      
    
  
  **Exceptions**
  
  *   :py:class:`WAFRegional.Client.exceptions.WAFInternalErrorException`

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

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

  