ListIPSets
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 IPSetSummary objects in the response.
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
IPSetobjects that you want AWS WAF to return for this request. If you have moreIPSetobjects than the number you specify forLimit, the response includes aNextMarkervalue that you can use to get another batch ofIPSetobjects.Type: Integer
Valid Range: Minimum value of 0. Maximum value of 100.
Required: No
- NextMarker
-
AWS WAF returns a
NextMarkervalue in the response that allows you to list another group ofIPSets. For the second and subsequentListIPSetsrequests, specify the value ofNextMarkerfrom the previous response to get information about another batch ofIPSets.Type: String
Length Constraints: Minimum length of 1. Maximum length of 1224.
Pattern:
.*\S.*Required: No
Response Syntax
{
"IPSets": [
{
"IPSetId": "string",
"Name": "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.
- IPSets
-
An array of IPSetSummary objects.
Type: Array of IPSetSummary objects
- NextMarker
-
To list more
IPSetobjects, submit anotherListIPSetsrequest, and in the next request use theNextMarkerresponse value as theNextMarkervalue.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
- 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:
