<a id="cli-aws-waf-regional-update-rule"></a>

# update-rule

## Description

#### NOTE
This is **AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.

> **For the latest version of AWS WAF** , use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) . With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Inserts or deletes  Predicate objects in a `Rule` . Each `Predicate` object identifies a predicate, such as a  ByteMatchSet or an  IPSet , that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a `Rule` , a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose that you add the following to a `Rule` :

* A `ByteMatchSet` that matches the value `BadBot` in the `User-Agent` header
* An `IPSet` that matches the IP address `192.0.2.44`

You then add the `Rule` to a `WebACL` and specify that you want to block requests that satisfy the `Rule` . For a request to be blocked, the `User-Agent` header in the request must contain the value `BadBot`  *and* the request must originate from the IP address 192.0.2.44.

To create and configure a `Rule` , perform the following steps:

* Create and update the predicates that you want to include in the `Rule` .
* Create the `Rule` . See  CreateRule .
* Use `GetChangeToken` to get the change token that you provide in the `ChangeToken` parameter of an  UpdateRule request.
* Submit an `UpdateRule` request to add predicates to the `Rule` .
* Create and update a `WebACL` that contains the `Rule` . See  CreateWebACL .

If you want to replace one `ByteMatchSet` or `IPSet` with another, you delete the existing one and add the new one.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/) .

See also: [AWS API Documentation](https://docs.aws.amazon.com/goto/WebAPI/waf-regional-2016-11-28/UpdateRule)

## Synopsis

```
  update-rule
--rule-id <value>
--change-token <value>
--updates <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
```

## Options

`--rule-id` (string) [required]

> The `RuleId` of the `Rule` that you want to update. `RuleId` is returned by `CreateRule` and by  ListRules .

> Constraints:

> * min: `1`
> * max: `128`
> * pattern: `.*\S.*`

`--change-token` (string) [required]

> The value returned by the most recent call to  GetChangeToken .

> Constraints:

> * min: `1`
> * max: `128`
> * pattern: `.*\S.*`

`--updates` (list) [required]

> An array of `RuleUpdate` objects that you want to insert into or delete from a  Rule . For more information, see the applicable data types:

> * RuleUpdate : Contains `Action` and `Predicate`
> * Predicate : Contains `DataId` , `Negated` , and `Type`
> * FieldToMatch : Contains `Data` and `Type`

> (structure)

> > #### NOTE
> > This is **AWS WAF Classic** documentation. For more information, see [AWS WAF Classic](https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html) in the developer guide.

> > > **For the latest version of AWS WAF** , use the AWS WAFV2 API and see the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html) . With the latest version, AWS WAF has a single set of endpoints for regional and global use.

> > Specifies a `Predicate` (such as an `IPSet` ) and indicates whether you want to add it to a `Rule` or delete it from a `Rule` .

> > Action -> (string) [required]

> > > Specify `INSERT` to add a `Predicate` to a `Rule` . Use `DELETE` to remove a `Predicate` from a `Rule` .

> > > Possible values:

> > > * `INSERT`
> > > * `DELETE`

> > Predicate -> (structure) [required]

> > > The ID of the `Predicate` (such as an `IPSet` ) that you want to add to a `Rule` .

> > > Negated -> (boolean) [required]

> > > > Set `Negated` to `False` if you want AWS WAF to allow, block, or count requests based on the settings in the specified  ByteMatchSet ,  IPSet ,  SqlInjectionMatchSet ,  XssMatchSet ,  RegexMatchSet ,  GeoMatchSet , or  SizeConstraintSet . For example, if an `IPSet` includes the IP address `192.0.2.44` , AWS WAF will allow or block requests based on that IP address.

> > > > Set `Negated` to `True` if you want AWS WAF to allow or block a request based on the negation of the settings in the  ByteMatchSet ,  IPSet ,  SqlInjectionMatchSet ,  XssMatchSet ,  RegexMatchSet ,  GeoMatchSet , or  SizeConstraintSet . For example, if an `IPSet` includes the IP address `192.0.2.44` , AWS WAF will allow, block, or count requests based on all IP addresses *except*  `192.0.2.44` .

> > > Type -> (string) [required]

> > > > The type of predicate in a `Rule` , such as `ByteMatch` or `IPSet` .

> > > > Possible values:

> > > > * `IPMatch`
> > > > * `ByteMatch`
> > > > * `SqlInjectionMatch`
> > > > * `GeoMatch`
> > > > * `SizeConstraint`
> > > > * `XssMatch`
> > > > * `RegexMatch`

> > > DataId -> (string) [required]

> > > > A unique identifier for a predicate in a `Rule` , such as `ByteMatchSetId` or `IPSetId` . The ID is returned by the corresponding `Create` or `List` command.

> > > > Constraints:

> > > > * min: `1`
> > > > * max: `128`
> > > > * pattern: `.*\S.*`

Shorthand Syntax:

```
Action=string,Predicate={Negated=boolean,Type=string,DataId=string} ...
```

JSON Syntax:

```json
[
  {
    "Action": "INSERT"|"DELETE",
    "Predicate": {
      "Negated": true|false,
      "Type": "IPMatch"|"ByteMatch"|"SqlInjectionMatch"|"GeoMatch"|"SizeConstraint"|"XssMatch"|"RegexMatch",
      "DataId": "string"
    }
  }
  ...
]
```

`--cli-input-json` | `--cli-input-yaml` (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by `--generate-cli-skeleton`. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with `--cli-input-yaml`.

`--generate-cli-skeleton` (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value `input`, prints a sample input JSON that can be used as an argument for `--cli-input-json`. Similarly, if provided `yaml-input` it will print a sample input YAML that can be used with `--cli-input-yaml`. If provided with the value `output`, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

## Global Options

`--debug` (boolean)

Turn on debug logging.

`--endpoint-url` (string)

Override command’s default URL with the given URL.

`--no-verify-ssl` (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

`--no-paginate` (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

`--output` (string)

The formatting style for command output.

* json
* text
* table
* yaml
* yaml-stream
* off

`--query` (string)

A JMESPath query to use in filtering the response data.

`--profile` (string)

Use a specific profile from your credential file.

`--region` (string)

The region to use. Overrides config/env settings.

`--version` (string)

Display the version of this tool.

`--color` (string)

Turn on/off color output.

* on
* off
* auto

`--no-sign-request` (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

`--ca-bundle` (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

`--cli-read-timeout` (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

`--cli-connect-timeout` (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

`--cli-binary-format` (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob `fileb://` will always be treated as binary and use the file contents directly regardless of the `cli-binary-format` setting. When using `file://` the file contents will need to properly formatted for the configured `cli-binary-format`.

* base64
* raw-in-base64-out

`--no-cli-pager` (boolean)

Disable cli pager for output.

`--cli-auto-prompt` (boolean)

Automatically prompt for CLI input parameters.

`--no-cli-auto-prompt` (boolean)

Disable automatically prompt for CLI input parameters.

`--cli-error-format` (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

* legacy
* json
* yaml
* text
* table
* enhanced

## Examples

#### NOTE
To use the following examples, you must have the AWS CLI installed and configured. See the [Getting started guide](https://docs.aws.amazon.com/cli/latest/userguide/cli-chap-getting-started.html) in the *AWS CLI User Guide* for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See [Using quotation marks with strings](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-parameters-quoting-strings.html) in the *AWS CLI User Guide* .

**To update a rule**

The following `update-rule` example deletes a `Predicate` object in a rule. Because the `updates` value has embedded double quotes, you must surround the entire value with single quotes.

```bash
aws waf-regional update-rule \
    --rule-id a1b2c3d4-5678-90ab-cdef-EXAMPLE11111 \
    --change-token 12cs345-67cd-890b-1cd2-c3a4567d89f1 \
    --updates 'Action="DELETE",Predicate={Negated=false,Type="ByteMatch",DataId="MyByteMatchSetID"}'
```

Output:

```json
{
    "ChangeToken": "12cs345-67cd-890b-1cd2-c3a4567d89f1"
}
```

For more information, see [Working with rules](https://docs.aws.amazon.com/waf/latest/developerguide/classic-web-acl-rules.html) in the *AWS WAF, AWS Firewall Manager, and AWS Shield Advanced Developer Guide*.

## Output

ChangeToken -> (string)

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

> Constraints:

> * min: `1`
> * max: `128`
> * pattern: `.*\S.*`