API Reference


Creates a RuleGroup. A rule group is a collection of predefined rules that you add to a web ACL. You use UpdateRuleGroup to add rules to the rule group.

Rule groups are subject to the following limits:

  • Three rule groups per account. You can request an increase to this limit by contacting customer support.

  • One rule group per web ACL.

  • Ten rules per rule group.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Request Syntax

{ "ChangeToken": "string", "MetricName": "string", "Name": "string", "Tags": [ { "Key": "string", "Value": "string" } ] }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.


The value returned by the most recent call to GetChangeToken.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes


A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RuleGroup.

Type: String

Required: Yes


A friendly name or description of the RuleGroup. You can't change Name after you create a RuleGroup.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Required: Yes


Type: Array of Tag objects

Array Members: Minimum number of 1 item.

Required: No

Response Syntax

{ "ChangeToken": "string", "RuleGroup": { "MetricName": "string", "Name": "string", "RuleGroupId": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


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

Type: String

Length Constraints: Minimum length of 1.


An empty RuleGroup.

Type: RuleGroup object


For information about the errors that are common to all actions, see Common Errors.


HTTP Status Code: 400


The name specified is invalid.

HTTP Status Code: 400


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

HTTP Status Code: 500


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.

HTTP Status Code: 400


The operation failed because you tried to create, update, or delete an object by using a change token that has already been used.

HTTP Status Code: 400


HTTP Status Code: 400


HTTP Status Code: 500

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: