UpdateIPSetCommand

Use a bare-bones client and the command you need to make an API call.

UpdateIPSetCommandInput

[UpdateIPSetCommandInput](@aws-sdk/client-waf!UpdateIPSetCommandInput:Interface)

<note> This is AWS WAF Classic documentation. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html">AWS WAF Classic</a> in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API and see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. With the latest version, AWS WAF has a single set of endpoints for regional and global use. </note> Inserts or deletes IPSetDescriptor objects in an <code>IPSet</code>. For each <code>IPSetDescriptor</code> object, you specify the following values: <ul> <li> Whether to insert or delete the object from the array. If you want to change an <code>IPSetDescriptor</code> object, you delete the existing object and add a new one. </li> <li> The IP address version, <code>IPv4</code> or <code>IPv6</code>. </li> <li> The IP address in CIDR notation, for example, <code>192.0.2.0/24</code> (for the range of IP addresses from <code>192.0.2.0</code> to <code>192.0.2.255</code>) or <code>192.0.2.44/32</code> (for the individual IP address <code>192.0.2.44</code>). </li> </ul> 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 <a href="https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Classless Inter-Domain Routing</a>. IPv6 addresses can be represented using any of the following formats: <ul> <li> 1111:0000:0000:0000:0000:0000:0000:0111/128 </li> <li> 1111:0:0:0:0:0:0:0111/128 </li> <li> 1111::0111/128 </li> <li> 1111::111/128 </li> </ul> You use an <code>IPSet</code> 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 <code>IPSet</code> that specifies those IP addresses, and then configure AWS WAF to block the requests. To create and configure an <code>IPSet</code>, perform the following steps: <ol> <li> Submit a CreateIPSet request. </li> <li> Use GetChangeToken to get the change token that you provide in the <code>ChangeToken</code> parameter of an UpdateIPSet request. </li> <li> Submit an <code>UpdateIPSet</code> request to specify the IP addresses that you want AWS WAF to watch for. </li> </ol> When you update an <code>IPSet</code>, 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 <a href="https://docs.aws.amazon.com/waf/latest/developerguide/">AWS WAF Developer Guide</a>.

ChangeToken

The value returned by the most recent call to GetChangeToken.

IPSetId

The <code>IPSetId</code> of the IPSet that you want to update. <code>IPSetId</code> is returned by CreateIPSet and by ListIPSets.

Updates

An array of <code>IPSetUpdate</code> objects that you want to insert into or delete from an IPSet. For more information, see the applicable data types: <ul> <li> IPSetUpdate: Contains <code>Action</code> and <code>IPSetDescriptor</code> </li> <li> IPSetDescriptor: Contains <code>Type</code> and <code>Value</code> </li> </ul> You can insert a maximum of 1000 addresses in a single request.

The input for [UpdateIPSetCommand](@aws-sdk/client-waf!UpdateIPSetCommand:Class).

$metadata

The <code>ChangeToken</code> that you used to submit the <code>UpdateIPSet</code> request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

UpdateIPSetCommandOutput

The output of [UpdateIPSetCommand](@aws-sdk/client-waf!UpdateIPSetCommand:Class).

$fault

$response

$retryable

(constructor)

options

Constructs a new instance of the <code>ServiceException</code> class

[Symbol.hasInstance]

instance

Custom instanceof check to support the operator for ServiceException base class

isInstance

value

Checks if a value is an instance of ServiceException (duck typed)

name

WAFInternalErrorException

The operation failed because of a system problem, even though the request was valid. Retry your request.

WAFInvalidAccountException

The operation failed because you tried to create, update, or delete an object by using an invalid account identifier.

WAFInvalidOperationException

The operation failed because there was nothing to do. For example: <ul> <li> You tried to remove a <code>Rule</code> from a <code>WebACL</code>, but the <code>Rule</code> isn't in the specified <code>WebACL</code>. </li> <li> You tried to remove an IP address from an <code>IPSet</code>, but the IP address isn't in the specified <code>IPSet</code>. </li> <li> You tried to remove a <code>ByteMatchTuple</code> from a <code>ByteMatchSet</code>, but the <code>ByteMatchTuple</code> isn't in the specified <code>WebACL</code>. </li> <li> You tried to add a <code>Rule</code> to a <code>WebACL</code>, but the <code>Rule</code> already exists in the specified <code>WebACL</code>. </li> <li> You tried to add a <code>ByteMatchTuple</code> to a <code>ByteMatchSet</code>, but the <code>ByteMatchTuple</code> already exists in the specified <code>WebACL</code>. </li> </ul>

field

parameter

reason

WAFInvalidParameterException

The operation failed because AWS WAF didn't recognize a parameter in the request. For example: <ul> <li> You specified an invalid parameter name. </li> <li> You specified an invalid value. </li> <li> You tried to update an object (<code>ByteMatchSet</code>, <code>IPSet</code>, <code>Rule</code>, or <code>WebACL</code>) using an action other than <code>INSERT</code> or <code>DELETE</code>. </li> <li> You tried to create a <code>WebACL</code> with a <code>DefaultAction</code> <code>Type</code> other than <code>ALLOW</code>, <code>BLOCK</code>, or <code>COUNT</code>. </li> <li> You tried to create a <code>RateBasedRule</code> with a <code>RateKey</code> value other than <code>IP</code>. </li> <li> You tried to update a <code>WebACL</code> with a <code>WafAction</code> <code>Type</code> other than <code>ALLOW</code>, <code>BLOCK</code>, or <code>COUNT</code>. </li> <li> You tried to update a <code>ByteMatchSet</code> with a <code>FieldToMatch</code> <code>Type</code> other than HEADER, METHOD, QUERY_STRING, URI, or BODY. </li> <li> You tried to update a <code>ByteMatchSet</code> with a <code>Field</code> of <code>HEADER</code> but no value for <code>Data</code>. </li> <li> Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated. </li> </ul>

WAFLimitsExceededException

The operation exceeds a resource limit, for example, the maximum number of <code>WebACL</code> objects that you can create for an AWS account. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/limits.html">Limits</a> in the AWS WAF Developer Guide.

WAFNonexistentContainerException

The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example: <ul> <li> You tried to add a <code>Rule</code> to or delete a <code>Rule</code> from a <code>WebACL</code> that doesn't exist. </li> <li> You tried to add a <code>ByteMatchSet</code> to or delete a <code>ByteMatchSet</code> from a <code>Rule</code> that doesn't exist. </li> <li> You tried to add an IP address to or delete an IP address from an <code>IPSet</code> that doesn't exist. </li> <li> You tried to add a <code>ByteMatchTuple</code> to or delete a <code>ByteMatchTuple</code> from a <code>ByteMatchSet</code> that doesn't exist. </li> </ul>

WAFNonexistentItemException

The operation failed because the referenced object doesn't exist.

WAFReferencedItemException

The operation failed because you tried to delete an object that is still in use. For example: <ul> <li> You tried to delete a <code>ByteMatchSet</code> that is still referenced by a <code>Rule</code>. </li> <li> You tried to delete a <code>Rule</code> that is still referenced by a <code>WebACL</code>. </li> </ul>

WAFStaleDataException

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.