- 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
Updates the specified IPSet.
This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call.
To modify an IP set, do the following:
-
Retrieve it by calling GetIPSet
-
Update its settings as needed
-
Provide the complete IP set specification to this call
Temporary inconsistencies during updates
When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.
The following are examples of the temporary inconsistencies that you might notice during change propagation:
-
After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.
-
After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.
-
After you change a rule action setting, you might see the old action in some places and the new action in others.
-
After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { WAFV2Client, UpdateIPSetCommand } from "@aws-sdk/client-wafv2"; // ES Modules import
// const { WAFV2Client, UpdateIPSetCommand } = require("@aws-sdk/client-wafv2"); // CommonJS import
const client = new WAFV2Client(config);
const input = { // UpdateIPSetRequest
Name: "STRING_VALUE", // required
Scope: "CLOUDFRONT" || "REGIONAL", // required
Id: "STRING_VALUE", // required
Description: "STRING_VALUE",
Addresses: [ // IPAddresses // required
"STRING_VALUE",
],
LockToken: "STRING_VALUE", // required
};
const command = new UpdateIPSetCommand(input);
const response = await client.send(command);
// { // UpdateIPSetResponse
// NextLockToken: "STRING_VALUE",
// };
UpdateIPSetCommand Input
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
AddressesRequired | string[] | undefined | Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for Example address strings:
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing . Example JSON
|
IdRequired | string | undefined | A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. |
LockTokenRequired | string | undefined | A token used for optimistic locking. WAF returns a token to your |
NameRequired | string | undefined | The name of the IP set. You cannot change the name of an |
ScopeRequired | Scope | undefined | Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an Amplify application, use To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
|
Description | string | undefined | A description of the IP set that helps with identification. |
UpdateIPSetCommand Output
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
NextLockToken | string | undefined | A token used for optimistic locking. WAF returns this token to your |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| WAFDuplicateItemException | client | WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one. |
| WAFInternalErrorException | server | Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request. |
| WAFInvalidOperationException | client | The operation isn't valid. |
| WAFInvalidParameterException | client | The operation failed because WAF didn't recognize a parameter in the request. For example:
|
| WAFLimitsExceededException | client | WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of |
| WAFNonexistentItemException | client | WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. |
| WAFOptimisticLockException | client | WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation. |
| WAFV2ServiceException | Base exception class for all service exceptions from WAFV2 service. |