Split (1)

train · 107k rows

id stringlengths 8 78	source stringclasses 743 values	chunk_id int64 1 5.05k	text stringlengths 593 49.7k
waf-apiref-258	waf-apiref.pdf	258	base64-encoded version of the value. The maximum length of the value before you base64-encode it is 200 bytes. For example, suppose the value of Type is HEADER and the value of Data is User-Agent. If you want to search the User-Agent header for the value BadBot, you base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90, in the value of SearchString. If you're using the AWS CLI or one of the AWS SDKs The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value. Type: Base64-encoded binary data object Required: Yes TextTransformations Text transformations eliminate some of the unusual formatting that attackers use in web requests in an eﬀort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the speciﬁed content, starting from the lowest priority setting, and then uses the transformed component contents. Type: Array of TextTransformation objects Array Members: Minimum number of 1 item. Required: Yes ByteMatchStatement 1262 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ByteMatchStatement 1263 AWS WAFV2 CaptchaAction Service: AWS WAFV2 API Reference Speciﬁes that AWS WAF should run a CAPTCHA check against the request: • If the request includes a valid, unexpired CAPTCHA token, AWS WAF applies any custom request handling and labels that you've conﬁgured and then allows the web request inspection to proceed to the next rule, similar to a CountAction. • If the request doesn't include a valid, unexpired token, AWS WAF discontinues the web ACL evaluation of the request and blocks it from going to its intended destination. AWS WAF generates a response that it sends back to the client, which includes the following: • The header x-amzn-waf-action with a value of captcha. • The HTTP status code 405 Method Not Allowed. • If the request contains an Accept header with a value of text/html, the response includes a CAPTCHA JavaScript page interstitial. You can conﬁgure the expiration time in the CaptchaConfig ImmunityTimeProperty setting at the rule and web ACL level. The rule setting overrides the web ACL setting. This action option is available for rules. It isn't available for web ACL default actions. Contents CustomRequestHandling Deﬁnes custom handling for the web request, used when the CAPTCHA inspection determines that the request's token is valid and unexpired. For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide. Type: CustomRequestHandling object Required: No CaptchaAction 1264 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CaptchaAction 1265 AWS WAFV2 CaptchaConﬁg Service: AWS WAFV2 API Reference Speciﬁes how AWS WAF should handle CAPTCHA evaluations. This is available at the web ACL level and in each rule. Contents ImmunityTimeProperty Determines how long a CAPTCHA timestamp in the token remains valid after the client successfully solves a CAPTCHA puzzle. Type: ImmunityTimeProperty object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CaptchaConﬁg 1266 AWS WAFV2 CaptchaResponse Service: AWS WAFV2 API Reference The result from the inspection of the web request for a valid CAPTCHA token. Contents FailureReason The reason for failure, populated when the evaluation of the token fails. Type: String Valid Values: TOKEN_MISSING \| TOKEN_EXPIRED \| TOKEN_INVALID \| TOKEN_DOMAIN_MISMATCH Required: No ResponseCode The HTTP response code indicating the status of the CAPTCHA token in the web request. If the token is missing, invalid, or expired, this code is 405 Method Not Allowed. Type: Integer Required: No SolveTimestamp The time that the CAPTCHA was last solved for the supplied token. Type: Long Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 CaptchaResponse 1267 AWS WAFV2 • AWS SDK for Ruby V3 API Reference CaptchaResponse 1268 AWS WAFV2 ChallengeAction Service: AWS WAFV2 API Reference Speciﬁes that AWS WAF should run a Challenge check against the request to verify that the request is coming from a legitimate client session: • If the request includes a valid, unexpired
waf-apiref-259	waf-apiref.pdf	259	The time that the CAPTCHA was last solved for the supplied token. Type: Long Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 CaptchaResponse 1267 AWS WAFV2 • AWS SDK for Ruby V3 API Reference CaptchaResponse 1268 AWS WAFV2 ChallengeAction Service: AWS WAFV2 API Reference Speciﬁes that AWS WAF should run a Challenge check against the request to verify that the request is coming from a legitimate client session: • If the request includes a valid, unexpired challenge token, AWS WAF applies any custom request handling and labels that you've conﬁgured and then allows the web request inspection to proceed to the next rule, similar to a CountAction. • If the request doesn't include a valid, unexpired challenge token, AWS WAF discontinues the web ACL evaluation of the request and blocks it from going to its intended destination. AWS WAF then generates a challenge response that it sends back to the client, which includes the following: • The header x-amzn-waf-action with a value of challenge. • The HTTP status code 202 Request Accepted. • If the request contains an Accept header with a value of text/html, the response includes a JavaScript page interstitial with a challenge script. Challenges run silent browser interrogations in the background, and don't generally aﬀect the end user experience. A challenge enforces token acquisition using an interstitial JavaScript challenge that inspects the client session for legitimate behavior. The challenge blocks bots or at least increases the cost of operating sophisticated bots. After the client session successfully responds to the challenge, it receives a new token from AWS WAF, which the challenge script uses to resubmit the original request. You can conﬁgure the expiration time in the ChallengeConfig ImmunityTimeProperty setting at the rule and web ACL level. The rule setting overrides the web ACL setting. This action option is available for rules. It isn't available for web ACL default actions. ChallengeAction 1269 AWS WAFV2 Contents CustomRequestHandling API Reference Deﬁnes custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired. For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide. Type: CustomRequestHandling object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ChallengeAction 1270 AWS WAFV2 ChallengeConﬁg Service: AWS WAFV2 API Reference Speciﬁes how AWS WAF should handle Challenge evaluations. This is available at the web ACL level and in each rule. Contents ImmunityTimeProperty Determines how long a challenge timestamp in the token remains valid after the client successfully responds to a challenge. Type: ImmunityTimeProperty object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ChallengeConﬁg 1271 AWS WAFV2 ChallengeResponse Service: AWS WAFV2 API Reference The result from the inspection of the web request for a valid challenge token. Contents FailureReason The reason for failure, populated when the evaluation of the token fails. Type: String Valid Values: TOKEN_MISSING \| TOKEN_EXPIRED \| TOKEN_INVALID \| TOKEN_DOMAIN_MISMATCH Required: No ResponseCode The HTTP response code indicating the status of the challenge token in the web request. If the token is missing, invalid, or expired, this code is 202 Request Accepted. Type: Integer Required: No SolveTimestamp The time that the challenge was last solved for the supplied token. Type: Long Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 ChallengeResponse 1272 AWS WAFV2 • AWS SDK for Ruby V3 API Reference ChallengeResponse 1273 AWS WAFV2 Condition Service: AWS WAFV2 A single match condition for a Filter. Contents ActionCondition API Reference A single action condition. This is the action setting that a log record must contain in order to meet the condition. Type: ActionCondition object Required: No LabelNameCondition A single label name condition. This is the fully qualiﬁed label name that a log record must contain in order to meet the condition. Fully qualiﬁed labels have a preﬁx, optional namespaces, and label name. The preﬁx identiﬁes the rule group or web ACL context of the rule that added the label. Type: LabelNameCondition object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS
waf-apiref-260	waf-apiref.pdf	260	order to meet the condition. Type: ActionCondition object Required: No LabelNameCondition A single label name condition. This is the fully qualiﬁed label name that a log record must contain in order to meet the condition. Fully qualiﬁed labels have a preﬁx, optional namespaces, and label name. The preﬁx identiﬁes the rule group or web ACL context of the rule that added the label. Type: LabelNameCondition object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Condition 1274 AWS WAFV2 CookieMatchPattern Service: AWS WAFV2 API Reference The ﬁlter to use to identify the subset of cookies to inspect in a web request. You must specify exactly one setting: either All, IncludedCookies, or ExcludedCookies. Example JSON: "MatchPattern": { "IncludedCookies": [ "session-id-time", "session-id" ] } Contents All Inspect all cookies. Type: All object Required: No ExcludedCookies Inspect only the cookies whose keys don't match any of the strings speciﬁed here. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 199 items. Length Constraints: Minimum length of 1. Maximum length of 60. Pattern: .\S. Required: No IncludedCookies Inspect only the cookies that have a key that matches one of the strings speciﬁed here. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 199 items. Length Constraints: Minimum length of 1. Maximum length of 60. Pattern: .\S. CookieMatchPattern 1275 AWS WAFV2 Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CookieMatchPattern 1276 AWS WAFV2 Cookies Service: AWS WAFV2 API Reference Inspect the cookies in the web request. You can specify the parts of the cookies to inspect and you can narrow the set of cookies to inspect by including or excluding speciﬁc keys. This is used to indicate the web request component to inspect, in the FieldToMatch speciﬁcation. Example JSON: "Cookies": { "MatchPattern": { "All": {} }, "MatchScope": "KEY", "OversizeHandling": "MATCH" } Contents MatchPattern The ﬁlter to use to identify the subset of cookies to inspect in a web request. You must specify exactly one setting: either All, IncludedCookies, or ExcludedCookies. Example JSON: "MatchPattern": { "IncludedCookies": [ "session-id-time", "session-id" ] } Type: CookieMatchPattern object Required: Yes MatchScope The parts of the cookies to inspect with the rule inspection criteria. If you specify ALL, AWS WAF inspects both keys and values. All does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical AND statement to combine two match rules, one that inspects the keys and another that inspects the values. Type: String Valid Values: ALL \| KEY \| VALUE Required: Yes Cookies 1277 AWS WAFV2 OversizeHandling API Reference What AWS WAF should do if the cookies of the request are more numerous or larger than AWS WAF can inspect. AWS WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to AWS WAF. The options for oversize handling are the following: • CONTINUE - Inspect the available cookies normally, according to the rule inspection criteria. • MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request. • NO_MATCH - Treat the web request as not matching the rule statement. Type: String Valid Values: CONTINUE \| MATCH \| NO_MATCH Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Cookies 1278 AWS WAFV2 CountAction Service: AWS WAFV2 API Reference Speciﬁes that AWS WAF should count the request. Optionally deﬁnes additional custom handling for the request. This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction. Contents CustomRequestHandling Deﬁnes custom handling for the web request. For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide. Type: CustomRequestHandling object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for
waf-apiref-261	waf-apiref.pdf	261	that AWS WAF should count the request. Optionally deﬁnes additional custom handling for the request. This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction. Contents CustomRequestHandling Deﬁnes custom handling for the web request. For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide. Type: CustomRequestHandling object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CountAction 1279 AWS WAFV2 CustomHTTPHeader Service: AWS WAFV2 API Reference A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling. Contents Name The name of the custom header. For custom request header insertion, when AWS WAF inserts the header into the request, it preﬁxes this name x-amzn-waf-, to avoid confusion with the headers that are already in the request. For example, for the header name sample, AWS WAF inserts the header x-amzn-waf- sample. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^[a-zA-Z0-9._$-]+$ Required: Yes Value The value of the custom header. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: .* Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: CustomHTTPHeader 1280 AWS WAFV2 • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference CustomHTTPHeader 1281 AWS WAFV2 API Reference CustomRequestHandling Service: AWS WAFV2 Custom request handling behavior that inserts custom headers into a web request. You can add custom request handling for AWS WAF to use when the rule action doesn't block the request. For example, CaptchaAction for requests with valid t okens, and AllowAction. For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide. Contents InsertHeaders The HTTP headers to insert into the request. Duplicate header names are not allowed. For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide. Type: Array of CustomHTTPHeader objects Array Members: Minimum number of 1 item. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CustomRequestHandling 1282 AWS WAFV2 CustomResponse Service: AWS WAFV2 API Reference A custom response to send to the client. You can deﬁne a custom response for rule actions and default web ACL actions that are set to BlockAction. For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide. Contents ResponseCode The HTTP status code to return to the client. For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the AWS WAF Developer Guide. Type: Integer Valid Range: Minimum value of 200. Maximum value of 599. Required: Yes CustomResponseBodyKey References the response body that you want AWS WAF to return to the web request client. You can deﬁne a custom response for a rule action or a default web ACL action that is set to block. To do this, you ﬁrst deﬁne the response body key and value in the CustomResponseBodies setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL default action BlockAction setting, you reference the response body using this key. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: No ResponseHeaders The HTTP headers to use in the response. You can specify any header name except for content-type. Duplicate header names are not allowed. CustomResponse 1283 AWS WAFV2 API Reference For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide. Type: Array of CustomHTTPHeader objects Array Members: Minimum number of 1 item. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CustomResponse 1284 AWS WAFV2 CustomResponseBody Service: AWS WAFV2 API Reference The response body to use in a custom response to a web request. This is referenced by key from CustomResponse CustomResponseBodyKey. Contents Content The payload of the custom response. You can use JSON escape strings in JSON content.
waf-apiref-262	waf-apiref.pdf	262	Developer Guide. Type: Array of CustomHTTPHeader objects Array Members: Minimum number of 1 item. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 CustomResponse 1284 AWS WAFV2 CustomResponseBody Service: AWS WAFV2 API Reference The response body to use in a custom response to a web request. This is referenced by key from CustomResponse CustomResponseBodyKey. Contents Content The payload of the custom response. You can use JSON escape strings in JSON content. To do this, you must specify JSON content in the ContentType setting. For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide. Type: String Length Constraints: Minimum length of 1. Maximum length of 10240. Pattern: [\s\S]* Required: Yes ContentType The type of content in the payload that you are deﬁning in the Content string. Type: String Valid Values: TEXT_PLAIN \| TEXT_HTML \| APPLICATION_JSON Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ CustomResponseBody 1285 AWS WAFV2 • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference CustomResponseBody 1286 AWS WAFV2 DataProtection Service: AWS WAFV2 API Reference Speciﬁes the protection behavior for a ﬁeld type. This is part of the data protection conﬁguration for a web ACL. Contents Action Speciﬁes how to protect the ﬁeld. AWS WAF can apply a one-way hash to the ﬁeld or hard code a string substitution. • One-way hash example: ade099751dEXAMPLEHASH2ea9f3393f80dd5d3bEXAMPLEHASH966ae0d3cd5a1e • Substitution example: REDACTED Type: String Valid Values: SUBSTITUTION \| HASH Required: Yes Field Speciﬁes the ﬁeld type and optional keys to apply the protection behavior to. Type: FieldToProtect object Required: Yes ExcludeRateBasedDetails Speciﬁes whether to also exclude any rate-based rule details from the data protection you have enabled for a given ﬁeld. If you specify this exception, RateBasedDetails will show the value of the ﬁeld. For additional information, see the log ﬁeld rateBasedRuleList at Log ﬁelds for web ACL traﬃc in the AWS WAF Developer Guide. Default: FALSE Type: Boolean Required: No DataProtection 1287 AWS WAFV2 ExcludeRuleMatchDetails API Reference Speciﬁes whether to also exclude any rule match details from the data protection you have enabled for a given ﬁeld. AWS WAF logs these details for non-terminating matching rules and for the terminating matching rule. For additional information, see Log ﬁelds for web ACL traﬃc in the AWS WAF Developer Guide. Default: FALSE Type: Boolean Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DataProtection 1288 AWS WAFV2 DataProtectionConﬁg Service: AWS WAFV2 API Reference Speciﬁes data protection to apply to the web request data for the web ACL. This is a web ACL level data protection option. The data protection that you conﬁgure for the web ACL alters the data that's available for any other data collection activity, including your AWS WAF logging destinations, web ACL request sampling, and Amazon Security Lake data collection and management. Your other option for data protection is in the logging conﬁguration, which only aﬀects logging. This is part of the data protection conﬁguration for a web ACL. Contents DataProtections An array of data protection conﬁgurations for speciﬁc web request ﬁeld types. This is deﬁned for each web ACL. AWS WAF applies the speciﬁed protection to all web requests that the web ACL inspects. Type: Array of DataProtection objects Array Members: Minimum number of 1 item. Maximum number of 26 items. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DataProtectionConﬁg 1289 AWS WAFV2 DefaultAction Service: AWS WAFV2 API Reference In a WebACL, this is the action that you want AWS WAF to perform when a web request doesn't match any of the rules in the WebACL. The default action must be a terminating action. Contents Allow Speciﬁes that AWS WAF should allow requests by default. Type: AllowAction object Required: No Block Speciﬁes that AWS WAF should block requests by default. Type: BlockAction object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DefaultAction 1290 AWS WAFV2 EmailField Service: AWS WAFV2 API Reference The name of the ﬁeld in the request payload that contains your customer's email.
waf-apiref-263	waf-apiref.pdf	263	WebACL. The default action must be a terminating action. Contents Allow Speciﬁes that AWS WAF should allow requests by default. Type: AllowAction object Required: No Block Speciﬁes that AWS WAF should block requests by default. Type: BlockAction object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DefaultAction 1290 AWS WAFV2 EmailField Service: AWS WAFV2 API Reference The name of the ﬁeld in the request payload that contains your customer's email. This data type is used in the RequestInspectionACFP data type. Contents Identiﬁer The name of the email ﬁeld. How you specify this depends on the request inspection payload type. • For JSON payloads, specify the ﬁeld name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer. For example, for the JSON payload { "form": { "email": "THE_EMAIL" } }, the email ﬁeld speciﬁcation is /form/email. • For form encoded payload types, use the HTML form names. For example, for an HTML form with the input element named email1, the email ﬁeld speciﬁcation is email1. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: .\S. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 EmailField 1291 AWS WAFV2 • AWS SDK for Ruby V3 API Reference EmailField 1292 AWS WAFV2 ExcludedRule Service: AWS WAFV2 API Reference Speciﬁes a single rule in a rule group whose action you want to override to Count. Note Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including Count. Contents Name The name of the rule whose action you want to override to Count. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ExcludedRule 1293 AWS WAFV2 FieldToMatch Service: AWS WAFV2 API Reference Speciﬁes a web request component to be used in a rule match statement or in a logging conﬁguration. • In a rule statement, this is the part of the web request that you want AWS WAF to inspect. Include the single FieldToMatch type that you want to inspect, with additional speciﬁcations as needed, according to the type. You specify a single request component in FieldToMatch for each rule statement that requires it. To inspect more than one component of the web request, create a separate rule statement for each component. Example JSON for a QueryString ﬁeld to match: "FieldToMatch": { "QueryString": {} } Example JSON for a Method ﬁeld to match speciﬁcation: "FieldToMatch": { "Method": { "Name": "DELETE" } } • In a logging conﬁguration, this is used in the RedactedFields property to specify a ﬁeld to redact from the logging records. For this use case, note the following: • Even though all FieldToMatch settings are available, the only valid settings for ﬁeld redaction are UriPath, QueryString, SingleHeader, and Method. • In this documentation, the descriptions of the individual ﬁelds talk about specifying the web request component to inspect, but for ﬁeld redaction, you are specifying the component type to redact from the logs. • If you have request sampling enabled, the redacted ﬁelds conﬁguration for logging has no impact on sampling. You can only exclude ﬁelds from request sampling by disabling sampling in the web ACL visibility conﬁguration or by conﬁguring data protection for the web ACL. Contents AllQueryArguments Inspect all query arguments. Type: AllQueryArguments object Required: No FieldToMatch 1294 AWS WAFV2 Body API Reference Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection. • For Application Load Balancer and AWS AppSync, the limit is ﬁxed at 8 KB (8,192 bytes). • For CloudFront, API Gateway, Amazon Cognito, App Runner, and Veriﬁed Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web
waf-apiref-264	waf-apiref.pdf	264	does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection. • For Application Load Balancer and AWS AppSync, the limit is ﬁxed at 8 KB (8,192 bytes). • For CloudFront, API Gateway, Amazon Cognito, App Runner, and Veriﬁed Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig, for additional processing fees. • For AWS Amplify, use the CloudFront limit. For information about how to handle oversized request bodies, see the Body object conﬁguration. Type: Body object Required: No Cookies Inspect the request cookies. You must conﬁgure scope and pattern matching ﬁlters in the Cookies object, to deﬁne the set of cookies and the parts of the cookies that AWS WAF inspects. Only the ﬁrst 8 KB (8192 bytes) of a request's cookies and only the ﬁrst 200 cookies are forwarded to AWS WAF for inspection by the underlying host service. You must conﬁgure how to handle any oversize cookie content in the Cookies object. AWS WAF applies the pattern matching ﬁlters to the cookies that it receives from the underlying host service. Type: Cookies object Required: No HeaderOrder Inspect a string containing the list of the request's header names, ordered as they appear in the web request that AWS WAF receives for inspection. AWS WAF generates the string and FieldToMatch 1295 AWS WAFV2 API Reference then uses that as the ﬁeld to match component in its inspection. AWS WAF separates the header names in the string using colons and no added spaces, for example host:user- agent:accept:authorization:referer. Type: HeaderOrder object Required: No Headers Inspect the request headers. You must conﬁgure scope and pattern matching ﬁlters in the Headers object, to deﬁne the set of headers to and the parts of the headers that AWS WAF inspects. Only the ﬁrst 8 KB (8192 bytes) of a request's headers and only the ﬁrst 200 headers are forwarded to AWS WAF for inspection by the underlying host service. You must conﬁgure how to handle any oversize header content in the Headers object. AWS WAF applies the pattern matching ﬁlters to the headers that it receives from the underlying host service. Type: Headers object Required: No JA3Fingerprint Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA3 ﬁngerprint. The JA3 ﬁngerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This ﬁngerprint serves as a unique identiﬁer for the client's TLS conﬁguration. AWS WAF calculates and logs this ﬁngerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information. Note You can use this choice only with a string match ByteMatchStatement with the PositionalConstraint set to EXACTLY. You can obtain the JA3 ﬁngerprint for client requests from the web ACL logs. If AWS WAF is able to calculate the ﬁngerprint, it includes it in the logs. For information about the logging ﬁelds, see Log ﬁelds in the AWS WAF Developer Guide. FieldToMatch 1296 AWS WAFV2 API Reference Provide the JA3 ﬁngerprint string from the logs in your string match statement speciﬁcation, to match with any future requests that have the same TLS conﬁguration. Type: JA3Fingerprint object Required: No JA4Fingerprint Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA4 ﬁngerprint. The JA4 ﬁngerprint is a 36-character hash derived from the TLS Client Hello of an incoming request. This ﬁngerprint serves as a unique identiﬁer for the client's TLS conﬁguration. AWS WAF calculates and logs this ﬁngerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information. Note You can use this choice only with a string match ByteMatchStatement with the PositionalConstraint set to EXACTLY. You can obtain the JA4 ﬁngerprint for client requests from the web ACL logs. If AWS WAF is able to calculate the ﬁngerprint, it includes it in the logs. For information about the logging ﬁelds, see Log ﬁelds in the AWS WAF Developer Guide. Provide the JA4 ﬁngerprint string from the logs in your string match statement speciﬁcation, to match with any future requests that have the same TLS conﬁguration. Type: JA4Fingerprint object Required: No JsonBody Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. AWS WAF does not support inspecting the
waf-apiref-265	waf-apiref.pdf	265	For information about the logging ﬁelds, see Log ﬁelds in the AWS WAF Developer Guide. Provide the JA4 ﬁngerprint string from the logs in your string match statement speciﬁcation, to match with any future requests that have the same TLS conﬁguration. Type: JA4Fingerprint object Required: No JsonBody Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the FieldToMatch 1297 AWS WAFV2 API Reference underlying host service only forwards the contents that are within the limit to AWS WAF for inspection. • For Application Load Balancer and AWS AppSync, the limit is ﬁxed at 8 KB (8,192 bytes). • For CloudFront, API Gateway, Amazon Cognito, App Runner, and Veriﬁed Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig, for additional processing fees. • For AWS Amplify, use the CloudFront limit. For information about how to handle oversized request bodies, see the JsonBody object conﬁguration. Type: JsonBody object Required: No Method Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform. Type: Method object Required: No QueryString Inspect the query string. This is the part of a URL that appears after a ? character, if any. Type: QueryString object Required: No SingleHeader Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive. Example JSON: "SingleHeader": { "Name": "haystack" } Alternately, you can ﬁlter and inspect all headers with the Headers FieldToMatch setting. Type: SingleHeader object Required: No FieldToMatch 1298 AWS WAFV2 SingleQueryArgument API Reference Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive. Example JSON: "SingleQueryArgument": { "Name": "myArgument" } Type: SingleQueryArgument object Required: No UriFragment Inspect fragments of the request URI. You must conﬁgure scope and pattern matching ﬁlters in the UriFragment object, to deﬁne the fragment of a URI that AWS WAF inspects. Only the ﬁrst 8 KB (8192 bytes) of a request's URI fragments and only the ﬁrst 200 URI fragments are forwarded to AWS WAF for inspection by the underlying host service. You must conﬁgure how to handle any oversize URI fragment content in the UriFragment object. AWS WAF applies the pattern matching ﬁlters to the cookies that it receives from the underlying host service. Type: UriFragment object Required: No UriPath Inspect the request URI path. This is the part of the web request that identiﬁes a resource, for example, /images/daily-ad.jpg. Type: UriPath object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 FieldToMatch 1299 AWS WAFV2 • AWS SDK for Ruby V3 API Reference FieldToMatch 1300 AWS WAFV2 FieldToProtect Service: AWS WAFV2 API Reference Speciﬁes a ﬁeld type and keys to protect in stored web request data. This is part of the data protection conﬁguration for a web ACL. Contents FieldType Speciﬁes the web request component type to protect. Type: String Valid Values: SINGLE_HEADER \| SINGLE_COOKIE \| SINGLE_QUERY_ARGUMENT \| QUERY_STRING \| BODY Required: Yes FieldKeys Speciﬁes the keys to protect for the speciﬁed ﬁeld type. If you don't specify any key, then all keys for the ﬁeld type are protected. Type: Array of strings Array Members: Maximum number of 100 items. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: .\S. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 FieldToProtect 1301 AWS WAFV2 • AWS SDK for Ruby V3 API Reference FieldToProtect 1302 API Reference AWS WAFV2 Filter Service: AWS WAFV2 A single logging ﬁlter, used in LoggingFilter. Contents Behavior How to handle logs that satisfy the ﬁlter's conditions and requirement. Type: String Valid Values: KEEP \| DROP Required: Yes Conditions Match conditions for the ﬁlter. Type: Array of Condition objects Array Members: Minimum number of 1 item. Required: Yes Requirement Logic to apply to the ﬁltering conditions. You can specify that, in order to satisfy the ﬁlter, a log must match all conditions or must match at least one condition. Type: String Valid Values: MEETS_ALL \|
waf-apiref-266	waf-apiref.pdf	266	Ruby V3 API Reference FieldToProtect 1302 API Reference AWS WAFV2 Filter Service: AWS WAFV2 A single logging ﬁlter, used in LoggingFilter. Contents Behavior How to handle logs that satisfy the ﬁlter's conditions and requirement. Type: String Valid Values: KEEP \| DROP Required: Yes Conditions Match conditions for the ﬁlter. Type: Array of Condition objects Array Members: Minimum number of 1 item. Required: Yes Requirement Logic to apply to the ﬁltering conditions. You can specify that, in order to satisfy the ﬁlter, a log must match all conditions or must match at least one condition. Type: String Valid Values: MEETS_ALL \| MEETS_ANY Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Filter 1303 AWS WAFV2 • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference Filter 1304 AWS WAFV2 API Reference FirewallManagerRuleGroup Service: AWS WAFV2 A rule group that's deﬁned for an AWS Firewall Manager AWS WAF policy. Contents FirewallManagerStatement The processing guidance for an AWS Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference. Type: FirewallManagerStatement object Required: Yes Name The name of the rule group. You cannot change the name of a rule group after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: Yes OverrideAction The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only. You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement. Note This option is usually set to none. It does not aﬀect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings. FirewallManagerRuleGroup 1305 AWS WAFV2 Type: OverrideAction object Required: Yes Priority API Reference If you deﬁne more than one rule group in the ﬁrst or last Firewall Manager rule groups, AWS WAF evaluates each request against the rule groups in order, starting from the lowest priority setting. The priorities don't need to be consecutive, but they must all be diﬀerent. Type: Integer Valid Range: Minimum value of 0. Required: Yes VisibilityConﬁg Deﬁnes and enables Amazon CloudWatch metrics and web request sample collection. Type: VisibilityConﬁg object Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 FirewallManagerRuleGroup 1306 AWS WAFV2 API Reference FirewallManagerStatement Service: AWS WAFV2 The processing guidance for an AWS Firewall Manager rule. This is like a regular rule Statement, but it can only contain a single rule group reference. Contents ManagedRuleGroupStatement A statement used by AWS Firewall Manager to run the rules that are deﬁned in a managed rule group. This is managed by Firewall Manager for an AWS Firewall Manager AWS WAF policy. Type: ManagedRuleGroupStatement object Required: No RuleGroupReferenceStatement A statement used by AWS Firewall Manager to run the rules that are deﬁned in a rule group. This is managed by Firewall Manager for an AWS Firewall Manager AWS WAF policy. Type: RuleGroupReferenceStatement object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 FirewallManagerStatement 1307 AWS WAFV2 ForwardedIPConﬁg Service: AWS WAFV2 API Reference The conﬁguration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name. Note If the speciﬁed header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all. This conﬁguration is used for GeoMatchStatement and RateBasedStatement. For IPSetReferenceStatement, use IPSetForwardedIPConﬁg instead. AWS WAF only evaluates the ﬁrst IP address found in the speciﬁed HTTP header. Contents FallbackBehavior The match status to assign to the web request if the request doesn't have a valid IP address in the speciﬁed position. Note If the speciﬁed header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all. You can specify the following fallback behaviors: • MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request. • NO_MATCH
waf-apiref-267	waf-apiref.pdf	267	used for GeoMatchStatement and RateBasedStatement. For IPSetReferenceStatement, use IPSetForwardedIPConﬁg instead. AWS WAF only evaluates the ﬁrst IP address found in the speciﬁed HTTP header. Contents FallbackBehavior The match status to assign to the web request if the request doesn't have a valid IP address in the speciﬁed position. Note If the speciﬁed header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all. You can specify the following fallback behaviors: • MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request. • NO_MATCH - Treat the web request as not matching the rule statement. Type: String Valid Values: MATCH \| NO_MATCH ForwardedIPConﬁg 1308 AWS WAFV2 Required: Yes HeaderName API Reference The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded- For (XFF) header, set this to X-Forwarded-For. Note If the speciﬁed header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^[a-zA-Z0-9-]+$ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ForwardedIPConﬁg 1309 AWS WAFV2 GeoMatchStatement Service: AWS WAFV2 API Reference A rule statement that labels web requests by country and region and that matches against web requests based on country code. A geo match rule labels every request that it inspects regardless of whether it ﬁnds a match. • To manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the CountryCodes array. • Otherwise, conﬁgure your geo match rule with Count action so that it only labels requests. Then, add one or more label match rules to run after the geo match rule and conﬁgure them to match against the geographic labels and handle the requests as needed. AWS WAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. AWS WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match ForwardedIPConfig. If you use the web request origin, the label formats are awswaf:clientip:geo:region:<ISO country code>-<ISO region code> and awswaf:clientip:geo:country:<ISO country code>. If you use a forwarded IP address, the label formats are awswaf:forwardedip:geo:region:<ISO country code>-<ISO region code> and awswaf:forwardedip:geo:country:<ISO country code>. For additional details, see Geographic match rule statement in the AWS WAF Developer Guide. Contents CountryCodes An array of two-character country codes that you want to match against, for example, [ "US", "CN" ], from the alpha-2 country ISO codes of the ISO 3166 international standard. When you use a geo match statement just for the region and country labels that it adds to requests, you still have to supply a country code for the rule to evaluate. In this case, you conﬁgure the rule to only count matching requests, but it will still generate logging and count GeoMatchStatement 1310 AWS WAFV2 API Reference metrics for any matches. You can reduce the logging and metrics that the rule produces by specifying a country that's unlikely to be a source of traﬃc to your site. Type: Array of strings Array Members: Minimum number of 1 item. Valid Values: AF \| AX \| AL \| DZ \| AS \| AD \| AO \| AI \| AQ \| AG \| AR \| AM \| AW \| AU \| AT \| AZ \| BS \| BH \| BD \| BB \| BY \| BE \| BZ \| BJ \| BM \| BT \| BO \| BQ \| BA \| BW \| BV \| BR \| IO \| BN \| BG \| BF \| BI \| KH \| CM \| CA \| CV \| KY \| CF \| TD \| CL \| CN \| CX \| CC \| CO \| KM \| CG \| CD \| CK \| CR \| CI \| HR \| CU \| CW \| CY \| CZ \| DK \| DJ \| DM \| DO \| EC \| EG \| SV \| GQ \| ER \| EE \| ET \| FK \| FO \| FJ \| FI \| FR \| GF \| PF \| TF \| GA \| GM \| GE \| DE \| GH \| GI \| GR \| GL \| GD \| GP \| GU \| GT \| GG \| GN \| GW \| GY \| HT \| HM \| VA \| HN \| HK \| HU \| IS \| IN \| ID \| IR \| IQ \| IE \| IM \| IL \|
waf-apiref-268	waf-apiref.pdf	268	CZ \| DK \| DJ \| DM \| DO \| EC \| EG \| SV \| GQ \| ER \| EE \| ET \| FK \| FO \| FJ \| FI \| FR \| GF \| PF \| TF \| GA \| GM \| GE \| DE \| GH \| GI \| GR \| GL \| GD \| GP \| GU \| GT \| GG \| GN \| GW \| GY \| HT \| HM \| VA \| HN \| HK \| HU \| IS \| IN \| ID \| IR \| IQ \| IE \| IM \| IL \| IT \| JM \| JP \| JE \| JO \| KZ \| KE \| KI \| KP \| KR \| KW \| KG \| LA \| LV \| LB \| LS \| LR \| LY \| LI \| LT \| LU \| MO \| MK \| MG \| MW \| MY \| MV \| ML \| MT \| MH \| MQ \| MR \| MU \| YT \| MX \| FM \| MD \| MC \| MN \| ME \| MS \| MA \| MZ \| MM \| NA \| NR \| NP \| NL \| NC \| NZ \| NI \| NE \| NG \| NU \| NF \| MP \| NO \| OM \| PK \| PW \| PS \| PA \| PG \| PY \| PE \| PH \| PN \| PL \| PT \| PR \| QA \| RE \| RO \| RU \| RW \| BL \| SH \| KN \| LC \| MF \| PM \| VC \| WS \| SM \| ST \| SA \| SN \| RS \| SC \| SL \| SG \| SX \| SK \| SI \| SB \| SO \| ZA \| GS \| SS \| ES \| LK \| SD \| SR \| SJ \| SZ \| SE \| CH \| SY \| TW \| TJ \| TZ \| TH \| TL \| TG \| TK \| TO \| TT \| TN \| TR \| TM \| TC \| TV \| UG \| UA \| AE \| GB \| US \| UM \| UY \| UZ \| VU \| VE \| VN \| VG \| VI \| WF \| EH \| YE \| ZM \| ZW \| XK Required: No ForwardedIPConﬁg The conﬁguration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X- Forwarded-For (XFF) header, but you can specify any header name. Note If the speciﬁed header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all. GeoMatchStatement 1311 AWS WAFV2 API Reference Type: ForwardedIPConﬁg object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 GeoMatchStatement 1312 AWS WAFV2 HeaderMatchPattern Service: AWS WAFV2 API Reference The ﬁlter to use to identify the subset of headers to inspect in a web request. You must specify exactly one setting: either All, IncludedHeaders, or ExcludedHeaders. Example JSON: "MatchPattern": { "ExcludedHeaders": [ "KeyToExclude1", "KeyToExclude2" ] } Contents All Inspect all headers. Type: All object Required: No ExcludedHeaders Inspect only the headers whose keys don't match any of the strings speciﬁed here. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 199 items. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: .\S. Required: No IncludedHeaders Inspect only the headers that have a key that matches one of the strings speciﬁed here. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 199 items. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: .\S. HeaderMatchPattern 1313 AWS WAFV2 Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 HeaderMatchPattern 1314 AWS WAFV2 HeaderOrder Service: AWS WAFV2 API Reference Inspect a string containing the list of the request's header names, ordered as they appear in the web request that AWS WAF receives for inspection. AWS WAF generates the string and then uses that as the ﬁeld to match component in its inspection. AWS WAF separates the header names in the string using colons and no added spaces, for example host:user- agent:accept:authorization:referer. Contents OversizeHandling What AWS WAF should do if the headers determined by your match scope are more numerous or larger than AWS WAF can inspect. AWS WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192
waf-apiref-269	waf-apiref.pdf	269	list of the request's header names, ordered as they appear in the web request that AWS WAF receives for inspection. AWS WAF generates the string and then uses that as the ﬁeld to match component in its inspection. AWS WAF separates the header names in the string using colons and no added spaces, for example host:user- agent:accept:authorization:referer. Contents OversizeHandling What AWS WAF should do if the headers determined by your match scope are more numerous or larger than AWS WAF can inspect. AWS WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to AWS WAF. The options for oversize handling are the following: • CONTINUE - Inspect the available headers normally, according to the rule inspection criteria. • MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request. • NO_MATCH - Treat the web request as not matching the rule statement. Type: String Valid Values: CONTINUE \| MATCH \| NO_MATCH Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 HeaderOrder 1315 AWS WAFV2 • AWS SDK for Ruby V3 API Reference HeaderOrder 1316 AWS WAFV2 Headers Service: AWS WAFV2 API Reference Inspect all headers in the web request. You can specify the parts of the headers to inspect and you can narrow the set of headers to inspect by including or excluding speciﬁc keys. This is used to indicate the web request component to inspect, in the FieldToMatch speciﬁcation. If you want to inspect just the value of a single header, use the SingleHeader FieldToMatch setting instead. Example JSON: "Headers": { "MatchPattern": { "All": {} }, "MatchScope": "KEY", "OversizeHandling": "MATCH" } Contents MatchPattern The ﬁlter to use to identify the subset of headers to inspect in a web request. You must specify exactly one setting: either All, IncludedHeaders, or ExcludedHeaders. Example JSON: "MatchPattern": { "ExcludedHeaders": [ "KeyToExclude1", "KeyToExclude2" ] } Type: HeaderMatchPattern object Required: Yes MatchScope The parts of the headers to match with the rule inspection criteria. If you specify ALL, AWS WAF inspects both keys and values. All does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical AND statement to combine two match rules, one that inspects the keys and another that inspects the values. Type: String Valid Values: ALL \| KEY \| VALUE Headers 1317 AWS WAFV2 Required: Yes OversizeHandling API Reference What AWS WAF should do if the headers determined by your match scope are more numerous or larger than AWS WAF can inspect. AWS WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to AWS WAF. The options for oversize handling are the following: • CONTINUE - Inspect the available headers normally, according to the rule inspection criteria. • MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request. • NO_MATCH - Treat the web request as not matching the rule statement. Type: String Valid Values: CONTINUE \| MATCH \| NO_MATCH Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Headers 1318 AWS WAFV2 HTTPHeader Service: AWS WAFV2 API Reference Part of the response from GetSampledRequests. This is a complex type that appears as Headers in the response syntax. HTTPHeader contains the names and values of all of the headers that appear in one of the web requests. Contents Name The name of the HTTP header. Type: String Required: No Value The value of the HTTP header. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 HTTPHeader 1319 AWS WAFV2 HTTPRequest Service: AWS WAFV2 API Reference Part of the response from GetSampledRequests. This is a complex type that appears as Request in the response syntax. HTTPRequest contains information about one of the web requests. Contents ClientIP The IP address that
waf-apiref-270	waf-apiref.pdf	270	name of the HTTP header. Type: String Required: No Value The value of the HTTP header. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 HTTPHeader 1319 AWS WAFV2 HTTPRequest Service: AWS WAFV2 API Reference Part of the response from GetSampledRequests. This is a complex type that appears as Request in the response syntax. HTTPRequest contains information about one of the web requests. Contents ClientIP The IP address that the request originated from. If the web ACL is associated with a CloudFront distribution, this is the value of one of the following ﬁelds in CloudFront access logs: • c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the request • x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request Type: String Required: No Country The two-letter country code for the country that the request originated from. For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2. Type: String Required: No Headers A complex type that contains the name and value for each header in the sampled web request. Type: Array of HTTPHeader objects Required: No HTTPVersion The HTTP version speciﬁed in the sampled web request, for example, HTTP/1.1. Type: String Required: No HTTPRequest 1320 AWS WAFV2 Method The HTTP method speciﬁed in the sampled web request. API Reference Type: String Required: No URI The URI path of the request, which identiﬁes the resource, for example, /images/daily- ad.jpg. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 HTTPRequest 1321 AWS WAFV2 API Reference ImmunityTimeProperty Service: AWS WAFV2 Used for CAPTCHA and challenge token settings. Determines how long a CAPTCHA or challenge timestamp remains valid after AWS WAF updates it for a successful CAPTCHA or challenge response. Contents ImmunityTime The amount of time, in seconds, that a CAPTCHA or challenge timestamp is considered valid by AWS WAF. The default setting is 300. For the Challenge action, the minimum setting is 300. Type: Long Valid Range: Minimum value of 60. Maximum value of 259200. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ImmunityTimeProperty 1322 AWS WAFV2 IPSet Service: AWS WAFV2 API Reference Contains zero or more IP addresses or blocks of IP addresses speciﬁed in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all IPv4 and IPv6 CIDR ranges except for /0. For information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. AWS WAF assigns an ARN to each IPSet that you create. To use an IP set in a rule, you provide the ARN to the Rule statement IPSetReferenceStatement. Contents Addresses Contains an array of strings that speciﬁes zero or more IP addresses or blocks of IP addresses that you want AWS WAF to inspect for in incoming requests. All addresses must be speciﬁed using Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all IPv4 and IPv6 CIDR ranges except for /0. Example address strings: • For requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32. • For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24. • For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128. • For requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ﬀﬀ:ﬀﬀ:ﬀﬀ:ﬀﬀ, specify 1111:0000:0000:0000:0000:0000:0000:0000/64. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. Example JSON Addresses speciﬁcations: • Empty array: "Addresses": [] • Array with one address: "Addresses": ["192.0.2.44/32"] • Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"] IPSet 1323 AWS WAFV2 API Reference • INVALID speciﬁcation: "Addresses": [""] INVALID Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 50. Pattern: .\S. Required: Yes ARN The Amazon Resource Name (ARN) of the entity. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .\S. Required: Yes Id A unique identiﬁer for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ Required: Yes IPAddressVersion The version of the IP addresses, either IPV4 or IPV6. Type: String Valid Values: IPV4 \| IPV6 Required: Yes IPSet 1324 AWS WAFV2 Name API Reference The name of the IP set. You cannot change
waf-apiref-271	waf-apiref.pdf	271	(ARN) of the entity. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .\S. Required: Yes Id A unique identiﬁer for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ Required: Yes IPAddressVersion The version of the IP addresses, either IPV4 or IPV6. Type: String Valid Values: IPV4 \| IPV6 Required: Yes IPSet 1324 AWS WAFV2 Name API Reference The name of the IP set. You cannot change the name of an IPSet after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: Yes Description A description of the IP set that helps with identiﬁcation. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 IPSet 1325 AWS WAFV2 API Reference IPSetForwardedIPConﬁg Service: AWS WAFV2 The conﬁguration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name. Note If the speciﬁed header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all. This conﬁguration is used only for IPSetReferenceStatement. For GeoMatchStatement and RateBasedStatement, use ForwardedIPConﬁg instead. Contents FallbackBehavior The match status to assign to the web request if the request doesn't have a valid IP address in the speciﬁed position. Note If the speciﬁed header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all. You can specify the following fallback behaviors: • MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request. • NO_MATCH - Treat the web request as not matching the rule statement. Type: String Valid Values: MATCH \| NO_MATCH Required: Yes IPSetForwardedIPConﬁg 1326 AWS WAFV2 HeaderName API Reference The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded- For (XFF) header, set this to X-Forwarded-For. Note If the speciﬁed header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^[a-zA-Z0-9-]+$ Required: Yes Position The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the ﬁrst IP address identiﬁes the original client and the rest identify proxies that the request went through. The options for this setting are the following: • FIRST - Inspect the ﬁrst IP address in the list of IP addresses in the header. This is usually the client's original IP. • LAST - Inspect the last IP address in the list of IP addresses in the header. • ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, AWS WAF inspects the last 10. Type: String Valid Values: FIRST \| LAST \| ANY Required: Yes IPSetForwardedIPConﬁg 1327 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 IPSetForwardedIPConﬁg 1328 AWS WAFV2 API Reference IPSetReferenceStatement Service: AWS WAFV2 A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that speciﬁes the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet. Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it. Contents ARN The Amazon Resource Name (ARN) of the IPSet that this statement references. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .\S. Required: Yes IPSetForwardedIPConﬁg The conﬁguration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X- Forwarded-For (XFF) header, but you can specify any header name. Note
waf-apiref-272	waf-apiref.pdf	272	rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it. Contents ARN The Amazon Resource Name (ARN) of the IPSet that this statement references. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .\S. Required: Yes IPSetForwardedIPConﬁg The conﬁguration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X- Forwarded-For (XFF) header, but you can specify any header name. Note If the speciﬁed header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all. Type: IPSetForwardedIPConﬁg object Required: No IPSetReferenceStatement 1329 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 IPSetReferenceStatement 1330 AWS WAFV2 IPSetSummary Service: AWS WAFV2 API Reference High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an IPSet, and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule. Contents ARN The Amazon Resource Name (ARN) of the entity. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .\S. Required: No Description A description of the IP set that helps with identiﬁcation. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$ Required: No Id A unique identiﬁer for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ IPSetSummary 1331 AWS WAFV2 Required: No LockToken API Reference A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ Required: No Name The name of the IP set. You cannot change the name of an IPSet after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 IPSetSummary 1332 AWS WAFV2 JA3Fingerprint Service: AWS WAFV2 API Reference Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA3 ﬁngerprint. The JA3 ﬁngerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This ﬁngerprint serves as a unique identiﬁer for the client's TLS conﬁguration. AWS WAF calculates and logs this ﬁngerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information. Note You can use this choice only with a string match ByteMatchStatement with the PositionalConstraint set to EXACTLY. You can obtain the JA3 ﬁngerprint for client requests from the web ACL logs. If AWS WAF is able to calculate the ﬁngerprint, it includes it in the logs. For information about the logging ﬁelds, see Log ﬁelds in the AWS WAF Developer Guide. Provide the JA3 ﬁngerprint string from the logs in your string match statement speciﬁcation, to match with any future requests that have the same TLS conﬁguration. Contents FallbackBehavior The match status to assign to the web request if the request doesn't have a JA3 ﬁngerprint. You can specify the following fallback behaviors: • MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request. • NO_MATCH - Treat the web request as not matching the rule statement. Type: String Valid Values: MATCH \| NO_MATCH Required: Yes JA3Fingerprint 1333 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 JA3Fingerprint 1334 AWS WAFV2 JA4Fingerprint Service:
waf-apiref-273	waf-apiref.pdf	273	JA3 ﬁngerprint. You can specify the following fallback behaviors: • MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request. • NO_MATCH - Treat the web request as not matching the rule statement. Type: String Valid Values: MATCH \| NO_MATCH Required: Yes JA3Fingerprint 1333 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 JA3Fingerprint 1334 AWS WAFV2 JA4Fingerprint Service: AWS WAFV2 API Reference Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA4 ﬁngerprint. The JA4 ﬁngerprint is a 36-character hash derived from the TLS Client Hello of an incoming request. This ﬁngerprint serves as a unique identiﬁer for the client's TLS conﬁguration. AWS WAF calculates and logs this ﬁngerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information. Note You can use this choice only with a string match ByteMatchStatement with the PositionalConstraint set to EXACTLY. You can obtain the JA4 ﬁngerprint for client requests from the web ACL logs. If AWS WAF is able to calculate the ﬁngerprint, it includes it in the logs. For information about the logging ﬁelds, see Log ﬁelds in the AWS WAF Developer Guide. Provide the JA4 ﬁngerprint string from the logs in your string match statement speciﬁcation, to match with any future requests that have the same TLS conﬁguration. Contents FallbackBehavior The match status to assign to the web request if the request doesn't have a JA4 ﬁngerprint. You can specify the following fallback behaviors: • MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request. • NO_MATCH - Treat the web request as not matching the rule statement. Type: String Valid Values: MATCH \| NO_MATCH Required: Yes JA4Fingerprint 1335 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 JA4Fingerprint 1336 AWS WAFV2 JsonBody Service: AWS WAFV2 API Reference Inspect the body of the web request as JSON. The body immediately follows the request headers. This is used to indicate the web request component to inspect, in the FieldToMatch speciﬁcation. Use the speciﬁcations in this object to indicate which parts of the JSON body to inspect using the rule's inspection criteria. AWS WAF inspects only the parts of the JSON that result from the matches that you indicate. Example JSON: "JsonBody": { "MatchPattern": { "All": {} }, "MatchScope": "ALL" } For additional information about this request component option, see JSON body in the AWS WAF Developer Guide. Contents MatchPattern The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria. Type: JsonMatchPattern object Required: Yes MatchScope The parts of the JSON to match against using the MatchPattern. If you specify ALL, AWS WAF matches against keys and values. All does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logical AND statement to combine two match rules, one that inspects the keys and another that inspects the values. Type: String Valid Values: ALL \| KEY \| VALUE Required: Yes JsonBody 1337 AWS WAFV2 InvalidFallbackBehavior API Reference What AWS WAF should do if it fails to completely parse the JSON body. The options are the following: • EVALUATE_AS_STRING - Inspect the body as plain text. AWS WAF applies the text transformations and inspection criteria that you deﬁned for the JSON inspection to the body text string. • MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request. • NO_MATCH - Treat the web request as not matching the rule statement. If you don't provide this setting, AWS WAF parses and evaluates the content only up to the ﬁrst parsing failure that it encounters. Note AWS WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, AWS WAF doesn't apply the fallback behavior. For more information, see JSON body in the AWS WAF Developer Guide. Type: String Valid Values: MATCH \| NO_MATCH \| EVALUATE_AS_STRING Required: No OversizeHandling What AWS WAF should do if the body is larger than AWS WAF can inspect. AWS WAF does
waf-apiref-274	waf-apiref.pdf	274	as not matching the rule statement. If you don't provide this setting, AWS WAF parses and evaluates the content only up to the ﬁrst parsing failure that it encounters. Note AWS WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, AWS WAF doesn't apply the fallback behavior. For more information, see JSON body in the AWS WAF Developer Guide. Type: String Valid Values: MATCH \| NO_MATCH \| EVALUATE_AS_STRING Required: No OversizeHandling What AWS WAF should do if the body is larger than AWS WAF can inspect. AWS WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to AWS WAF for inspection. • For Application Load Balancer and AWS AppSync, the limit is ﬁxed at 8 KB (8,192 bytes). • For CloudFront, API Gateway, Amazon Cognito, App Runner, and Veriﬁed Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL AssociationConfig, for additional processing fees. JsonBody 1338 AWS WAFV2 API Reference • For AWS Amplify, use the CloudFront limit. The options for oversize handling are the following: • CONTINUE - Inspect the available body contents normally, according to the rule inspection criteria. • MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request. • NO_MATCH - Treat the web request as not matching the rule statement. You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit. Default: CONTINUE Type: String Valid Values: CONTINUE \| MATCH \| NO_MATCH Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 JsonBody 1339 AWS WAFV2 JsonMatchPattern Service: AWS WAFV2 API Reference The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria. This is used with the FieldToMatch option JsonBody. Contents All Match all of the elements. See also MatchScope in JsonBody. You must specify either this setting or the IncludedPaths setting, but not both. Type: All object Required: No IncludedPaths Match only the speciﬁed include paths. See also MatchScope in JsonBody. Provide the include paths using JSON Pointer syntax. For example, "IncludedPaths": ["/ dogs/0/name", "/dogs/1/name"]. For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer. You must specify either this setting or the All setting, but not both. Note Don't use this option to include all paths. Instead, use the All setting. Type: Array of strings Array Members: Minimum number of 1 item. Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: ([/])\|([/](([^~])\|(~[01]))+) Required: No JsonMatchPattern 1340 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 JsonMatchPattern 1341 AWS WAFV2 Label Service: AWS WAFV2 API Reference A single label container. This is used as an element of a label array in multiple contexts, for example, in RuleLabels inside a Rule and in Labels inside a SampledHTTPRequest. Contents Name The label string. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: ^[0-9A-Za-z_\-:]+$ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Label 1342 AWS WAFV2 LabelMatchStatement Service: AWS WAFV2 API Reference A rule statement to match against labels that have been added to the web request by rules that have already run in the web ACL. The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualiﬁed label name that had been added to the web request. Fully qualiﬁed labels have a preﬁx, optional namespaces, and label name. The preﬁx identiﬁes the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualiﬁed name in your label match string, AWS WAF performs the search for labels that were added in the same context as the label match statement. Contents Key The string to match
waf-apiref-275	waf-apiref.pdf	275	statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualiﬁed label name that had been added to the web request. Fully qualiﬁed labels have a preﬁx, optional namespaces, and label name. The preﬁx identiﬁes the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualiﬁed name in your label match string, AWS WAF performs the search for labels that were added in the same context as the label match statement. Contents Key The string to match against. The setting you provide for this depends on the match statement's Scope setting: • If the Scope indicates LABEL, then this speciﬁcation must include the name and can include any number of preceding namespace speciﬁcations and preﬁx up to providing the fully qualiﬁed label name. • If the Scope indicates NAMESPACE, then this speciﬁcation can include any number of contiguous namespace strings, and can include the entire label namespace preﬁx from the rule group or web ACL where the label originates. Labels are case sensitive and components of a label must be separated by colon, for example NS1:NS2:name. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: ^[0-9A-Za-z_\-:]+$ Required: Yes Scope Specify whether you want to match using the label name or just the namespace. LabelMatchStatement 1343 AWS WAFV2 Type: String Valid Values: LABEL \| NAMESPACE Required: Yes See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 LabelMatchStatement 1344 AWS WAFV2 LabelNameCondition Service: AWS WAFV2 A single label name condition for a Condition in a logging ﬁlter. API Reference Contents LabelName The label name that a log record must contain in order to meet the condition. This must be a fully qualiﬁed label name. Fully qualiﬁed labels have a preﬁx, optional namespaces, and label name. The preﬁx identiﬁes the rule group or web ACL context of the rule that added the label. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: ^[0-9A-Za-z_\-:]+$ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 LabelNameCondition 1345 AWS WAFV2 LabelSummary Service: AWS WAFV2 API Reference List of labels used by one or more of the rules of a RuleGroup. This summary object is used for the following rule group lists: • AvailableLabels - Labels that rules add to matching requests. These labels are deﬁned in the RuleLabels for a Rule. • ConsumedLabels - Labels that rules match against. These labels are deﬁned in a LabelMatchStatement speciﬁcation, in the Statement deﬁnition of a rule. Contents Name An individual label speciﬁcation. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: ^[0-9A-Za-z_\-:]+$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 LabelSummary 1346 AWS WAFV2 LoggingConﬁguration Service: AWS WAFV2 API Reference Deﬁnes an association between logging destinations and a web ACL resource, for logging from AWS WAF. As part of the association, you can specify parts of the standard logging ﬁelds to keep out of the logs and you can specify ﬁlters so that you log only a subset of the logging records. If you conﬁgure data protection for the web ACL, the protection applies to the data that AWS WAF sends to the logs. Note You can deﬁne one logging destination per web ACL. You can access information about the traﬃc that AWS WAF inspects using the following steps: 1. Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose. The name that you give the destination must start with aws-waf-logs-. Depending on the type of destination, you might need to conﬁgure additional settings or permissions. For conﬁguration requirements and pricing information for each destination type, see Logging web ACL traﬃc in the AWS WAF Developer Guide. 2. Associate your logging destination to your web ACL using a PutLoggingConfiguration request. When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF creates an additional role or policy that is required to write logs to the logging destination. For an Amazon CloudWatch Logs log group, AWS WAF creates a resource policy on the log group. For an Amazon S3 bucket, AWS WAF creates a bucket policy. For an Amazon Kinesis
waf-apiref-276	waf-apiref.pdf	276	need to conﬁgure additional settings or permissions. For conﬁguration requirements and pricing information for each destination type, see Logging web ACL traﬃc in the AWS WAF Developer Guide. 2. Associate your logging destination to your web ACL using a PutLoggingConfiguration request. When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF creates an additional role or policy that is required to write logs to the logging destination. For an Amazon CloudWatch Logs log group, AWS WAF creates a resource policy on the log group. For an Amazon S3 bucket, AWS WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, AWS WAF creates a service-linked role. For additional information about web ACL logging, see Logging web ACL traﬃc information in the AWS WAF Developer Guide. LoggingConﬁguration 1347 AWS WAFV2 Contents LogDestinationConﬁgs API Reference The logging destination conﬁguration that you want to associate with the web ACL. Note You can associate one logging destination to a web ACL. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 100 items. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .\S. Required: Yes ResourceArn The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .\S. Required: Yes LoggingFilter Filtering that speciﬁes which web requests are kept in the logs and which are dropped. You can ﬁlter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation. Type: LoggingFilter object Required: No LoggingConﬁguration 1348 AWS WAFV2 LogScope API Reference The owner of the logging conﬁguration, which must be set to CUSTOMER for the conﬁgurations that you manage. The log scope SECURITY_LAKE indicates a conﬁguration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see Collecting data from AWS services in the Amazon Security Lake user guide. Default: CUSTOMER Type: String Valid Values: CUSTOMER \| SECURITY_LAKE Required: No LogType Used to distinguish between various logging options. Currently, there is one option. Default: WAF_LOGS Type: String Valid Values: WAF_LOGS Required: No ManagedByFirewallManager Indicates whether the logging conﬁguration was created by AWS Firewall Manager, as part of an AWS WAF policy conﬁguration. If true, only Firewall Manager can modify or delete the conﬁguration. The logging conﬁguration can be created by AWS Firewall Manager for use with any web ACL that Firewall Manager is using for an AWS WAF policy. Web ACLs that Firewall Manager creates and uses have their ManagedByFirewallManager property set to true. Web ACLs that were created by a customer account and then retroﬁtted by Firewall Manager for use by a policy have their RetrofittedByFirewallManager property set to true. For either case, any corresponding logging conﬁguration will indicate ManagedByFirewallManager. LoggingConﬁguration 1349 AWS WAFV2 Type: Boolean Required: No RedactedFields API Reference The parts of the request that you want to keep out of the logs. For example, if you redact the SingleHeader ﬁeld, the HEADER ﬁeld in the logs will be REDACTED for all rules that use the SingleHeader FieldToMatch setting. If you conﬁgure data protection for the web ACL, the protection applies to the data that AWS WAF sends to the logs. Redaction applies only to the component that's speciﬁed in the rule's FieldToMatch setting, so the SingleHeader redaction doesn't apply to rules that use the Headers FieldToMatch. Note You can specify only the following ﬁelds for redaction: UriPath, QueryString, SingleHeader, and Method. Note This setting has no impact on request sampling. You can only exclude ﬁelds from request sampling by disabling sampling in the web ACL visibility conﬁguration or by conﬁguring data protection for the web ACL. Type: Array of FieldToMatch objects Array Members: Maximum number of 100 items. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: LoggingConﬁguration 1350 AWS WAFV2 • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference LoggingConﬁguration 1351 AWS WAFV2 LoggingFilter Service: AWS WAFV2 API Reference Filtering that speciﬁes which web requests are kept in the logs and which are dropped, deﬁned for a web ACL's LoggingConﬁguration. You can ﬁlter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation. Contents DefaultBehavior Default handling for logs that don't match any of the speciﬁed ﬁltering conditions. Type: String Valid Values: KEEP \| DROP Required: Yes Filters The ﬁlters that you want to apply to the logs. Type: Array of Filter objects Array Members: Minimum number of 1 item. Required: Yes See Also For more information about using this API in one
waf-apiref-277	waf-apiref.pdf	277	web requests are kept in the logs and which are dropped, deﬁned for a web ACL's LoggingConﬁguration. You can ﬁlter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation. Contents DefaultBehavior Default handling for logs that don't match any of the speciﬁed ﬁltering conditions. Type: String Valid Values: KEEP \| DROP Required: Yes Filters The ﬁlters that you want to apply to the logs. Type: Array of Filter objects Array Members: Minimum number of 1 item. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 LoggingFilter 1352 AWS WAFV2 API Reference ManagedProductDescriptor Service: AWS WAFV2 The properties of a managed product, such as an AWS Managed Rules rule group or an AWS Marketplace managed rule group. Contents IsAdvancedManagedRuleSet Indicates whether the rule group provides an advanced set of protections, such as the the AWS Managed Rules rule groups that are used for AWS WAF intelligent threat mitigation. Type: Boolean Required: No IsVersioningSupported Indicates whether the rule group is versioned. Type: Boolean Required: No ManagedRuleSetName The name of the managed rule group. For example, AWSManagedRulesAnonymousIpList or AWSManagedRulesATPRuleSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: No ProductDescription A short description of the managed rule group. Type: String Length Constraints: Minimum length of 1. ManagedProductDescriptor 1353 AWS WAFV2 Pattern: .\S. Required: No ProductId API Reference A unique identiﬁer for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No ProductLink For AWS Marketplace managed rule groups only, the link to the rule group product page. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: .\S. Required: No ProductTitle The display name for the managed rule group. For example, Anonymous IP list or Account takeover prevention. Type: String Length Constraints: Minimum length of 1. Pattern: .\S. Required: No SnsTopicArn The Amazon resource name (ARN) of the Amazon Simple Notiﬁcation Service SNS topic that's used to provide notiﬁcation of changes to the managed rule group. You can subscribe to the ManagedProductDescriptor 1354 AWS WAFV2 API Reference SNS topic to receive notiﬁcations when the managed rule group is modiﬁed, such as for new versions and for version expiration. For more information, see the Amazon Simple Notiﬁcation Service Developer Guide. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .\S. Required: No VendorName The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ManagedProductDescriptor 1355 AWS WAFV2 API Reference ManagedRuleGroupConﬁg Service: AWS WAFV2 Additional information that's used by a managed rule group. Many managed rule groups don't require this. The rule groups used for intelligent threat mitigation require additional conﬁguration: • Use the AWSManagedRulesACFPRuleSet conﬁguration object to conﬁgure the account creation fraud prevention managed rule group. The conﬁguration includes the registration and sign-up pages of your application and the locations in the account creation request payload of data, such as the user email and phone number ﬁelds. • Use the AWSManagedRulesATPRuleSet conﬁguration object to conﬁgure the account takeover prevention managed rule group. The conﬁguration includes the sign-in page of your application and the locations in the login request payload of data such as the username and password. • Use the AWSManagedRulesBotControlRuleSet conﬁguration object to conﬁgure the protection level that you want the Bot Control rule group to use. For example speciﬁcations, see the examples section of CreateWebACL. Contents AWSManagedRulesACFPRuleSet Additional conﬁguration for using the account creation fraud prevention (ACFP) managed rule group, AWSManagedRulesACFPRuleSet. Use this to provide account creation request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to account creation requests. For information about using the ACFP managed rule group, see AWS WAF Fraud Control account creation fraud prevention (ACFP) rule group and AWS WAF Fraud Control account creation fraud prevention (ACFP) in the AWS WAF Developer Guide. Type: AWSManagedRulesACFPRuleSet object Required: No ManagedRuleGroupConﬁg 1356 AWS WAFV2 AWSManagedRulesATPRuleSet API Reference Additional conﬁguration for using the account takeover prevention (ATP) managed rule group, AWSManagedRulesATPRuleSet. Use this to provide login request information
waf-apiref-278	waf-apiref.pdf	278	account creation request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to account creation requests. For information about using the ACFP managed rule group, see AWS WAF Fraud Control account creation fraud prevention (ACFP) rule group and AWS WAF Fraud Control account creation fraud prevention (ACFP) in the AWS WAF Developer Guide. Type: AWSManagedRulesACFPRuleSet object Required: No ManagedRuleGroupConﬁg 1356 AWS WAFV2 AWSManagedRulesATPRuleSet API Reference Additional conﬁguration for using the account takeover prevention (ATP) managed rule group, AWSManagedRulesATPRuleSet. Use this to provide login request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to login requests. This conﬁguration replaces the individual conﬁguration ﬁelds in ManagedRuleGroupConfig and provides additional feature conﬁguration. For information about using the ATP managed rule group, see AWS WAF Fraud Control account takeover prevention (ATP) rule group and AWS WAF Fraud Control account takeover prevention (ATP) in the AWS WAF Developer Guide. Type: AWSManagedRulesATPRuleSet object Required: No AWSManagedRulesBotControlRuleSet Additional conﬁguration for using the Bot Control managed rule group. Use this to specify the inspection level that you want to use. For information about using the Bot Control managed rule group, see AWS WAF Bot Control rule group and AWS WAF Bot Control in the AWS WAF Developer Guide. Type: AWSManagedRulesBotControlRuleSet object Required: No LoginPath This member has been deprecated. Note Instead of this setting, provide your conﬁguration under AWSManagedRulesATPRuleSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: .\S. ManagedRuleGroupConﬁg 1357 API Reference AWS WAFV2 Required: No PasswordField This member has been deprecated. Note Instead of this setting, provide your conﬁguration under the request inspection conﬁguration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet. Type: PasswordField object Required: No PayloadType This member has been deprecated. Note Instead of this setting, provide your conﬁguration under the request inspection conﬁguration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet. Type: String Valid Values: JSON \| FORM_ENCODED Required: No UsernameField This member has been deprecated. Note Instead of this setting, provide your conﬁguration under the request inspection conﬁguration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet. ManagedRuleGroupConﬁg 1358 AWS WAFV2 Type: UsernameField object Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ManagedRuleGroupConﬁg 1359 AWS WAFV2 API Reference ManagedRuleGroupStatement Service: AWS WAFV2 A rule statement used to run the rules that are deﬁned in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups. You cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. You cannot use a managed rule group inside another rule group. You can only reference a managed rule group as a top-level statement within a rule that you deﬁne in a web ACL. Note You are charged additional fees when you use the AWS WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet, the AWS WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet, or the AWS WAF Fraud Control account creation fraud prevention (ACFP) managed rule group AWSManagedRulesACFPRuleSet. For more information, see AWS WAF Pricing. Contents Name The name of the managed rule group. You use this, along with the vendor name, to identify the rule group. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: Yes VendorName The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group. ManagedRuleGroupStatement 1360 AWS WAFV2 Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes ExcludedRules Rules in the referenced rule group whose actions are set to Count. Note Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including Count. Type: Array of ExcludedRule objects Array Members: Maximum number of 100 items. Required: No ManagedRuleGroupConﬁgs Additional information that's used by a managed rule group. Many managed rule groups don't require this. The rule groups used for intelligent threat mitigation require additional conﬁguration: • Use the AWSManagedRulesACFPRuleSet conﬁguration object to conﬁgure the account creation fraud prevention managed rule group. The conﬁguration includes the registration and sign-up pages of your application and the locations in the account creation request payload of data, such as the user email and phone number ﬁelds. • Use the AWSManagedRulesATPRuleSet conﬁguration object to conﬁgure the account takeover prevention managed rule group. The conﬁguration includes the sign-in page of your application and the locations in the login request payload of data such as the username and password. • Use the AWSManagedRulesBotControlRuleSet
waf-apiref-279	waf-apiref.pdf	279	groups used for intelligent threat mitigation require additional conﬁguration: • Use the AWSManagedRulesACFPRuleSet conﬁguration object to conﬁgure the account creation fraud prevention managed rule group. The conﬁguration includes the registration and sign-up pages of your application and the locations in the account creation request payload of data, such as the user email and phone number ﬁelds. • Use the AWSManagedRulesATPRuleSet conﬁguration object to conﬁgure the account takeover prevention managed rule group. The conﬁguration includes the sign-in page of your application and the locations in the login request payload of data such as the username and password. • Use the AWSManagedRulesBotControlRuleSet conﬁguration object to conﬁgure the protection level that you want the Bot Control rule group to use. ManagedRuleGroupStatement 1361 AWS WAFV2 API Reference Type: Array of ManagedRuleGroupConﬁg objects Required: No RuleActionOverrides Action settings to use in the place of the rule actions that are conﬁgured inside the rule group. You specify one override for each rule whose action you want to change. Note Take care to verify the rule names in your overrides. If you provide a rule name that doesn't match the name of any rule in the rule group, AWS WAF doesn't return an error and doesn't apply the override setting. You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traﬃc. You can also permanently override some or all actions, to modify how the rule group manages your web traﬃc. Type: Array of RuleActionOverride objects Array Members: Maximum number of 100 items. Required: No ScopeDownStatement An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement. Type: Statement object Required: No Version The version of the managed rule group to use. If you specify this, the version setting is ﬁxed until you change it. If you don't specify this, AWS WAF uses the vendor's default version, and ManagedRuleGroupStatement 1362 AWS WAFV2 API Reference then keeps the version at the vendor's default when the vendor updates the managed rule group settings. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^[\w#:\.\-/]+$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ManagedRuleGroupStatement 1363 AWS WAFV2 API Reference ManagedRuleGroupSummary Service: AWS WAFV2 High-level information about a managed rule group, returned by ListAvailableManagedRuleGroups. This provides information like the name and vendor name, that you provide when you add a ManagedRuleGroupStatement to a web ACL. Managed rule groups include AWS Managed Rules rule groups and AWS Marketplace managed rule groups. To use any AWS Marketplace managed rule group, ﬁrst subscribe to the rule group through AWS Marketplace. Contents Description The description of the managed rule group, provided by AWS Managed Rules or the AWS Marketplace seller who manages it. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$ Required: No Name The name of the managed rule group. You use this, along with the vendor name, to identify the rule group. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: No VendorName The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group. Type: String ManagedRuleGroupSummary 1364 AWS WAFV2 API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No VersioningSupported Indicates whether the managed rule group is versioned. If it is, you can retrieve the versions list by calling ListAvailableManagedRuleGroupVersions. Type: Boolean Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ManagedRuleGroupSummary 1365 AWS WAFV2 API Reference ManagedRuleGroupVersion Service: AWS WAFV2 Describes a single version of a managed rule group. Contents LastUpdateTimestamp The date and time that the managed rule group owner updated the rule group version information. Type: Timestamp Required: No Name The version name. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^[\w#:\.\-/]+$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3
waf-apiref-280	waf-apiref.pdf	280	for Ruby V3 ManagedRuleGroupSummary 1365 AWS WAFV2 API Reference ManagedRuleGroupVersion Service: AWS WAFV2 Describes a single version of a managed rule group. Contents LastUpdateTimestamp The date and time that the managed rule group owner updated the rule group version information. Type: Timestamp Required: No Name The version name. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^[\w#:\.\-/]+$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ManagedRuleGroupVersion 1366 AWS WAFV2 ManagedRuleSet Service: AWS WAFV2 API Reference A set of rules that is managed by AWS and AWS Marketplace sellers to provide versioned managed rule groups for customers of AWS WAF. Note This is intended for use only by vendors of managed rule sets. Vendors are AWS and AWS Marketplace sellers. Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group oﬀerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate. Contents ARN The Amazon Resource Name (ARN) of the entity. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .\S. Required: Yes Id A unique identiﬁer for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ Required: Yes ManagedRuleSet 1367 AWS WAFV2 Name API Reference The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set. This name is assigned to the corresponding managed rule group, which your customers can access and use. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: Yes Description A description of the set that helps with identiﬁcation. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$ Required: No LabelNamespace The label namespace preﬁx for the managed rule groups that are oﬀered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this preﬁx. • The syntax for the label namespace preﬁx for a managed rule group is the following: awswaf:managed:<vendor>:<rule group name>: • When a rule with a label matches a web request, AWS WAF adds the fully qualiﬁed label to the request. A fully qualiﬁed label is made up of the label namespace from the rule group or web ACL where the rule is deﬁned and the label from the rule, separated by a colon: <label namespace>:<label from rule> Type: String ManagedRuleSet 1368 AWS WAFV2 API Reference Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: ^[0-9A-Za-z_\-:]+$ Required: No PublishedVersions The versions of this managed rule set that are available for use by customers. Type: String to ManagedRuleSetVersion object map Key Length Constraints: Minimum length of 1. Maximum length of 64. Key Pattern: ^[\w#:\.\-/]+$ Required: No RecommendedVersion The version that you would like your customers to use. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^[\w#:\.\-/]+$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ManagedRuleSet 1369 AWS WAFV2 API Reference ManagedRuleSetSummary Service: AWS WAFV2 High-level information for a managed rule set. Note This is intended for use only by vendors of managed rule sets. Vendors are AWS and AWS Marketplace sellers. Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group oﬀerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate. Contents ARN The Amazon Resource Name (ARN) of the entity. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .\S. Required: No Description A description of the set that helps with identiﬁcation. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$ Required: No ManagedRuleSetSummary 1370 AWS WAFV2 Id API Reference A unique identiﬁer for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ Required: No LabelNamespace The label namespace preﬁx for the managed rule groups that are oﬀered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this preﬁx. • The syntax for the label namespace preﬁx for a managed rule group is the following: awswaf:managed:<vendor>:<rule
waf-apiref-281	waf-apiref.pdf	281	WAFV2 Id API Reference A unique identiﬁer for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ Required: No LabelNamespace The label namespace preﬁx for the managed rule groups that are oﬀered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this preﬁx. • The syntax for the label namespace preﬁx for a managed rule group is the following: awswaf:managed:<vendor>:<rule group name>: • When a rule with a label matches a web request, AWS WAF adds the fully qualiﬁed label to the request. A fully qualiﬁed label is made up of the label namespace from the rule group or web ACL where the rule is deﬁned and the label from the rule, separated by a colon: <label namespace>:<label from rule> Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: ^[0-9A-Za-z_\-:]+$ Required: No LockToken A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a ManagedRuleSetSummary 1371 AWS WAFV2 API Reference WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ Required: No Name The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set. This name is assigned to the corresponding managed rule group, which your customers can access and use. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ManagedRuleSetSummary 1372 AWS WAFV2 API Reference ManagedRuleSetVersion Service: AWS WAFV2 Information for a single version of a managed rule set. Note This is intended for use only by vendors of managed rule sets. Vendors are AWS and AWS Marketplace sellers. Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group oﬀerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate. Contents AssociatedRuleGroupArn The Amazon Resource Name (ARN) of the vendor rule group that's used to deﬁne the published version of your managed rule group. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .\S. Required: No Capacity The web ACL capacity units (WCUs) required for this rule group. AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity diﬀerently for each rule type, to reﬂect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is ﬁxed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see AWS WAF web ACL capacity units (WCU) in the AWS WAF Developer Guide. ManagedRuleSetVersion 1373 AWS WAFV2 Type: Long Valid Range: Minimum value of 1. Required: No ExpiryTimestamp The time that this version is set to expire. API Reference Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". Type: Timestamp Required: No ForecastedLifetime The amount of time you expect this version of your managed rule group to last, in days. Type: Integer Valid Range: Minimum value of 1. Required: No LastUpdateTimestamp The last time that you updated this version. Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". Type: Timestamp Required: No PublishTimestamp The time that you ﬁrst published this version. Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". Type: Timestamp ManagedRuleSetVersion 1374 AWS WAFV2 Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ManagedRuleSetVersion 1375 AWS WAFV2 Method Service: AWS WAFV2 API Reference Inspect
waf-apiref-282	waf-apiref.pdf	282	(UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". Type: Timestamp Required: No PublishTimestamp The time that you ﬁrst published this version. Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". Type: Timestamp ManagedRuleSetVersion 1374 AWS WAFV2 Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ManagedRuleSetVersion 1375 AWS WAFV2 Method Service: AWS WAFV2 API Reference Inspect the HTTP method of the web request. The method indicates the type of operation that the request is asking the origin to perform. This is used in the FieldToMatch speciﬁcation for some web request component types. JSON speciﬁcation: "Method": {} Contents The members of this exception structure are context-dependent. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Method 1376 AWS WAFV2 MobileSdkRelease Service: AWS WAFV2 API Reference Information for a release of the mobile SDK, including release notes and tags. The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage AWS WAF tokens for use in HTTP(S) requests from a mobile device to AWS WAF. For more information, see AWS WAF client application integration in the AWS WAF Developer Guide. Contents ReleaseNotes Notes describing the release. Type: String Required: No ReleaseVersion The release version. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^[\w#:\.\-/]+$ Required: No Tags Tags that are associated with the release. Type: Array of Tag objects Array Members: Minimum number of 1 item. Required: No Timestamp The timestamp of the release. MobileSdkRelease 1377 AWS WAFV2 Type: Timestamp Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 MobileSdkRelease 1378 AWS WAFV2 NoneAction Service: AWS WAFV2 API Reference Speciﬁes that AWS WAF should do nothing. This is used for the OverrideAction setting on a Rule when the rule uses a rule group reference statement. This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction. JSON speciﬁcation: "None": {} Contents The members of this exception structure are context-dependent. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 NoneAction 1379 AWS WAFV2 NotStatement Service: AWS WAFV2 API Reference A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement. Contents Statement The statement to negate. You can use any statement that can be nested. Type: Statement object Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 NotStatement 1380 AWS WAFV2 OrStatement Service: AWS WAFV2 API Reference A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement. Contents Statements The statements to combine with OR logic. You can use any statements that can be nested. Type: Array of Statement objects Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 OrStatement 1381 AWS WAFV2 OverrideAction Service: AWS WAFV2 API Reference The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only. You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement. Note This option is usually set to none. It does not aﬀect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings. Contents Count Override the rule group evaluation result to count only. Note This option is usually set to none. It does not aﬀect how the rules
waf-apiref-283	waf-apiref.pdf	283	only. You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement. Note This option is usually set to none. It does not aﬀect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings. Contents Count Override the rule group evaluation result to count only. Note This option is usually set to none. It does not aﬀect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings. Type: CountAction object Required: No None Don't override the rule group evaluation result. This is the most common setting. Type: NoneAction object OverrideAction 1382 AWS WAFV2 Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 OverrideAction 1383 AWS WAFV2 PasswordField Service: AWS WAFV2 API Reference The name of the ﬁeld in the request payload that contains your customer's password. This data type is used in the RequestInspection and RequestInspectionACFP data types. Contents Identiﬁer The name of the password ﬁeld. How you specify this depends on the request inspection payload type. • For JSON payloads, specify the ﬁeld name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer. For example, for the JSON payload { "form": { "password": "THE_PASSWORD" } }, the password ﬁeld speciﬁcation is /form/password. • For form encoded payload types, use the HTML form names. For example, for an HTML form with the input element named password1, the password ﬁeld speciﬁcation is password1. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: .\S. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 PasswordField 1384 AWS WAFV2 • AWS SDK for Ruby V3 API Reference PasswordField 1385 AWS WAFV2 PhoneNumberField Service: AWS WAFV2 API Reference The name of a ﬁeld in the request payload that contains part or all of your customer's primary phone number. This data type is used in the RequestInspectionACFP data type. Contents Identiﬁer The name of a single primary phone number ﬁeld. How you specify the phone number ﬁelds depends on the request inspection payload type. • For JSON payloads, specify the ﬁeld identiﬁers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer. For example, for the JSON payload { "form": { "primaryphoneline1": "THE_PHONE1", "primaryphoneline2": "THE_PHONE2", "primaryphoneline3": "THE_PHONE3" } }, the phone number ﬁeld identiﬁers are /form/primaryphoneline1, /form/primaryphoneline2, and /form/primaryphoneline3. • For form encoded payload types, use the HTML form names. For example, for an HTML form with input elements named primaryphoneline1, primaryphoneline2, and primaryphoneline3, the phone number ﬁeld identiﬁers are primaryphoneline1, primaryphoneline2, and primaryphoneline3. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: .\S. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: PhoneNumberField 1386 AWS WAFV2 • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference PhoneNumberField 1387 AWS WAFV2 QueryString Service: AWS WAFV2 API Reference Inspect the query string of the web request. This is the part of a URL that appears after a ? character, if any. This is used in the FieldToMatch speciﬁcation for some web request component types. JSON speciﬁcation: "QueryString": {} Contents The members of this exception structure are context-dependent. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 QueryString 1388 AWS WAFV2 RateBasedStatement Service: AWS WAFV2 API Reference A rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance. Note If you change any of these settings in a rule that's currently in use, the change resets the rule's rate limiting counts. This can pause the rule's rate limiting activities for up to a
waf-apiref-284	waf-apiref.pdf	284	• AWS SDK for Java V2 • AWS SDK for Ruby V3 QueryString 1388 AWS WAFV2 RateBasedStatement Service: AWS WAFV2 API Reference A rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance. Note If you change any of these settings in a rule that's currently in use, the change resets the rule's rate limiting counts. This can pause the rule's rate limiting activities for up to a minute. You can specify individual aggregation keys, like IP address or HTTP method. You can also specify aggregation key combinations, like IP address and HTTP method, or HTTP method, query argument, and cookie. Each unique set of values for the aggregation keys that you specify is a separate aggregation instance, with the value from each key contributing to the aggregation instance deﬁnition. For example, assume the rule evaluates web requests with the following IP address and HTTP method values: • IP address 10.1.1.1, HTTP method POST • IP address 10.1.1.1, HTTP method GET • IP address 127.0.0.0, HTTP method POST • IP address 10.1.1.1, HTTP method GET The rule would create diﬀerent aggregation instances according to your aggregation criteria, for example: • If the aggregation criteria is just the IP address, then each individual address is an aggregation instance, and AWS WAF counts requests separately for each. The aggregation instances and request counts for our example would be the following: • IP address 10.1.1.1: count 3 • IP address 127.0.0.0: count 1 RateBasedStatement 1389 AWS WAFV2 API Reference • If the aggregation criteria is HTTP method, then each individual HTTP method is an aggregation instance. The aggregation instances and request counts for our example would be the following: • HTTP method POST: count 2 • HTTP method GET: count 2 • If the aggregation criteria is IP address and HTTP method, then each IP address and each HTTP method would contribute to the combined aggregation instance. The aggregation instances and request counts for our example would be the following: • IP address 10.1.1.1, HTTP method POST: count 1 • IP address 10.1.1.1, HTTP method GET: count 2 • IP address 127.0.0.0, HTTP method POST: count 1 For any n-tuple of aggregation keys, each unique combination of values for the keys deﬁnes a separate aggregation instance, which AWS WAF counts and rate-limits individually. You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts and rate limits requests that match the nested statement. You can use this nested scope-down statement in conjunction with your aggregation key speciﬁcations or you can just count and rate limit all requests that match the scope-down statement, without additional aggregation. When you choose to just manage all requests that match a scope-down statement, the aggregation instance is singular for the rule. You cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement. You can deﬁne a RateBasedStatement inside a web ACL and inside a rule group. For additional information about the options, see Rate limiting web requests using rate-based rules in the AWS WAF Developer Guide. If you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that AWS WAF is currently rate limiting for a rule through the API call GetRateBasedStatementManagedKeys. This option is not available for other aggregation conﬁgurations. AWS WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by AWS WAF. If you deﬁne a rate-based rule inside a rule group, and then use RateBasedStatement 1390 AWS WAFV2 API Reference that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by AWS WAF. Contents AggregateKeyType Setting that indicates how to aggregate the request counts. Note Web requests that are missing any of the components speciﬁed in the aggregation keys are omitted from the rate-based rule evaluation and handling. • CONSTANT - Count and limit the requests that match the rate-based rule's scope-down statement. With this option, the counted requests aren't further aggregated. The scope- down statement is the only speciﬁcation used. When the count of all requests that satisfy the scope-down statement goes over the limit, AWS WAF applies the rule action to all requests that satisfy the scope-down statement. With this option, you must conﬁgure the ScopeDownStatement property. • CUSTOM_KEYS -
waf-apiref-285	waf-apiref.pdf	285	request counts. Note Web requests that are missing any of the components speciﬁed in the aggregation keys are omitted from the rate-based rule evaluation and handling. • CONSTANT - Count and limit the requests that match the rate-based rule's scope-down statement. With this option, the counted requests aren't further aggregated. The scope- down statement is the only speciﬁcation used. When the count of all requests that satisfy the scope-down statement goes over the limit, AWS WAF applies the rule action to all requests that satisfy the scope-down statement. With this option, you must conﬁgure the ScopeDownStatement property. • CUSTOM_KEYS - Aggregate the request counts using one or more web request components as the aggregate keys. With this option, you must specify the aggregate keys in the CustomKeys property. To aggregate on only the IP address or only the forwarded IP address, don't use custom keys. Instead, set the aggregate key type to IP or FORWARDED_IP. • FORWARDED_IP - Aggregate the request counts on the ﬁrst IP address in an HTTP header. With this option, you must specify the header to use in the ForwardedIPConfig property. To aggregate on a combination of the forwarded IP address with other aggregate keys, use CUSTOM_KEYS. • IP - Aggregate the request counts on the IP address from the web request origin. To aggregate on a combination of the IP address with other aggregate keys, use CUSTOM_KEYS. RateBasedStatement 1391 AWS WAFV2 Type: String API Reference Valid Values: IP \| FORWARDED_IP \| CUSTOM_KEYS \| CONSTANT Required: Yes Limit The limit on requests during the speciﬁed evaluation window for a single aggregation instance for the rate-based rule. If the rate-based statement includes a ScopeDownStatement, this limit is applied only to the requests that match the statement. Examples: • If you aggregate on just the IP address, this is the limit on requests from any single IP address. • If you aggregate on the HTTP method and the query argument name "city", then this is the limit on requests for any single method, city pair. Type: Long Valid Range: Minimum value of 10. Maximum value of 2000000000. Required: Yes CustomKeys Speciﬁes the aggregate keys to use in a rate-base rule. Type: Array of RateBasedStatementCustomKey objects Array Members: Maximum number of 5 items. Required: No EvaluationWindowSec The amount of time, in seconds, that AWS WAF should include in its request counts, looking back from the current time. For example, for a setting of 120, when AWS WAF checks the rate, it counts the requests for the 2 minutes immediately preceding the current time. Valid settings are 60, 120, 300, and 600. This setting doesn't determine how often AWS WAF checks the rate, but how far back it looks each time it checks. AWS WAF checks the rate about every 10 seconds. RateBasedStatement 1392 AWS WAFV2 Default: 300 (5 minutes) Type: Long Required: No ForwardedIPConﬁg API Reference The conﬁguration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X- Forwarded-For (XFF) header, but you can specify any header name. Note If the speciﬁed header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all. This is required if you specify a forwarded IP in the rule's aggregate key settings. Type: ForwardedIPConﬁg object Required: No ScopeDownStatement An optional nested statement that narrows the scope of the web requests that are evaluated and managed by the rate-based statement. When you use a scope-down statement, the rate- based rule only tracks and rate limits requests that match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement. Type: Statement object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ RateBasedStatement 1393 AWS WAFV2 • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference RateBasedStatement 1394 AWS WAFV2 API Reference RateBasedStatementCustomKey Service: AWS WAFV2 Speciﬁes a single custom aggregate key for a rate-base rule. Note Web requests that are missing any of the components speciﬁed in the aggregation keys are omitted from the rate-based rule evaluation and handling. Contents Cookie Use the value of a cookie in the request as an aggregate key. Each distinct value in the cookie contributes to the aggregation instance. If you use a single cookie as your custom key, then each value fully deﬁnes an aggregation instance. Type: RateLimitCookie object Required: No ForwardedIP Use the ﬁrst IP address in an HTTP header as an aggregate key. Each distinct forwarded IP address contributes to the aggregation instance. When you specify an IP or
waf-apiref-286	waf-apiref.pdf	286	that are missing any of the components speciﬁed in the aggregation keys are omitted from the rate-based rule evaluation and handling. Contents Cookie Use the value of a cookie in the request as an aggregate key. Each distinct value in the cookie contributes to the aggregation instance. If you use a single cookie as your custom key, then each value fully deﬁnes an aggregation instance. Type: RateLimitCookie object Required: No ForwardedIP Use the ﬁrst IP address in an HTTP header as an aggregate key. Each distinct forwarded IP address contributes to the aggregation instance. When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the forwarded IP address by specifying FORWARDED_IP in your rate-based statement's AggregateKeyType. With this option, you must specify the header to use in the rate-based rule's ForwardedIPConfig property. Type: RateLimitForwardedIP object Required: No RateBasedStatementCustomKey 1395 AWS WAFV2 Header API Reference Use the value of a header in the request as an aggregate key. Each distinct value in the header contributes to the aggregation instance. If you use a single header as your custom key, then each value fully deﬁnes an aggregation instance. Type: RateLimitHeader object Required: No HTTPMethod Use the request's HTTP method as an aggregate key. Each distinct HTTP method contributes to the aggregation instance. If you use just the HTTP method as your custom key, then each method fully deﬁnes an aggregation instance. Type: RateLimitHTTPMethod object Required: No IP Use the request's originating IP address as an aggregate key. Each distinct IP address contributes to the aggregation instance. When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the IP address by specifying IP in your rate-based statement's AggregateKeyType. Type: RateLimitIP object Required: No JA3Fingerprint Use the request's JA3 ﬁngerprint as an aggregate key. If you use a single JA3 ﬁngerprint as your custom key, then each value fully deﬁnes an aggregation instance. Type: RateLimitJA3Fingerprint object Required: No JA4Fingerprint Use the request's JA4 ﬁngerprint as an aggregate key. If you use a single JA4 ﬁngerprint as your custom key, then each value fully deﬁnes an aggregation instance. RateBasedStatementCustomKey 1396 AWS WAFV2 API Reference Type: RateLimitJA4Fingerprint object Required: No LabelNamespace Use the speciﬁed label namespace as an aggregate key. Each distinct fully qualiﬁed label name that has the speciﬁed label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully deﬁnes an aggregation instance. This uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL. For information about label namespaces and names, see Label syntax and naming requirements in the AWS WAF Developer Guide. Type: RateLimitLabelNamespace object Required: No QueryArgument Use the speciﬁed query argument as an aggregate key. Each distinct value for the named query argument contributes to the aggregation instance. If you use a single query argument as your custom key, then each value fully deﬁnes an aggregation instance. Type: RateLimitQueryArgument object Required: No QueryString Use the request's query string as an aggregate key. Each distinct string contributes to the aggregation instance. If you use just the query string as your custom key, then each string fully deﬁnes an aggregation instance. Type: RateLimitQueryString object Required: No UriPath Use the request's URI path as an aggregate key. Each distinct URI path contributes to the aggregation instance. If you use just the URI path as your custom key, then each URI path fully deﬁnes an aggregation instance. RateBasedStatementCustomKey 1397 AWS WAFV2 API Reference Type: RateLimitUriPath object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RateBasedStatementCustomKey 1398 AWS WAFV2 API Reference RateBasedStatementManagedKeysIPSet Service: AWS WAFV2 The set of IP addresses that are currently blocked for a RateBasedStatement. This is only available for rate-based rules that aggregate on just the IP address, with the AggregateKeyType set to IP or FORWARDED_IP. A rate-based rule applies its rule action to requests from IP addresses that are in the rule's managed keys list and that match the rule's scope-down statement. When a rule has no scope- down statement, it applies the action to all requests from the IP addresses that are in the list. The rule applies its rule action to rate limit the matching requests. The action is usually Block but it can be any valid rule action except for Allow. The maximum number of IP addresses that can be rate limited by a single rate-based
waf-apiref-287	waf-apiref.pdf	287	AggregateKeyType set to IP or FORWARDED_IP. A rate-based rule applies its rule action to requests from IP addresses that are in the rule's managed keys list and that match the rule's scope-down statement. When a rule has no scope- down statement, it applies the action to all requests from the IP addresses that are in the list. The rule applies its rule action to rate limit the matching requests. The action is usually Block but it can be any valid rule action except for Allow. The maximum number of IP addresses that can be rate limited by a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, AWS WAF limits those with the highest rates. Contents Addresses The IP addresses that are currently blocked. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 50. Pattern: .\S. Required: No IPAddressVersion The version of the IP addresses, either IPV4 or IPV6. Type: String Valid Values: IPV4 \| IPV6 Required: No RateBasedStatementManagedKeysIPSet 1399 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RateBasedStatementManagedKeysIPSet 1400 AWS WAFV2 RateLimitCookie Service: AWS WAFV2 API Reference Speciﬁes a cookie as an aggregate key for a rate-based rule. Each distinct value in the cookie contributes to the aggregation instance. If you use a single cookie as your custom key, then each value fully deﬁnes an aggregation instance. Contents Name The name of the cookie to use. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: .\S. Required: Yes TextTransformations Text transformations eliminate some of the unusual formatting that attackers use in web requests in an eﬀort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the speciﬁed content, starting from the lowest priority setting, and then uses the transformed component contents. Type: Array of TextTransformation objects Array Members: Minimum number of 1 item. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: RateLimitCookie 1401 AWS WAFV2 • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference RateLimitCookie 1402 AWS WAFV2 RateLimitForwardedIP Service: AWS WAFV2 API Reference Speciﬁes the ﬁrst IP address in an HTTP header as an aggregate key for a rate-based rule. Each distinct forwarded IP address contributes to the aggregation instance. This setting is used only in the RateBasedStatementCustomKey speciﬁcation of a rate-based rule statement. When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the forwarded IP address by specifying FORWARDED_IP in your rate-based statement's AggregateKeyType. This data type supports using the forwarded IP address in the web request aggregation for a rate- based rule, in RateBasedStatementCustomKey. The JSON speciﬁcation for using the forwarded IP address doesn't explicitly use this data type. JSON speciﬁcation: "ForwardedIP": {} When you use this speciﬁcation, you must also conﬁgure the forwarded IP address in the rate- based statement's ForwardedIPConfig. Contents The members of this exception structure are context-dependent. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RateLimitForwardedIP 1403 AWS WAFV2 RateLimitHeader Service: AWS WAFV2 API Reference Speciﬁes a header as an aggregate key for a rate-based rule. Each distinct value in the header contributes to the aggregation instance. If you use a single header as your custom key, then each value fully deﬁnes an aggregation instance. Contents Name The name of the header to use. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: .\S. Required: Yes TextTransformations Text transformations eliminate some of the unusual formatting that attackers use in web requests in an eﬀort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the speciﬁed content, starting from the lowest priority setting, and then uses the transformed component contents. Type: Array of TextTransformation objects Array Members: Minimum number of 1 item. Required: Yes
waf-apiref-288	waf-apiref.pdf	288	Text transformations eliminate some of the unusual formatting that attackers use in web requests in an eﬀort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the speciﬁed content, starting from the lowest priority setting, and then uses the transformed component contents. Type: Array of TextTransformation objects Array Members: Minimum number of 1 item. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: RateLimitHeader 1404 AWS WAFV2 • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference RateLimitHeader 1405 AWS WAFV2 RateLimitHTTPMethod Service: AWS WAFV2 API Reference Speciﬁes the request's HTTP method as an aggregate key for a rate-based rule. Each distinct HTTP method contributes to the aggregation instance. If you use just the HTTP method as your custom key, then each method fully deﬁnes an aggregation instance. JSON speciﬁcation: "RateLimitHTTPMethod": {} Contents The members of this exception structure are context-dependent. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RateLimitHTTPMethod 1406 AWS WAFV2 RateLimitIP Service: AWS WAFV2 API Reference Speciﬁes the IP address in the web request as an aggregate key for a rate-based rule. Each distinct IP address contributes to the aggregation instance. This setting is used only in the RateBasedStatementCustomKey speciﬁcation of a rate-based rule statement. To use this in the custom key settings, you must specify at least one other key to use, along with the IP address. To aggregate on only the IP address, in your rate-based statement's AggregateKeyType, specify IP. JSON speciﬁcation: "RateLimitIP": {} Contents The members of this exception structure are context-dependent. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RateLimitIP 1407 AWS WAFV2 API Reference RateLimitJA3Fingerprint Service: AWS WAFV2 Use the request's JA3 ﬁngerprint derived from the TLS Client Hello of an incoming request as an aggregate key. If you use a single JA3 ﬁngerprint as your custom key, then each value fully deﬁnes an aggregation instance. Contents FallbackBehavior The match status to assign to the web request if there is insuﬃcient TSL Client Hello information to compute the JA3 ﬁngerprint. You can specify the following fallback behaviors: • MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request. • NO_MATCH - Treat the web request as not matching the rule statement. Type: String Valid Values: MATCH \| NO_MATCH Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RateLimitJA3Fingerprint 1408 AWS WAFV2 API Reference RateLimitJA4Fingerprint Service: AWS WAFV2 Use the request's JA4 ﬁngerprint derived from the TLS Client Hello of an incoming request as an aggregate key. If you use a single JA4 ﬁngerprint as your custom key, then each value fully deﬁnes an aggregation instance. Contents FallbackBehavior The match status to assign to the web request if there is insuﬃcient TSL Client Hello information to compute the JA4 ﬁngerprint. You can specify the following fallback behaviors: • MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request. • NO_MATCH - Treat the web request as not matching the rule statement. Type: String Valid Values: MATCH \| NO_MATCH Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RateLimitJA4Fingerprint 1409 AWS WAFV2 API Reference RateLimitLabelNamespace Service: AWS WAFV2 Speciﬁes a label namespace to use as an aggregate key for a rate-based rule. Each distinct fully qualiﬁed label name that has the speciﬁed label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully deﬁnes an aggregation instance. This uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL. For information about label namespaces and names, see Label syntax and naming requirements in the AWS WAF Developer Guide. Contents Namespace The
waf-apiref-289	waf-apiref.pdf	289	Service: AWS WAFV2 Speciﬁes a label namespace to use as an aggregate key for a rate-based rule. Each distinct fully qualiﬁed label name that has the speciﬁed label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully deﬁnes an aggregation instance. This uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL. For information about label namespaces and names, see Label syntax and naming requirements in the AWS WAF Developer Guide. Contents Namespace The namespace to use for aggregation. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: ^[0-9A-Za-z_\-:]+:$ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RateLimitLabelNamespace 1410 AWS WAFV2 API Reference RateLimitQueryArgument Service: AWS WAFV2 Speciﬁes a query argument in the request as an aggregate key for a rate-based rule. Each distinct value for the named query argument contributes to the aggregation instance. If you use a single query argument as your custom key, then each value fully deﬁnes an aggregation instance. Contents Name The name of the query argument to use. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: .\S. Required: Yes TextTransformations Text transformations eliminate some of the unusual formatting that attackers use in web requests in an eﬀort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the speciﬁed content, starting from the lowest priority setting, and then uses the transformed component contents. Type: Array of TextTransformation objects Array Members: Minimum number of 1 item. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: RateLimitQueryArgument 1411 AWS WAFV2 • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference RateLimitQueryArgument 1412 AWS WAFV2 RateLimitQueryString Service: AWS WAFV2 API Reference Speciﬁes the request's query string as an aggregate key for a rate-based rule. Each distinct string contributes to the aggregation instance. If you use just the query string as your custom key, then each string fully deﬁnes an aggregation instance. Contents TextTransformations Text transformations eliminate some of the unusual formatting that attackers use in web requests in an eﬀort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the speciﬁed content, starting from the lowest priority setting, and then uses the transformed component contents. Type: Array of TextTransformation objects Array Members: Minimum number of 1 item. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RateLimitQueryString 1413 AWS WAFV2 RateLimitUriPath Service: AWS WAFV2 API Reference Speciﬁes the request's URI path as an aggregate key for a rate-based rule. Each distinct URI path contributes to the aggregation instance. If you use just the URI path as your custom key, then each URI path fully deﬁnes an aggregation instance. Contents TextTransformations Text transformations eliminate some of the unusual formatting that attackers use in web requests in an eﬀort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the speciﬁed content, starting from the lowest priority setting, and then uses the transformed component contents. Type: Array of TextTransformation objects Array Members: Minimum number of 1 item. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RateLimitUriPath 1414 API Reference AWS WAFV2 Regex Service: AWS WAFV2 A single regular expression. This is used in a RegexPatternSet. Contents RegexString The string representing the regular expression. Type: String Length Constraints: Minimum length of 1. Maximum length of
waf-apiref-290	waf-apiref.pdf	290	the lowest priority setting, and then uses the transformed component contents. Type: Array of TextTransformation objects Array Members: Minimum number of 1 item. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RateLimitUriPath 1414 API Reference AWS WAFV2 Regex Service: AWS WAFV2 A single regular expression. This is used in a RegexPatternSet. Contents RegexString The string representing the regular expression. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: .* Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Regex 1415 AWS WAFV2 RegexMatchStatement Service: AWS WAFV2 API Reference A rule statement used to search web request components for a match against a single regular expression. Contents FieldToMatch The part of the web request that you want AWS WAF to inspect. Type: FieldToMatch object Required: Yes RegexString The string representing the regular expression. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: .* Required: Yes TextTransformations Text transformations eliminate some of the unusual formatting that attackers use in web requests in an eﬀort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the speciﬁed content, starting from the lowest priority setting, and then uses the transformed component contents. Type: Array of TextTransformation objects Array Members: Minimum number of 1 item. Required: Yes RegexMatchStatement 1416 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RegexMatchStatement 1417 AWS WAFV2 RegexPatternSet Service: AWS WAFV2 Contains one or more regular expressions. API Reference AWS WAF assigns an ARN to each RegexPatternSet that you create. To use a set in a rule, you provide the ARN to the Rule statement RegexPatternSetReferenceStatement. Contents ARN The Amazon Resource Name (ARN) of the entity. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .\S. Required: No Description A description of the set that helps with identiﬁcation. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$ Required: No Id A unique identiﬁer for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ RegexPatternSet 1418 AWS WAFV2 Required: No Name API Reference The name of the set. You cannot change the name after you create the set. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: No RegularExpressionList The regular expression patterns in the set. Type: Array of Regex objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RegexPatternSet 1419 AWS WAFV2 API Reference RegexPatternSetReferenceStatement Service: AWS WAFV2 A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that speciﬁes the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet. Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it. Contents ARN The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .\S. Required: Yes FieldToMatch The part of the web request that you want AWS WAF to inspect. Type: FieldToMatch object Required: Yes TextTransformations Text transformations eliminate some of the unusual formatting that attackers use in web requests in an eﬀort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule
waf-apiref-291	waf-apiref.pdf	291	automatically updates all rules that reference it. Contents ARN The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .\S. Required: Yes FieldToMatch The part of the web request that you want AWS WAF to inspect. Type: FieldToMatch object Required: Yes TextTransformations Text transformations eliminate some of the unusual formatting that attackers use in web requests in an eﬀort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF RegexPatternSetReferenceStatement 1420 AWS WAFV2 API Reference performs all transformations on the speciﬁed content, starting from the lowest priority setting, and then uses the transformed component contents. Type: Array of TextTransformation objects Array Members: Minimum number of 1 item. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RegexPatternSetReferenceStatement 1421 AWS WAFV2 API Reference RegexPatternSetSummary Service: AWS WAFV2 High-level information about a RegexPatternSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RegexPatternSet, and the ARN, that you provide to the RegexPatternSetReferenceStatement to use the pattern set in a Rule. Contents ARN The Amazon Resource Name (ARN) of the entity. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .\S. Required: No Description A description of the set that helps with identiﬁcation. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$ Required: No Id A unique identiﬁer for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ RegexPatternSetSummary 1422 AWS WAFV2 Required: No LockToken API Reference A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ Required: No Name The name of the data type instance. You cannot change the name after you create the instance. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RegexPatternSetSummary 1423 API Reference AWS WAFV2 ReleaseSummary Service: AWS WAFV2 High level information for an SDK release. Contents ReleaseVersion The release version. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^[\w#:\.\-/]+$ Required: No Timestamp The timestamp of the release. Type: Timestamp Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ReleaseSummary 1424 AWS WAFV2 API Reference RequestBodyAssociatedResourceTypeConﬁg Service: AWS WAFV2 Customizes the maximum size of the request body that your protected CloudFront, API Gateway, Amazon Cognito, App Runner, and Veriﬁed Access resources forward to AWS WAF for inspection. The default size is 16 KB (16,384 bytes). You can change the setting for any of the available resource types. Note You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see AWS WAF Pricing. Example JSON: { "API_GATEWAY": "KB_48", "APP_RUNNER_SERVICE": "KB_32" } For Application Load Balancer and AWS AppSync, the limit is ﬁxed at 8 KB (8,192 bytes). This is used in the AssociationConfig of the web ACL. Contents DefaultSizeInspectionLimit Speciﬁes the maximum size of the web request body component that an associated CloudFront, API Gateway, Amazon Cognito, App Runner, or Veriﬁed Access resource should send to AWS WAF for inspection. This applies to statements in the web ACL that inspect the body or JSON body. Default: 16 KB (16,384 bytes) Type: String Valid Values:
waf-apiref-292	waf-apiref.pdf	292	the default. For more information, see AWS WAF Pricing. Example JSON: { "API_GATEWAY": "KB_48", "APP_RUNNER_SERVICE": "KB_32" } For Application Load Balancer and AWS AppSync, the limit is ﬁxed at 8 KB (8,192 bytes). This is used in the AssociationConfig of the web ACL. Contents DefaultSizeInspectionLimit Speciﬁes the maximum size of the web request body component that an associated CloudFront, API Gateway, Amazon Cognito, App Runner, or Veriﬁed Access resource should send to AWS WAF for inspection. This applies to statements in the web ACL that inspect the body or JSON body. Default: 16 KB (16,384 bytes) Type: String Valid Values: KB_16 \| KB_32 \| KB_48 \| KB_64 Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: RequestBodyAssociatedResourceTypeConﬁg 1425 AWS WAFV2 • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference RequestBodyAssociatedResourceTypeConﬁg 1426 AWS WAFV2 RequestInspection Service: AWS WAFV2 API Reference The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage. This is part of the AWSManagedRulesATPRuleSet conﬁguration in ManagedRuleGroupConfig. In these settings, you specify how your application accepts login attempts by providing the request payload type and the names of the ﬁelds within the request body where the username and password are provided. Contents PasswordField The name of the ﬁeld in the request payload that contains your customer's password. How you specify this depends on the request inspection payload type. • For JSON payloads, specify the ﬁeld name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer. For example, for the JSON payload { "form": { "password": "THE_PASSWORD" } }, the password ﬁeld speciﬁcation is /form/password. • For form encoded payload types, use the HTML form names. For example, for an HTML form with the input element named password1, the password ﬁeld speciﬁcation is password1. Type: PasswordField object Required: Yes PayloadType The payload type for your login endpoint, either JSON or form encoded. Type: String Valid Values: JSON \| FORM_ENCODED Required: Yes RequestInspection 1427 AWS WAFV2 UsernameField API Reference The name of the ﬁeld in the request payload that contains your customer's username. How you specify this depends on the request inspection payload type. • For JSON payloads, specify the ﬁeld name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer. For example, for the JSON payload { "form": { "username": "THE_USERNAME" } }, the username ﬁeld speciﬁcation is /form/username. • For form encoded payload types, use the HTML form names. For example, for an HTML form with the input element named username1, the username ﬁeld speciﬁcation is username1 Type: UsernameField object Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RequestInspection 1428 AWS WAFV2 API Reference RequestInspectionACFP Service: AWS WAFV2 The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts. This is part of the AWSManagedRulesACFPRuleSet conﬁguration in ManagedRuleGroupConfig. In these settings, you specify how your application accepts account creation attempts by providing the request payload type and the names of the ﬁelds within the request body where the username, password, email, and primary address and phone number ﬁelds are provided. Contents PayloadType The payload type for your account creation endpoint, either JSON or form encoded. Type: String Valid Values: JSON \| FORM_ENCODED Required: Yes AddressFields The names of the ﬁelds in the request payload that contain your customer's primary physical address. Order the address ﬁelds in the array exactly as they are ordered in the request payload. How you specify the address ﬁelds depends on the request inspection payload type. • For JSON payloads, specify the ﬁeld identiﬁers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer. For example, for the JSON payload { "form": { "primaryaddressline1": "THE_ADDRESS1", "primaryaddressline2": "THE_ADDRESS2", "primaryaddressline3": "THE_ADDRESS3" } }, the address ﬁeld idenﬁers are /form/primaryaddressline1, /form/primaryaddressline2, and /form/ primaryaddressline3. RequestInspectionACFP 1429 AWS WAFV2 API Reference • For form encoded payload types, use the HTML form names. For example, for an HTML form with input elements named primaryaddressline1, primaryaddressline2, and primaryaddressline3, the address ﬁelds identiﬁers are primaryaddressline1, primaryaddressline2, and primaryaddressline3. Type: Array of AddressField objects Required: No EmailField The name of the ﬁeld in the request payload that contains your customer's email. How you specify this depends on the request inspection payload type. • For JSON payloads, specify the ﬁeld name in JSON
waf-apiref-293	waf-apiref.pdf	293	"THE_ADDRESS1", "primaryaddressline2": "THE_ADDRESS2", "primaryaddressline3": "THE_ADDRESS3" } }, the address ﬁeld idenﬁers are /form/primaryaddressline1, /form/primaryaddressline2, and /form/ primaryaddressline3. RequestInspectionACFP 1429 AWS WAFV2 API Reference • For form encoded payload types, use the HTML form names. For example, for an HTML form with input elements named primaryaddressline1, primaryaddressline2, and primaryaddressline3, the address ﬁelds identiﬁers are primaryaddressline1, primaryaddressline2, and primaryaddressline3. Type: Array of AddressField objects Required: No EmailField The name of the ﬁeld in the request payload that contains your customer's email. How you specify this depends on the request inspection payload type. • For JSON payloads, specify the ﬁeld name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer. For example, for the JSON payload { "form": { "email": "THE_EMAIL" } }, the email ﬁeld speciﬁcation is /form/email. • For form encoded payload types, use the HTML form names. For example, for an HTML form with the input element named email1, the email ﬁeld speciﬁcation is email1. Type: EmailField object Required: No PasswordField The name of the ﬁeld in the request payload that contains your customer's password. How you specify this depends on the request inspection payload type. • For JSON payloads, specify the ﬁeld name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer. For example, for the JSON payload { "form": { "password": "THE_PASSWORD" } }, the password ﬁeld speciﬁcation is /form/password. • For form encoded payload types, use the HTML form names. RequestInspectionACFP 1430 AWS WAFV2 API Reference For example, for an HTML form with the input element named password1, the password ﬁeld speciﬁcation is password1. Type: PasswordField object Required: No PhoneNumberFields The names of the ﬁelds in the request payload that contain your customer's primary phone number. Order the phone number ﬁelds in the array exactly as they are ordered in the request payload. How you specify the phone number ﬁelds depends on the request inspection payload type. • For JSON payloads, specify the ﬁeld identiﬁers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer. For example, for the JSON payload { "form": { "primaryphoneline1": "THE_PHONE1", "primaryphoneline2": "THE_PHONE2", "primaryphoneline3": "THE_PHONE3" } }, the phone number ﬁeld identiﬁers are /form/primaryphoneline1, /form/primaryphoneline2, and /form/primaryphoneline3. • For form encoded payload types, use the HTML form names. For example, for an HTML form with input elements named primaryphoneline1, primaryphoneline2, and primaryphoneline3, the phone number ﬁeld identiﬁers are primaryphoneline1, primaryphoneline2, and primaryphoneline3. Type: Array of PhoneNumberField objects Required: No UsernameField The name of the ﬁeld in the request payload that contains your customer's username. How you specify this depends on the request inspection payload type. • For JSON payloads, specify the ﬁeld name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer. RequestInspectionACFP 1431 AWS WAFV2 API Reference For example, for the JSON payload { "form": { "username": "THE_USERNAME" } }, the username ﬁeld speciﬁcation is /form/username. • For form encoded payload types, use the HTML form names. For example, for an HTML form with the input element named username1, the username ﬁeld speciﬁcation is username1 Type: UsernameField object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RequestInspectionACFP 1432 AWS WAFV2 ResponseInspection Service: AWS WAFV2 API Reference The criteria for inspecting responses to login requests and account creation requests, used by the ATP and ACFP rule groups to track login and account creation success and failure rates. Note Response inspection is available only in web ACLs that protect Amazon CloudFront distributions. The rule groups evaluates the responses that your protected resources send back to client login and account creation attempts, keeping count of successful and failed attempts from each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses with too much suspicious activity in a short amount of time. This is part of the AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet conﬁgurations in ManagedRuleGroupConfig. Enable response inspection by conﬁguring exactly one component of the response to inspect, for example, Header or StatusCode. You can't conﬁgure more than one component for inspection. If you don't conﬁgure any of the response inspection options, response inspection is disabled. Contents BodyContains Conﬁgures inspection of the response body for success and failure indicators. AWS WAF can inspect the ﬁrst 65,536 bytes (64 KB) of the response body. Type: ResponseInspectionBodyContains object Required: No Header Conﬁgures inspection of the response header for
waf-apiref-294	waf-apiref.pdf	294	suspicious activity in a short amount of time. This is part of the AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet conﬁgurations in ManagedRuleGroupConfig. Enable response inspection by conﬁguring exactly one component of the response to inspect, for example, Header or StatusCode. You can't conﬁgure more than one component for inspection. If you don't conﬁgure any of the response inspection options, response inspection is disabled. Contents BodyContains Conﬁgures inspection of the response body for success and failure indicators. AWS WAF can inspect the ﬁrst 65,536 bytes (64 KB) of the response body. Type: ResponseInspectionBodyContains object Required: No Header Conﬁgures inspection of the response header for success and failure indicators. Type: ResponseInspectionHeader object Required: No ResponseInspection 1433 AWS WAFV2 Json API Reference Conﬁgures inspection of the response JSON for success and failure indicators. AWS WAF can inspect the ﬁrst 65,536 bytes (64 KB) of the response JSON. Type: ResponseInspectionJson object Required: No StatusCode Conﬁgures inspection of the response status code for success and failure indicators. Type: ResponseInspectionStatusCode object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ResponseInspection 1434 AWS WAFV2 API Reference ResponseInspectionBodyContains Service: AWS WAFV2 Conﬁgures inspection of the response body. AWS WAF can inspect the ﬁrst 65,536 bytes (64 KB) of the response body. This is part of the ResponseInspection conﬁguration for AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet. Note Response inspection is available only in web ACLs that protect Amazon CloudFront distributions. Contents FailureStrings Strings in the body of the response that indicate a failed login or account creation attempt. To be counted as a failure, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings. JSON example: "FailureStrings": [ "Request failed" ] Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 5 items. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: .\S. Required: Yes SuccessStrings Strings in the body of the response that indicate a successful login or account creation attempt. To be counted as a success, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings. JSON examples: "SuccessStrings": [ "Login successful" ] and "SuccessStrings": [ "Account creation successful", "Welcome to our site!" ] ResponseInspectionBodyContains 1435 AWS WAFV2 Type: Array of strings API Reference Array Members: Minimum number of 1 item. Maximum number of 5 items. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: .\S. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ResponseInspectionBodyContains 1436 AWS WAFV2 API Reference ResponseInspectionHeader Service: AWS WAFV2 Conﬁgures inspection of the response header. This is part of the ResponseInspection conﬁguration for AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet. Note Response inspection is available only in web ACLs that protect Amazon CloudFront distributions. Contents FailureValues Values in the response header with the speciﬁed name that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values. JSON examples: "FailureValues": [ "LoginFailed", "Failed login" ] and "FailureValues": [ "AccountCreationFailed" ] Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 3 items. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: .\S. Required: Yes Name The name of the header to match against. The name must be an exact match, including case. JSON example: "Name": [ "RequestResult" ] Type: String Length Constraints: Minimum length of 1. Maximum length of 200. ResponseInspectionHeader 1437 AWS WAFV2 Pattern: .\S. Required: Yes SuccessValues API Reference Values in the response header with the speciﬁed name that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values. JSON examples: "SuccessValues": [ "LoginPassed", "Successful login" ] and "SuccessValues": [ "AccountCreated", "Successful account creation" ] Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 3 items. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: .\S. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ResponseInspectionHeader 1438 AWS WAFV2 API Reference ResponseInspectionJson Service: AWS WAFV2 Conﬁgures inspection of the
waf-apiref-295	waf-apiref.pdf	295	success and failure values. JSON examples: "SuccessValues": [ "LoginPassed", "Successful login" ] and "SuccessValues": [ "AccountCreated", "Successful account creation" ] Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 3 items. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: .\S. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ResponseInspectionHeader 1438 AWS WAFV2 API Reference ResponseInspectionJson Service: AWS WAFV2 Conﬁgures inspection of the response JSON. AWS WAF can inspect the ﬁrst 65,536 bytes (64 KB) of the response JSON. This is part of the ResponseInspection conﬁguration for AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet. Note Response inspection is available only in web ACLs that protect Amazon CloudFront distributions. Contents FailureValues Values for the speciﬁed identiﬁer in the response JSON that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values. JSON example: "FailureValues": [ "False", "Failed" ] Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 5 items. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: .\S. Required: Yes Identiﬁer The identiﬁer for the value to match against in the JSON. The identiﬁer must be an exact match, including case. JSON examples: "Identifier": [ "/login/success" ] and "Identifier": [ "/ sign-up/success" ] Type: String ResponseInspectionJson 1439 AWS WAFV2 API Reference Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: .\S. Required: Yes SuccessValues Values for the speciﬁed identiﬁer in the response JSON that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values. JSON example: "SuccessValues": [ "True", "Succeeded" ] Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 5 items. Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: .\S. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ResponseInspectionJson 1440 AWS WAFV2 API Reference ResponseInspectionStatusCode Service: AWS WAFV2 Conﬁgures inspection of the response status code. This is part of the ResponseInspection conﬁguration for AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet. Note Response inspection is available only in web ACLs that protect Amazon CloudFront distributions. Contents FailureCodes Status codes in the response that indicate a failed login or account creation attempt. To be counted as a failure, the response status code must match one of these. Each code must be unique among the success and failure status codes. JSON example: "FailureCodes": [ 400, 404 ] Type: Array of integers Array Members: Minimum number of 1 item. Maximum number of 10 items. Valid Range: Minimum value of 0. Maximum value of 999. Required: Yes SuccessCodes Status codes in the response that indicate a successful login or account creation attempt. To be counted as a success, the response status code must match one of these. Each code must be unique among the success and failure status codes. JSON example: "SuccessCodes": [ 200, 201 ] Type: Array of integers Array Members: Minimum number of 1 item. Maximum number of 10 items. ResponseInspectionStatusCode 1441 AWS WAFV2 API Reference Valid Range: Minimum value of 0. Maximum value of 999. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ResponseInspectionStatusCode 1442 AWS WAFV2 Rule Service: AWS WAFV2 API Reference A single rule, which you can use in a WebACL or RuleGroup to identify web requests that you want to manage in some way. Each rule includes one top-level Statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them. Contents Name The name of the rule. If you change the name of a Rule after you create it and you want the rule's metric name to reﬂect the change, update the metric name in the rule's VisibilityConfig settings. AWS WAF doesn't automatically update the metric name when you update the rule name. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: Yes Priority If you deﬁne more than one Rule in a WebACL, AWS WAF evaluates each request against the Rules in order based on the value of Priority. AWS WAF processes rules with lower priority ﬁrst. The priorities
waf-apiref-296	waf-apiref.pdf	296	rule. If you change the name of a Rule after you create it and you want the rule's metric name to reﬂect the change, update the metric name in the rule's VisibilityConfig settings. AWS WAF doesn't automatically update the metric name when you update the rule name. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: Yes Priority If you deﬁne more than one Rule in a WebACL, AWS WAF evaluates each request against the Rules in order based on the value of Priority. AWS WAF processes rules with lower priority ﬁrst. The priorities don't need to be consecutive, but they must all be diﬀerent. Type: Integer Valid Range: Minimum value of 0. Required: Yes Statement The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement. Type: Statement object Rule 1443 AWS WAFV2 Required: Yes VisibilityConﬁg API Reference Deﬁnes and enables Amazon CloudWatch metrics and web request sample collection. If you change the name of a Rule after you create it and you want the rule's metric name to reﬂect the change, update the metric name as well. AWS WAF doesn't automatically update the metric name. Type: VisibilityConﬁg object Required: Yes Action The action that AWS WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting. This is used only for rules whose statements do not reference a rule group. Rule statements that reference a rule group include RuleGroupReferenceStatement and ManagedRuleGroupStatement. You must specify either this Action setting or the rule OverrideAction setting, but not both: • If the rule statement does not reference a rule group, use this rule action setting and not the rule override action setting. • If the rule statement references a rule group, use the override action setting and not this action setting. Type: RuleAction object Required: No CaptchaConﬁg Speciﬁes how AWS WAF should handle CAPTCHA evaluations. If you don't specify this, AWS WAF uses the CAPTCHA conﬁguration that's deﬁned for the web ACL. Type: CaptchaConﬁg object Required: No Rule 1444 AWS WAFV2 ChallengeConﬁg API Reference Speciﬁes how AWS WAF should handle Challenge evaluations. If you don't specify this, AWS WAF uses the challenge conﬁguration that's deﬁned for the web ACL. Type: ChallengeConﬁg object Required: No OverrideAction The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only. You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement. Note This option is usually set to none. It does not aﬀect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with Count action, in your rule group reference statement settings. Type: OverrideAction object Required: No RuleLabels Labels to apply to web requests that match the rule match statement. AWS WAF applies fully qualiﬁed labels to matching web requests. A fully qualiﬁed label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL deﬁnes the label namespace. Note Any rule that isn't a rule group reference statement or managed rule group statement can add labels to matching web requests. Rule 1445 AWS WAFV2 API Reference Rules that run after this rule in the web ACL can match against these labels using a LabelMatchStatement. For each label, provide a case-sensitive string containing optional namespaces and a label name, according to the following guidelines: • Separate each component of the label with a colon. • Each namespace or name can have up to 128 characters. • You can specify up to 5 namespaces in a label. • Don't use the following reserved words in your label speciﬁcation: aws, waf, managed, rulegroup, webacl, regexpatternset, or ipset. For example, myLabelName or nameSpace1:nameSpace2:myLabelName. Type: Array of Label objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Rule 1446 AWS WAFV2 RuleAction Service: AWS WAFV2 API Reference The action that AWS WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting. Contents Allow Instructs AWS WAF to allow the web request. Type: AllowAction object Required: No Block Instructs AWS WAF to block the web request. Type: BlockAction object Required: No Captcha Instructs AWS WAF to run a CAPTCHA check against the web
waf-apiref-297	waf-apiref.pdf	297	see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Rule 1446 AWS WAFV2 RuleAction Service: AWS WAFV2 API Reference The action that AWS WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting. Contents Allow Instructs AWS WAF to allow the web request. Type: AllowAction object Required: No Block Instructs AWS WAF to block the web request. Type: BlockAction object Required: No Captcha Instructs AWS WAF to run a CAPTCHA check against the web request. Type: CaptchaAction object Required: No Challenge Instructs AWS WAF to run a Challenge check against the web request. Type: ChallengeAction object Required: No Count Instructs AWS WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL. Type: CountAction object RuleAction 1447 AWS WAFV2 Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RuleAction 1448 AWS WAFV2 RuleActionOverride Service: AWS WAFV2 API Reference Action setting to use in the place of a rule action that is conﬁgured inside the rule group. You specify one override for each rule whose action you want to change. Note Take care to verify the rule names in your overrides. If you provide a rule name that doesn't match the name of any rule in the rule group, AWS WAF doesn't return an error and doesn't apply the override setting. You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traﬃc. You can also permanently override some or all actions, to modify how the rule group manages your web traﬃc. Contents ActionToUse The override action to use, in place of the conﬁgured action of the rule in the rule group. Type: RuleAction object Required: Yes Name The name of the rule to override. Note Take care to verify the rule names in your overrides. If you provide a rule name that doesn't match the name of any rule in the rule group, AWS WAF doesn't return an error and doesn't apply the override setting. Type: String RuleActionOverride 1449 AWS WAFV2 API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RuleActionOverride 1450 AWS WAFV2 RuleGroup Service: AWS WAFV2 API Reference A rule group deﬁnes a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you deﬁne an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with conﬁdence in its capacity requirements. Contents ARN The Amazon Resource Name (ARN) of the entity. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .\S. Required: Yes Capacity The web ACL capacity units (WCUs) required for this rule group. When you create your own rule group, you deﬁne this, and you cannot change it after creation. When you add or modify the rules in a rule group, AWS WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity. AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity diﬀerently for each rule type, to reﬂect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is ﬁxed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see AWS WAF web ACL capacity units (WCU) in the AWS WAF Developer Guide. Type: Long Valid Range: Minimum value of 1. Required: Yes RuleGroup 1451 AWS WAFV2 Id API Reference A unique identiﬁer for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ Required: Yes Name The name of the rule group. You cannot change the name of a rule group after you create it. Type: String Length Constraints: Minimum length of
waf-apiref-298	waf-apiref.pdf	298	WAF web ACL capacity units (WCU) in the AWS WAF Developer Guide. Type: Long Valid Range: Minimum value of 1. Required: Yes RuleGroup 1451 AWS WAFV2 Id API Reference A unique identiﬁer for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ Required: Yes Name The name of the rule group. You cannot change the name of a rule group after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: Yes VisibilityConﬁg Deﬁnes and enables Amazon CloudWatch metrics and web request sample collection. Type: VisibilityConﬁg object Required: Yes AvailableLabels The labels that one or more rules in this rule group add to matching web requests. These labels are deﬁned in the RuleLabels for a Rule. Type: Array of LabelSummary objects Required: No ConsumedLabels The labels that one or more rules in this rule group match against in label match statements. These labels are deﬁned in a LabelMatchStatement speciﬁcation, in the Statement deﬁnition of a rule. RuleGroup 1452 AWS WAFV2 API Reference Type: Array of LabelSummary objects Required: No CustomResponseBodies A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You deﬁne these for the rule group, and then use them in the rules that you deﬁne in the rule group. For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide. For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide. Type: String to CustomResponseBody object map Map Entries: Maximum number of items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: ^[\w\-]+$ Required: No Description A description of the rule group that helps with identiﬁcation. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$ Required: No LabelNamespace The label namespace preﬁx for this rule group. All labels added by rules in this rule group have this preﬁx. • The syntax for the label namespace preﬁx for your rule groups is the following: awswaf:<account ID>:rulegroup:<rule group name>: RuleGroup 1453 AWS WAFV2 API Reference • When a rule with a label matches a web request, AWS WAF adds the fully qualiﬁed label to the request. A fully qualiﬁed label is made up of the label namespace from the rule group or web ACL where the rule is deﬁned and the label from the rule, separated by a colon: <label namespace>:<label from rule> Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: ^[0-9A-Za-z_\-:]+$ Required: No Rules The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them. Type: Array of Rule objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RuleGroup 1454 AWS WAFV2 API Reference RuleGroupReferenceStatement Service: AWS WAFV2 A rule statement used to run the rules that are deﬁned in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement. You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. You cannot use a rule group reference statement inside another rule group. You can only reference a rule group as a top-level statement within a rule that you deﬁne in a web ACL. Contents ARN The Amazon Resource Name (ARN) of the entity. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .\S. Required: Yes ExcludedRules Rules in the referenced rule group whose actions are set to Count. Note Instead of this option, use RuleActionOverrides. It accepts any valid action setting, including Count. Type: Array of ExcludedRule objects Array Members: Maximum number of 100 items. Required: No RuleGroupReferenceStatement 1455 AWS WAFV2 RuleActionOverrides API Reference Action settings to use in the place of the rule actions that are conﬁgured inside the rule group. You specify one override for each rule whose action you want to change. Note Take care to verify the rule names in your overrides. If you provide a rule name that doesn't match the name of any rule in the rule group, AWS WAF doesn't return an error and doesn't apply the override setting.
waf-apiref-299	waf-apiref.pdf	299	accepts any valid action setting, including Count. Type: Array of ExcludedRule objects Array Members: Maximum number of 100 items. Required: No RuleGroupReferenceStatement 1455 AWS WAFV2 RuleActionOverrides API Reference Action settings to use in the place of the rule actions that are conﬁgured inside the rule group. You specify one override for each rule whose action you want to change. Note Take care to verify the rule names in your overrides. If you provide a rule name that doesn't match the name of any rule in the rule group, AWS WAF doesn't return an error and doesn't apply the override setting. You can use overrides for testing, for example you can override all of rule actions to Count and then monitor the resulting count metrics to understand how the rule group would handle your web traﬃc. You can also permanently override some or all actions, to modify how the rule group manages your web traﬃc. Type: Array of RuleActionOverride objects Array Members: Maximum number of 100 items. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RuleGroupReferenceStatement 1456 AWS WAFV2 RuleGroupSummary Service: AWS WAFV2 API Reference High-level information about a RuleGroup, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule. Contents ARN The Amazon Resource Name (ARN) of the entity. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .\S. Required: No Description A description of the rule group that helps with identiﬁcation. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$ Required: No Id A unique identiﬁer for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ RuleGroupSummary 1457 AWS WAFV2 Required: No LockToken API Reference A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ Required: No Name The name of the data type instance. You cannot change the name after you create the instance. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RuleGroupSummary 1458 AWS WAFV2 RuleSummary Service: AWS WAFV2 API Reference High-level information about a Rule, returned by operations like DescribeManagedRuleGroup. This provides information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule. Contents Action The action that AWS WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting. Type: RuleAction object Required: No Name The name of the rule. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RuleSummary 1459 AWS WAFV2 SampledHTTPRequest Service: AWS WAFV2 API Reference Represents a single sampled web request. The response from GetSampledRequests includes a SampledHTTPRequests complex type that appears as SampledRequests in the response syntax. SampledHTTPRequests contains an array of SampledHTTPRequest objects. Contents Request A complex type that contains detailed information about the request. Type: HTTPRequest object Required: Yes Weight A value that indicates how one result in the response relates proportionally to other results in the response. For example, a result that has a weight of 2 represents roughly twice as many web requests as a result that has a weight of 1. Type: Long Valid
waf-apiref-300	waf-apiref.pdf	300	Service: AWS WAFV2 API Reference Represents a single sampled web request. The response from GetSampledRequests includes a SampledHTTPRequests complex type that appears as SampledRequests in the response syntax. SampledHTTPRequests contains an array of SampledHTTPRequest objects. Contents Request A complex type that contains detailed information about the request. Type: HTTPRequest object Required: Yes Weight A value that indicates how one result in the response relates proportionally to other results in the response. For example, a result that has a weight of 2 represents roughly twice as many web requests as a result that has a weight of 1. Type: Long Valid Range: Minimum value of 0. Required: Yes Action The action that AWS WAF applied to the request. Type: String Required: No CaptchaResponse The CAPTCHA response for the request. Type: CaptchaResponse object Required: No SampledHTTPRequest 1460 AWS WAFV2 ChallengeResponse The Challenge response for the request. Type: ChallengeResponse object Required: No Labels API Reference Labels applied to the web request by matching rules. AWS WAF applies fully qualiﬁed labels to matching web requests. A fully qualiﬁed label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL deﬁnes the label namespace. For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or awswaf:managed:aws:managed-rule-set:header:encoding:utf8. Type: Array of Label objects Required: No OverriddenAction Used only for rule group rules that have a rule action override in place in the web ACL. This is the action that the rule group rule is conﬁgured for, and not the action that was applied to the request. The action that AWS WAF applied is the Action value. Type: String Required: No RequestHeadersInserted Custom request headers inserted by AWS WAF into the request, according to the custom request conﬁguration for the matching rule action. Type: Array of HTTPHeader objects Required: No ResponseCodeSent The response code that was sent for the request. SampledHTTPRequest 1461 AWS WAFV2 Type: Integer API Reference Valid Range: Minimum value of 200. Maximum value of 599. Required: No RuleNameWithinRuleGroup The name of the Rule that the request matched. For managed rule groups, the format for this name is <vendor name>#<managed rule group name>#<rule name>. For your own rule groups, the format for this name is <rule group name>#<rule name>. If the rule is not in a rule group, this ﬁeld is absent. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: No Timestamp The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds). Type: Timestamp Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SampledHTTPRequest 1462 AWS WAFV2 SingleHeader Service: AWS WAFV2 API Reference Inspect one of the headers in the web request, identiﬁed by name, for example, User-Agent or Referer. The name isn't case sensitive. You can ﬁlter and inspect all headers with the FieldToMatch setting Headers. This is used to indicate the web request component to inspect, in the FieldToMatch speciﬁcation. Example JSON: "SingleHeader": { "Name": "haystack" } Contents Name The name of the query header to inspect. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: .\S. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SingleHeader 1463 AWS WAFV2 SingleQueryArgument Service: AWS WAFV2 API Reference Inspect one query argument in the web request, identiﬁed by name, for example UserName or SalesRegion. The name isn't case sensitive. This is used to indicate the web request component to inspect, in the FieldToMatch speciﬁcation. Example JSON: "SingleQueryArgument": { "Name": "myArgument" } Contents Name The name of the query argument to inspect. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: .\S. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SingleQueryArgument 1464 AWS WAFV2 API Reference SizeConstraintStatement Service: AWS WAFV2 A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes. If you conﬁgure AWS WAF to inspect the request body, AWS WAF inspects only the number of bytes in the body up to the limit for the web ACL and protected resource type. If you know that the request body for your web requests should
waf-apiref-301	waf-apiref.pdf	301	API Reference SizeConstraintStatement Service: AWS WAFV2 A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes. If you conﬁgure AWS WAF to inspect the request body, AWS WAF inspects only the number of bytes in the body up to the limit for the web ACL and protected resource type. If you know that the request body for your web requests should never exceed the inspection limit, you can use a size constraint statement to block requests that have a larger request body size. For more information about the inspection limits, see Body and JsonBody settings for the FieldToMatch data type. If you choose URI for the value of Part of the request to ﬁlter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long. Contents ComparisonOperator The operator to use to compare the request part to the size setting. Type: String Valid Values: EQ \| NE \| LE \| LT \| GE \| GT Required: Yes FieldToMatch The part of the web request that you want AWS WAF to inspect. Type: FieldToMatch object Required: Yes Size The size, in byte, to compare to the request part, after any transformations. Type: Long Valid Range: Minimum value of 0. Maximum value of 21474836480. SizeConstraintStatement 1465 AWS WAFV2 Required: Yes TextTransformations API Reference Text transformations eliminate some of the unusual formatting that attackers use in web requests in an eﬀort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the speciﬁed content, starting from the lowest priority setting, and then uses the transformed component contents. Type: Array of TextTransformation objects Array Members: Minimum number of 1 item. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SizeConstraintStatement 1466 AWS WAFV2 SqliMatchStatement Service: AWS WAFV2 API Reference A rule statement that inspects for malicious SQL code. Attackers insert malicious SQL code into web requests to do things like modify your database or extract data from it. Contents FieldToMatch The part of the web request that you want AWS WAF to inspect. Type: FieldToMatch object Required: Yes TextTransformations Text transformations eliminate some of the unusual formatting that attackers use in web requests in an eﬀort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the speciﬁed content, starting from the lowest priority setting, and then uses the transformed component contents. Type: Array of TextTransformation objects Array Members: Minimum number of 1 item. Required: Yes SensitivityLevel The sensitivity that you want AWS WAF to use to inspect for SQL injection attacks. HIGH detects more attacks, but might generate more false positives, especially if your web requests frequently contain unusual strings. For information about identifying and mitigating false positives, see Testing and tuning in the AWS WAF Developer Guide. LOW is generally a better choice for resources that already have other protections against SQL injection attacks or that have a low tolerance for false positives. SqliMatchStatement 1467 AWS WAFV2 Default: LOW Type: String Valid Values: LOW \| HIGH Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SqliMatchStatement 1468 AWS WAFV2 Statement Service: AWS WAFV2 API Reference The processing guidance for a Rule, used by AWS WAF to determine whether a web request matches the rule. For example speciﬁcations, see the examples section of CreateWebACL. Contents AndStatement A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement. Type: AndStatement object Required: No ByteMatchStatement A rule statement that deﬁnes a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search
waf-apiref-302	waf-apiref.pdf	302	for a Rule, used by AWS WAF to determine whether a web request matches the rule. For example speciﬁcations, see the examples section of CreateWebACL. Contents AndStatement A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement. Type: AndStatement object Required: No ByteMatchStatement A rule statement that deﬁnes a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is called a string match statement. Type: ByteMatchStatement object Required: No GeoMatchStatement A rule statement that labels web requests by country and region and that matches against web requests based on country code. A geo match rule labels every request that it inspects regardless of whether it ﬁnds a match. • To manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the CountryCodes array. • Otherwise, conﬁgure your geo match rule with Count action so that it only labels requests. Then, add one or more label match rules to run after the geo match rule and conﬁgure them to match against the geographic labels and handle the requests as needed. Statement 1469 AWS WAFV2 API Reference AWS WAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. AWS WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match ForwardedIPConfig. If you use the web request origin, the label formats are awswaf:clientip:geo:region:<ISO country code>-<ISO region code> and awswaf:clientip:geo:country:<ISO country code>. If you use a forwarded IP address, the label formats are awswaf:forwardedip:geo:region:<ISO country code>-<ISO region code> and awswaf:forwardedip:geo:country:<ISO country code>. For additional details, see Geographic match rule statement in the AWS WAF Developer Guide. Type: GeoMatchStatement object Required: No IPSetReferenceStatement A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that speciﬁes the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet. Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it. Type: IPSetReferenceStatement object Required: No LabelMatchStatement A rule statement to match against labels that have been added to the web request by rules that have already run in the web ACL. The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualiﬁed label name that had been added to the web request. Fully qualiﬁed labels have a preﬁx, optional namespaces, and label name. The preﬁx identiﬁes the rule group or web ACL context of the rule that added the label. If you do not Statement 1470 AWS WAFV2 API Reference provide the fully qualiﬁed name in your label match string, AWS WAF performs the search for labels that were added in the same context as the label match statement. Type: LabelMatchStatement object Required: No ManagedRuleGroupStatement A rule statement used to run the rules that are deﬁned in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups. You cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. You cannot use a managed rule group inside another rule group. You can only reference a managed rule group as a top-level statement within a rule that you deﬁne in a web ACL. Note You are charged additional fees when you use the AWS WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet, the AWS WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet, or the AWS WAF Fraud Control account creation fraud prevention (ACFP) managed rule group AWSManagedRulesACFPRuleSet. For more information, see AWS WAF Pricing. Type: ManagedRuleGroupStatement object Required: No NotStatement A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement. Type: NotStatement object Required: No OrStatement A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement. Statement 1471 AWS WAFV2 Type: OrStatement object Required: No RateBasedStatement API Reference A rate-based rule
waf-apiref-303	waf-apiref.pdf	303	Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet, or the AWS WAF Fraud Control account creation fraud prevention (ACFP) managed rule group AWSManagedRulesACFPRuleSet. For more information, see AWS WAF Pricing. Type: ManagedRuleGroupStatement object Required: No NotStatement A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement. Type: NotStatement object Required: No OrStatement A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement. Statement 1471 AWS WAFV2 Type: OrStatement object Required: No RateBasedStatement API Reference A rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance. Note If you change any of these settings in a rule that's currently in use, the change resets the rule's rate limiting counts. This can pause the rule's rate limiting activities for up to a minute. You can specify individual aggregation keys, like IP address or HTTP method. You can also specify aggregation key combinations, like IP address and HTTP method, or HTTP method, query argument, and cookie. Each unique set of values for the aggregation keys that you specify is a separate aggregation instance, with the value from each key contributing to the aggregation instance deﬁnition. For example, assume the rule evaluates web requests with the following IP address and HTTP method values: • IP address 10.1.1.1, HTTP method POST • IP address 10.1.1.1, HTTP method GET • IP address 127.0.0.0, HTTP method POST • IP address 10.1.1.1, HTTP method GET The rule would create diﬀerent aggregation instances according to your aggregation criteria, for example: • If the aggregation criteria is just the IP address, then each individual address is an aggregation instance, and AWS WAF counts requests separately for each. The aggregation instances and request counts for our example would be the following: • IP address 10.1.1.1: count 3 • IP address 127.0.0.0: count 1 Statement 1472 AWS WAFV2 API Reference • If the aggregation criteria is HTTP method, then each individual HTTP method is an aggregation instance. The aggregation instances and request counts for our example would be the following: • HTTP method POST: count 2 • HTTP method GET: count 2 • If the aggregation criteria is IP address and HTTP method, then each IP address and each HTTP method would contribute to the combined aggregation instance. The aggregation instances and request counts for our example would be the following: • IP address 10.1.1.1, HTTP method POST: count 1 • IP address 10.1.1.1, HTTP method GET: count 2 • IP address 127.0.0.0, HTTP method POST: count 1 For any n-tuple of aggregation keys, each unique combination of values for the keys deﬁnes a separate aggregation instance, which AWS WAF counts and rate-limits individually. You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts and rate limits requests that match the nested statement. You can use this nested scope-down statement in conjunction with your aggregation key speciﬁcations or you can just count and rate limit all requests that match the scope-down statement, without additional aggregation. When you choose to just manage all requests that match a scope-down statement, the aggregation instance is singular for the rule. You cannot nest a RateBasedStatement inside another statement, for example inside a NotStatement or OrStatement. You can deﬁne a RateBasedStatement inside a web ACL and inside a rule group. For additional information about the options, see Rate limiting web requests using rate-based rules in the AWS WAF Developer Guide. If you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that AWS WAF is currently rate limiting for a rule through the API call GetRateBasedStatementManagedKeys. This option is not available for other aggregation conﬁgurations. AWS WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by AWS WAF. If you deﬁne a rate-based rule inside a rule Statement 1473 AWS WAFV2 API Reference group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by AWS WAF. Type: RateBasedStatement object Required: No RegexMatchStatement A rule statement used to search web request components for a match against a single regular expression. Type: RegexMatchStatement object Required: No RegexPatternSetReferenceStatement A rule statement used to
waf-apiref-304	waf-apiref.pdf	304	two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by AWS WAF. If you deﬁne a rate-based rule inside a rule Statement 1473 AWS WAFV2 API Reference group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by AWS WAF. Type: RateBasedStatement object Required: No RegexMatchStatement A rule statement used to search web request components for a match against a single regular expression. Type: RegexMatchStatement object Required: No RegexPatternSetReferenceStatement A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that speciﬁes the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet. Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it. Type: RegexPatternSetReferenceStatement object Required: No RuleGroupReferenceStatement A rule statement used to run the rules that are deﬁned in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement. You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. You cannot use a rule group reference statement inside another rule group. You can only reference a rule group as a top-level statement within a rule that you deﬁne in a web ACL. Type: RuleGroupReferenceStatement object Required: No Statement 1474 AWS WAFV2 SizeConstraintStatement API Reference A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes. If you conﬁgure AWS WAF to inspect the request body, AWS WAF inspects only the number of bytes in the body up to the limit for the web ACL and protected resource type. If you know that the request body for your web requests should never exceed the inspection limit, you can use a size constraint statement to block requests that have a larger request body size. For more information about the inspection limits, see Body and JsonBody settings for the FieldToMatch data type. If you choose URI for the value of Part of the request to ﬁlter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long. Type: SizeConstraintStatement object Required: No SqliMatchStatement A rule statement that inspects for malicious SQL code. Attackers insert malicious SQL code into web requests to do things like modify your database or extract data from it. Type: SqliMatchStatement object Required: No XssMatchStatement A rule statement that inspects for cross-site scripting (XSS) attacks. In XSS attacks, the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. Type: XssMatchStatement object Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Statement 1475 AWS WAFV2 • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference Statement 1476 AWS WAFV2 Tag Service: AWS WAFV2 API Reference A tag associated with an AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as "environment", and the tag value represents a speciﬁc value within that category, such as "test," "development," or "production". Or you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource. You can tag the AWS resources that you manage through AWS WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the AWS WAF console. Contents Key Part of the key:value pair that deﬁnes a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ Required: Yes Value Part of the key:value pair that deﬁnes a tag. You can use a tag value to describe a
waf-apiref-305	waf-apiref.pdf	305	a resource. You can tag the AWS resources that you manage through AWS WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the AWS WAF console. Contents Key Part of the key:value pair that deﬁnes a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@])$ Required: Yes Value Part of the key:value pair that deﬁnes a tag. You can use a tag value to describe a speciﬁc value within a category, such as "companyA" or "companyB." Tag values are case-sensitive. Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@])$ Required: Yes Tag 1477 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Tag 1478 AWS WAFV2 TagInfoForResource Service: AWS WAFV2 API Reference The collection of tagging deﬁnitions for an AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as "environment", and the tag value represents a speciﬁc value within that category, such as "test," "development," or "production". Or you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource. You can tag the AWS resources that you manage through AWS WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the AWS WAF console. Contents ResourceARN The Amazon Resource Name (ARN) of the resource. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .\S. Required: No TagList The array of Tag objects deﬁned for the resource. Type: Array of Tag objects Array Members: Minimum number of 1 item. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: TagInfoForResource 1479 AWS WAFV2 • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference TagInfoForResource 1480 AWS WAFV2 TextTransformation Service: AWS WAFV2 API Reference Text transformations eliminate some of the unusual formatting that attackers use in web requests in an eﬀort to bypass detection. Contents Priority Sets the relative processing order for multiple transformations. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be diﬀerent. Type: Integer Valid Range: Minimum value of 0. Required: Yes Type For detailed descriptions of each of the transformation types, see Text transformations in the AWS WAF Developer Guide. Type: String Valid Values: NONE \| COMPRESS_WHITE_SPACE \| HTML_ENTITY_DECODE \| LOWERCASE \| CMD_LINE \| URL_DECODE \| BASE64_DECODE \| HEX_DECODE \| MD5 \| REPLACE_COMMENTS \| ESCAPE_SEQ_DECODE \| SQL_HEX_DECODE \| CSS_DECODE \| JS_DECODE \| NORMALIZE_PATH \| NORMALIZE_PATH_WIN \| REMOVE_NULLS \| REPLACE_NULLS \| BASE64_DECODE_EXT \| URL_DECODE_UNI \| UTF8_TO_UNICODE Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ TextTransformation 1481 AWS WAFV2 • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference TextTransformation 1482 AWS WAFV2 TimeWindow Service: AWS WAFV2 API Reference In a GetSampledRequests request, the StartTime and EndTime objects specify the time range for which you want AWS WAF to return a sample of web requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours. In a GetSampledRequests response, the StartTime and EndTime objects specify the time range for which AWS WAF actually returned a sample of web requests. AWS WAF gets the speciﬁed number of requests from among the ﬁrst 5,000 requests that your AWS resource receives during the speciﬁed time period. If your resource receives more than 5,000 requests during that period, AWS WAF stops sampling after the 5,000th request. In that case, EndTime is the time that AWS WAF received the 5,000th request. Contents EndTime The end of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours. Type: Timestamp Required: Yes StartTime The
waf-apiref-306	waf-apiref.pdf	306	the speciﬁed time period. If your resource receives more than 5,000 requests during that period, AWS WAF stops sampling after the 5,000th request. In that case, EndTime is the time that AWS WAF received the 5,000th request. Contents EndTime The end of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours. Type: Timestamp Required: Yes StartTime The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours. Type: Timestamp Required: Yes TimeWindow 1483 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 TimeWindow 1484 AWS WAFV2 UriFragment Service: AWS WAFV2 API Reference Inspect fragments of the request URI. You can specify the parts of the URI fragment to inspect and you can narrow the set of URI fragments to inspect by including or excluding speciﬁc keys. This is used to indicate the web request component to inspect, in the FieldToMatch speciﬁcation. Example JSON: "UriFragment": { "MatchPattern": { "All": {} }, "MatchScope": "KEY", "OversizeHandling": "MATCH" } Contents FallbackBehavior What AWS WAF should do if it fails to completely parse the JSON body. The options are the following: • EVALUATE_AS_STRING - Inspect the body as plain text. AWS WAF applies the text transformations and inspection criteria that you deﬁned for the JSON inspection to the body text string. • MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request. • NO_MATCH - Treat the web request as not matching the rule statement. If you don't provide this setting, AWS WAF parses and evaluates the content only up to the ﬁrst parsing failure that it encounters. Example JSON: { "UriFragment": { "FallbackBehavior": "MATCH"} } Note AWS WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, AWS WAF doesn't apply the fallback behavior. For more information, see JSON body in the AWS WAF Developer Guide. Type: String Valid Values: MATCH \| NO_MATCH UriFragment 1485 AWS WAFV2 Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 UriFragment 1486 AWS WAFV2 UriPath Service: AWS WAFV2 API Reference Inspect the path component of the URI of the web request. This is the part of the web request that identiﬁes a resource. For example, /images/daily-ad.jpg. This is used in the FieldToMatch speciﬁcation for some web request component types. JSON speciﬁcation: "UriPath": {} Contents The members of this exception structure are context-dependent. See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 UriPath 1487 AWS WAFV2 UsernameField Service: AWS WAFV2 API Reference The name of the ﬁeld in the request payload that contains your customer's username. This data type is used in the RequestInspection and RequestInspectionACFP data types. Contents Identiﬁer The name of the username ﬁeld. How you specify this depends on the request inspection payload type. • For JSON payloads, specify the ﬁeld name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer. For example, for the JSON payload { "form": { "username": "THE_USERNAME" } }, the username ﬁeld speciﬁcation is /form/username. • For form encoded payload types, use the HTML form names. For example, for an HTML form with the input element named username1, the username ﬁeld speciﬁcation is username1 Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: .\S. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 UsernameField 1488 AWS WAFV2 • AWS SDK for Ruby V3 API Reference UsernameField 1489 AWS WAFV2 VersionToPublish Service: AWS WAFV2 API Reference A version of the named managed rule group, that the rule group's vendor publishes for use by customers.
waf-apiref-307	waf-apiref.pdf	307	HTML form with the input element named username1, the username ﬁeld speciﬁcation is username1 Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: .\S. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 UsernameField 1488 AWS WAFV2 • AWS SDK for Ruby V3 API Reference UsernameField 1489 AWS WAFV2 VersionToPublish Service: AWS WAFV2 API Reference A version of the named managed rule group, that the rule group's vendor publishes for use by customers. Note This is intended for use only by vendors of managed rule sets. Vendors are AWS and AWS Marketplace sellers. Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group oﬀerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate. Contents AssociatedRuleGroupArn The Amazon Resource Name (ARN) of the vendor's rule group that's used in the published managed rule group version. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .\S. Required: No ForecastedLifetime The amount of time the vendor expects this version of the managed rule group to last, in days. Type: Integer Valid Range: Minimum value of 1. Required: No VersionToPublish 1490 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 VersionToPublish 1491 AWS WAFV2 VisibilityConﬁg Service: AWS WAFV2 API Reference Deﬁnes and enables Amazon CloudWatch metrics and web request sample collection. Contents CloudWatchMetricsEnabled Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see AWS WAF Metrics in the AWS WAF Developer Guide. For web ACLs, the metrics are for web requests that have the web ACL default action applied. AWS WAF applies the default action to web requests that pass the inspection of all rules in the web ACL without being either allowed or blocked. For more information, see The web ACL default action in the AWS WAF Developer Guide. Type: Boolean Required: Yes MetricName A name of the Amazon CloudWatch metric dimension. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names that are reserved for AWS WAF, for example All and Default_Action. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^[\w#:\.\-/]+$ Required: Yes SampledRequestsEnabled Indicates whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console. If you conﬁgure data protection for the web ACL, the protection applies to the web ACL's sampled web request data. VisibilityConﬁg 1492 AWS WAFV2 Note API Reference Request sampling doesn't provide a ﬁeld redaction option, and any ﬁeld redaction that you specify in your logging conﬁguration doesn't aﬀect sampling. You can only exclude ﬁelds from request sampling by disabling sampling in the web ACL visibility conﬁguration or by conﬁguring data protection for the web ACL. Type: Boolean Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 VisibilityConﬁg 1493 AWS WAFV2 WebACL Service: AWS WAFV2 API Reference A web ACL deﬁnes a collection of rules to use to inspect and control web requests. Each rule has a statement that deﬁnes what to look for in web requests and an action that AWS WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more AWS resources to protect. The resource types include Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AWS AppSync GraphQL API, Amazon Cognito user pool, AWS App Runner service, AWS Amplify application, and AWS Veriﬁed Access instance. Contents ARN The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .\S. Required: Yes DefaultAction The action to perform if none of the Rules contained in the WebACL match. Type: DefaultAction object Required: Yes Id A unique identiﬁer for the WebACL. This ID is returned in the responses to create and list commands.
waf-apiref-308	waf-apiref.pdf	308	Gateway REST API, Application Load Balancer, AWS AppSync GraphQL API, Amazon Cognito user pool, AWS App Runner service, AWS Amplify application, and AWS Veriﬁed Access instance. Contents ARN The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .\S. Required: Yes DefaultAction The action to perform if none of the Rules contained in the WebACL match. Type: DefaultAction object Required: Yes Id A unique identiﬁer for the WebACL. This ID is returned in the responses to create and list commands. You use this ID to do things like get, update, and delete a WebACL. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. WebACL 1494 AWS WAFV2 API Reference Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ Required: Yes Name The name of the web ACL. You cannot change the name of a web ACL after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: Yes VisibilityConﬁg Deﬁnes and enables Amazon CloudWatch metrics and web request sample collection. Type: VisibilityConﬁg object Required: Yes AssociationConﬁg Speciﬁes custom conﬁgurations for the associations between the web ACL and protected resources. Use this to customize the maximum size of the request body that your protected resources forward to AWS WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Veriﬁed Access resources. The default setting is 16 KB (16,384 bytes). Note You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see AWS WAF Pricing. For Application Load Balancer and AWS AppSync, the limit is ﬁxed at 8 KB (8,192 bytes). Type: AssociationConﬁg object WebACL 1495 AWS WAFV2 Required: No Capacity API Reference The web ACL capacity units (WCUs) currently being used by this web ACL. AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity diﬀerently for each rule type, to reﬂect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is ﬁxed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see AWS WAF web ACL capacity units (WCU) in the AWS WAF Developer Guide. Type: Long Valid Range: Minimum value of 0. Required: No CaptchaConﬁg Speciﬁes how AWS WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, AWS WAF uses its default settings for CaptchaConfig. Type: CaptchaConﬁg object Required: No ChallengeConﬁg Speciﬁes how AWS WAF should handle challenge evaluations for rules that don't have their own ChallengeConfig settings. If you don't specify this, AWS WAF uses its default settings for ChallengeConfig. Type: ChallengeConﬁg object Required: No CustomResponseBodies A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You deﬁne these for the web ACL, and then use them in the rules and default actions that you deﬁne in the web ACL. WebACL 1496 AWS WAFV2 API Reference For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide. For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide. Type: String to CustomResponseBody object map Map Entries: Maximum number of items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: ^[\w\-]+$ Required: No DataProtectionConﬁg Speciﬁes data protection to apply to the web request data for the web ACL. This is a web ACL level data protection option. The data protection that you conﬁgure for the web ACL alters the data that's available for any other data collection activity, including your AWS WAF logging destinations, web ACL request sampling, and Amazon Security Lake data collection and management. Your other option for data protection is in the logging conﬁguration, which only aﬀects logging. Type: DataProtectionConﬁg object Required: No Description A description of the web ACL that helps with identiﬁcation. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$ Required: No LabelNamespace The label namespace preﬁx for this web ACL. All labels added by rules in this web ACL have this preﬁx. WebACL 1497 AWS WAFV2 API Reference • The syntax for the label namespace preﬁx for a web ACL is the following: awswaf:<account ID>:webacl:<web ACL name>: • When a rule with a label matches a web request, AWS WAF
waf-apiref-309	waf-apiref.pdf	309	is in the logging conﬁguration, which only aﬀects logging. Type: DataProtectionConﬁg object Required: No Description A description of the web ACL that helps with identiﬁcation. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$ Required: No LabelNamespace The label namespace preﬁx for this web ACL. All labels added by rules in this web ACL have this preﬁx. WebACL 1497 AWS WAFV2 API Reference • The syntax for the label namespace preﬁx for a web ACL is the following: awswaf:<account ID>:webacl:<web ACL name>: • When a rule with a label matches a web request, AWS WAF adds the fully qualiﬁed label to the request. A fully qualiﬁed label is made up of the label namespace from the rule group or web ACL where the rule is deﬁned and the label from the rule, separated by a colon: <label namespace>:<label from rule> Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: ^[0-9A-Za-z_\-:]+$ Required: No ManagedByFirewallManager Indicates whether this web ACL was created by AWS Firewall Manager and is being managed by Firewall Manager. If true, then only Firewall Manager can delete the web ACL or any Firewall Manager rule groups in the web ACL. See also the properties RetrofittedByFirewallManager, PreProcessFirewallManagerRuleGroups, and PostProcessFirewallManagerRuleGroups. Type: Boolean Required: No PostProcessFirewallManagerRuleGroups The last set of rules for AWS WAF to process in the web ACL. This is deﬁned in an AWS Firewall Manager AWS WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you deﬁne for the web ACL are prioritized before these. In the Firewall Manager AWS WAF policy, the Firewall Manager administrator can deﬁne a set of rule groups to run ﬁrst in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order. Type: Array of FirewallManagerRuleGroup objects Required: No WebACL 1498 AWS WAFV2 API Reference PreProcessFirewallManagerRuleGroups The ﬁrst set of rules for AWS WAF to process in the web ACL. This is deﬁned in an AWS Firewall Manager AWS WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you deﬁne for the web ACL are prioritized after these. In the Firewall Manager AWS WAF policy, the Firewall Manager administrator can deﬁne a set of rule groups to run ﬁrst in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order. Type: Array of FirewallManagerRuleGroup objects Required: No RetroﬁttedByFirewallManager Indicates whether this web ACL was created by a customer account and then retroﬁtted by AWS Firewall Manager. If true, then the web ACL is currently being managed by a Firewall Manager AWS WAF policy, and only Firewall Manager can manage any Firewall Manager rule groups in the web ACL. See also the properties ManagedByFirewallManager, PreProcessFirewallManagerRuleGroups, and PostProcessFirewallManagerRuleGroups. Type: Boolean Required: No Rules The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them. Type: Array of Rule objects Required: No TokenDomains Speciﬁes the domains that AWS WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When AWS WAF provides a token, it uses the domain of the AWS resource that the web ACL is protecting. If you don't specify a list of token domains, AWS WAF accepts tokens only for the domain of the protected resource. With a token WebACL 1499 AWS WAFV2 API Reference domain list, AWS WAF accepts the resource's host domain plus all domains in the token domain list, including their preﬁxed subdomains. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 253. Pattern: ^[\w\.\-/]+$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 WebACL 1500 AWS WAFV2 WebACLSummary Service: AWS WAFV2 API Reference High-level information about a WebACL, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a WebACL, and the ARN, that you provide to operations like AssociateWebACL. Contents ARN The Amazon Resource Name (ARN) of the entity. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .\S. Required: No Description A description of the web ACL that helps with identiﬁcation. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$ Required: No Id The unique identiﬁer for the
waf-apiref-310	waf-apiref.pdf	310	WAFV2 API Reference High-level information about a WebACL, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a WebACL, and the ARN, that you provide to operations like AssociateWebACL. Contents ARN The Amazon Resource Name (ARN) of the entity. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .\S. Required: No Description A description of the web ACL that helps with identiﬁcation. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$ Required: No Id The unique identiﬁer for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ WebACLSummary 1501 AWS WAFV2 Required: No LockToken API Reference A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ Required: No Name The name of the web ACL. You cannot change the name of a web ACL after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 WebACLSummary 1502 AWS WAFV2 XssMatchStatement Service: AWS WAFV2 API Reference A rule statement that inspects for cross-site scripting (XSS) attacks. In XSS attacks, the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. Contents FieldToMatch The part of the web request that you want AWS WAF to inspect. Type: FieldToMatch object Required: Yes TextTransformations Text transformations eliminate some of the unusual formatting that attackers use in web requests in an eﬀort to bypass detection. Text transformations are used in rule match statements, to transform the FieldToMatch request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, AWS WAF performs all transformations on the speciﬁed content, starting from the lowest priority setting, and then uses the transformed component contents. Type: Array of TextTransformation objects Array Members: Minimum number of 1 item. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 XssMatchStatement 1503 AWS WAFV2 • AWS SDK for Ruby V3 AWS WAF Classic The following data types are supported by AWS WAF Classic: API Reference • ActivatedRule • ByteMatchSet • ByteMatchSetSummary • ByteMatchSetUpdate • ByteMatchTuple • ExcludedRule • FieldToMatch • GeoMatchConstraint • GeoMatchSet • GeoMatchSetSummary • GeoMatchSetUpdate • HTTPHeader • HTTPRequest • IPSet • IPSetDescriptor • IPSetSummary • IPSetUpdate • LoggingConﬁguration • Predicate • RateBasedRule • RegexMatchSet • RegexMatchSetSummary • RegexMatchSetUpdate • RegexMatchTuple • RegexPatternSet AWS WAF Classic 1504 API Reference AWS WAFV2 • RegexPatternSetSummary • RegexPatternSetUpdate • Rule • RuleGroup • RuleGroupSummary • RuleGroupUpdate • RuleSummary • RuleUpdate • SampledHTTPRequest • SizeConstraint • SizeConstraintSet • SizeConstraintSetSummary • SizeConstraintSetUpdate • SqlInjectionMatchSet • SqlInjectionMatchSetSummary • SqlInjectionMatchSetUpdate • SqlInjectionMatchTuple • SubscribedRuleGroupSummary • Tag • TagInfoForResource • TimeWindow • WafAction • WafOverrideAction • WebACL • WebACLSummary • WebACLUpdate • XssMatchSet • XssMatchSetSummary • XssMatchSetUpdate • XssMatchTuple AWS WAF Classic 1505 AWS WAFV2 API Reference AWS WAF Classic 1506 AWS WAFV2 ActivatedRule Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. The ActivatedRule object in an UpdateWebACL request speciﬁes a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK,
waf-apiref-311	waf-apiref.pdf	311	30, 2025. 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. The ActivatedRule object in an UpdateWebACL request speciﬁes a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT). To specify whether to insert or delete a Rule, use the Action parameter in the WebACLUpdate data type. Contents Priority Speciﬁes the order in which the Rules in a WebACL are evaluated. Rules with a lower value for Priority are evaluated before Rules with a higher value. The value must be a unique integer. If you add multiple Rules to a WebACL, the values don't need to be consecutive. Type: Integer Required: Yes RuleId The RuleId 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 a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule). RuleId is returned by CreateRule and by ListRules. Type: String ActivatedRule 1507 AWS WAFV2 API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes Action Speciﬁes the action that Amazon CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. Valid values for Action include the following: • ALLOW: CloudFront responds with the requested object. • BLOCK: CloudFront responds with an HTTP 403 (Forbidden) status code. • COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL. ActivatedRule\|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case, you do not use ActivatedRule\|Action. For all other update requests, ActivatedRule\|Action is used instead of ActivatedRule\|OverrideAction. Type: WafAction object Required: No ExcludedRules An array of rules to exclude from a rule group. This is applicable only when the ActivatedRule refers to a RuleGroup. Sometimes it is necessary to troubleshoot rule groups that are blocking traﬃc unexpectedly (false positives). One troubleshooting technique is to identify the speciﬁc rule within the rule group that is blocking the legitimate traﬃc and then disable (exclude) that particular rule. You can exclude rules from both your own rule groups and AWS Marketplace rule groups that have been associated with a web ACL. Specifying ExcludedRules does not remove those rules from the rule group. Rather, it changes the action for the rules to COUNT. Therefore, requests that match an ExcludedRule are counted but not blocked. The RuleGroup owner will receive COUNT metrics for each ExcludedRule. If you want to exclude rules from a rule group that is already associated with a web ACL, perform the following steps: ActivatedRule 1508 AWS WAFV2 API Reference 1. Use the AWS WAF logs to identify the IDs of the rules that you want to exclude. For more information about the logs, see Logging Web ACL Traﬃc Information. 2. Submit an UpdateWebACL request that has two actions: • The ﬁrst action deletes the existing rule group from the web ACL. That is, in the UpdateWebACL request, the ﬁrst Updates:Action should be DELETE and Updates:ActivatedRule:RuleId should be the rule group that contains the rules that you want to exclude. • The second action inserts the same rule group back in, but specifying the rules to exclude. That is, the second Updates:Action should be INSERT, Updates:ActivatedRule:RuleId should be the rule group that you just removed, and ExcludedRules should contain the rules that you want to exclude. Type: Array of ExcludedRule objects Required: No OverrideAction Use the OverrideAction to test your RuleGroup. Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to None, the RuleGroup will block a request if any individual rule in the RuleGroup matches the request and is conﬁgured to block that request. However if you ﬁrst want to test the RuleGroup, set the OverrideAction to Count. The RuleGroup will then override any block action speciﬁed by individual rules contained within the group. Instead of blocking matching requests, those requests will be counted. You can view a record of counted requests using GetSampledRequests. ActivatedRule\|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule\|Action. For all other update requests, ActivatedRule\|Action is used instead of ActivatedRule\|OverrideAction. Type: WafOverrideAction object Required: No Type The rule type, either REGULAR, as deﬁned by
waf-apiref-312	waf-apiref.pdf	312	conﬁgured to block that request. However if you ﬁrst want to test the RuleGroup, set the OverrideAction to Count. The RuleGroup will then override any block action speciﬁed by individual rules contained within the group. Instead of blocking matching requests, those requests will be counted. You can view a record of counted requests using GetSampledRequests. ActivatedRule\|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule\|Action. For all other update requests, ActivatedRule\|Action is used instead of ActivatedRule\|OverrideAction. Type: WafOverrideAction object Required: No Type The rule type, either REGULAR, as deﬁned by Rule, RATE_BASED, as deﬁned by RateBasedRule, or GROUP, as deﬁned by RuleGroup. The default is REGULAR. Although this ﬁeld is optional, ActivatedRule 1509 AWS WAFV2 API Reference be aware that if you try to add a RATE_BASED rule to a web ACL without setting the type, the UpdateWebACL request will fail because the request tries to add a REGULAR rule with the speciﬁed ID, which does not exist. Type: String Valid Values: REGULAR \| RATE_BASED \| GROUP Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ActivatedRule 1510 AWS WAFV2 ByteMatchSet Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. In a GetByteMatchSet request, ByteMatchSet is a complex type that contains the ByteMatchSetId and Name of a ByteMatchSet, and the values that you speciﬁed when you updated the ByteMatchSet. A complex type that contains ByteMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect and the values that you want AWS WAF to search for. If a ByteMatchSet contains more than one ByteMatchTuple object, a request needs to match the settings in only one ByteMatchTuple to be considered a match. Contents ByteMatchSetId The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see DeleteByteMatchSet). ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes ByteMatchSet 1511 AWS WAFV2 ByteMatchTuples API Reference Speciﬁes the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. Type: Array of ByteMatchTuple objects Required: Yes Name A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ByteMatchSet 1512 AWS WAFV2 API Reference ByteMatchSetSummary Service: AWS WAF Classic Note AWS WAF Classic support will end on September 30, 2025. 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. Returned by ListByteMatchSets. Each ByteMatchSetSummary object includes the Name and ByteMatchSetId for one ByteMatchSet. Contents ByteMatchSetId The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet, update a ByteMatchSet, remove a ByteMatchSet from a Rule, and delete a ByteMatchSet from AWS WAF. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes Name A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet. Type: String ByteMatchSetSummary 1513 AWS WAFV2 API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ByteMatchSetSummary 1514 AWS WAFV2 ByteMatchSetUpdate Service: AWS WAF Classic Note API
waf-apiref-313	waf-apiref.pdf	313	Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes Name A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet. Type: String ByteMatchSetSummary 1513 AWS WAFV2 API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ByteMatchSetSummary 1514 AWS WAFV2 ByteMatchSetUpdate Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. In an UpdateByteMatchSet request, ByteMatchSetUpdate speciﬁes whether to insert or delete a ByteMatchTuple and includes the settings for the ByteMatchTuple. Contents Action Speciﬁes whether to insert or delete a ByteMatchTuple. Type: String Valid Values: INSERT \| DELETE Required: Yes ByteMatchTuple Information about the part of a web request that you want AWS WAF to inspect and the value that you want AWS WAF to search for. If you specify DELETE for the value of Action, the ByteMatchTuple values must exactly match the values in the ByteMatchTuple that you want to delete from the ByteMatchSet. Type: ByteMatchTuple object Required: Yes ByteMatchSetUpdate 1515 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ByteMatchSetUpdate 1516 AWS WAFV2 ByteMatchTuple Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. Contents FieldToMatch The part of a web request that you want AWS WAF to search, such as a speciﬁed header or a query string. For more information, see FieldToMatch. Type: FieldToMatch object Required: Yes PositionalConstraint Within the portion of a web request that you want to search (for example, in the query string, if any), specify where you want AWS WAF to search. Valid values include the following: CONTAINS The speciﬁed part of the web request must include the value of TargetString, but the location doesn't matter. CONTAINS_WORD ByteMatchTuple 1517 AWS WAFV2 API Reference The speciﬁed part of the web request must include the value of TargetString, and TargetString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, TargetString must be a word, which means one of the following: • TargetString exactly matches the value of the speciﬁed part of the web request, such as the value of a header. • TargetString is at the beginning of the speciﬁed part of the web request and is followed by a character other than an alphanumeric character or underscore (_), for example, BadBot;. • TargetString is at the end of the speciﬁed part of the web request and is preceded by a character other than an alphanumeric character or underscore (_), for example, ;BadBot. • TargetString is in the middle of the speciﬁed part of the web request and is preceded and followed by characters other than alphanumeric characters or underscore (_), for example, - BadBot;. EXACTLY The value of the speciﬁed part of the web request must exactly match the value of TargetString. STARTS_WITH The value of TargetString must appear at the beginning of the speciﬁed part of the web request. ENDS_WITH The value of TargetString must appear at the end of the speciﬁed part of the web request. Type: String Valid Values: EXACTLY \| STARTS_WITH \| ENDS_WITH \| CONTAINS \| CONTAINS_WORD Required: Yes TargetString The value that you want AWS WAF to search for. AWS WAF searches for the speciﬁed string in the part of web requests that you speciﬁed in FieldToMatch. The maximum length of the value is 50 bytes. ByteMatchTuple 1518 AWS WAFV2 API Reference Valid values depend on the values that you speciﬁed for FieldToMatch: • HEADER: The value that you want AWS WAF to
waf-apiref-314	waf-apiref.pdf	314	web request. ENDS_WITH The value of TargetString must appear at the end of the speciﬁed part of the web request. Type: String Valid Values: EXACTLY \| STARTS_WITH \| ENDS_WITH \| CONTAINS \| CONTAINS_WORD Required: Yes TargetString The value that you want AWS WAF to search for. AWS WAF searches for the speciﬁed string in the part of web requests that you speciﬁed in FieldToMatch. The maximum length of the value is 50 bytes. ByteMatchTuple 1518 AWS WAFV2 API Reference Valid values depend on the values that you speciﬁed for FieldToMatch: • HEADER: The value that you want AWS WAF to search for in the request header that you speciﬁed in FieldToMatch, for example, the value of the User-Agent or Referer header. • METHOD: The HTTP method, which indicates the type of operation speciﬁed in the request. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. • QUERY_STRING: The value that you want AWS WAF to search for in the query string, which is the part of a URL that appears after a ? character. • URI: The path component of the URI. This does not include the query string or fragment components of the URI. For information, see Uniform Resource Identiﬁer (URI): Generic Syntax. • BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the ﬁrst 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet. • SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters. • ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but instead of inspecting a single parameter, AWS WAF inspects all parameters within the query string for the value or regex pattern that you specify in TargetString. If TargetString includes alphabetic characters A-Z and a-z, note that the value is case sensitive. If you're using the AWS WAF API Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes. For example, suppose the value of Type is HEADER and the value of Data is User-Agent. If you want to search the User-Agent header for the value BadBot, you base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90, in the value of TargetString. If you're using the AWS CLI or one of the AWS SDKs ByteMatchTuple 1519 AWS WAFV2 API Reference The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value. Type: Base64-encoded binary data object Required: Yes TextTransformation Text transformations eliminate some of the unusual formatting that attackers use in web requests in an eﬀort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting it for a match. You can only specify a single type of TextTransformation. CMD_LINE When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: • Delete the following characters: \ " ' ^ • Delete spaces before the following characters: / ( • Replace the following characters with a space: , ; • Replace multiple spaces with one space • Convert uppercase letters (A-Z) to lowercase (a-z) COMPRESS_WHITE_SPACE Use this option to replace the following characters with a space character (decimal 32): • \f, formfeed, decimal 12 • \t, tab, decimal 9 • \n, newline, decimal 10 • \r, carriage return, decimal 13 • \v, vertical tab, decimal 11 • non-breaking space, decimal 160 COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. HTML_ENTITY_DECODE ByteMatchTuple 1520 AWS WAFV2 API Reference Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: • Replaces (ampersand)quot; with " • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 • Replaces (ampersand)lt; with a "less than" symbol • Replaces (ampersand)gt; with > • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this option to decode a URL-encoded value. NONE Specify NONE if you don't want to perform any text transformations. Type: String Valid Values: NONE \| COMPRESS_WHITE_SPACE \| HTML_ENTITY_DECODE \| LOWERCASE \| CMD_LINE \| URL_DECODE Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS
waf-apiref-315	waf-apiref.pdf	315	than" symbol • Replaces (ampersand)gt; with > • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this option to decode a URL-encoded value. NONE Specify NONE if you don't want to perform any text transformations. Type: String Valid Values: NONE \| COMPRESS_WHITE_SPACE \| HTML_ENTITY_DECODE \| LOWERCASE \| CMD_LINE \| URL_DECODE Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ByteMatchTuple 1521 AWS WAFV2 API Reference ByteMatchTuple 1522 AWS WAFV2 ExcludedRule Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. The rule to exclude from a rule group. This is applicable only when the ActivatedRule refers to a RuleGroup. The rule must belong to the RuleGroup that is speciﬁed by the ActivatedRule. Contents RuleId The unique identiﬁer for the rule to exclude from the rule group. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ExcludedRule 1523 AWS WAFV2 FieldToMatch Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. Speciﬁes where in a web request to look for TargetString. Contents Type The part of the web request that you want AWS WAF to search for a speciﬁed string. Parts of a request that you can search include the following: • HEADER: A speciﬁed request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data. • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any. • URI: The path component of the URI. This does not include the query string or fragment components of the URI. For information, see Uniform Resource Identiﬁer (URI): Generic Syntax. • BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the ﬁrst 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet. FieldToMatch 1524 AWS WAFV2 API Reference • SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters. • ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString. Type: String Valid Values: URI \| QUERY_STRING \| HEADER \| METHOD \| BODY \| SINGLE_QUERY_ARG \| ALL_QUERY_ARGS Required: Yes Data When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive. When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive. If the value of Type is any other value, omit Data. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No See Also For more information about using this API in
waf-apiref-316	waf-apiref.pdf	316	of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive. When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive. If the value of Type is any other value, omit Data. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 FieldToMatch 1525 AWS WAFV2 API Reference FieldToMatch 1526 AWS WAFV2 GeoMatchConstraint Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. The country from which web requests originate that you want AWS WAF to search for. Contents Type The type of geographical area you want AWS WAF to search for. Currently Country is the only valid value. Type: String Valid Values: Country Required: Yes Value The country that you want AWS WAF to search for. Type: String Valid Values: AF \| AX \| AL \| DZ \| AS \| AD \| AO \| AI \| AQ \| AG \| AR \| AM \| AW \| AU \| AT \| AZ \| BS \| BH \| BD \| BB \| BY \| BE \| BZ \| BJ \| BM \| BT \| BO \| BQ \| BA \| BW \| BV \| BR \| IO \| BN \| BG \| BF \| BI \| KH \| CM \| CA \| CV \| KY \| CF \| TD \| CL \| CN \| CX \| CC \| CO \| KM \| CG \| CD \| CK \| CR \| CI \| HR \| CU \| CW \| CY \| CZ \| DK \| DJ \| DM \| DO \| EC \| EG \| SV \| GQ \| ER \| EE \| ET \| FK \| FO \| FJ \| FI \| FR \| GF \| PF \| TF \| GA \| GM \| GE \| DE \| GH \| GI \| GeoMatchConstraint 1527 AWS WAFV2 API Reference GR \| GL \| GD \| GP \| GU \| GT \| GG \| GN \| GW \| GY \| HT \| HM \| VA \| HN \| HK \| HU \| IS \| IN \| ID \| IR \| IQ \| IE \| IM \| IL \| IT \| JM \| JP \| JE \| JO \| KZ \| KE \| KI \| KP \| KR \| KW \| KG \| LA \| LV \| LB \| LS \| LR \| LY \| LI \| LT \| LU \| MO \| MK \| MG \| MW \| MY \| MV \| ML \| MT \| MH \| MQ \| MR \| MU \| YT \| MX \| FM \| MD \| MC \| MN \| ME \| MS \| MA \| MZ \| MM \| NA \| NR \| NP \| NL \| NC \| NZ \| NI \| NE \| NG \| NU \| NF \| MP \| NO \| OM \| PK \| PW \| PS \| PA \| PG \| PY \| PE \| PH \| PN \| PL \| PT \| PR \| QA \| RE \| RO \| RU \| RW \| BL \| SH \| KN \| LC \| MF \| PM \| VC \| WS \| SM \| ST \| SA \| SN \| RS \| SC \| SL \| SG \| SX \| SK \| SI \| SB \| SO \| ZA \| GS \| SS \| ES \| LK \| SD \| SR \| SJ \| SZ \| SE \| CH \| SY \| TW \| TJ \| TZ \| TH \| TL \| TG \| TK \| TO \| TT \| TN \| TR \| TM \| TC \| TV \| UG \| UA \| AE \| GB \| US \| UM \| UY \| UZ \| VU \| VE \| VN \| VG \| VI \| WF \| EH \| YE \| ZM \| ZW Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java
waf-apiref-317	waf-apiref.pdf	317	SE \| CH \| SY \| TW \| TJ \| TZ \| TH \| TL \| TG \| TK \| TO \| TT \| TN \| TR \| TM \| TC \| TV \| UG \| UA \| AE \| GB \| US \| UM \| UY \| UZ \| VU \| VE \| VN \| VG \| VI \| WF \| EH \| YE \| ZM \| ZW Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 GeoMatchConstraint 1528 AWS WAFV2 GeoMatchSet Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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 one or more countries that AWS WAF will search for. Contents GeoMatchConstraints An array of GeoMatchConstraint objects, which contain the country that you want AWS WAF to search for. Type: Array of GeoMatchConstraint objects Required: Yes GeoMatchSetId The GeoMatchSetId for an GeoMatchSet. You use GeoMatchSetId to get information about a GeoMatchSet (see GeoMatchSet), update a GeoMatchSet (see UpdateGeoMatchSet), insert a GeoMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a GeoMatchSet from AWS WAF (see DeleteGeoMatchSet). GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes GeoMatchSet 1529 AWS WAFV2 Name API Reference A friendly name or description of the GeoMatchSet. You can't change the name of an GeoMatchSet after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 GeoMatchSet 1530 AWS WAFV2 GeoMatchSetSummary Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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 identiﬁer and the name of the GeoMatchSet. Contents GeoMatchSetId The GeoMatchSetId for an GeoMatchSet. You can use GeoMatchSetId in a GetGeoMatchSet request to get detailed information about an GeoMatchSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes Name A friendly name or description of the GeoMatchSet. You can't change the name of an GeoMatchSet after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes GeoMatchSetSummary 1531 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 GeoMatchSetSummary 1532 AWS WAFV2 GeoMatchSetUpdate Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. Speciﬁes the type of update to perform to an GeoMatchSet with UpdateGeoMatchSet. Contents Action Speciﬁes whether to insert or delete a country with UpdateGeoMatchSet. Type: String Valid Values: INSERT \| DELETE Required: Yes GeoMatchConstraint The country from which web requests originate that you want AWS WAF to search for. Type: GeoMatchConstraint object Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ GeoMatchSetUpdate 1533 AWS WAFV2 • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference GeoMatchSetUpdate 1534 AWS WAFV2 HTTPHeader Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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
waf-apiref-318	waf-apiref.pdf	318	See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ GeoMatchSetUpdate 1533 AWS WAFV2 • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference GeoMatchSetUpdate 1534 AWS WAFV2 HTTPHeader Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. The response from a GetSampledRequests request includes an HTTPHeader complex type that appears as Headers in the response syntax. HTTPHeader contains the names and values of all of the headers that appear in one of the web requests that were returned by GetSampledRequests. Contents Name The name of one of the headers in the sampled web request. Type: String Required: No Value The value of one of the headers in the sampled web request. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ HTTPHeader 1535 AWS WAFV2 • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference HTTPHeader 1536 AWS WAFV2 HTTPRequest Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. The response from a GetSampledRequests request includes an HTTPRequest complex type that appears as Request in the response syntax. HTTPRequest contains information about one of the web requests that were returned by GetSampledRequests. Contents ClientIP The IP address that the request originated from. If the WebACL is associated with an Amazon CloudFront distribution, this is the value of one of the following ﬁelds in CloudFront access logs: • c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the request • x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request Type: String Required: No Country The two-letter country code for the country that the request originated from. For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2. Type: String Required: No HTTPRequest 1537 AWS WAFV2 Headers API Reference A complex type that contains two values for each header in the sampled web request: the name of the header and the value of the header. Type: Array of HTTPHeader objects Required: No HTTPVersion The HTTP version speciﬁed in the sampled web request, for example, HTTP/1.1. Type: String Required: No Method The HTTP method speciﬁed in the sampled web request. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. Type: String Required: No URI The path component of the URI. This does not include the query string or fragment components of the URI. For information, see Uniform Resource Identiﬁer (URI): Generic Syntax. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 HTTPRequest 1538 AWS WAFV2 API Reference HTTPRequest 1539 AWS WAFV2 IPSet Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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 one or more IP addresses or blocks of IP addresses speciﬁed in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. To specify an individual IP address, you specify the four-part IP address followed by a /32, for example, 192.0.2.0/32. To block a range of IP addresses, you can specify /8 or any range between /16 through /32 (for IPv4) or /24, /32, /48, /56, /64, or /128 (for IPv6). For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. Contents IPSetDescriptors The IP
waf-apiref-319	waf-apiref.pdf	319	speciﬁed in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. To specify an individual IP address, you specify the four-part IP address followed by a /32, for example, 192.0.2.0/32. To block a range of IP addresses, you can specify /8 or any range between /16 through /32 (for IPv4) or /24, /32, /48, /56, /64, or /128 (for IPv6). For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. Contents IPSetDescriptors The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL is associated with an Amazon CloudFront distribution and the viewer did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip ﬁeld in the CloudFront access logs. Type: Array of IPSetDescriptor objects Required: Yes IPSetId The IPSetId for an IPSet. You use IPSetId to get information about an IPSet (see GetIPSet), update an IPSet (see UpdateIPSet), insert an IPSet into a Rule or delete one from a Rule (see UpdateRule), and delete an IPSet from AWS WAF (see DeleteIPSet). IPSet 1540 AWS WAFV2 API Reference IPSetId is returned by CreateIPSet and by ListIPSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes Name A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 IPSet 1541 AWS WAFV2 IPSetDescriptor Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. Speciﬁes the IP address type (IPV4 or IPV6) and the IP address range (in CIDR format) that web requests originate from. Contents Type Specify IPV4 or IPV6. Type: String Valid Values: IPV4 \| IPV6 Required: Yes Value Specify an IPv4 address by using CIDR notation. For example: • To conﬁgure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32. • To conﬁgure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. Specify an IPv6 address by using CIDR notation. For example: IPSetDescriptor 1542 AWS WAFV2 API Reference • To conﬁgure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128. • To conﬁgure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ﬀﬀ:ﬀﬀ:ﬀﬀ:ﬀﬀ, specify 1111:0000:0000:0000:0000:0000:0000:0000/64. Type: String Length Constraints: Minimum length of 1. Maximum length of 50. Pattern: .\S. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 IPSetDescriptor 1543 AWS WAFV2 IPSetSummary Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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 identiﬁer and the name of the IPSet. Contents IPSetId The IPSetId for an IPSet. You can use IPSetId in a GetIPSet request to get detailed information about an IPSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes Name A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes IPSetSummary 1544 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for
waf-apiref-320	waf-apiref.pdf	320	to get detailed information about an IPSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes Name A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes IPSetSummary 1544 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 IPSetSummary 1545 AWS WAFV2 IPSetUpdate Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. Speciﬁes the type of update to perform to an IPSet with UpdateIPSet. Contents Action Speciﬁes whether to insert or delete an IP address with UpdateIPSet. Type: String Valid Values: INSERT \| DELETE Required: Yes IPSetDescriptor The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web requests originate from. Type: IPSetDescriptor object Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: IPSetUpdate 1546 AWS WAFV2 • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference IPSetUpdate 1547 AWS WAFV2 LoggingConﬁguration Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. The Amazon Data Firehose, RedactedFields information, and the web ACL Amazon Resource Name (ARN). Contents LogDestinationConﬁgs An array of Amazon Data Firehose ARNs. Type: Array of strings Array Members: Fixed number of 1 item. Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .\S. Required: Yes ResourceArn The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs. Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .\S. LoggingConﬁguration 1548 AWS WAFV2 Required: Yes RedactedFields API Reference The parts of the request that you want redacted from the logs. For example, if you redact the cookie ﬁeld, the cookie ﬁeld in the ﬁrehose will be xxx. Type: Array of FieldToMatch objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 LoggingConﬁguration 1549 AWS WAFV2 Predicate Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. Speciﬁes the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a Rule and, 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. Contents DataId A unique identiﬁer for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes Negated Set Negated to False if you want AWS WAF to allow, block, or count requests based on the settings in the speciﬁed ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address. Predicate 1550 AWS WAFV2 API Reference Set Negated to True if 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 IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44. Type: Boolean Required: Yes Type The
waf-apiref-321	waf-apiref.pdf	321	speciﬁed ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address. Predicate 1550 AWS WAFV2 API Reference Set Negated to True if 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 IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44. Type: Boolean Required: Yes Type The type of predicate in a Rule, such as ByteMatch or IPSet. Type: String Valid Values: IPMatch \| ByteMatch \| SqlInjectionMatch \| GeoMatch \| SizeConstraint \| XssMatch \| RegexMatch Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Predicate 1551 AWS WAFV2 RateBasedRule Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. A RateBasedRule is identical to a regular Rule, with one addition: a RateBasedRule counts the number of requests that arrive from a speciﬁed IP address every ﬁve minutes. For example, based on recent requests that you've seen from an attacker, you might create a RateBasedRule that includes the following conditions: • The requests come from 192.0.2.44. • They contain the value BadBot in the User-Agent header. In the rule, you also deﬁne the rate limit as 1,000. Requests that meet both of these conditions and exceed 1,000 requests every ﬁve minutes trigger the rule's action (block or count), which is deﬁned in the web ACL. Contents MetricName 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 RateBasedRule. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. RateBasedRule 1552 AWS WAFV2 Pattern: .\S. Required: Yes Name API Reference A friendly name or description for a RateBasedRule. You can't change the name of a RateBasedRule after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes RateKey The ﬁeld 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 RateKey is IP. IP indicates that requests arriving from the same IP address are subject to the RateLimit that is speciﬁed in the RateBasedRule. Type: String Valid Values: IP Required: Yes RateLimit The maximum number of requests, which have an identical value in the ﬁeld speciﬁed by the RateKey, allowed in a ﬁve-minute period. If the number of requests exceeds the RateLimit and the other predicates speciﬁed in the rule are also met, AWS WAF triggers the action that is speciﬁed for this rule. Type: Long Valid Range: Minimum value of 100. Maximum value of 2000000000. Required: Yes RateBasedRule 1553 AWS WAFV2 RuleId API Reference A unique identiﬁer for a RateBasedRule. You use RuleId to get more information about a RateBasedRule (see GetRateBasedRule), update a RateBasedRule (see UpdateRateBasedRule), insert a RateBasedRule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RateBasedRule from AWS WAF (see DeleteRateBasedRule). Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes MatchPredicates The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a RateBasedRule. Type: Array of Predicate objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RateBasedRule 1554 AWS WAFV2 RegexMatchSet Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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
waf-apiref-322	waf-apiref.pdf	322	one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RateBasedRule 1554 AWS WAFV2 RegexMatchSet Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. In a GetRegexMatchSet request, RegexMatchSet is a complex type that contains the RegexMatchSetId and Name of a RegexMatchSet, and the values that you speciﬁed when you updated the RegexMatchSet. The values are contained in a RegexMatchTuple object, which specify the parts of web requests that you want AWS WAF to inspect and the values that you want AWS WAF to search for. If a RegexMatchSet contains more than one RegexMatchTuple object, a request needs to match the settings in only one ByteMatchTuple to be considered a match. Contents Name A friendly name or description of the RegexMatchSet. You can't change Name after you create a RegexMatchSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No RegexMatchSetId The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get information about a RegexMatchSet (see GetRegexMatchSet), update a RegexMatchSet (see RegexMatchSet 1555 AWS WAFV2 API Reference UpdateRegexMatchSet), insert a RegexMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a RegexMatchSet from AWS WAF (see DeleteRegexMatchSet). RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No RegexMatchTuples Contains an array of RegexMatchTuple objects. Each RegexMatchTuple object contains: • The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header. • The identiﬁer of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet. • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the speciﬁed string. Type: Array of RegexMatchTuple objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RegexMatchSet 1556 AWS WAFV2 API Reference RegexMatchSetSummary Service: AWS WAF Classic Note AWS WAF Classic support will end on September 30, 2025. 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. Returned by ListRegexMatchSets. Each RegexMatchSetSummary object includes the Name and RegexMatchSetId for one RegexMatchSet. Contents Name A friendly name or description of the RegexMatchSet. You can't change Name after you create a RegexMatchSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes RegexMatchSetId The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get information about a RegexMatchSet, update a RegexMatchSet, remove a RegexMatchSet from a Rule, and delete a RegexMatchSet from AWS WAF. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets. Type: String RegexMatchSetSummary 1557 AWS WAFV2 API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RegexMatchSetSummary 1558 AWS WAFV2 RegexMatchSetUpdate Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. In an UpdateRegexMatchSet request, RegexMatchSetUpdate speciﬁes whether to insert or delete a RegexMatchTuple and includes the settings for the RegexMatchTuple. Contents Action Speciﬁes whether to insert or delete a RegexMatchTuple. Type: String Valid Values: INSERT \| DELETE Required: Yes RegexMatchTuple Information about the part of a web request that you want AWS WAF to inspect and the identiﬁer of the regular expression (regex) pattern that you want AWS WAF to search for. If you specify DELETE for the value
waf-apiref-323	waf-apiref.pdf	323	AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. In an UpdateRegexMatchSet request, RegexMatchSetUpdate speciﬁes whether to insert or delete a RegexMatchTuple and includes the settings for the RegexMatchTuple. Contents Action Speciﬁes whether to insert or delete a RegexMatchTuple. Type: String Valid Values: INSERT \| DELETE Required: Yes RegexMatchTuple Information about the part of a web request that you want AWS WAF to inspect and the identiﬁer of the regular expression (regex) pattern that you want AWS WAF to search for. If you specify DELETE for the value of Action, the RegexMatchTuple values must exactly match the values in the RegexMatchTuple that you want to delete from the RegexMatchSet. Type: RegexMatchTuple object Required: Yes RegexMatchSetUpdate 1559 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RegexMatchSetUpdate 1560 AWS WAFV2 RegexMatchTuple Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. The regular expression pattern that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. Each RegexMatchTuple object contains: • The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header. • The identiﬁer of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet. • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the speciﬁed string. Contents FieldToMatch Speciﬁes where in a web request to look for the RegexPatternSet. Type: FieldToMatch object Required: Yes RegexPatternSetId The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet (see GetRegexPatternSet), update a RegexPatternSet (see UpdateRegexPatternSet), insert a RegexPatternSet into a RegexMatchTuple 1561 AWS WAFV2 API Reference RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet). RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes TextTransformation Text transformations eliminate some of the unusual formatting that attackers use in web requests in an eﬀort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on RegexPatternSet before inspecting a request for a match. You can only specify a single type of TextTransformation. CMD_LINE When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: • Delete the following characters: \ " ' ^ • Delete spaces before the following characters: / ( • Replace the following characters with a space: , ; • Replace multiple spaces with one space • Convert uppercase letters (A-Z) to lowercase (a-z) COMPRESS_WHITE_SPACE Use this option to replace the following characters with a space character (decimal 32): • \f, formfeed, decimal 12 • \t, tab, decimal 9 • \n, newline, decimal 10 • \r, carriage return, decimal 13 • \v, vertical tab, decimal 11 RegexMatchTuple 1562 AWS WAFV2 API Reference • non-breaking space, decimal 160 COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: • Replaces (ampersand)quot; with " • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 • Replaces (ampersand)lt; with a "less than" symbol • Replaces (ampersand)gt; with > • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this option to decode a URL-encoded value. NONE Specify NONE if you don't want to perform any text transformations. Type: String Valid Values: NONE \| COMPRESS_WHITE_SPACE \| HTML_ENTITY_DECODE \| LOWERCASE \| CMD_LINE \| URL_DECODE Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: RegexMatchTuple 1563 AWS WAFV2 • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference RegexMatchTuple 1564 AWS WAFV2 RegexPatternSet Service: AWS WAF Classic Note
waf-apiref-324	waf-apiref.pdf	324	this option to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this option to decode a URL-encoded value. NONE Specify NONE if you don't want to perform any text transformations. Type: String Valid Values: NONE \| COMPRESS_WHITE_SPACE \| HTML_ENTITY_DECODE \| LOWERCASE \| CMD_LINE \| URL_DECODE Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: RegexMatchTuple 1563 AWS WAFV2 • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference RegexMatchTuple 1564 AWS WAFV2 RegexPatternSet Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. The RegexPatternSet speciﬁes the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. You can then conﬁgure AWS WAF to reject those requests. Contents RegexPatternSetId The identiﬁer for the RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet, update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF. RegexMatchSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes RegexPatternStrings Speciﬁes the regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t. Type: Array of strings Array Members: Maximum number of 10 items. RegexPatternSet 1565 AWS WAFV2 API Reference Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: .* Required: Yes Name A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RegexPatternSet 1566 AWS WAFV2 API Reference RegexPatternSetSummary Service: AWS WAF Classic Note AWS WAF Classic support will end on September 30, 2025. 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. Returned by ListRegexPatternSets. Each RegexPatternSetSummary object includes the Name and RegexPatternSetId for one RegexPatternSet. Contents Name A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes RegexPatternSetId The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet, update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets. Type: String RegexPatternSetSummary 1567 AWS WAFV2 API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RegexPatternSetSummary 1568 AWS WAFV2 API Reference RegexPatternSetUpdate Service: AWS WAF Classic Note AWS WAF Classic support will end on September 30, 2025. 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. In an UpdateRegexPatternSet request, RegexPatternSetUpdate speciﬁes whether to insert or delete a RegexPatternString and includes the settings for the RegexPatternString. Contents Action Speciﬁes whether to insert or delete a RegexPatternString. Type: String Valid Values: INSERT \| DELETE Required: Yes RegexPatternString Speciﬁes the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: .* Required: Yes RegexPatternSetUpdate 1569 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RegexPatternSetUpdate 1570 AWS WAFV2 Rule Service: AWS WAF Classic Note API Reference AWS WAF Classic support will
waf-apiref-325	waf-apiref.pdf	325	Valid Values: INSERT \| DELETE Required: Yes RegexPatternString Speciﬁes the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: .* Required: Yes RegexPatternSetUpdate 1569 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RegexPatternSetUpdate 1570 AWS WAFV2 Rule Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet objects that identify the web requests that you want to allow, block, or count. For example, you might create a Rule that includes the following predicates: • An IPSet that causes AWS WAF to search for web requests that originate from the IP address 192.0.2.44 • A ByteMatchSet that causes AWS WAF to search for web requests for which the value of the User-Agent header is BadBot. To match the settings in this Rule, a request must originate from 192.0.2.44 AND include a User-Agent header for which the value is BadBot. Contents Predicates The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule. Type: Array of Predicate objects Required: Yes Rule 1571 AWS WAFV2 RuleId API Reference A unique identiﬁer 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 a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule). RuleId is returned by CreateRule and by ListRules. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes MetricName A friendly name or description for the metrics for this Rule. 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 MetricName after you create the Rule. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No Name The friendly name or description for the Rule. You can't change the name of a Rule after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No Rule 1572 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Rule 1573 AWS WAFV2 RuleGroup Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. A collection of predeﬁned rules that you can add to a web ACL. Rule groups are subject to the following limits: • Three rule groups per account. You can request an increase to this limit by contacting customer support. • One rule group per web ACL. • Ten rules per rule group. Contents RuleGroupId A unique identiﬁer for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup). RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. RuleGroup 1574 AWS WAFV2 Required: Yes MetricName API Reference A friendly name or description for the metrics for this RuleGroup. 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 RuleGroup. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No Name The friendly name
waf-apiref-326	waf-apiref.pdf	326	Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. RuleGroup 1574 AWS WAFV2 Required: Yes MetricName API Reference A friendly name or description for the metrics for this RuleGroup. 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 RuleGroup. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No Name The friendly name or description for the RuleGroup. You can't change the name of a RuleGroup after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RuleGroup 1575 AWS WAFV2 RuleGroupSummary Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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 identiﬁer and the friendly name or description of the RuleGroup. Contents Name A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes RuleGroupId A unique identiﬁer for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup). RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. RuleGroupSummary 1576 AWS WAFV2 Pattern: .\S. Required: Yes See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RuleGroupSummary 1577 AWS WAFV2 RuleGroupUpdate Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. Speciﬁes an ActivatedRule and indicates whether you want to add it to a RuleGroup or delete it from a RuleGroup. Contents Action Specify INSERT to add an ActivatedRule to a RuleGroup. Use DELETE to remove an ActivatedRule from a RuleGroup. Type: String Valid Values: INSERT \| DELETE Required: Yes ActivatedRule The ActivatedRule object speciﬁes a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT). Type: ActivatedRule object Required: Yes RuleGroupUpdate 1578 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RuleGroupUpdate 1579 AWS WAFV2 RuleSummary Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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 identiﬁer and the friendly name or description of the Rule. Contents Name A friendly name or description of the Rule. You can't change the name of a Rule after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes RuleId A unique identiﬁer 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
waf-apiref-327	waf-apiref.pdf	327	the identiﬁer and the friendly name or description of the Rule. Contents Name A friendly name or description of the Rule. You can't change the name of a Rule after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes RuleId A unique identiﬁer 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. RuleSummary 1580 AWS WAFV2 Pattern: .\S. Required: Yes See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RuleSummary 1581 AWS WAFV2 RuleUpdate Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. Speciﬁes a Predicate (such as an IPSet) and indicates whether you want to add it to a Rule or delete it from a Rule. Contents Action Specify INSERT to add a Predicate to a Rule. Use DELETE to remove a Predicate from a Rule. Type: String Valid Values: INSERT \| DELETE Required: Yes Predicate The ID of the Predicate (such as an IPSet) that you want to add to a Rule. Type: Predicate object Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: RuleUpdate 1582 AWS WAFV2 • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference RuleUpdate 1583 AWS WAFV2 SampledHTTPRequest Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. The response from a GetSampledRequests request includes a SampledHTTPRequests complex type that appears as SampledRequests in the response syntax. SampledHTTPRequests contains one SampledHTTPRequest object for each web request that is returned by GetSampledRequests. Contents Request A complex type that contains detailed information about the request. Type: HTTPRequest object Required: Yes Weight A value that indicates how one result in the response relates proportionally to other results in the response. A result that has a weight of 2 represents roughly twice as many Amazon CloudFront web requests as a result that has a weight of 1. Type: Long Valid Range: Minimum value of 0. Required: Yes Action The action for the Rule that the request matched: ALLOW, BLOCK, or COUNT. SampledHTTPRequest 1584 AWS WAFV2 Type: String Required: No RuleWithinRuleGroup API Reference This value is returned if the GetSampledRequests request speciﬁes the ID of a RuleGroup rather than the ID of an individual rule. RuleWithinRuleGroup is the rule within the speciﬁed RuleGroup that matched the request listed in the response. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No Timestamp The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds). Type: Timestamp Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SampledHTTPRequest 1585 AWS WAFV2 SizeConstraint Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. Speciﬁes a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match. Contents
waf-apiref-328	waf-apiref.pdf	328	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. Speciﬁes a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match. Contents ComparisonOperator The type of comparison you want AWS WAF to perform. AWS WAF uses this in combination with the provided Size and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match. EQ: Used to test if the Size is equal to the size of the FieldToMatch NE: Used to test if the Size is not equal to the size of the FieldToMatch LE: Used to test if the Size is less than or equal to the size of the FieldToMatch LT: Used to test if the Size is strictly less than the size of the FieldToMatch GE: Used to test if the Size is greater than or equal to the size of the FieldToMatch GT: Used to test if the Size is strictly greater than the size of the FieldToMatch Type: String SizeConstraint 1586 AWS WAFV2 API Reference Valid Values: EQ \| NE \| LE \| LT \| GE \| GT Required: Yes FieldToMatch Speciﬁes where in a web request to look for the size constraint. Type: FieldToMatch object Required: Yes Size The size in bytes that you want AWS WAF to compare against the size of the speciﬁed FieldToMatch. AWS WAF uses this in combination with ComparisonOperator and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match. Valid values for size are 0 - 21474836480 bytes (0 - 20 GB). If you specify URI for the value of Type, the / in the URI path that you specify counts as one character. For example, the URI /logo.jpg is nine characters long. Type: Long Valid Range: Minimum value of 0. Maximum value of 21474836480. Required: Yes TextTransformation Text transformations eliminate some of the unusual formatting that attackers use in web requests in an eﬀort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting it for a match. You can only specify a single type of TextTransformation. Note that if you choose BODY for the value of Type, you must choose NONE for TextTransformation because Amazon CloudFront forwards only the ﬁrst 8192 bytes for inspection. NONE SizeConstraint 1587 AWS WAFV2 API Reference Specify NONE if you don't want to perform any text transformations. CMD_LINE When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: • Delete the following characters: \ " ' ^ • Delete spaces before the following characters: / ( • Replace the following characters with a space: , ; • Replace multiple spaces with one space • Convert uppercase letters (A-Z) to lowercase (a-z) COMPRESS_WHITE_SPACE Use this option to replace the following characters with a space character (decimal 32): • \f, formfeed, decimal 12 • \t, tab, decimal 9 • \n, newline, decimal 10 • \r, carriage return, decimal 13 • \v, vertical tab, decimal 11 • non-breaking space, decimal 160 COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: • Replaces (ampersand)quot; with " • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 • Replaces (ampersand)lt; with a "less than" symbol • Replaces (ampersand)gt; with > • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters SizeConstraint 1588 AWS WAFV2 API Reference • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this option to decode a URL-encoded value. Type: String Valid Values: NONE \| COMPRESS_WHITE_SPACE \| HTML_ENTITY_DECODE \| LOWERCASE \| CMD_LINE \| URL_DECODE Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SizeConstraint 1589 AWS WAFV2 SizeConstraintSet Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September
waf-apiref-329	waf-apiref.pdf	329	format, (ampersand)#nnnn;, with the corresponding characters LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this option to decode a URL-encoded value. Type: String Valid Values: NONE \| COMPRESS_WHITE_SPACE \| HTML_ENTITY_DECODE \| LOWERCASE \| CMD_LINE \| URL_DECODE Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SizeConstraint 1589 AWS WAFV2 SizeConstraintSet Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. A complex type that contains SizeConstraint objects, which specify the parts of web requests that you want AWS WAF to inspect the size of. If a SizeConstraintSet contains more than one SizeConstraint object, a request only needs to match one constraint to be considered a match. Contents SizeConstraints Speciﬁes the parts of web requests that you want to inspect the size of. Type: Array of SizeConstraint objects Required: Yes SizeConstraintSetId A unique identiﬁer for a SizeConstraintSet. You use SizeConstraintSetId to get information about a SizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet). SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. SizeConstraintSet 1590 API Reference AWS WAFV2 Pattern: .\S. Required: Yes Name The name, if any, of the SizeConstraintSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SizeConstraintSet 1591 AWS WAFV2 API Reference SizeConstraintSetSummary Service: AWS WAF Classic Note AWS WAF Classic support will end on September 30, 2025. 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. The Id and Name of a SizeConstraintSet. Contents Name The name of the SizeConstraintSet, if any. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes SizeConstraintSetId A unique identiﬁer for a SizeConstraintSet. You use SizeConstraintSetId to get information about a SizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet). SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. SizeConstraintSetSummary 1592 AWS WAFV2 Pattern: .\S. Required: Yes See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SizeConstraintSetSummary 1593 AWS WAFV2 API Reference SizeConstraintSetUpdate Service: AWS WAF Classic Note AWS WAF Classic support will end on September 30, 2025. 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. Speciﬁes the part of a web request that you want to inspect the size of and indicates whether you want to add the speciﬁcation to a SizeConstraintSet or delete it from a SizeConstraintSet. Contents Action Specify INSERT to add a SizeConstraintSetUpdate to a SizeConstraintSet. Use DELETE to remove a SizeConstraintSetUpdate from a SizeConstraintSet. Type: String Valid Values: INSERT \| DELETE Required: Yes SizeConstraint Speciﬁes a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match. Type: SizeConstraint object Required: Yes SizeConstraintSetUpdate 1594 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK
waf-apiref-330	waf-apiref.pdf	330	SizeConstraintSet. Use DELETE to remove a SizeConstraintSetUpdate from a SizeConstraintSet. Type: String Valid Values: INSERT \| DELETE Required: Yes SizeConstraint Speciﬁes a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match. Type: SizeConstraint object Required: Yes SizeConstraintSetUpdate 1594 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SizeConstraintSetUpdate 1595 AWS WAFV2 SqlInjectionMatchSet Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. A complex type that contains SqlInjectionMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. If a SqlInjectionMatchSet contains more than one SqlInjectionMatchTuple object, a request needs to include snippets of SQL code in only one of the speciﬁed parts of the request to be considered a match. Contents SqlInjectionMatchSetId A unique identiﬁer for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet). SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes SqlInjectionMatchSet 1596 AWS WAFV2 SqlInjectionMatchTuples API Reference Speciﬁes the parts of web requests that you want to inspect for snippets of malicious SQL code. Type: Array of SqlInjectionMatchTuple objects Required: Yes Name The name, if any, of the SqlInjectionMatchSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SqlInjectionMatchSet 1597 AWS WAFV2 API Reference SqlInjectionMatchSetSummary Service: AWS WAF Classic Note AWS WAF Classic support will end on September 30, 2025. 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. The Id and Name of a SqlInjectionMatchSet. Contents Name The name of the SqlInjectionMatchSet, if any, speciﬁed by Id. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes SqlInjectionMatchSetId A unique identiﬁer for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet). SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets. Type: String SqlInjectionMatchSetSummary 1598 AWS WAFV2 API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SqlInjectionMatchSetSummary 1599 AWS WAFV2 API Reference SqlInjectionMatchSetUpdate Service: AWS WAF Classic Note AWS WAF Classic support will end on September 30, 2025. 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. Speciﬁes the part of a web request that you want to inspect for snippets of malicious SQL code and indicates whether you want to add the speciﬁcation to a SqlInjectionMatchSet or delete it from a SqlInjectionMatchSet. Contents Action Specify INSERT to add a SqlInjectionMatchSetUpdate to a SqlInjectionMatchSet. Use DELETE to remove a SqlInjectionMatchSetUpdate from a SqlInjectionMatchSet. Type: String Valid Values: INSERT \| DELETE Required: Yes SqlInjectionMatchTuple Speciﬁes the part of a web request that
waf-apiref-331	waf-apiref.pdf	331	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. Speciﬁes the part of a web request that you want to inspect for snippets of malicious SQL code and indicates whether you want to add the speciﬁcation to a SqlInjectionMatchSet or delete it from a SqlInjectionMatchSet. Contents Action Specify INSERT to add a SqlInjectionMatchSetUpdate to a SqlInjectionMatchSet. Use DELETE to remove a SqlInjectionMatchSetUpdate from a SqlInjectionMatchSet. Type: String Valid Values: INSERT \| DELETE Required: Yes SqlInjectionMatchTuple Speciﬁes the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. Type: SqlInjectionMatchTuple object Required: Yes SqlInjectionMatchSetUpdate 1600 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SqlInjectionMatchSetUpdate 1601 AWS WAFV2 API Reference SqlInjectionMatchTuple Service: AWS WAF Classic Note AWS WAF Classic support will end on September 30, 2025. 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. Speciﬁes the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. Contents FieldToMatch Speciﬁes where in a web request to look for snippets of malicious SQL code. Type: FieldToMatch object Required: Yes TextTransformation Text transformations eliminate some of the unusual formatting that attackers use in web requests in an eﬀort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting it for a match. You can only specify a single type of TextTransformation. CMD_LINE When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: • Delete the following characters: \ " ' ^ SqlInjectionMatchTuple 1602 AWS WAFV2 API Reference • Delete spaces before the following characters: / ( • Replace the following characters with a space: , ; • Replace multiple spaces with one space • Convert uppercase letters (A-Z) to lowercase (a-z) COMPRESS_WHITE_SPACE Use this option to replace the following characters with a space character (decimal 32): • \f, formfeed, decimal 12 • \t, tab, decimal 9 • \n, newline, decimal 10 • \r, carriage return, decimal 13 • \v, vertical tab, decimal 11 • non-breaking space, decimal 160 COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: • Replaces (ampersand)quot; with " • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 • Replaces (ampersand)lt; with a "less than" symbol • Replaces (ampersand)gt; with > • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this option to decode a URL-encoded value. SqlInjectionMatchTuple 1603 AWS WAFV2 NONE API Reference Specify NONE if you don't want to perform any text transformations. Type: String Valid Values: NONE \| COMPRESS_WHITE_SPACE \| HTML_ENTITY_DECODE \| LOWERCASE \| CMD_LINE \| URL_DECODE Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SqlInjectionMatchTuple 1604 AWS WAFV2 API Reference SubscribedRuleGroupSummary Service: AWS WAF Classic Note AWS WAF Classic support will end on September 30, 2025. 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. A summary of the rule groups you are subscribed to. Contents MetricName A friendly name or description for the metrics for this RuleGroup. 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
waf-apiref-332	waf-apiref.pdf	332	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. A summary of the rule groups you are subscribed to. Contents MetricName A friendly name or description for the metrics for this RuleGroup. 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 RuleGroup. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes Name A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. SubscribedRuleGroupSummary 1605 AWS WAFV2 Required: Yes RuleGroupId A unique identiﬁer for a RuleGroup. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. API Reference Pattern: .\S. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SubscribedRuleGroupSummary 1606 AWS WAFV2 Tag Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. A tag associated with an AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource. Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules. Contents Key Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes Value Type: String Length Constraints: Minimum length of 0. Maximum length of 256. Tag 1607 AWS WAFV2 Pattern: .* Required: Yes See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Tag 1608 AWS WAFV2 TagInfoForResource Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. Information for a tag associated with an AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource. Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules. Contents ResourceARN Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .\S. Required: No TagList Type: Array of Tag objects Array Members: Minimum number of 1 item. TagInfoForResource 1609 AWS WAFV2 Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 TagInfoForResource 1610 AWS WAFV2 TimeWindow Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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
waf-apiref-333	waf-apiref.pdf	333	Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 TagInfoForResource 1610 AWS WAFV2 TimeWindow Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. In a GetSampledRequests request, the StartTime and EndTime objects specify the time range for which you want AWS WAF to return a sample of web requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". In a GetSampledRequests response, the StartTime and EndTime objects specify the time range for which AWS WAF actually returned a sample of web requests. AWS WAF gets the speciﬁed number of requests from among the ﬁrst 5,000 requests that your AWS resource receives during the speciﬁed time period. If your resource receives more than 5,000 requests during that period, AWS WAF stops sampling after the 5,000th request. In that case, EndTime is the time that AWS WAF received the 5,000th request. Contents EndTime The end of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. You must specify the date and time in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours. Type: Timestamp Required: Yes TimeWindow 1611 AWS WAFV2 StartTime API Reference The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. You must specify the date and time in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours. Type: Timestamp Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 TimeWindow 1612 AWS WAFV2 WafAction Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. For the action that is associated with a rule in a WebACL, speciﬁes the action that you want AWS WAF to perform when a web request matches all of the conditions in a rule. For the default action in a WebACL, speciﬁes the action that you want AWS WAF to take when a web request doesn't match all of the conditions in any of the rules in a WebACL. Contents Type Speciﬁes how you want AWS WAF to respond to requests that match the settings in a Rule. Valid settings include the following: • ALLOW: AWS WAF allows requests • BLOCK: AWS WAF blocks requests • COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a WebACL. Type: String Valid Values: BLOCK \| ALLOW \| COUNT Required: Yes WafAction 1613 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 WafAction 1614 AWS WAFV2 WafOverrideAction Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. The action to take if any rule within the RuleGroup matches a request. Contents Type COUNT overrides the action speciﬁed by the individual rule within a RuleGroup . If set to NONE, the rule's action will
waf-apiref-334	waf-apiref.pdf	334	AWS WAF Classic support will end on September 30, 2025. 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. The action to take if any rule within the RuleGroup matches a request. Contents Type COUNT overrides the action speciﬁed by the individual rule within a RuleGroup . If set to NONE, the rule's action will take place. Type: String Valid Values: NONE \| COUNT Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 WafOverrideAction 1615 AWS WAFV2 WebACL Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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 Rules that identify the requests that you want to allow, block, or count. In a WebACL, you also specify a default action (ALLOW or BLOCK), and the action for each Rule that you add to a WebACL, for example, block requests from speciﬁed IP addresses or block requests from speciﬁed referrers. You also associate the WebACL with an Amazon CloudFront distribution to identify the requests that you want AWS WAF to ﬁlter. If you add more than one Rule to a WebACL, a request needs to match only one of the speciﬁcations to be allowed, blocked, or counted. For more information, see UpdateWebACL. Contents DefaultAction The action to perform if none of the Rules contained in the WebACL match. The action is speciﬁed by the WafAction object. Type: WafAction object Required: Yes Rules An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule. Type: Array of ActivatedRule objects Required: Yes WebACL 1616 AWS WAFV2 WebACLId API Reference A unique identiﬁer for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL). WebACLId is returned by CreateWebACL and by ListWebACLs. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes MetricName A friendly name or description for the metrics for this WebACL. 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 MetricName after you create the WebACL. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No Name A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No WebACL 1617 AWS WAFV2 WebACLArn API Reference Tha Amazon Resource Name (ARN) of the web ACL. Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .\S. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 WebACL 1618 AWS WAFV2 WebACLSummary Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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 identiﬁer and the name or description of the WebACL. Contents Name A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes WebACLId A unique identiﬁer for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL). WebACLId is returned by CreateWebACL and by ListWebACLs. Type: String Length Constraints: Minimum length of 1. Maximum length
waf-apiref-335	waf-apiref.pdf	335	use. Contains the identiﬁer and the name or description of the WebACL. Contents Name A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes WebACLId A unique identiﬁer for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL). WebACLId is returned by CreateWebACL and by ListWebACLs. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. WebACLSummary 1619 AWS WAFV2 Pattern: .\S. Required: Yes See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 WebACLSummary 1620 AWS WAFV2 WebACLUpdate Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. Speciﬁes whether to insert a Rule into or delete a Rule from a WebACL. Contents Action Speciﬁes whether to insert a Rule into or delete a Rule from a WebACL. Type: String Valid Values: INSERT \| DELETE Required: Yes ActivatedRule The ActivatedRule object in an UpdateWebACL request speciﬁes a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT). Type: ActivatedRule object Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: WebACLUpdate 1621 AWS WAFV2 • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference WebACLUpdate 1622 AWS WAFV2 XssMatchSet Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. A complex type that contains XssMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. If a XssMatchSet contains more than one XssMatchTuple object, a request needs to include cross-site scripting attacks in only one of the speciﬁed parts of the request to be considered a match. Contents XssMatchSetId A unique identiﬁer for an XssMatchSet. You use XssMatchSetId to get information about an XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see DeleteXssMatchSet). XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes XssMatchTuples Speciﬁes the parts of web requests that you want to inspect for cross-site scripting attacks. XssMatchSet 1623 AWS WAFV2 API Reference Type: Array of XssMatchTuple objects Required: Yes Name The name, if any, of the XssMatchSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 XssMatchSet 1624 AWS WAFV2 XssMatchSetSummary Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. The Id and Name of an XssMatchSet. Contents Name The name of the XssMatchSet, if any, speciﬁed by Id. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes XssMatchSetId A unique identiﬁer for an XssMatchSet. You use XssMatchSetId to get information about a XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert
waf-apiref-336	waf-apiref.pdf	336	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. The Id and Name of an XssMatchSet. Contents Name The name of the XssMatchSet, if any, speciﬁed by Id. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes XssMatchSetId A unique identiﬁer for an XssMatchSet. You use XssMatchSetId to get information about a XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see DeleteXssMatchSet). XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. XssMatchSetSummary 1625 AWS WAFV2 Pattern: .\S. Required: Yes See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 XssMatchSetSummary 1626 AWS WAFV2 XssMatchSetUpdate Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. Speciﬁes the part of a web request that you want to inspect for cross-site scripting attacks and indicates whether you want to add the speciﬁcation to an XssMatchSet or delete it from an XssMatchSet. Contents Action Specify INSERT to add an XssMatchSetUpdate to an XssMatchSet. Use DELETE to remove an XssMatchSetUpdate from an XssMatchSet. Type: String Valid Values: INSERT \| DELETE Required: Yes XssMatchTuple Speciﬁes the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. Type: XssMatchTuple object Required: Yes XssMatchSetUpdate 1627 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 XssMatchSetUpdate 1628 AWS WAFV2 XssMatchTuple Service: AWS WAF Classic Note API Reference AWS WAF Classic support will end on September 30, 2025. 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. Speciﬁes the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header. Contents FieldToMatch Speciﬁes where in a web request to look for cross-site scripting attacks. Type: FieldToMatch object Required: Yes TextTransformation Text transformations eliminate some of the unusual formatting that attackers use in web requests in an eﬀort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting it for a match. You can only specify a single type of TextTransformation. CMD_LINE When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: • Delete the following characters: \ " ' ^ XssMatchTuple 1629 AWS WAFV2 API Reference • Delete spaces before the following characters: / ( • Replace the following characters with a space: , ; • Replace multiple spaces with one space • Convert uppercase letters (A-Z) to lowercase (a-z) COMPRESS_WHITE_SPACE Use this option to replace the following characters with a space character (decimal 32): • \f, formfeed, decimal 12 • \t, tab, decimal 9 • \n, newline, decimal 10 • \r, carriage return, decimal 13 • \v, vertical tab, decimal 11 • non-breaking space, decimal 160 COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: • Replaces (ampersand)quot; with " • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 • Replaces (ampersand)lt; with a "less than" symbol • Replaces (ampersand)gt; with > • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters LOWERCASE Use this option to convert
waf-apiref-337	waf-apiref.pdf	337	carriage return, decimal 13 • \v, vertical tab, decimal 11 • non-breaking space, decimal 160 COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: • Replaces (ampersand)quot; with " • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 • Replaces (ampersand)lt; with a "less than" symbol • Replaces (ampersand)gt; with > • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this option to decode a URL-encoded value. XssMatchTuple 1630 AWS WAFV2 NONE API Reference Specify NONE if you don't want to perform any text transformations. Type: String Valid Values: NONE \| COMPRESS_WHITE_SPACE \| HTML_ENTITY_DECODE \| LOWERCASE \| CMD_LINE \| URL_DECODE Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AWS WAF Classic Regional The following data types are supported by AWS WAF Classic Regional: • ActivatedRule • ByteMatchSet • ByteMatchSetSummary • ByteMatchSetUpdate • ByteMatchTuple • ExcludedRule • FieldToMatch • GeoMatchConstraint • GeoMatchSet • GeoMatchSetSummary • GeoMatchSetUpdate AWS WAF Classic Regional 1631 API Reference AWS WAFV2 • HTTPHeader • HTTPRequest • IPSet • IPSetDescriptor • IPSetSummary • IPSetUpdate • LoggingConﬁguration • Predicate • RateBasedRule • RegexMatchSet • RegexMatchSetSummary • RegexMatchSetUpdate • RegexMatchTuple • RegexPatternSet • RegexPatternSetSummary • RegexPatternSetUpdate • Rule • RuleGroup • RuleGroupSummary • RuleGroupUpdate • RuleSummary • RuleUpdate • SampledHTTPRequest • SizeConstraint • SizeConstraintSet • SizeConstraintSetSummary • SizeConstraintSetUpdate • SqlInjectionMatchSet • SqlInjectionMatchSetSummary • SqlInjectionMatchSetUpdate AWS WAF Classic Regional 1632 API Reference AWS WAFV2 • SqlInjectionMatchTuple • SubscribedRuleGroupSummary • Tag • TagInfoForResource • TimeWindow • WafAction • WafOverrideAction • WebACL • WebACLSummary • WebACLUpdate • XssMatchSet • XssMatchSetSummary • XssMatchSetUpdate • XssMatchTuple AWS WAF Classic Regional 1633 AWS WAFV2 API Reference ActivatedRule Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. The ActivatedRule object in an UpdateWebACL request speciﬁes a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT). To specify whether to insert or delete a Rule, use the Action parameter in the WebACLUpdate data type. Contents Priority Speciﬁes the order in which the Rules in a WebACL are evaluated. Rules with a lower value for Priority are evaluated before Rules with a higher value. The value must be a unique integer. If you add multiple Rules to a WebACL, the values don't need to be consecutive. Type: Integer Required: Yes RuleId The RuleId 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 a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule). RuleId is returned by CreateRule and by ListRules. Type: String ActivatedRule 1634 AWS WAFV2 API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes Action Speciﬁes the action that Amazon CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. Valid values for Action include the following: • ALLOW: CloudFront responds with the requested object. • BLOCK: CloudFront responds with an HTTP 403 (Forbidden) status code. • COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL. ActivatedRule\|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case, you do not use ActivatedRule\|Action. For all other update requests, ActivatedRule\|Action is used instead of ActivatedRule\|OverrideAction. Type: WafAction object Required: No ExcludedRules An array of rules to exclude from a rule group. This is applicable only when the ActivatedRule refers to a RuleGroup. Sometimes it is necessary to troubleshoot rule groups that are blocking traﬃc unexpectedly (false positives). One troubleshooting technique is to identify the speciﬁc rule within the rule group that is blocking the legitimate traﬃc and then disable (exclude) that particular rule. You can exclude rules from both your own rule groups and AWS Marketplace rule groups that
waf-apiref-338	waf-apiref.pdf	338	you do not use ActivatedRule\|Action. For all other update requests, ActivatedRule\|Action is used instead of ActivatedRule\|OverrideAction. Type: WafAction object Required: No ExcludedRules An array of rules to exclude from a rule group. This is applicable only when the ActivatedRule refers to a RuleGroup. Sometimes it is necessary to troubleshoot rule groups that are blocking traﬃc unexpectedly (false positives). One troubleshooting technique is to identify the speciﬁc rule within the rule group that is blocking the legitimate traﬃc and then disable (exclude) that particular rule. You can exclude rules from both your own rule groups and AWS Marketplace rule groups that have been associated with a web ACL. Specifying ExcludedRules does not remove those rules from the rule group. Rather, it changes the action for the rules to COUNT. Therefore, requests that match an ExcludedRule are counted but not blocked. The RuleGroup owner will receive COUNT metrics for each ExcludedRule. If you want to exclude rules from a rule group that is already associated with a web ACL, perform the following steps: ActivatedRule 1635 AWS WAFV2 API Reference 1. Use the AWS WAF logs to identify the IDs of the rules that you want to exclude. For more information about the logs, see Logging Web ACL Traﬃc Information. 2. Submit an UpdateWebACL request that has two actions: • The ﬁrst action deletes the existing rule group from the web ACL. That is, in the UpdateWebACL request, the ﬁrst Updates:Action should be DELETE and Updates:ActivatedRule:RuleId should be the rule group that contains the rules that you want to exclude. • The second action inserts the same rule group back in, but specifying the rules to exclude. That is, the second Updates:Action should be INSERT, Updates:ActivatedRule:RuleId should be the rule group that you just removed, and ExcludedRules should contain the rules that you want to exclude. Type: Array of ExcludedRule objects Required: No OverrideAction Use the OverrideAction to test your RuleGroup. Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to None, the RuleGroup will block a request if any individual rule in the RuleGroup matches the request and is conﬁgured to block that request. However if you ﬁrst want to test the RuleGroup, set the OverrideAction to Count. The RuleGroup will then override any block action speciﬁed by individual rules contained within the group. Instead of blocking matching requests, those requests will be counted. You can view a record of counted requests using GetSampledRequests. ActivatedRule\|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule\|Action. For all other update requests, ActivatedRule\|Action is used instead of ActivatedRule\|OverrideAction. Type: WafOverrideAction object Required: No Type The rule type, either REGULAR, as deﬁned by Rule, RATE_BASED, as deﬁned by RateBasedRule, or GROUP, as deﬁned by RuleGroup. The default is REGULAR. Although this ﬁeld is optional, ActivatedRule 1636 AWS WAFV2 API Reference be aware that if you try to add a RATE_BASED rule to a web ACL without setting the type, the UpdateWebACL request will fail because the request tries to add a REGULAR rule with the speciﬁed ID, which does not exist. Type: String Valid Values: REGULAR \| RATE_BASED \| GROUP Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ActivatedRule 1637 AWS WAFV2 API Reference ByteMatchSet Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. In a GetByteMatchSet request, ByteMatchSet is a complex type that contains the ByteMatchSetId and Name of a ByteMatchSet, and the values that you speciﬁed when you updated the ByteMatchSet. A complex type that contains ByteMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect and the values that you want AWS WAF to search for. If a ByteMatchSet contains more than one ByteMatchTuple object, a request needs to match the settings in only one ByteMatchTuple to be considered a match. Contents ByteMatchSetId The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see DeleteByteMatchSet). ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required:
waf-apiref-339	waf-apiref.pdf	339	want AWS WAF to search for. If a ByteMatchSet contains more than one ByteMatchTuple object, a request needs to match the settings in only one ByteMatchTuple to be considered a match. Contents ByteMatchSetId The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see DeleteByteMatchSet). ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes ByteMatchSet 1638 AWS WAFV2 ByteMatchTuples API Reference Speciﬁes the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. Type: Array of ByteMatchTuple objects Required: Yes Name A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ByteMatchSet 1639 AWS WAFV2 API Reference ByteMatchSetSummary Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. Returned by ListByteMatchSets. Each ByteMatchSetSummary object includes the Name and ByteMatchSetId for one ByteMatchSet. Contents ByteMatchSetId The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet, update a ByteMatchSet, remove a ByteMatchSet from a Rule, and delete a ByteMatchSet from AWS WAF. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes Name A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet. Type: String ByteMatchSetSummary 1640 AWS WAFV2 API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ByteMatchSetSummary 1641 AWS WAFV2 API Reference ByteMatchSetUpdate Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. In an UpdateByteMatchSet request, ByteMatchSetUpdate speciﬁes whether to insert or delete a ByteMatchTuple and includes the settings for the ByteMatchTuple. Contents Action Speciﬁes whether to insert or delete a ByteMatchTuple. Type: String Valid Values: INSERT \| DELETE Required: Yes ByteMatchTuple Information about the part of a web request that you want AWS WAF to inspect and the value that you want AWS WAF to search for. If you specify DELETE for the value of Action, the ByteMatchTuple values must exactly match the values in the ByteMatchTuple that you want to delete from the ByteMatchSet. Type: ByteMatchTuple object Required: Yes ByteMatchSetUpdate 1642 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ByteMatchSetUpdate 1643 AWS WAFV2 API Reference ByteMatchTuple Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. Contents FieldToMatch The part of a web request that you want AWS WAF to search, such as a speciﬁed header or a query string. For more
waf-apiref-340	waf-apiref.pdf	340	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. The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. Contents FieldToMatch The part of a web request that you want AWS WAF to search, such as a speciﬁed header or a query string. For more information, see FieldToMatch. Type: FieldToMatch object Required: Yes PositionalConstraint Within the portion of a web request that you want to search (for example, in the query string, if any), specify where you want AWS WAF to search. Valid values include the following: CONTAINS The speciﬁed part of the web request must include the value of TargetString, but the location doesn't matter. CONTAINS_WORD ByteMatchTuple 1644 AWS WAFV2 API Reference The speciﬁed part of the web request must include the value of TargetString, and TargetString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, TargetString must be a word, which means one of the following: • TargetString exactly matches the value of the speciﬁed part of the web request, such as the value of a header. • TargetString is at the beginning of the speciﬁed part of the web request and is followed by a character other than an alphanumeric character or underscore (_), for example, BadBot;. • TargetString is at the end of the speciﬁed part of the web request and is preceded by a character other than an alphanumeric character or underscore (_), for example, ;BadBot. • TargetString is in the middle of the speciﬁed part of the web request and is preceded and followed by characters other than alphanumeric characters or underscore (_), for example, - BadBot;. EXACTLY The value of the speciﬁed part of the web request must exactly match the value of TargetString. STARTS_WITH The value of TargetString must appear at the beginning of the speciﬁed part of the web request. ENDS_WITH The value of TargetString must appear at the end of the speciﬁed part of the web request. Type: String Valid Values: EXACTLY \| STARTS_WITH \| ENDS_WITH \| CONTAINS \| CONTAINS_WORD Required: Yes TargetString The value that you want AWS WAF to search for. AWS WAF searches for the speciﬁed string in the part of web requests that you speciﬁed in FieldToMatch. The maximum length of the value is 50 bytes. ByteMatchTuple 1645 AWS WAFV2 API Reference Valid values depend on the values that you speciﬁed for FieldToMatch: • HEADER: The value that you want AWS WAF to search for in the request header that you speciﬁed in FieldToMatch, for example, the value of the User-Agent or Referer header. • METHOD: The HTTP method, which indicates the type of operation speciﬁed in the request. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. • QUERY_STRING: The value that you want AWS WAF to search for in the query string, which is the part of a URL that appears after a ? character. • URI: The path component of the URI. This does not include the query string or fragment components of the URI. For information, see Uniform Resource Identiﬁer (URI): Generic Syntax. • BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the ﬁrst 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet. • SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters. • ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but instead of inspecting a single parameter, AWS WAF inspects all parameters within the query string for the value or regex pattern that you specify in TargetString. If TargetString includes alphabetic characters A-Z and a-z, note that the value is case sensitive. If you're using the AWS WAF API Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes. For example, suppose the value of Type is HEADER and the value of Data is User-Agent. If you want to search the User-Agent header for the value BadBot, you base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90, in the value of TargetString. If you're using the AWS CLI or one
waf-apiref-341	waf-apiref.pdf	341	that you specify in TargetString. If TargetString includes alphabetic characters A-Z and a-z, note that the value is case sensitive. If you're using the AWS WAF API Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes. For example, suppose the value of Type is HEADER and the value of Data is User-Agent. If you want to search the User-Agent header for the value BadBot, you base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90, in the value of TargetString. If you're using the AWS CLI or one of the AWS SDKs ByteMatchTuple 1646 AWS WAFV2 API Reference The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value. Type: Base64-encoded binary data object Required: Yes TextTransformation Text transformations eliminate some of the unusual formatting that attackers use in web requests in an eﬀort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting it for a match. You can only specify a single type of TextTransformation. CMD_LINE When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: • Delete the following characters: \ " ' ^ • Delete spaces before the following characters: / ( • Replace the following characters with a space: , ; • Replace multiple spaces with one space • Convert uppercase letters (A-Z) to lowercase (a-z) COMPRESS_WHITE_SPACE Use this option to replace the following characters with a space character (decimal 32): • \f, formfeed, decimal 12 • \t, tab, decimal 9 • \n, newline, decimal 10 • \r, carriage return, decimal 13 • \v, vertical tab, decimal 11 • non-breaking space, decimal 160 COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. HTML_ENTITY_DECODE ByteMatchTuple 1647 AWS WAFV2 API Reference Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: • Replaces (ampersand)quot; with " • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 • Replaces (ampersand)lt; with a "less than" symbol • Replaces (ampersand)gt; with > • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this option to decode a URL-encoded value. NONE Specify NONE if you don't want to perform any text transformations. Type: String Valid Values: NONE \| COMPRESS_WHITE_SPACE \| HTML_ENTITY_DECODE \| LOWERCASE \| CMD_LINE \| URL_DECODE Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ByteMatchTuple 1648 AWS WAFV2 API Reference ByteMatchTuple 1649 AWS WAFV2 API Reference ExcludedRule Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. The rule to exclude from a rule group. This is applicable only when the ActivatedRule refers to a RuleGroup. The rule must belong to the RuleGroup that is speciﬁed by the ActivatedRule. Contents RuleId The unique identiﬁer for the rule to exclude from the rule group. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ExcludedRule 1650 AWS WAFV2 API Reference FieldToMatch Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. Speciﬁes where in a web request to look for TargetString. Contents Type The part of the web request that you want AWS WAF to search for a speciﬁed string. Parts of a request that you can search include the following: • HEADER: A speciﬁed request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify
waf-apiref-342	waf-apiref.pdf	342	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. Speciﬁes where in a web request to look for TargetString. Contents Type The part of the web request that you want AWS WAF to search for a speciﬁed string. Parts of a request that you can search include the following: • HEADER: A speciﬁed request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data. • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any. • URI: The path component of the URI. This does not include the query string or fragment components of the URI. For information, see Uniform Resource Identiﬁer (URI): Generic Syntax. • BODY: The part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form. The request body immediately follows the request headers. Note that only the ﬁrst 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet. FieldToMatch 1651 AWS WAFV2 API Reference • SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters. • ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString. Type: String Valid Values: URI \| QUERY_STRING \| HEADER \| METHOD \| BODY \| SINGLE_QUERY_ARG \| ALL_QUERY_ARGS Required: Yes Data When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive. When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive. If the value of Type is any other value, omit Data. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 FieldToMatch 1652 AWS WAFV2 API Reference FieldToMatch 1653 AWS WAFV2 API Reference GeoMatchConstraint Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. The country from which web requests originate that you want AWS WAF to search for. Contents Type The type of geographical area you want AWS WAF to search for. Currently Country is the only valid value. Type: String Valid Values: Country Required: Yes Value The country that you want AWS WAF to search for. Type: String Valid Values: AF \| AX \| AL \| DZ \| AS \| AD \| AO \| AI \| AQ \| AG \| AR \| AM \| AW \| AU \| AT \| AZ \| BS \| BH \| BD \| BB \| BY \| BE \| BZ \| BJ \| BM \| BT \| BO \| BQ \| BA \| BW \| BV \| BR \| IO \| BN \| BG \| BF \| BI \| KH \| CM \| CA \| CV \| KY \| CF \| TD \| CL \| CN \| CX \| CC \| CO \| KM \| CG \| CD \| CK \| CR \| CI \| HR \| CU \| CW \| CY \| CZ \| DK \| DJ \| DM \| DO \| EC \| EG \| SV \| GQ \| ER \| EE \| ET \| FK \| FO \| FJ \| FI \| FR \| GF \| PF \| TF \| GA \| GM \| GE \| DE \| GH \| GI \| GeoMatchConstraint 1654 AWS WAFV2
waf-apiref-343	waf-apiref.pdf	343	KH \| CM \| CA \| CV \| KY \| CF \| TD \| CL \| CN \| CX \| CC \| CO \| KM \| CG \| CD \| CK \| CR \| CI \| HR \| CU \| CW \| CY \| CZ \| DK \| DJ \| DM \| DO \| EC \| EG \| SV \| GQ \| ER \| EE \| ET \| FK \| FO \| FJ \| FI \| FR \| GF \| PF \| TF \| GA \| GM \| GE \| DE \| GH \| GI \| GeoMatchConstraint 1654 AWS WAFV2 API Reference GR \| GL \| GD \| GP \| GU \| GT \| GG \| GN \| GW \| GY \| HT \| HM \| VA \| HN \| HK \| HU \| IS \| IN \| ID \| IR \| IQ \| IE \| IM \| IL \| IT \| JM \| JP \| JE \| JO \| KZ \| KE \| KI \| KP \| KR \| KW \| KG \| LA \| LV \| LB \| LS \| LR \| LY \| LI \| LT \| LU \| MO \| MK \| MG \| MW \| MY \| MV \| ML \| MT \| MH \| MQ \| MR \| MU \| YT \| MX \| FM \| MD \| MC \| MN \| ME \| MS \| MA \| MZ \| MM \| NA \| NR \| NP \| NL \| NC \| NZ \| NI \| NE \| NG \| NU \| NF \| MP \| NO \| OM \| PK \| PW \| PS \| PA \| PG \| PY \| PE \| PH \| PN \| PL \| PT \| PR \| QA \| RE \| RO \| RU \| RW \| BL \| SH \| KN \| LC \| MF \| PM \| VC \| WS \| SM \| ST \| SA \| SN \| RS \| SC \| SL \| SG \| SX \| SK \| SI \| SB \| SO \| ZA \| GS \| SS \| ES \| LK \| SD \| SR \| SJ \| SZ \| SE \| CH \| SY \| TW \| TJ \| TZ \| TH \| TL \| TG \| TK \| TO \| TT \| TN \| TR \| TM \| TC \| TV \| UG \| UA \| AE \| GB \| US \| UM \| UY \| UZ \| VU \| VE \| VN \| VG \| VI \| WF \| EH \| YE \| ZM \| ZW Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 GeoMatchConstraint 1655 AWS WAFV2 API Reference GeoMatchSet Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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 one or more countries that AWS WAF will search for. Contents GeoMatchConstraints An array of GeoMatchConstraint objects, which contain the country that you want AWS WAF to search for. Type: Array of GeoMatchConstraint objects Required: Yes GeoMatchSetId The GeoMatchSetId for an GeoMatchSet. You use GeoMatchSetId to get information about a GeoMatchSet (see GeoMatchSet), update a GeoMatchSet (see UpdateGeoMatchSet), insert a GeoMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a GeoMatchSet from AWS WAF (see DeleteGeoMatchSet). GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes GeoMatchSet 1656 AWS WAFV2 Name API Reference A friendly name or description of the GeoMatchSet. You can't change the name of an GeoMatchSet after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 GeoMatchSet 1657 AWS WAFV2 API Reference GeoMatchSetSummary Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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
waf-apiref-344	waf-apiref.pdf	344	this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 GeoMatchSet 1657 AWS WAFV2 API Reference GeoMatchSetSummary Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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 identiﬁer and the name of the GeoMatchSet. Contents GeoMatchSetId The GeoMatchSetId for an GeoMatchSet. You can use GeoMatchSetId in a GetGeoMatchSet request to get detailed information about an GeoMatchSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes Name A friendly name or description of the GeoMatchSet. You can't change the name of an GeoMatchSet after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes GeoMatchSetSummary 1658 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 GeoMatchSetSummary 1659 AWS WAFV2 API Reference GeoMatchSetUpdate Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. Speciﬁes the type of update to perform to an GeoMatchSet with UpdateGeoMatchSet. Contents Action Speciﬁes whether to insert or delete a country with UpdateGeoMatchSet. Type: String Valid Values: INSERT \| DELETE Required: Yes GeoMatchConstraint The country from which web requests originate that you want AWS WAF to search for. Type: GeoMatchConstraint object Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ GeoMatchSetUpdate 1660 AWS WAFV2 • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference GeoMatchSetUpdate 1661 AWS WAFV2 API Reference HTTPHeader Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. The response from a GetSampledRequests request includes an HTTPHeader complex type that appears as Headers in the response syntax. HTTPHeader contains the names and values of all of the headers that appear in one of the web requests that were returned by GetSampledRequests. Contents Name The name of one of the headers in the sampled web request. Type: String Required: No Value The value of one of the headers in the sampled web request. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ HTTPHeader 1662 AWS WAFV2 • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference HTTPHeader 1663 AWS WAFV2 API Reference HTTPRequest Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. The response from a GetSampledRequests request includes an HTTPRequest complex type that appears as Request in the response syntax. HTTPRequest contains information about one of the web requests that were returned by GetSampledRequests. Contents ClientIP The IP address that the request originated from. If the WebACL is associated with an Amazon CloudFront distribution, this is the value of one of the following ﬁelds in CloudFront access logs: • c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the request • x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request Type: String Required: No Country The two-letter country code for the country that the request originated from.
waf-apiref-345	waf-apiref.pdf	345	information about one of the web requests that were returned by GetSampledRequests. Contents ClientIP The IP address that the request originated from. If the WebACL is associated with an Amazon CloudFront distribution, this is the value of one of the following ﬁelds in CloudFront access logs: • c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the request • x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request Type: String Required: No Country The two-letter country code for the country that the request originated from. For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2. Type: String Required: No HTTPRequest 1664 AWS WAFV2 Headers API Reference A complex type that contains two values for each header in the sampled web request: the name of the header and the value of the header. Type: Array of HTTPHeader objects Required: No HTTPVersion The HTTP version speciﬁed in the sampled web request, for example, HTTP/1.1. Type: String Required: No Method The HTTP method speciﬁed in the sampled web request. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. Type: String Required: No URI The path component of the URI. This does not include the query string or fragment components of the URI. For information, see Uniform Resource Identiﬁer (URI): Generic Syntax. Type: String Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 HTTPRequest 1665 AWS WAFV2 API Reference HTTPRequest 1666 AWS WAFV2 API Reference IPSet Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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 one or more IP addresses or blocks of IP addresses speciﬁed in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. To specify an individual IP address, you specify the four-part IP address followed by a /32, for example, 192.0.2.0/32. To block a range of IP addresses, you can specify /8 or any range between /16 through /32 (for IPv4) or /24, /32, /48, /56, /64, or /128 (for IPv6). For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. Contents IPSetDescriptors The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL is associated with an Amazon CloudFront distribution and the viewer did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip ﬁeld in the CloudFront access logs. Type: Array of IPSetDescriptor objects Required: Yes IPSetId The IPSetId for an IPSet. You use IPSetId to get information about an IPSet (see GetIPSet), update an IPSet (see UpdateIPSet), insert an IPSet into a Rule or delete one from a Rule (see UpdateRule), and delete an IPSet from AWS WAF (see DeleteIPSet). IPSet 1667 AWS WAFV2 API Reference IPSetId is returned by CreateIPSet and by ListIPSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes Name A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 IPSet 1668 AWS WAFV2 API Reference IPSetDescriptor Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. Speciﬁes the IP address type (IPV4 or IPV6) and the IP address range (in CIDR format) that web requests originate from. Contents Type Specify IPV4 or IPV6. Type: String Valid Values: IPV4 \| IPV6 Required: Yes Value Specify an IPv4 address by using CIDR
waf-apiref-346	waf-apiref.pdf	346	30, 2025. 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. Speciﬁes the IP address type (IPV4 or IPV6) and the IP address range (in CIDR format) that web requests originate from. Contents Type Specify IPV4 or IPV6. Type: String Valid Values: IPV4 \| IPV6 Required: Yes Value Specify an IPv4 address by using CIDR notation. For example: • To conﬁgure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32. • To conﬁgure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. Specify an IPv6 address by using CIDR notation. For example: IPSetDescriptor 1669 AWS WAFV2 API Reference • To conﬁgure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128. • To conﬁgure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ﬀﬀ:ﬀﬀ:ﬀﬀ:ﬀﬀ, specify 1111:0000:0000:0000:0000:0000:0000:0000/64. Type: String Length Constraints: Minimum length of 1. Maximum length of 50. Pattern: .\S. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 IPSetDescriptor 1670 AWS WAFV2 API Reference IPSetSummary Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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 identiﬁer and the name of the IPSet. Contents IPSetId The IPSetId for an IPSet. You can use IPSetId in a GetIPSet request to get detailed information about an IPSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes Name A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes IPSetSummary 1671 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 IPSetSummary 1672 AWS WAFV2 API Reference IPSetUpdate Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. Speciﬁes the type of update to perform to an IPSet with UpdateIPSet. Contents Action Speciﬁes whether to insert or delete an IP address with UpdateIPSet. Type: String Valid Values: INSERT \| DELETE Required: Yes IPSetDescriptor The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web requests originate from. Type: IPSetDescriptor object Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: IPSetUpdate 1673 AWS WAFV2 • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference IPSetUpdate 1674 AWS WAFV2 API Reference LoggingConﬁguration Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. The Amazon Data Firehose, RedactedFields information, and the web ACL Amazon Resource Name (ARN). Contents LogDestinationConﬁgs An array of Amazon Data Firehose ARNs. Type: Array of strings Array Members: Fixed number of 1 item. Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .\S. Required: Yes ResourceArn The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs. Type: String Length Constraints: Minimum length of 1. Maximum
waf-apiref-347	waf-apiref.pdf	347	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. The Amazon Data Firehose, RedactedFields information, and the web ACL Amazon Resource Name (ARN). Contents LogDestinationConﬁgs An array of Amazon Data Firehose ARNs. Type: Array of strings Array Members: Fixed number of 1 item. Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .\S. Required: Yes ResourceArn The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs. Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .\S. LoggingConﬁguration 1675 AWS WAFV2 Required: Yes RedactedFields API Reference The parts of the request that you want redacted from the logs. For example, if you redact the cookie ﬁeld, the cookie ﬁeld in the ﬁrehose will be xxx. Type: Array of FieldToMatch objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 LoggingConﬁguration 1676 AWS WAFV2 API Reference Predicate Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. Speciﬁes the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, and SizeConstraintSet objects that you want to add to a Rule and, 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. Contents DataId A unique identiﬁer for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes Negated Set Negated to False if you want AWS WAF to allow, block, or count requests based on the settings in the speciﬁed ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address. Predicate 1677 AWS WAFV2 API Reference Set Negated to True if 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 IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44. Type: Boolean Required: Yes Type The type of predicate in a Rule, such as ByteMatch or IPSet. Type: String Valid Values: IPMatch \| ByteMatch \| SqlInjectionMatch \| GeoMatch \| SizeConstraint \| XssMatch \| RegexMatch Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Predicate 1678 AWS WAFV2 API Reference RateBasedRule Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. A RateBasedRule is identical to a regular Rule, with one addition: a RateBasedRule counts the number of requests that arrive from a speciﬁed IP address every ﬁve minutes. For example, based on recent requests that you've seen from an attacker, you might create a RateBasedRule that includes the following conditions: • The requests come from 192.0.2.44. • They contain the value BadBot in the User-Agent header. In the rule, you also deﬁne the rate limit as 1,000. Requests that meet both of these conditions and exceed 1,000 requests every ﬁve minutes trigger the rule's action (block or count), which is deﬁned in the web ACL. Contents MetricName 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 RateBasedRule. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. RateBasedRule 1679 AWS WAFV2 Pattern: .\S. Required: Yes Name API
waf-apiref-348	waf-apiref.pdf	348	1,000 requests every ﬁve minutes trigger the rule's action (block or count), which is deﬁned in the web ACL. Contents MetricName 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 RateBasedRule. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. RateBasedRule 1679 AWS WAFV2 Pattern: .\S. Required: Yes Name API Reference A friendly name or description for a RateBasedRule. You can't change the name of a RateBasedRule after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes RateKey The ﬁeld 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 RateKey is IP. IP indicates that requests arriving from the same IP address are subject to the RateLimit that is speciﬁed in the RateBasedRule. Type: String Valid Values: IP Required: Yes RateLimit The maximum number of requests, which have an identical value in the ﬁeld speciﬁed by the RateKey, allowed in a ﬁve-minute period. If the number of requests exceeds the RateLimit and the other predicates speciﬁed in the rule are also met, AWS WAF triggers the action that is speciﬁed for this rule. Type: Long Valid Range: Minimum value of 100. Maximum value of 2000000000. Required: Yes RateBasedRule 1680 AWS WAFV2 RuleId API Reference A unique identiﬁer for a RateBasedRule. You use RuleId to get more information about a RateBasedRule (see GetRateBasedRule), update a RateBasedRule (see UpdateRateBasedRule), insert a RateBasedRule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RateBasedRule from AWS WAF (see DeleteRateBasedRule). Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes MatchPredicates The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a RateBasedRule. Type: Array of Predicate objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RateBasedRule 1681 AWS WAFV2 API Reference RegexMatchSet Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. In a GetRegexMatchSet request, RegexMatchSet is a complex type that contains the RegexMatchSetId and Name of a RegexMatchSet, and the values that you speciﬁed when you updated the RegexMatchSet. The values are contained in a RegexMatchTuple object, which specify the parts of web requests that you want AWS WAF to inspect and the values that you want AWS WAF to search for. If a RegexMatchSet contains more than one RegexMatchTuple object, a request needs to match the settings in only one ByteMatchTuple to be considered a match. Contents Name A friendly name or description of the RegexMatchSet. You can't change Name after you create a RegexMatchSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No RegexMatchSetId The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get information about a RegexMatchSet (see GetRegexMatchSet), update a RegexMatchSet (see RegexMatchSet 1682 AWS WAFV2 API Reference UpdateRegexMatchSet), insert a RegexMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a RegexMatchSet from AWS WAF (see DeleteRegexMatchSet). RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No RegexMatchTuples Contains an array of RegexMatchTuple objects. Each RegexMatchTuple object contains: • The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header. • The identiﬁer of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet. • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the speciﬁed string. Type: Array of RegexMatchTuple objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RegexMatchSet 1683 AWS WAFV2
waf-apiref-349	waf-apiref.pdf	349	query string or the value of the User-Agent header. • The identiﬁer of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet. • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the speciﬁed string. Type: Array of RegexMatchTuple objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RegexMatchSet 1683 AWS WAFV2 API Reference RegexMatchSetSummary Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. Returned by ListRegexMatchSets. Each RegexMatchSetSummary object includes the Name and RegexMatchSetId for one RegexMatchSet. Contents Name A friendly name or description of the RegexMatchSet. You can't change Name after you create a RegexMatchSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes RegexMatchSetId The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get information about a RegexMatchSet, update a RegexMatchSet, remove a RegexMatchSet from a Rule, and delete a RegexMatchSet from AWS WAF. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets. Type: String RegexMatchSetSummary 1684 AWS WAFV2 API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RegexMatchSetSummary 1685 AWS WAFV2 API Reference RegexMatchSetUpdate Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. In an UpdateRegexMatchSet request, RegexMatchSetUpdate speciﬁes whether to insert or delete a RegexMatchTuple and includes the settings for the RegexMatchTuple. Contents Action Speciﬁes whether to insert or delete a RegexMatchTuple. Type: String Valid Values: INSERT \| DELETE Required: Yes RegexMatchTuple Information about the part of a web request that you want AWS WAF to inspect and the identiﬁer of the regular expression (regex) pattern that you want AWS WAF to search for. If you specify DELETE for the value of Action, the RegexMatchTuple values must exactly match the values in the RegexMatchTuple that you want to delete from the RegexMatchSet. Type: RegexMatchTuple object Required: Yes RegexMatchSetUpdate 1686 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RegexMatchSetUpdate 1687 AWS WAFV2 API Reference RegexMatchTuple Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. The regular expression pattern that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings. Each RegexMatchTuple object contains: • The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header. • The identiﬁer of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet. • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the speciﬁed string. Contents FieldToMatch Speciﬁes where in a web request to look for the RegexPatternSet. Type: FieldToMatch object Required: Yes RegexPatternSetId The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet (see GetRegexPatternSet), update a RegexPatternSet (see UpdateRegexPatternSet), insert a RegexPatternSet into a RegexMatchTuple 1688 AWS WAFV2 API Reference RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet). RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
waf-apiref-350	waf-apiref.pdf	350	RegexPatternSet. • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the speciﬁed string. Contents FieldToMatch Speciﬁes where in a web request to look for the RegexPatternSet. Type: FieldToMatch object Required: Yes RegexPatternSetId The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet (see GetRegexPatternSet), update a RegexPatternSet (see UpdateRegexPatternSet), insert a RegexPatternSet into a RegexMatchTuple 1688 AWS WAFV2 API Reference RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet). RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes TextTransformation Text transformations eliminate some of the unusual formatting that attackers use in web requests in an eﬀort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on RegexPatternSet before inspecting a request for a match. You can only specify a single type of TextTransformation. CMD_LINE When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: • Delete the following characters: \ " ' ^ • Delete spaces before the following characters: / ( • Replace the following characters with a space: , ; • Replace multiple spaces with one space • Convert uppercase letters (A-Z) to lowercase (a-z) COMPRESS_WHITE_SPACE Use this option to replace the following characters with a space character (decimal 32): • \f, formfeed, decimal 12 • \t, tab, decimal 9 • \n, newline, decimal 10 • \r, carriage return, decimal 13 • \v, vertical tab, decimal 11 RegexMatchTuple 1689 AWS WAFV2 API Reference • non-breaking space, decimal 160 COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: • Replaces (ampersand)quot; with " • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 • Replaces (ampersand)lt; with a "less than" symbol • Replaces (ampersand)gt; with > • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this option to decode a URL-encoded value. NONE Specify NONE if you don't want to perform any text transformations. Type: String Valid Values: NONE \| COMPRESS_WHITE_SPACE \| HTML_ENTITY_DECODE \| LOWERCASE \| CMD_LINE \| URL_DECODE Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: RegexMatchTuple 1690 AWS WAFV2 • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference RegexMatchTuple 1691 AWS WAFV2 API Reference RegexPatternSet Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. The RegexPatternSet speciﬁes the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. You can then conﬁgure AWS WAF to reject those requests. Contents RegexPatternSetId The identiﬁer for the RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet, update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF. RegexMatchSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes RegexPatternStrings Speciﬁes the regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t. Type: Array of strings Array Members: Maximum number of 10 items. RegexPatternSet 1692 AWS WAFV2 API Reference Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: .* Required: Yes Name A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RegexPatternSet 1693 AWS WAFV2 API Reference RegexPatternSetSummary Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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
waf-apiref-351	waf-apiref.pdf	351	length of 1. Maximum length of 128. Pattern: .\S. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RegexPatternSet 1693 AWS WAFV2 API Reference RegexPatternSetSummary Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. Returned by ListRegexPatternSets. Each RegexPatternSetSummary object includes the Name and RegexPatternSetId for one RegexPatternSet. Contents Name A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes RegexPatternSetId The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet, update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets. Type: String RegexPatternSetSummary 1694 AWS WAFV2 API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RegexPatternSetSummary 1695 AWS WAFV2 API Reference RegexPatternSetUpdate Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. In an UpdateRegexPatternSet request, RegexPatternSetUpdate speciﬁes whether to insert or delete a RegexPatternString and includes the settings for the RegexPatternString. Contents Action Speciﬁes whether to insert or delete a RegexPatternString. Type: String Valid Values: INSERT \| DELETE Required: Yes RegexPatternString Speciﬁes the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Pattern: .* Required: Yes RegexPatternSetUpdate 1696 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RegexPatternSetUpdate 1697 AWS WAFV2 API Reference Rule Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. A combination of ByteMatchSet, IPSet, and/or SqlInjectionMatchSet objects that identify the web requests that you want to allow, block, or count. For example, you might create a Rule that includes the following predicates: • An IPSet that causes AWS WAF to search for web requests that originate from the IP address 192.0.2.44 • A ByteMatchSet that causes AWS WAF to search for web requests for which the value of the User-Agent header is BadBot. To match the settings in this Rule, a request must originate from 192.0.2.44 AND include a User-Agent header for which the value is BadBot. Contents Predicates The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule. Type: Array of Predicate objects Required: Yes Rule 1698 AWS WAFV2 RuleId API Reference A unique identiﬁer 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 a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule). RuleId is returned by CreateRule and by ListRules. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes MetricName A friendly name or description for the metrics for this Rule. 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 MetricName after you create the Rule.
waf-apiref-352	waf-apiref.pdf	352	Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule). RuleId is returned by CreateRule and by ListRules. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes MetricName A friendly name or description for the metrics for this Rule. 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 MetricName after you create the Rule. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No Name The friendly name or description for the Rule. You can't change the name of a Rule after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No Rule 1699 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Rule 1700 AWS WAFV2 API Reference RuleGroup Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. A collection of predeﬁned rules that you can add to a web ACL. Rule groups are subject to the following limits: • Three rule groups per account. You can request an increase to this limit by contacting customer support. • One rule group per web ACL. • Ten rules per rule group. Contents RuleGroupId A unique identiﬁer for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup). RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. RuleGroup 1701 AWS WAFV2 Required: Yes MetricName API Reference A friendly name or description for the metrics for this RuleGroup. 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 RuleGroup. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No Name The friendly name or description for the RuleGroup. You can't change the name of a RuleGroup after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RuleGroup 1702 AWS WAFV2 API Reference RuleGroupSummary Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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 identiﬁer and the friendly name or description of the RuleGroup. Contents Name A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes RuleGroupId A unique identiﬁer for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup). RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. RuleGroupSummary 1703 AWS WAFV2 Pattern: .\S. Required: Yes See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RuleGroupSummary 1704 AWS WAFV2 API Reference RuleGroupUpdate Service: AWS WAF
waf-apiref-353	waf-apiref.pdf	353	UpdateRuleGroup), insert a RuleGroup into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup). RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. RuleGroupSummary 1703 AWS WAFV2 Pattern: .\S. Required: Yes See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RuleGroupSummary 1704 AWS WAFV2 API Reference RuleGroupUpdate Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. Speciﬁes an ActivatedRule and indicates whether you want to add it to a RuleGroup or delete it from a RuleGroup. Contents Action Specify INSERT to add an ActivatedRule to a RuleGroup. Use DELETE to remove an ActivatedRule from a RuleGroup. Type: String Valid Values: INSERT \| DELETE Required: Yes ActivatedRule The ActivatedRule object speciﬁes a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT). Type: ActivatedRule object Required: Yes RuleGroupUpdate 1705 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RuleGroupUpdate 1706 AWS WAFV2 API Reference RuleSummary Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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 identiﬁer and the friendly name or description of the Rule. Contents Name A friendly name or description of the Rule. You can't change the name of a Rule after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes RuleId A unique identiﬁer 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. RuleSummary 1707 AWS WAFV2 Pattern: .\S. Required: Yes See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 RuleSummary 1708 AWS WAFV2 API Reference RuleUpdate Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. Speciﬁes a Predicate (such as an IPSet) and indicates whether you want to add it to a Rule or delete it from a Rule. Contents Action Specify INSERT to add a Predicate to a Rule. Use DELETE to remove a Predicate from a Rule. Type: String Valid Values: INSERT \| DELETE Required: Yes Predicate The ID of the Predicate (such as an IPSet) that you want to add to a Rule. Type: Predicate object Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: RuleUpdate 1709 AWS WAFV2 • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference RuleUpdate 1710 AWS WAFV2 API Reference SampledHTTPRequest Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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
waf-apiref-354	waf-apiref.pdf	354	Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: RuleUpdate 1709 AWS WAFV2 • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference RuleUpdate 1710 AWS WAFV2 API Reference SampledHTTPRequest Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. The response from a GetSampledRequests request includes a SampledHTTPRequests complex type that appears as SampledRequests in the response syntax. SampledHTTPRequests contains one SampledHTTPRequest object for each web request that is returned by GetSampledRequests. Contents Request A complex type that contains detailed information about the request. Type: HTTPRequest object Required: Yes Weight A value that indicates how one result in the response relates proportionally to other results in the response. A result that has a weight of 2 represents roughly twice as many Amazon CloudFront web requests as a result that has a weight of 1. Type: Long Valid Range: Minimum value of 0. Required: Yes Action The action for the Rule that the request matched: ALLOW, BLOCK, or COUNT. SampledHTTPRequest 1711 AWS WAFV2 Type: String Required: No RuleWithinRuleGroup API Reference This value is returned if the GetSampledRequests request speciﬁes the ID of a RuleGroup rather than the ID of an individual rule. RuleWithinRuleGroup is the rule within the speciﬁed RuleGroup that matched the request listed in the response. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No Timestamp The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds). Type: Timestamp Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SampledHTTPRequest 1712 AWS WAFV2 API Reference SizeConstraint Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. Speciﬁes a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match. Contents ComparisonOperator The type of comparison you want AWS WAF to perform. AWS WAF uses this in combination with the provided Size and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match. EQ: Used to test if the Size is equal to the size of the FieldToMatch NE: Used to test if the Size is not equal to the size of the FieldToMatch LE: Used to test if the Size is less than or equal to the size of the FieldToMatch LT: Used to test if the Size is strictly less than the size of the FieldToMatch GE: Used to test if the Size is greater than or equal to the size of the FieldToMatch GT: Used to test if the Size is strictly greater than the size of the FieldToMatch Type: String SizeConstraint 1713 AWS WAFV2 API Reference Valid Values: EQ \| NE \| LE \| LT \| GE \| GT Required: Yes FieldToMatch Speciﬁes where in a web request to look for the size constraint. Type: FieldToMatch object Required: Yes Size The size in bytes that you want AWS WAF to compare against the size of the speciﬁed FieldToMatch. AWS WAF uses this in combination with ComparisonOperator and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match. Valid values for size are 0 - 21474836480 bytes (0 - 20 GB). If you specify URI for the value of Type, the / in the URI path that you specify counts as one character. For example, the URI /logo.jpg is nine characters long. Type: Long Valid Range: Minimum value of 0. Maximum value of 21474836480. Required: Yes TextTransformation Text transformations eliminate some of the unusual formatting that attackers
waf-apiref-355	waf-apiref.pdf	355	combination with ComparisonOperator and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match. Valid values for size are 0 - 21474836480 bytes (0 - 20 GB). If you specify URI for the value of Type, the / in the URI path that you specify counts as one character. For example, the URI /logo.jpg is nine characters long. Type: Long Valid Range: Minimum value of 0. Maximum value of 21474836480. Required: Yes TextTransformation Text transformations eliminate some of the unusual formatting that attackers use in web requests in an eﬀort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting it for a match. You can only specify a single type of TextTransformation. Note that if you choose BODY for the value of Type, you must choose NONE for TextTransformation because Amazon CloudFront forwards only the ﬁrst 8192 bytes for inspection. NONE SizeConstraint 1714 AWS WAFV2 API Reference Specify NONE if you don't want to perform any text transformations. CMD_LINE When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: • Delete the following characters: \ " ' ^ • Delete spaces before the following characters: / ( • Replace the following characters with a space: , ; • Replace multiple spaces with one space • Convert uppercase letters (A-Z) to lowercase (a-z) COMPRESS_WHITE_SPACE Use this option to replace the following characters with a space character (decimal 32): • \f, formfeed, decimal 12 • \t, tab, decimal 9 • \n, newline, decimal 10 • \r, carriage return, decimal 13 • \v, vertical tab, decimal 11 • non-breaking space, decimal 160 COMPRESS_WHITE_SPACE also replaces multiple spaces with one space. HTML_ENTITY_DECODE Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations: • Replaces (ampersand)quot; with " • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 • Replaces (ampersand)lt; with a "less than" symbol • Replaces (ampersand)gt; with > • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters SizeConstraint 1715 AWS WAFV2 API Reference • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters LOWERCASE Use this option to convert uppercase letters (A-Z) to lowercase (a-z). URL_DECODE Use this option to decode a URL-encoded value. Type: String Valid Values: NONE \| COMPRESS_WHITE_SPACE \| HTML_ENTITY_DECODE \| LOWERCASE \| CMD_LINE \| URL_DECODE Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SizeConstraint 1716 AWS WAFV2 API Reference SizeConstraintSet Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. A complex type that contains SizeConstraint objects, which specify the parts of web requests that you want AWS WAF to inspect the size of. If a SizeConstraintSet contains more than one SizeConstraint object, a request only needs to match one constraint to be considered a match. Contents SizeConstraints Speciﬁes the parts of web requests that you want to inspect the size of. Type: Array of SizeConstraint objects Required: Yes SizeConstraintSetId A unique identiﬁer for a SizeConstraintSet. You use SizeConstraintSetId to get information about a SizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet). SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. SizeConstraintSet 1717 API Reference AWS WAFV2 Pattern: .\S. Required: Yes Name The name, if any, of the SizeConstraintSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SizeConstraintSet 1718 AWS WAFV2 API Reference SizeConstraintSetSummary Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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
waf-apiref-356	waf-apiref.pdf	356	Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SizeConstraintSet 1718 AWS WAFV2 API Reference SizeConstraintSetSummary Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. The Id and Name of a SizeConstraintSet. Contents Name The name of the SizeConstraintSet, if any. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes SizeConstraintSetId A unique identiﬁer for a SizeConstraintSet. You use SizeConstraintSetId to get information about a SizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet). SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. SizeConstraintSetSummary 1719 AWS WAFV2 Pattern: .\S. Required: Yes See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SizeConstraintSetSummary 1720 AWS WAFV2 API Reference SizeConstraintSetUpdate Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. Speciﬁes the part of a web request that you want to inspect the size of and indicates whether you want to add the speciﬁcation to a SizeConstraintSet or delete it from a SizeConstraintSet. Contents Action Specify INSERT to add a SizeConstraintSetUpdate to a SizeConstraintSet. Use DELETE to remove a SizeConstraintSetUpdate from a SizeConstraintSet. Type: String Valid Values: INSERT \| DELETE Required: Yes SizeConstraint Speciﬁes a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match. Type: SizeConstraint object Required: Yes SizeConstraintSetUpdate 1721 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SizeConstraintSetUpdate 1722 AWS WAFV2 API Reference SqlInjectionMatchSet Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. A complex type that contains SqlInjectionMatchTuple objects, which specify the parts of web requests that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. If a SqlInjectionMatchSet contains more than one SqlInjectionMatchTuple object, a request needs to include snippets of SQL code in only one of the speciﬁed parts of the request to be considered a match. Contents SqlInjectionMatchSetId A unique identiﬁer for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet). SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes SqlInjectionMatchSet 1723 AWS WAFV2 SqlInjectionMatchTuples API Reference Speciﬁes the parts of web requests that you want to inspect for snippets of malicious SQL code. Type: Array of SqlInjectionMatchTuple objects Required: Yes Name The name, if any, of the SqlInjectionMatchSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the
waf-apiref-357	waf-apiref.pdf	357	WAF (see DeleteSqlInjectionMatchSet). SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes SqlInjectionMatchSet 1723 AWS WAFV2 SqlInjectionMatchTuples API Reference Speciﬁes the parts of web requests that you want to inspect for snippets of malicious SQL code. Type: Array of SqlInjectionMatchTuple objects Required: Yes Name The name, if any, of the SqlInjectionMatchSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SqlInjectionMatchSet 1724 AWS WAFV2 API Reference SqlInjectionMatchSetSummary Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. The Id and Name of a SqlInjectionMatchSet. Contents Name The name of the SqlInjectionMatchSet, if any, speciﬁed by Id. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes SqlInjectionMatchSetId A unique identiﬁer for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet). SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets. Type: String SqlInjectionMatchSetSummary 1725 AWS WAFV2 API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .\S. Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SqlInjectionMatchSetSummary 1726 AWS WAFV2 API Reference SqlInjectionMatchSetUpdate Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. Speciﬁes the part of a web request that you want to inspect for snippets of malicious SQL code and indicates whether you want to add the speciﬁcation to a SqlInjectionMatchSet or delete it from a SqlInjectionMatchSet. Contents Action Specify INSERT to add a SqlInjectionMatchSetUpdate to a SqlInjectionMatchSet. Use DELETE to remove a SqlInjectionMatchSetUpdate from a SqlInjectionMatchSet. Type: String Valid Values: INSERT \| DELETE Required: Yes SqlInjectionMatchTuple Speciﬁes the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. Type: SqlInjectionMatchTuple object Required: Yes SqlInjectionMatchSetUpdate 1727 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SqlInjectionMatchSetUpdate 1728 AWS WAFV2 API Reference SqlInjectionMatchTuple Service: AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. 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. Speciﬁes the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header. Contents FieldToMatch Speciﬁes where in a web request to look for snippets of malicious SQL code. Type: FieldToMatch object Required: Yes TextTransformation Text transformations eliminate some of the unusual formatting that attackers use in web requests in an eﬀort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting it for a match. You can only specify a single type of TextTransformation. CMD_LINE When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: • Delete the following characters: \ " ' ^ SqlInjectionMatchTuple 1729 AWS WAFV2 API Reference • Delete

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.