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

***********
update_rule
***********



.. py:method:: WAFRegional.Client.update_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.

    

   

  Inserts or deletes  Predicate objects in a ``Rule``. Each ``Predicate`` object identifies a predicate, such as a  ByteMatchSet or an  IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a ``Rule``, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose that you add the following to a ``Rule``:

   

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

   

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

   

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

   

   
  * Create and update the predicates that you want to include in the ``Rule``.
   
  * Create the ``Rule``. See  CreateRule.
   
  * Use ``GetChangeToken`` to get the change token that you provide in the ``ChangeToken`` parameter of an  UpdateRule request.
   
  * Submit an ``UpdateRule`` request to add predicates to the ``Rule``.
   
  * Create and update a ``WebACL`` that contains the ``Rule``. See  CreateWebACL.
   

   

  If you want to replace one ``ByteMatchSet`` or ``IPSet`` with another, you delete the existing one and add the new one.

   

  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/UpdateRule>`_  


  **Request Syntax**
  ::

    response = client.update_rule(
        RuleId='string',
        ChangeToken='string',
        Updates=[
            {
                'Action': 'INSERT'|'DELETE',
                'Predicate': {
                    'Negated': True|False,
                    'Type': 'IPMatch'|'ByteMatch'|'SqlInjectionMatch'|'GeoMatch'|'SizeConstraint'|'XssMatch'|'RegexMatch',
                    'DataId': 'string'
                }
            },
        ]
    )
    
  :type RuleId: string
  :param RuleId: **[REQUIRED]** 

    The ``RuleId`` of the ``Rule`` that you want to update. ``RuleId`` is returned by ``CreateRule`` and by  ListRules.

    

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

    The value returned by the most recent call to  GetChangeToken.

    

  
  :type Updates: list
  :param Updates: **[REQUIRED]** 

    An array of ``RuleUpdate`` objects that you want to insert into or delete from a  Rule. For more information, see the applicable data types:

     

    
    *  RuleUpdate: Contains ``Action`` and ``Predicate``
     
    *  Predicate: Contains ``DataId``, ``Negated``, and ``Type``
     
    *  FieldToMatch: Contains ``Data`` and ``Type``
    

    

  
    - *(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 a ``Predicate`` (such as an ``IPSet``) and indicates whether you want to add it to a ``Rule`` or delete it from a ``Rule``.

      

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

        Specify ``INSERT`` to add a ``Predicate`` to a ``Rule``. Use ``DELETE`` to remove a ``Predicate`` from a ``Rule``.

        

      
      - **Predicate** *(dict) --* **[REQUIRED]** 

        The ID of the ``Predicate`` (such as an ``IPSet``) that you want to add to a ``Rule``.

        

      
        - **Negated** *(boolean) --* **[REQUIRED]** 

          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) --* **[REQUIRED]** 

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

          

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

          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.

          

        
      
    

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

    
    ::

      {
          'ChangeToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        The ``ChangeToken`` that you used to submit the ``UpdateRule`` 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.WAFInvalidAccountException`

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

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

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

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

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

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

  

  **Examples**

  The following example deletes a Predicate object in a rule with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
  ::

    response = client.update_rule(
        ChangeToken='abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
        RuleId='example1ds3t-46da-4fdb-b8d5-abc321j569j5',
        Updates=[
            {
                'Action': 'DELETE',
                'Predicate': {
                    'DataId': 'MyByteMatchSetID',
                    'Negated': False,
                    'Type': 'ByteMatch',
                },
            },
        ],
    )
    
    print(response)

  
  Expected Output:
  ::

    {
        'ChangeToken': 'abcd12f2-46da-4fdb-b8d5-fbd4c466928f',
        'ResponseMetadata': {
            '...': '...',
        },
    }

  