ListActivatedRulesInRuleGroup
Note
AWS WAF Classic support will end on September 30, 2025.
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.
Request Syntax
{
"Limit": number,
"NextMarker": "string",
"RuleGroupId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Limit
-
Specifies the number of
ActivatedRulesthat you want AWS WAF to return for this request. If you have moreActivatedRulesthan the number that you specify forLimit, the response includes aNextMarkervalue that you can use to get another batch ofActivatedRules.Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
- NextMarker
-
If you specify a value for
Limitand you have moreActivatedRulesthan the value ofLimit, AWS WAF returns aNextMarkervalue in the response that allows you to list another group ofActivatedRules. For the second and subsequentListActivatedRulesInRuleGrouprequests, specify the value ofNextMarkerfrom the previous response to get information about another batch ofActivatedRules.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern:
.*\S.*Required: No
- RuleGroupId
-
The
RuleGroupIdof the RuleGroup for which you want to get a list of ActivatedRule objects.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
.*\S.*Required: No
Response Syntax
{
"ActivatedRules": [
{
"Action": {
"Type": "string"
},
"ExcludedRules": [
{
"RuleId": "string"
}
],
"OverrideAction": {
"Type": "string"
},
"Priority": number,
"RuleId": "string",
"Type": "string"
}
],
"NextMarker": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ActivatedRules
-
An array of
ActivatedRulesobjects.Type: Array of ActivatedRule objects
- NextMarker
-
If you have more
ActivatedRulesthan the number that you specified forLimitin the request, the response includes aNextMarkervalue. To list moreActivatedRules, submit anotherListActivatedRulesInRuleGrouprequest, and specify theNextMarkervalue from the response in theNextMarkervalue in the next request.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern:
.*\S.*
Errors
For information about the errors that are common to all actions, see Common Errors.
- WAFInternalErrorException
-
The operation failed because of a system problem, even though the request was valid. Retry your request.
HTTP Status Code: 500
- WAFInvalidParameterException
-
The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
-
You specified an invalid parameter name.
-
You specified an invalid value.
-
You tried to update an object (
ByteMatchSet,IPSet,Rule, orWebACL) using an action other thanINSERTorDELETE. -
You tried to create a
WebACLwith aDefaultActionTypeother thanALLOW,BLOCK, orCOUNT. -
You tried to create a
RateBasedRulewith aRateKeyvalue other thanIP. -
You tried to update a
WebACLwith aWafActionTypeother thanALLOW,BLOCK, orCOUNT. -
You tried to update a
ByteMatchSetwith aFieldToMatchTypeother than HEADER, METHOD, QUERY_STRING, URI, or BODY. -
You tried to update a
ByteMatchSetwith aFieldofHEADERbut no value forData. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
HTTP Status Code: 400
-
- WAFNonexistentItemException
-
The operation failed because the referenced object doesn't exist.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
