WAFRegional / Client / list_rate_based_rules

list_rate_based_rules#

WAFRegional.Client.list_rate_based_rules(**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 RuleSummary objects.

See also: AWS API Documentation

Request Syntax

response = client.list_rate_based_rules(
    NextMarker='string',
    Limit=123
)
Parameters:

  • NextMarker (string) – If you specify a value for Limit and you have more Rules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of Rules. For the second and subsequent ListRateBasedRules requests, specify the value of NextMarker from the previous response to get information about another batch of Rules.

  • Limit (integer) – Specifies the number of Rules that you want AWS WAF to return for this request. If you have more Rules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

Return type:

dict

Returns:

Response Syntax

{
    'NextMarker': 'string',
    'Rules': [
        {
            'RuleId': 'string',
            'Name': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • NextMarker (string) –

      If you have more Rules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more Rules, submit another ListRateBasedRules request, and specify the NextMarker value from the response in the NextMarker value in the next request.

    • Rules (list) –

      An array of RuleSummary 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.

        Contains the identifier and the friendly name or description of the Rule.

        • RuleId (string) –

          A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

          RuleId is returned by CreateRule and by ListRules.

        • Name (string) –

          A friendly name or description of the Rule. You can’t change the name of a Rule after you create it.

Exceptions

  • WAFRegional.Client.exceptions.WAFInternalErrorException

  • WAFRegional.Client.exceptions.WAFInvalidAccountException