WAF / Client / list_activated_rules_in_rule_group
list_activated_rules_in_rule_group#
- WAF.Client.list_activated_rules_in_rule_group(**kwargs)#
Note
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. 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
Request Syntax
response = client.list_activated_rules_in_rule_group( RuleGroupId='string', NextMarker='string', Limit=123 )
- Parameters:
RuleGroupId (string) – The
RuleGroupId
of the RuleGroup for which you want to get a list of ActivatedRule objects.NextMarker (string) – If you specify a value for
Limit
and you have moreActivatedRules
than the value ofLimit
, AWS WAF returns aNextMarker
value in the response that allows you to list another group ofActivatedRules
. For the second and subsequentListActivatedRulesInRuleGroup
requests, specify the value ofNextMarker
from the previous response to get information about another batch ofActivatedRules
.Limit (integer) – Specifies the number of
ActivatedRules
that you want AWS WAF to return for this request. If you have moreActivatedRules
than the number that you specify forLimit
, the response includes aNextMarker
value that you can use to get another batch ofActivatedRules
.
- Return type:
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 forLimit
in the request, the response includes aNextMarker
value. To list moreActivatedRules
, submit anotherListActivatedRulesInRuleGroup
request, and specify theNextMarker
value from the response in theNextMarker
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 in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. 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 aRule
that you want to insert or delete, the priority of theRule
in theWebACL
, and the action that you want AWS WAF to take when a web request matches theRule
(ALLOW
,BLOCK
, orCOUNT
).To specify whether to insert or delete a
Rule
, use theAction
parameter in the WebACLUpdate data type.Priority (integer) –
Specifies the order in which the
Rules
in aWebACL
are evaluated. Rules with a lower value forPriority
are evaluated beforeRules
with a higher value. The value must be a unique integer. If you add multipleRules
to aWebACL
, the values don’t need to be consecutive.RuleId (string) –
The
RuleId
for aRule
. You useRuleId
to get more information about aRule
(see GetRule), update aRule
(see UpdateRule), insert aRule
into aWebACL
or delete a one from aWebACL
(see UpdateWebACL), or delete aRule
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 forAction
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 aRuleGroup
to aWebACL
. In this case, you do not useActivatedRule|Action
. For all other update requests,ActivatedRule|Action
is used instead ofActivatedRule|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 requestsBLOCK
: AWS WAF blocks requestsCOUNT
: 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 specifyCOUNT
for the default action for aWebACL
.
OverrideAction (dict) –
Use the
OverrideAction
to test yourRuleGroup
.Any rule in a
RuleGroup
can potentially block a request. If you set theOverrideAction
toNone
, theRuleGroup
will block a request if any individual rule in theRuleGroup
matches the request and is configured to block that request. However if you first want to test theRuleGroup
, set theOverrideAction
toCount
. TheRuleGroup
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 aRuleGroup
to aWebACL
. In this case you do not useActivatedRule|Action
. For all other update requests,ActivatedRule|Action
is used instead ofActivatedRule|OverrideAction
.Type (string) –
COUNT
overrides the action specified by the individual rule within aRuleGroup
. If set toNONE
, the rule’s action will take place.
Type (string) –
The rule type, either
REGULAR
, as defined by Rule,RATE_BASED
, as defined by RateBasedRule, orGROUP
, 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 aRuleGroup
.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 toCOUNT
. Therefore, requests that match anExcludedRule
are counted but not blocked. TheRuleGroup
owner will receive COUNT metrics for eachExcludedRule
.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.
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 beDELETE
andUpdates: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 beINSERT
,Updates:ActivatedRule:RuleId
should be the rule group that you just removed, andExcludedRules
should contain the rules that you want to exclude.
(dict) –
Note
This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.
For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. 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 aRuleGroup
. The rule must belong to theRuleGroup
that is specified by theActivatedRule
.RuleId (string) –
The unique identifier for the rule to exclude from the rule group.
Exceptions
WAF.Client.exceptions.WAFInternalErrorException
WAF.Client.exceptions.WAFNonexistentItemException
WAF.Client.exceptions.WAFInvalidParameterException