WAF / Client / get_rule_group

get_rule_group#

WAF.Client.get_rule_group(**kwargs)#

Note

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 the RuleGroup that is specified by the RuleGroupId that you included in the GetRuleGroup request.

To view the rules in a rule group, use ListActivatedRulesInRuleGroup.

See also: AWS API Documentation

Request Syntax

response = client.get_rule_group(
    RuleGroupId='string'
)
Parameters:

RuleGroupId (string) –

[REQUIRED]

The RuleGroupId of the RuleGroup that you want to get. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

Return type:

dict

Returns:

Response Syntax

{
    'RuleGroup': {
        'RuleGroupId': 'string',
        'Name': 'string',
        'MetricName': 'string'
    }
}

Response Structure

  • (dict) –

    • RuleGroup (dict) –

      Information about the RuleGroup that you specified in the GetRuleGroup request.

      • RuleGroupId (string) –

        A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).

        RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

      • Name (string) –

        The friendly name or description for the RuleGroup. You can’t change the name of a RuleGroup after you create it.

      • MetricName (string) –

        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.

Exceptions