CaptchaAction
Specifies 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 configured and then allows the web request inspection to proceed to the next rule, similar to aCountAction
. -
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 ofcaptcha
. -
The HTTP status code
405 Method Not Allowed
. -
If the request contains an
Accept
header with a value oftext/html
, the response includes aCAPTCHA
JavaScript page interstitial.
-
You can configure 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
-
Defines 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: