ListRuleGroups
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 RuleGroup objects.
Request Syntax
{
"Limit": number,
"NextMarker": "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
RuleGroupsthat you want AWS WAF to return for this request. If you have moreRuleGroupsthan the number that you specify forLimit, the response includes aNextMarkervalue that you can use to get another batch ofRuleGroups.Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
- NextMarker
-
If you specify a value for
Limitand you have moreRuleGroupsthan the value ofLimit, AWS WAF returns aNextMarkervalue in the response that allows you to list another group ofRuleGroups. For the second and subsequentListRuleGroupsrequests, specify the value ofNextMarkerfrom the previous response to get information about another batch ofRuleGroups.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern:
.*\S.*Required: No
Response Syntax
{
"NextMarker": "string",
"RuleGroups": [
{
"Name": "string",
"RuleGroupId": "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.
- NextMarker
-
If you have more
RuleGroupsthan the number that you specified forLimitin the request, the response includes aNextMarkervalue. To list moreRuleGroups, submit anotherListRuleGroupsrequest, 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.* - RuleGroups
-
An array of RuleGroup objects.
Type: Array of RuleGroupSummary objects
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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
