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

***********
create_rule
***********



.. py:method:: WAFRegional.Client.create_rule(**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 ``Rule``, which contains the ``IPSet`` objects, ``ByteMatchSet`` objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a ``Rule``, a request must match all of the specifications to be allowed or blocked. For example, suppose that you add the following to a ``Rule``:

   

  
  * An ``IPSet`` that matches the IP address ``192.0.2.44/32``
   
  * A ``ByteMatchSet`` that matches ``BadBot`` in the ``User-Agent`` header
  

   

  You then add the ``Rule`` to a ``WebACL`` and specify that you want to blocks requests that satisfy the ``Rule``. For a request to be blocked, it must come from the IP address 192.0.2.44 *and* the ``User-Agent`` header in the request must contain the value ``BadBot``.

   

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

   

   
  * Create and update the predicates that you want to include in the ``Rule``. For more information, see  CreateByteMatchSet,  CreateIPSet, and  CreateSqlInjectionMatchSet.
   
  * Use  GetChangeToken to get the change token that you provide in the ``ChangeToken`` parameter of a ``CreateRule`` request.
   
  * Submit a ``CreateRule`` request.
   
  * Use ``GetChangeToken`` to get the change token that you provide in the ``ChangeToken`` parameter of an  UpdateRule request.
   
  * Submit an ``UpdateRule`` request to specify the predicates that you want to include in the ``Rule``.
   
  * Create and update a ``WebACL`` that contains the ``Rule``. For more information, see  CreateWebACL.
   

   

  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-regional-2016-11-28/CreateRule>`_  


  **Request Syntax**
  ::

    response = client.create_rule(
        Name='string',
        MetricName='string',
        ChangeToken='string',
        Tags=[
            {
                'Key': 'string',
                'Value': 'string'
            },
        ]
    )
    
  :type Name: string
  :param Name: **[REQUIRED]** 

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

    

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

    A friendly name or description for the metrics for this ``Rule``. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the ``Rule``.

    

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

    The value returned by the most recent call to  GetChangeToken.

    

  
  :type Tags: list
  :param Tags: 

  
    - *(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.

        

       

      A tag associated with an AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.

       

      Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.

      

    
      - **Key** *(string) --* **[REQUIRED]** 

      
      - **Value** *(string) --* **[REQUIRED]** 

      
    

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

    
    ::

      {
          'Rule': {
              'RuleId': 'string',
              'Name': 'string',
              'MetricName': 'string',
              'Predicates': [
                  {
                      'Negated': True|False,
                      'Type': 'IPMatch'|'ByteMatch'|'SqlInjectionMatch'|'GeoMatch'|'SizeConstraint'|'XssMatch'|'RegexMatch',
                      'DataId': 'string'
                  },
              ]
          },
          'ChangeToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **Rule** *(dict) --* 

        The  Rule returned in the ``CreateRule`` response.

        
        

        - **RuleId** *(string) --* 

          A unique identifier for a ``Rule``. You use ``RuleId`` to get more information about a ``Rule`` (see  GetRule), update a ``Rule`` (see  UpdateRule), insert a ``Rule`` into a ``WebACL`` or delete a one from a ``WebACL`` (see  UpdateWebACL), or delete a ``Rule`` from AWS WAF (see  DeleteRule).

           

          ``RuleId`` is returned by  CreateRule and by  ListRules.

          
        

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

          The friendly name or description for the ``Rule``. You can't change the name of a ``Rule`` after you create it.

          
        

        - **MetricName** *(string) --* 

          A friendly name or description for the metrics for this ``Rule``. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change ``MetricName`` after you create the ``Rule``.

          
        

        - **Predicates** *(list) --* 

          The ``Predicates`` object contains one ``Predicate`` element for each  ByteMatchSet,  IPSet, or  SqlInjectionMatchSet object that you want to include in a ``Rule``.

          
          

          - *(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  ByteMatchSet,  IPSet,  SqlInjectionMatchSet,  XssMatchSet,  RegexMatchSet,  GeoMatchSet, and  SizeConstraintSet objects that you want to add to a ``Rule`` and, for each object, indicates whether you want to negate the settings, for example, requests that do NOT originate from the IP address 192.0.2.44.

            
            

            - **Negated** *(boolean) --* 

              Set ``Negated`` to ``False`` if you want AWS WAF to allow, block, or count requests based on the settings in the specified  ByteMatchSet,  IPSet,  SqlInjectionMatchSet,  XssMatchSet,  RegexMatchSet,  GeoMatchSet, or  SizeConstraintSet. For example, if an ``IPSet`` includes the IP address ``192.0.2.44``, AWS WAF will allow or block requests based on that IP address.

               

              Set ``Negated`` to ``True`` if you want AWS WAF to allow or block a request based on the negation of the settings in the  ByteMatchSet,  IPSet,  SqlInjectionMatchSet,  XssMatchSet,  RegexMatchSet,  GeoMatchSet, or  SizeConstraintSet. For example, if an ``IPSet`` includes the IP address ``192.0.2.44``, AWS WAF will allow, block, or count requests based on all IP addresses *except* ``192.0.2.44``.

              
            

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

              The type of predicate in a ``Rule``, such as ``ByteMatch`` or ``IPSet``.

              
            

            - **DataId** *(string) --* 

              A unique identifier for a predicate in a ``Rule``, such as ``ByteMatchSetId`` or ``IPSetId``. The ID is returned by the corresponding ``Create`` or ``List`` command.

              
        
      
    
      

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

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

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

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

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

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

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

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

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

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

  

  **Examples**

  The following example creates a rule named WAFByteHeaderRule.
  ::

    response = client.create_rule(
        ChangeToken='abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
        MetricName='WAFByteHeaderRule',
        Name='WAFByteHeaderRule',
    )
    
    print(response)

  
  Expected Output:
  ::

    {
        'ChangeToken': 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
        'Rule': {
            'MetricName': 'WAFByteHeaderRule',
            'Name': 'WAFByteHeaderRule',
            'Predicates': [
                {
                    'DataId': 'MyByteMatchSetID',
                    'Negated': False,
                    'Type': 'ByteMatch',
                },
            ],
            'RuleId': 'WAFRule-1-Example',
        },
        'ResponseMetadata': {
            '...': '...',
        },
    }

  