WAF / Client / list_subscribed_rule_groups
list_subscribed_rule_groups#
- WAF.Client.list_subscribed_rule_groups(**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 an array of RuleGroup objects that you are subscribed to.
See also: AWS API Documentation
Request Syntax
response = client.list_subscribed_rule_groups( NextMarker='string', Limit=123 )
- Parameters:
NextMarker (string) – If you specify a value for
Limit
and you have moreByteMatchSets``subscribed rule groups than the value of ``Limit
, AWS WAF returns aNextMarker
value in the response that allows you to list another group of subscribed rule groups. For the second and subsequentListSubscribedRuleGroupsRequest
requests, specify the value ofNextMarker
from the previous response to get information about another batch of subscribed rule groups.Limit (integer) – Specifies the number of subscribed rule groups that you want AWS WAF to return for this request. If you have more objects than the number you specify for
Limit
, the response includes aNextMarker
value that you can use to get another batch of objects.
- Return type:
dict
- Returns:
Response Syntax
{ 'NextMarker': 'string', 'RuleGroups': [ { 'RuleGroupId': 'string', 'Name': 'string', 'MetricName': 'string' }, ] }
Response Structure
(dict) –
NextMarker (string) –
If you have more objects than the number that you specified for
Limit
in the request, the response includes aNextMarker
value. To list more objects, submit anotherListSubscribedRuleGroups
request, and specify theNextMarker
value from the response in theNextMarker
value in the next request.RuleGroups (list) –
An array of RuleGroup objects.
(dict) –
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.
A summary of the rule groups you are subscribed to.
RuleGroupId (string) –
A unique identifier for a
RuleGroup
.Name (string) –
A friendly name or description of the
RuleGroup
. You can’t change the name of aRuleGroup
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 theRuleGroup
.
Exceptions
WAF.Client.exceptions.WAFNonexistentItemException
WAF.Client.exceptions.WAFInternalErrorException