WAFRegional / Client / get_rate_based_rule_managed_keys

get_rate_based_rule_managed_keys#

WAFRegional.Client.get_rate_based_rule_managed_keys(**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 IP addresses currently being blocked by the RateBasedRule that is specified by the RuleId. The maximum number of managed keys that will be blocked is 10,000. If more than 10,000 addresses exceed the rate limit, the 10,000 addresses with the highest rates will be blocked.

See also: AWS API Documentation

Request Syntax

response = client.get_rate_based_rule_managed_keys(
    RuleId='string',
    NextMarker='string'
)
Parameters:

  • RuleId (string) –

    [REQUIRED]

    The RuleId of the RateBasedRule for which you want to get a list of ManagedKeys. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.

  • NextMarker (string) – A null value and not currently used. Do not include this in your request.

Return type:

dict

Returns:

Response Syntax

{
    'ManagedKeys': [
        'string',
    ],
    'NextMarker': 'string'
}

Response Structure

  • (dict) –

    • ManagedKeys (list) –

      An array of IP addresses that currently are blocked by the specified RateBasedRule.

      • (string) –

    • NextMarker (string) –

      A null value and not currently used.

Exceptions

  • WAFRegional.Client.exceptions.WAFInternalErrorException

  • WAFRegional.Client.exceptions.WAFInvalidAccountException

  • WAFRegional.Client.exceptions.WAFNonexistentItemException

  • WAFRegional.Client.exceptions.WAFInvalidParameterException