ListRules
Note
Deprecation notice: 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 RuleSummary 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
Rules
that you want AWS WAF to return for this request. If you have moreRules
than the number that you specify forLimit
, the response includes aNextMarker
value that you can use to get another batch ofRules
.Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
- NextMarker
-
If you specify a value for
Limit
and you have moreRules
than the value ofLimit
, AWS WAF returns aNextMarker
value in the response that allows you to list another group ofRules
. For the second and subsequentListRules
requests, specify the value ofNextMarker
from the previous response to get information about another batch ofRules
.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern:
.*\S.*
Required: No
Response Syntax
{
"NextMarker": "string",
"Rules": [
{
"Name": "string",
"RuleId": "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
Rules
than the number that you specified forLimit
in the request, the response includes aNextMarker
value. To list moreRules
, submit anotherListRules
request, and specify theNextMarker
value from the response in theNextMarker
value in the next request.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern:
.*\S.*
- Rules
-
An array of RuleSummary objects.
Type: Array of RuleSummary 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
- WAFInvalidAccountException
-
The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: