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

************************
create_regex_pattern_set
************************



.. py:method:: WAF.Client.create_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.

    

   

  Creates a ``RegexPatternSet``. You then use  UpdateRegexPatternSet to specify the regular expression (regex) pattern that you want AWS WAF to search for, such as ``B[a@]dB[o0]t``. You can then configure AWS WAF to reject those requests.

   

  To create and configure a ``RegexPatternSet``, perform the following steps:

   

   
  * Use  GetChangeToken to get the change token that you provide in the ``ChangeToken`` parameter of a ``CreateRegexPatternSet`` request.
   
  * Submit a ``CreateRegexPatternSet`` request.
   
  * Use ``GetChangeToken`` to get the change token that you provide in the ``ChangeToken`` parameter of an ``UpdateRegexPatternSet`` request.
   
  * Submit an  UpdateRegexPatternSet request to specify the string that you want AWS WAF to watch for.
   

   

  For more information about how to use the AWS WAF API to allow or block HTTP requests, see the `AWS WAF Developer Guide <https://docs.aws.amazon.com/waf/latest/developerguide/>`__.

  

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


  **Request Syntax**
  ::

    response = client.create_regex_pattern_set(
        Name='string',
        ChangeToken='string'
    )
    
  :type Name: string
  :param Name: **[REQUIRED]** 

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

    

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

    The value returned by the most recent call to  GetChangeToken.

    

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

    
    ::

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

    

    - *(dict) --* 
      

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

        A  RegexPatternSet that contains no objects.

        
        

        - **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) --* 
      
    
      

      - **ChangeToken** *(string) --* 

        The ``ChangeToken`` that you used to submit the ``CreateRegexPatternSet`` request. You can also use this value to query the status of the request. For more information, see  GetChangeTokenStatus.

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

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

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

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

  