GetIPSet
Note
This is Amazon WAF Classic documentation. For more information, see Amazon WAF Classic in the developer guide.
For the latest version of Amazon WAF , use the Amazon WAFV2 API and see the Amazon WAF Developer Guide. With the latest version, Amazon WAF has a single set of endpoints for regional and global use.
Returns the IPSet that is specified by IPSetId
.
Request Syntax
{
"IPSetId": "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.
- IPSetId
-
The
IPSetId
of the IPSet that you want to get.IPSetId
is returned by CreateIPSet and by ListIPSets.Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
.*\S.*
Required: Yes
Response Syntax
{
"IPSet": {
"IPSetDescriptors": [
{
"Type": "string",
"Value": "string"
}
],
"IPSetId": "string",
"Name": "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.
- IPSet
-
Information about the IPSet that you specified in the
GetIPSet
request. For more information, see the following topics:-
IPSet: Contains
IPSetDescriptors
,IPSetId
, andName
-
IPSetDescriptors
: Contains an array of IPSetDescriptor objects. EachIPSetDescriptor
object containsType
andValue
Type: IPSet object
-
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
- 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 Amazon SDKs, see the following: