- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
UpdateIPSetCommand
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.
Inserts or deletes IPSetDescriptor objects in an IPSet
. For each IPSetDescriptor
object, you specify the following values:
-
Whether to insert or delete the object from the array. If you want to change an
IPSetDescriptor
object, you delete the existing object and add a new one. -
The IP address version,
IPv4
orIPv6
. -
The IP address in CIDR notation, for example,
192.0.2.0/24
(for the range of IP addresses from192.0.2.0
to192.0.2.255
) or192.0.2.44/32
(for the individual IP address192.0.2.44
).
AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing .
IPv6 addresses can be represented using any of the following formats:
-
1111:0000:0000:0000:0000:0000:0000:0111/128
-
1111:0:0:0:0:0:0:0111/128
-
1111::0111/128
-
1111::111/128
You use an IPSet
to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an IPSet
that specifies those IP addresses, and then configure AWS WAF to block the requests.
To create and configure an IPSet
, perform the following steps:
-
Submit a CreateIPSet request.
-
Use GetChangeToken to get the change token that you provide in the
ChangeToken
parameter of an UpdateIPSet request. -
Submit an
UpdateIPSet
request to specify the IP addresses that you want AWS WAF to watch for.
When you update an IPSet
, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one.
You can insert a maximum of 1000 addresses in a single request.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide .
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { WAFClient, UpdateIPSetCommand } from "@aws-sdk/client-waf"; // ES Modules import
// const { WAFClient, UpdateIPSetCommand } = require("@aws-sdk/client-waf"); // CommonJS import
const client = new WAFClient(config);
const input = { // UpdateIPSetRequest
IPSetId: "STRING_VALUE", // required
ChangeToken: "STRING_VALUE", // required
Updates: [ // IPSetUpdates // required
{ // IPSetUpdate
Action: "INSERT" || "DELETE", // required
IPSetDescriptor: { // IPSetDescriptor
Type: "IPV4" || "IPV6", // required
Value: "STRING_VALUE", // required
},
},
],
};
const command = new UpdateIPSetCommand(input);
const response = await client.send(command);
// { // UpdateIPSetResponse
// ChangeToken: "STRING_VALUE",
// };
Example Usage
UpdateIPSetCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
ChangeToken Required | string | undefined | The value returned by the most recent call to GetChangeToken. |
IPSetId Required | string | undefined | The |
Updates Required | IPSetUpdate[] | undefined | An array of
You can insert a maximum of 1000 addresses in a single request. |
UpdateIPSetCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
ChangeToken | string | undefined | The |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
WAFInternalErrorException | server | The operation failed because of a system problem, even though the request was valid. Retry your request. |
WAFInvalidAccountException | client | The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. |
WAFInvalidOperationException | client | The operation failed because there was nothing to do. For example:
|
WAFInvalidParameterException | client | The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
|
WAFLimitsExceededException | client | The operation exceeds a resource limit, for example, the maximum number of |
WAFNonexistentContainerException | client | The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example:
|
WAFNonexistentItemException | client | The operation failed because the referenced object doesn't exist. |
WAFReferencedItemException | client | The operation failed because you tried to delete an object that is still in use. For example:
|
WAFStaleDataException | client | The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. |
WAFServiceException | Base exception class for all service exceptions from WAF service. |