Get Rate Based Statement Managed Keys
wafv2_get_rate_based_statement_managed_keys | R Documentation |
Retrieves the IP addresses that are currently blocked by a rate-based rule instance¶
Description¶
Retrieves the IP addresses that are currently blocked by a rate-based rule instance. This is only available for rate-based rules that aggregate solely on the IP address or on the forwarded IP address.
The maximum number of addresses that can be blocked for a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked.
For a rate-based rule that you've defined inside a rule group, provide the name of the rule group reference statement in your request, in addition to the rate-based rule name and the web ACL name.
WAF monitors web requests and manages keys independently for each unique combination of web ACL, optional rule group, and rate-based rule. For example, if you define a rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF monitors web requests and manages keys for that web ACL, rule group reference statement, and rate-based rule instance. If you use the same rule group in a second web ACL, WAF monitors web requests and manages keys for this second usage completely independent of your first.
Usage¶
wafv2_get_rate_based_statement_managed_keys(Scope, WebACLName, WebACLId,
RuleGroupRuleName, RuleName)
Arguments¶
Scope |
[required] Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
|
WebACLName |
[required] The name of the web ACL. You cannot change the name of a web ACL after you create it. |
WebACLId |
[required] The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. |
RuleGroupRuleName |
The name of the rule group reference statement in your web ACL. This is required only when you have the rate-based rule nested inside a rule group. |
RuleName |
[required] The name of the rate-based rule to get the keys for.
If you have the rule defined inside a rule group that you're using in
your web ACL, also provide the name of the rule group reference
statement in the request parameter
|
Value¶
A list with the following syntax:
list(
ManagedKeysIPV4 = list(
IPAddressVersion = "IPV4"|"IPV6",
Addresses = list(
"string"
)
),
ManagedKeysIPV6 = list(
IPAddressVersion = "IPV4"|"IPV6",
Addresses = list(
"string"
)
)
)
Request syntax¶
svc$get_rate_based_statement_managed_keys(
Scope = "CLOUDFRONT"|"REGIONAL",
WebACLName = "string",
WebACLId = "string",
RuleGroupRuleName = "string",
RuleName = "string"
)