Get Rate Based Rule

waf_get_rate_based_rule

R Documentation

This is AWS WAF Classic documentation¶

Description¶

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 the RateBasedRule that is specified by the RuleId that you included in the get_rate_based_rule request.

Usage¶

waf_get_rate_based_rule(RuleId)

Arguments¶

RuleId

[required] The RuleId of the RateBasedRule that you want to get. RuleId is returned by create_rate_based_rule and by list_rate_based_rules.

Value¶

A list with the following syntax:

list(
  Rule = list(
    RuleId = "string",
    Name = "string",
    MetricName = "string",
    MatchPredicates = list(
      list(
        Negated = TRUE|FALSE,
        Type = "IPMatch"|"ByteMatch"|"SqlInjectionMatch"|"GeoMatch"|"SizeConstraint"|"XssMatch"|"RegexMatch",
        DataId = "string"
      )
    ),
    RateKey = "IP",
    RateLimit = 123
  )
)

Request syntax¶

svc$get_rate_based_rule(
  RuleId = "string"
)