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

**********************************
list_activated_rules_in_rule_group
**********************************



.. py:method:: WAFRegional.Client.list_activated_rules_in_rule_group(**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 an array of  ActivatedRule objects.

  

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


  **Request Syntax**
  ::

    response = client.list_activated_rules_in_rule_group(
        RuleGroupId='string',
        NextMarker='string',
        Limit=123
    )
    
  :type RuleGroupId: string
  :param RuleGroupId: 

    The ``RuleGroupId`` of the  RuleGroup for which you want to get a list of  ActivatedRule objects.

    

  
  :type NextMarker: string
  :param NextMarker: 

    If you specify a value for ``Limit`` and you have more ``ActivatedRules`` than the value of ``Limit``, AWS WAF returns a ``NextMarker`` value in the response that allows you to list another group of ``ActivatedRules``. For the second and subsequent ``ListActivatedRulesInRuleGroup`` requests, specify the value of ``NextMarker`` from the previous response to get information about another batch of ``ActivatedRules``.

    

  
  :type Limit: integer
  :param Limit: 

    Specifies the number of ``ActivatedRules`` that you want AWS WAF to return for this request. If you have more ``ActivatedRules`` than the number that you specify for ``Limit``, the response includes a ``NextMarker`` value that you can use to get another batch of ``ActivatedRules``.

    

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

    
    ::

      {
          'NextMarker': 'string',
          'ActivatedRules': [
              {
                  'Priority': 123,
                  'RuleId': 'string',
                  'Action': {
                      'Type': 'BLOCK'|'ALLOW'|'COUNT'
                  },
                  'OverrideAction': {
                      'Type': 'NONE'|'COUNT'
                  },
                  'Type': 'REGULAR'|'RATE_BASED'|'GROUP',
                  'ExcludedRules': [
                      {
                          'RuleId': 'string'
                      },
                  ]
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **NextMarker** *(string) --* 

        If you have more ``ActivatedRules`` than the number that you specified for ``Limit`` in the request, the response includes a ``NextMarker`` value. To list more ``ActivatedRules``, submit another ``ListActivatedRulesInRuleGroup`` request, and specify the ``NextMarker`` value from the response in the ``NextMarker`` value in the next request.

        
      

      - **ActivatedRules** *(list) --* 

        An array of ``ActivatedRules`` objects.

        
        

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

            

           

          The ``ActivatedRule`` object in an  UpdateWebACL request specifies a ``Rule`` that you want to insert or delete, the priority of the ``Rule`` in the ``WebACL``, and the action that you want AWS WAF to take when a web request matches the ``Rule`` ( ``ALLOW``, ``BLOCK``, or ``COUNT``).

           

          To specify whether to insert or delete a ``Rule``, use the ``Action`` parameter in the  WebACLUpdate data type.

          
          

          - **Priority** *(integer) --* 

            Specifies the order in which the ``Rules`` in a ``WebACL`` are evaluated. Rules with a lower value for ``Priority`` are evaluated before ``Rules`` with a higher value. The value must be a unique integer. If you add multiple ``Rules`` to a ``WebACL``, the values don't need to be consecutive.

            
          

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

            The ``RuleId`` 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.

            
          

          - **Action** *(dict) --* 

            Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the ``Rule``. Valid values for ``Action`` include the following:

             

            
            * ``ALLOW``: CloudFront responds with the requested object.
             
            * ``BLOCK``: CloudFront responds with an HTTP 403 (Forbidden) status code.
             
            * ``COUNT``: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL.
            

             

            ``ActivatedRule|OverrideAction`` applies only when updating or adding a ``RuleGroup`` to a ``WebACL``. In this case, you do not use ``ActivatedRule|Action``. For all other update requests, ``ActivatedRule|Action`` is used instead of ``ActivatedRule|OverrideAction``.

            
            

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

              Specifies how you want AWS WAF to respond to requests that match the settings in a ``Rule``. Valid settings include the following:

               

              
              * ``ALLOW``: AWS WAF allows requests
               
              * ``BLOCK``: AWS WAF blocks requests
               
              * ``COUNT``: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify ``COUNT`` for the default action for a ``WebACL``.
              

              
        
          

          - **OverrideAction** *(dict) --* 

            Use the ``OverrideAction`` to test your ``RuleGroup``.

             

            Any rule in a ``RuleGroup`` can potentially block a request. If you set the ``OverrideAction`` to ``None``, the ``RuleGroup`` will block a request if any individual rule in the ``RuleGroup`` matches the request and is configured to block that request. However if you first want to test the ``RuleGroup``, set the ``OverrideAction`` to ``Count``. The ``RuleGroup`` will then override any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests will be counted. You can view a record of counted requests using  GetSampledRequests.

             

            ``ActivatedRule|OverrideAction`` applies only when updating or adding a ``RuleGroup`` to a ``WebACL``. In this case you do not use ``ActivatedRule|Action``. For all other update requests, ``ActivatedRule|Action`` is used instead of ``ActivatedRule|OverrideAction``.

            
            

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

              ``COUNT`` overrides the action specified by the individual rule within a ``RuleGroup`` . If set to ``NONE``, the rule's action will take place.

              
        
          

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

            The rule type, either ``REGULAR``, as defined by  Rule, ``RATE_BASED``, as defined by  RateBasedRule, or ``GROUP``, as defined by  RuleGroup. The default is REGULAR. Although this field is optional, be aware that if you try to add a RATE_BASED rule to a web ACL without setting the type, the  UpdateWebACL request will fail because the request tries to add a REGULAR rule with the specified ID, which does not exist.

            
          

          - **ExcludedRules** *(list) --* 

            An array of rules to exclude from a rule group. This is applicable only when the ``ActivatedRule`` refers to a ``RuleGroup``.

             

            Sometimes it is necessary to troubleshoot rule groups that are blocking traffic unexpectedly (false positives). One troubleshooting technique is to identify the specific rule within the rule group that is blocking the legitimate traffic and then disable (exclude) that particular rule. You can exclude rules from both your own rule groups and AWS Marketplace rule groups that have been associated with a web ACL.

             

            Specifying ``ExcludedRules`` does not remove those rules from the rule group. Rather, it changes the action for the rules to ``COUNT``. Therefore, requests that match an ``ExcludedRule`` are counted but not blocked. The ``RuleGroup`` owner will receive COUNT metrics for each ``ExcludedRule``.

             

            If you want to exclude rules from a rule group that is already associated with a web ACL, perform the following steps:

             

             
            * Use the AWS WAF logs to identify the IDs of the rules that you want to exclude. For more information about the logs, see `Logging Web ACL Traffic Information <https://docs.aws.amazon.com/waf/latest/developerguide/logging.html>`__.
             
            * Submit an  UpdateWebACL request that has two actions: 

              
              * The first action deletes the existing rule group from the web ACL. That is, in the  UpdateWebACL request, the first ``Updates:Action`` should be ``DELETE`` and ``Updates:ActivatedRule:RuleId`` should be the rule group that contains the rules that you want to exclude.
               
              * The second action inserts the same rule group back in, but specifying the rules to exclude. That is, the second ``Updates:Action`` should be ``INSERT``, ``Updates:ActivatedRule:RuleId`` should be the rule group that you just removed, and ``ExcludedRules`` should contain the rules that you want to exclude.
              

            
            

            
            

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

                

               

              The rule to exclude from a rule group. This is applicable only when the ``ActivatedRule`` refers to a ``RuleGroup``. The rule must belong to the ``RuleGroup`` that is specified by the ``ActivatedRule``.

              
              

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

                The unique identifier for the rule to exclude from the rule group.

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

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

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

  