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
See also: AWS API Documentation
get-rate-based-rule --rule-id <value> [--cli-input-json | --cli-input-yaml] [--generate-cli-skeleton <value>] [--debug] [--endpoint-url <value>] [--no-verify-ssl] [--no-paginate] [--output <value>] [--query <value>] [--profile <value>] [--region <value>] [--version <value>] [--color <value>] [--no-sign-request] [--ca-bundle <value>] [--cli-read-timeout <value>] [--cli-connect-timeout <value>] [--cli-binary-format <value>] [--no-cli-pager] [--cli-auto-prompt] [--no-cli-auto-prompt]
RuleIdof the RateBasedRule that you want to get.
RuleIdis returned by CreateRateBasedRule and by ListRateBasedRules .
Reads arguments from the JSON string provided. The JSON string follows the format provided by
--generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value
input, prints a sample input JSON that can be used as an argument for
--cli-input-json. Similarly, if provided
yaml-input it will print a sample input YAML that can be used with
--cli-input-yaml. If provided with the value
output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
Turn on debug logging.
Override command’s default URL with the given URL.
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
Disable automatic pagination.
The formatting style for command output.
A JMESPath query to use in filtering the response data.
Use a specific profile from your credential file.
The region to use. Overrides config/env settings.
Display the version of this tool.
Turn on/off color output.
Do not sign requests. Credentials will not be loaded if this argument is provided.
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob
fileb:// will always be treated as binary and use the file contents directly regardless of the
cli-binary-format setting. When using
file:// the file contents will need to properly formatted for the configured
Disable cli pager for output.
Automatically prompt for CLI input parameters.
Disable automatically prompt for CLI input parameters.
Rule -> (structure)
Information about the RateBasedRule that you specified in the
RuleId -> (string)A unique identifier for a
RateBasedRule. You use
RuleIdto get more information about a
RateBasedRule(see GetRateBasedRule ), update a
RateBasedRule(see UpdateRateBasedRule ), insert a
WebACLor delete one from a
WebACL(see UpdateWebACL ), or delete a
RateBasedRulefrom AWS WAF (see DeleteRateBasedRule ).
Name -> (string)A friendly name or description for a
RateBasedRule. You can’t change the name of a
RateBasedRuleafter you create it.
MetricName -> (string)A friendly name or description for the metrics for a
RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can’t contain whitespace or metric names reserved for AWS WAF, including “All” and “Default_Action.” You can’t change the name of the metric after you create the
MatchPredicates -> (list)
Predicatesobject contains one
Predicateelement for each ByteMatchSet , IPSet , or SqlInjectionMatchSet object that you want to include in a
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.
Specifies the ByteMatchSet , IPSet , SqlInjectionMatchSet , XssMatchSet , RegexMatchSet , GeoMatchSet , and SizeConstraintSet objects that you want to add to a
Ruleand, for each object, indicates whether you want to negate the settings, for example, requests that do NOT originate from the IP address 192.0.2.44.
Negated -> (boolean)
Falseif you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet , IPSet , SqlInjectionMatchSet , XssMatchSet , RegexMatchSet , GeoMatchSet , or SizeConstraintSet . For example, if an
IPSetincludes the IP address
192.0.2.44, AWS WAF will allow or block requests based on that IP address.
Trueif you want AWS WAF to allow or block a request based on the negation of the settings in the ByteMatchSet , IPSet , SqlInjectionMatchSet , XssMatchSet , RegexMatchSet , GeoMatchSet , or SizeConstraintSet . For example, if an
IPSetincludes the IP address
192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses except
Type -> (string)The type of predicate in a
Rule, such as
DataId -> (string)A unique identifier for a predicate in a
Rule, such as
IPSetId. The ID is returned by the corresponding
RateKey -> (string)The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring. The only valid value for
IPindicates that requests arriving from the same IP address are subject to the
RateLimitthat is specified in the
RateLimit -> (long)The maximum number of requests, which have an identical value in the field specified by the
RateKey, allowed in a five-minute period. If the number of requests exceeds the
RateLimitand the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.