WAF / Paginator / GetRateBasedRuleManagedKeys

GetRateBasedRuleManagedKeys#

class WAF.Paginator.GetRateBasedRuleManagedKeys#
paginator = client.get_paginator('get_rate_based_rule_managed_keys')
paginate(**kwargs)#

Creates an iterator that will paginate through responses from WAF.Client.get_rate_based_rule_managed_keys().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    RuleId='string',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': '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.

  • PaginationConfig (dict) –

    A dictionary that provides parameters to control pagination.

    • MaxItems (integer) –

      The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

    • StartingToken (string) –

      A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • ManagedKeys (list) –

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

      • (string) –

    • NextToken (string) –

      A token to resume pagination.