Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListActivatedRulesInRuleGroup

Note

AWS WAF Classic support will end on September 30, 2025.

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.

Returns an array of ActivatedRule objects.

Request Syntax


{
   "Limit": number,
   "NextMarker": "string",
   "RuleGroupId": "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.

Limit

Specifies the number of ActivatedRules that you want AWS WAF to return for this request. If you have more ActivatedRules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of ActivatedRules.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 100.

Required: No

NextMarker

If you specify a value for Limit and you have more ActivatedRules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ActivatedRules. For the second and subsequent ListActivatedRulesInRuleGroup requests, specify the value of NextMarker from the previous response to get information about another batch of ActivatedRules.

Type: String

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

Pattern: .*\S.*

Required: No

RuleGroupId

The RuleGroupId of the RuleGroup for which you want to get a list of ActivatedRule objects.

Type: String

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

Pattern: .*\S.*

Required: No

Response Syntax


{
   "ActivatedRules": [ 
      { 
         "Action": { 
            "Type": "string"
         },
         "ExcludedRules": [ 
            { 
               "RuleId": "string"
            }
         ],
         "OverrideAction": { 
            "Type": "string"
         },
         "Priority": number,
         "RuleId": "string",
         "Type": "string"
      }
   ],
   "NextMarker": "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.

ActivatedRules

An array of ActivatedRules objects.

Type: Array of ActivatedRule objects

NextMarker

If you have more ActivatedRules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more ActivatedRules, submit another ListActivatedRulesInRuleGroup request, and specify the NextMarker value from the response in the NextMarker value in the next request.

Type: String

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

Pattern: .*\S.*

Errors

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

WAFInternalErrorException

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

HTTP Status Code: 500

WAFInvalidParameterException

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.

HTTP Status Code: 400

WAFNonexistentItemException

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

HTTP Status Code: 400