Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

UpdateRuleGroupCommand

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 ActivatedRule objects in a RuleGroup.

You can only insert REGULAR rules into a rule group.

You can have a maximum of ten rules per rule group.

To create and configure a RuleGroup, perform the following steps:

Create and update the Rules that you want to include in the RuleGroup. See CreateRule.
Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRuleGroup request.
Submit an UpdateRuleGroup request to add Rules to the RuleGroup.
Create and update a WebACL that contains the RuleGroup. See CreateWebACL.

If you want to replace one Rule 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 .

Example Syntax

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

import { WAFClient, UpdateRuleGroupCommand } from "@aws-sdk/client-waf"; // ES Modules import
// const { WAFClient, UpdateRuleGroupCommand } = require("@aws-sdk/client-waf"); // CommonJS import
const client = new WAFClient(config);
const input = { // UpdateRuleGroupRequest
  RuleGroupId: "STRING_VALUE", // required
  Updates: [ // RuleGroupUpdates // required
    { // RuleGroupUpdate
      Action: "INSERT" || "DELETE", // required
      ActivatedRule: { // ActivatedRule
        Priority: Number("int"), // required
        RuleId: "STRING_VALUE", // required
        Action: { // WafAction
          Type: "BLOCK" || "ALLOW" || "COUNT", // required
        },
        OverrideAction: { // WafOverrideAction
          Type: "NONE" || "COUNT", // required
        },
        Type: "REGULAR" || "RATE_BASED" || "GROUP",
        ExcludedRules: [ // ExcludedRules
          { // ExcludedRule
            RuleId: "STRING_VALUE", // required
          },
        ],
      },
    },
  ],
  ChangeToken: "STRING_VALUE", // required
};
const command = new UpdateRuleGroupCommand(input);
const response = await client.send(command);
// { // UpdateRuleGroupResponse
//   ChangeToken: "STRING_VALUE",
// };

UpdateRuleGroupCommand Input

See UpdateRuleGroupCommandInput for more details

Parameter	Type	Description
`ChangeToken` Required	`string \| undefined`	The value returned by the most recent call to GetChangeToken.
`RuleGroupId` Required	`string \| undefined`	The `RuleGroupId` of the RuleGroup that you want to update. `RuleGroupId` is returned by CreateRuleGroup and by ListRuleGroups.
`Updates` Required	`RuleGroupUpdate[] \| undefined`	An array of `RuleGroupUpdate` objects that you want to insert into or delete from a RuleGroup. You can only insert `REGULAR` rules into a rule group. `ActivatedRule\|OverrideAction` applies only when updating or adding a `RuleGroup` to a `WebACL`. In this case you do not use `ActivatedRule\|Action`. For all other update requests, `ActivatedRule\|Action` is used instead of `ActivatedRule\|OverrideAction`.

UpdateRuleGroupCommand Output

See UpdateRuleGroupCommandOutput for details

Parameter	Type	Description
`$metadata` Required	`ResponseMetadata`	Metadata pertaining to this request.
`ChangeToken`	`string \| undefined`	The `ChangeToken` that you used to submit the `UpdateRuleGroup` request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Throws

Name	Fault	Details
WAFInternalErrorException	server	The operation failed because of a system problem, even though the request was valid. Retry your request.
WAFInvalidOperationException	client	The operation failed because there was nothing to do. For example: You tried to remove a `Rule` from a `WebACL`, but the `Rule` isn't in the specified `WebACL`. You tried to remove an IP address from an `IPSet`, but the IP address isn't in the specified `IPSet`. You tried to remove a `ByteMatchTuple` from a `ByteMatchSet`, but the `ByteMatchTuple` isn't in the specified `WebACL`. You tried to add a `Rule` to a `WebACL`, but the `Rule` already exists in the specified `WebACL`. You tried to add a `ByteMatchTuple` to a `ByteMatchSet`, but the `ByteMatchTuple` already exists in the specified `WebACL`.
WAFInvalidParameterException	client	The operation failed because AWS WAF didn't recognize a parameter in the request. For example: You specified an invalid parameter name. You specified an invalid value. You tried to update an object (`ByteMatchSet`, `IPSet`, `Rule`, or `WebACL`) using an action other than `INSERT` or `DELETE`. You tried to create a `WebACL` with a `DefaultAction` `Type` other than `ALLOW`, `BLOCK`, or `COUNT`. You tried to create a `RateBasedRule` with a `RateKey` value other than `IP`. You tried to update a `WebACL` with a `WafAction` `Type` other than `ALLOW`, `BLOCK`, or `COUNT`. You tried to update a `ByteMatchSet` with a `FieldToMatch` `Type` other than HEADER, METHOD, QUERY_STRING, URI, or BODY. You tried to update a `ByteMatchSet` with a `Field` of `HEADER` but no value for `Data`. Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated.
WAFLimitsExceededException	client	The operation exceeds a resource limit, for example, the maximum number of `WebACL` objects that you can create for an AWS account. For more information, see Limits in the AWS WAF Developer Guide.
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: You tried to add a `Rule` to or delete a `Rule` from a `WebACL` that doesn't exist. You tried to add a `ByteMatchSet` to or delete a `ByteMatchSet` from a `Rule` that doesn't exist. You tried to add an IP address to or delete an IP address from an `IPSet` that doesn't exist. You tried to add a `ByteMatchTuple` to or delete a `ByteMatchTuple` from a `ByteMatchSet` that doesn't exist.
WAFNonexistentItemException	client	The operation failed because the referenced object doesn't exist.
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.

Getting Started

References

UpdateRuleGroupCommand

Example Syntax

UpdateRuleGroupCommand Input

UpdateRuleGroupCommand Output

Throws

Table of Contents

Search