GetWebACL
Retrieves the specified WebACL.
Request Syntax
{
"Id": "string",
"Name": "string",
"Scope": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Id
-
The unique identifier 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}$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
- Scope
-
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, or an AWS Verified Access instance.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
-
CLI - Specify the Region when you use the CloudFront scope:
--scope=CLOUDFRONT --region=us-east-1. -
API and SDKs - For all calls, use the Region endpoint us-east-1.
Type: String
Valid Values:
CLOUDFRONT | REGIONALRequired: Yes
-
Response Syntax
{
"ApplicationIntegrationURL": "string",
"LockToken": "string",
"WebACL": {
"ARN": "string",
"AssociationConfig": {
"RequestBody": {
"string" : {
"DefaultSizeInspectionLimit": "string"
}
}
},
"Capacity": number,
"CaptchaConfig": {
"ImmunityTimeProperty": {
"ImmunityTime": number
}
},
"ChallengeConfig": {
"ImmunityTimeProperty": {
"ImmunityTime": number
}
},
"CustomResponseBodies": {
"string" : {
"Content": "string",
"ContentType": "string"
}
},
"DefaultAction": {
"Allow": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Block": {
"CustomResponse": {
"CustomResponseBodyKey": "string",
"ResponseCode": number,
"ResponseHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
}
},
"Description": "string",
"Id": "string",
"LabelNamespace": "string",
"ManagedByFirewallManager": boolean,
"Name": "string",
"PostProcessFirewallManagerRuleGroups": [
{
"FirewallManagerStatement": {
"ManagedRuleGroupStatement": {
"ExcludedRules": [
{
"Name": "string"
}
],
"ManagedRuleGroupConfigs": [
{
"AWSManagedRulesACFPRuleSet": {
"CreationPath": "string",
"EnableRegexInPath": boolean,
"RegistrationPagePath": "string",
"RequestInspection": {
"AddressFields": [
{
"Identifier": "string"
}
],
"EmailField": {
"Identifier": "string"
},
"PasswordField": {
"Identifier": "string"
},
"PayloadType": "string",
"PhoneNumberFields": [
{
"Identifier": "string"
}
],
"UsernameField": {
"Identifier": "string"
}
},
"ResponseInspection": {
"BodyContains": {
"FailureStrings": [ "string" ],
"SuccessStrings": [ "string" ]
},
"Header": {
"FailureValues": [ "string" ],
"Name": "string",
"SuccessValues": [ "string" ]
},
"Json": {
"FailureValues": [ "string" ],
"Identifier": "string",
"SuccessValues": [ "string" ]
},
"StatusCode": {
"FailureCodes": [ number ],
"SuccessCodes": [ number ]
}
}
},
"AWSManagedRulesATPRuleSet": {
"EnableRegexInPath": boolean,
"LoginPath": "string",
"RequestInspection": {
"PasswordField": {
"Identifier": "string"
},
"PayloadType": "string",
"UsernameField": {
"Identifier": "string"
}
},
"ResponseInspection": {
"BodyContains": {
"FailureStrings": [ "string" ],
"SuccessStrings": [ "string" ]
},
"Header": {
"FailureValues": [ "string" ],
"Name": "string",
"SuccessValues": [ "string" ]
},
"Json": {
"FailureValues": [ "string" ],
"Identifier": "string",
"SuccessValues": [ "string" ]
},
"StatusCode": {
"FailureCodes": [ number ],
"SuccessCodes": [ number ]
}
}
},
"AWSManagedRulesBotControlRuleSet": {
"EnableMachineLearning": boolean,
"InspectionLevel": "string"
},
"LoginPath": "string",
"PasswordField": {
"Identifier": "string"
},
"PayloadType": "string",
"UsernameField": {
"Identifier": "string"
}
}
],
"Name": "string",
"RuleActionOverrides": [
{
"ActionToUse": {
"Allow": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Block": {
"CustomResponse": {
"CustomResponseBodyKey": "string",
"ResponseCode": number,
"ResponseHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Captcha": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Challenge": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Count": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
}
},
"Name": "string"
}
],
"ScopeDownStatement": {
"AndStatement": {
"Statements": [
"Statement"
]
},
"ByteMatchStatement": {
"FieldToMatch": {
"AllQueryArguments": {
},
"Body": {
"OversizeHandling": "string"
},
"Cookies": {
"MatchPattern": {
"All": {
},
"ExcludedCookies": [ "string" ],
"IncludedCookies": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"HeaderOrder": {
"OversizeHandling": "string"
},
"Headers": {
"MatchPattern": {
"All": {
},
"ExcludedHeaders": [ "string" ],
"IncludedHeaders": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"JA3Fingerprint": {
"FallbackBehavior": "string"
},
"JsonBody": {
"InvalidFallbackBehavior": "string",
"MatchPattern": {
"All": {
},
"IncludedPaths": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"Method": {
},
"QueryString": {
},
"SingleHeader": {
"Name": "string"
},
"SingleQueryArgument": {
"Name": "string"
},
"UriPath": {
}
},
"PositionalConstraint": "string",
"SearchString": blob,
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"GeoMatchStatement": {
"CountryCodes": [ "string" ],
"ForwardedIPConfig": {
"FallbackBehavior": "string",
"HeaderName": "string"
}
},
"IPSetReferenceStatement": {
"ARN": "string",
"IPSetForwardedIPConfig": {
"FallbackBehavior": "string",
"HeaderName": "string",
"Position": "string"
}
},
"LabelMatchStatement": {
"Key": "string",
"Scope": "string"
},
"ManagedRuleGroupStatement": "ManagedRuleGroupStatement",
"NotStatement": {
"Statement": "Statement"
},
"OrStatement": {
"Statements": [
"Statement"
]
},
"RateBasedStatement": {
"AggregateKeyType": "string",
"CustomKeys": [
{
"Cookie": {
"Name": "string",
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"ForwardedIP": {
},
"Header": {
"Name": "string",
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"HTTPMethod": {
},
"IP": {
},
"LabelNamespace": {
"Namespace": "string"
},
"QueryArgument": {
"Name": "string",
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"QueryString": {
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"UriPath": {
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
}
}
],
"EvaluationWindowSec": number,
"ForwardedIPConfig": {
"FallbackBehavior": "string",
"HeaderName": "string"
},
"Limit": number,
"ScopeDownStatement": "Statement"
},
"RegexMatchStatement": {
"FieldToMatch": {
"AllQueryArguments": {
},
"Body": {
"OversizeHandling": "string"
},
"Cookies": {
"MatchPattern": {
"All": {
},
"ExcludedCookies": [ "string" ],
"IncludedCookies": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"HeaderOrder": {
"OversizeHandling": "string"
},
"Headers": {
"MatchPattern": {
"All": {
},
"ExcludedHeaders": [ "string" ],
"IncludedHeaders": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"JA3Fingerprint": {
"FallbackBehavior": "string"
},
"JsonBody": {
"InvalidFallbackBehavior": "string",
"MatchPattern": {
"All": {
},
"IncludedPaths": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"Method": {
},
"QueryString": {
},
"SingleHeader": {
"Name": "string"
},
"SingleQueryArgument": {
"Name": "string"
},
"UriPath": {
}
},
"RegexString": "string",
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"RegexPatternSetReferenceStatement": {
"ARN": "string",
"FieldToMatch": {
"AllQueryArguments": {
},
"Body": {
"OversizeHandling": "string"
},
"Cookies": {
"MatchPattern": {
"All": {
},
"ExcludedCookies": [ "string" ],
"IncludedCookies": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"HeaderOrder": {
"OversizeHandling": "string"
},
"Headers": {
"MatchPattern": {
"All": {
},
"ExcludedHeaders": [ "string" ],
"IncludedHeaders": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"JA3Fingerprint": {
"FallbackBehavior": "string"
},
"JsonBody": {
"InvalidFallbackBehavior": "string",
"MatchPattern": {
"All": {
},
"IncludedPaths": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"Method": {
},
"QueryString": {
},
"SingleHeader": {
"Name": "string"
},
"SingleQueryArgument": {
"Name": "string"
},
"UriPath": {
}
},
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"RuleGroupReferenceStatement": {
"ARN": "string",
"ExcludedRules": [
{
"Name": "string"
}
],
"RuleActionOverrides": [
{
"ActionToUse": {
"Allow": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Block": {
"CustomResponse": {
"CustomResponseBodyKey": "string",
"ResponseCode": number,
"ResponseHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Captcha": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Challenge": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Count": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
}
},
"Name": "string"
}
]
},
"SizeConstraintStatement": {
"ComparisonOperator": "string",
"FieldToMatch": {
"AllQueryArguments": {
},
"Body": {
"OversizeHandling": "string"
},
"Cookies": {
"MatchPattern": {
"All": {
},
"ExcludedCookies": [ "string" ],
"IncludedCookies": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"HeaderOrder": {
"OversizeHandling": "string"
},
"Headers": {
"MatchPattern": {
"All": {
},
"ExcludedHeaders": [ "string" ],
"IncludedHeaders": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"JA3Fingerprint": {
"FallbackBehavior": "string"
},
"JsonBody": {
"InvalidFallbackBehavior": "string",
"MatchPattern": {
"All": {
},
"IncludedPaths": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"Method": {
},
"QueryString": {
},
"SingleHeader": {
"Name": "string"
},
"SingleQueryArgument": {
"Name": "string"
},
"UriPath": {
}
},
"Size": number,
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"SqliMatchStatement": {
"FieldToMatch": {
"AllQueryArguments": {
},
"Body": {
"OversizeHandling": "string"
},
"Cookies": {
"MatchPattern": {
"All": {
},
"ExcludedCookies": [ "string" ],
"IncludedCookies": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"HeaderOrder": {
"OversizeHandling": "string"
},
"Headers": {
"MatchPattern": {
"All": {
},
"ExcludedHeaders": [ "string" ],
"IncludedHeaders": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"JA3Fingerprint": {
"FallbackBehavior": "string"
},
"JsonBody": {
"InvalidFallbackBehavior": "string",
"MatchPattern": {
"All": {
},
"IncludedPaths": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"Method": {
},
"QueryString": {
},
"SingleHeader": {
"Name": "string"
},
"SingleQueryArgument": {
"Name": "string"
},
"UriPath": {
}
},
"SensitivityLevel": "string",
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"XssMatchStatement": {
"FieldToMatch": {
"AllQueryArguments": {
},
"Body": {
"OversizeHandling": "string"
},
"Cookies": {
"MatchPattern": {
"All": {
},
"ExcludedCookies": [ "string" ],
"IncludedCookies": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"HeaderOrder": {
"OversizeHandling": "string"
},
"Headers": {
"MatchPattern": {
"All": {
},
"ExcludedHeaders": [ "string" ],
"IncludedHeaders": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"JA3Fingerprint": {
"FallbackBehavior": "string"
},
"JsonBody": {
"InvalidFallbackBehavior": "string",
"MatchPattern": {
"All": {
},
"IncludedPaths": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"Method": {
},
"QueryString": {
},
"SingleHeader": {
"Name": "string"
},
"SingleQueryArgument": {
"Name": "string"
},
"UriPath": {
}
},
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
}
},
"VendorName": "string",
"Version": "string"
},
"RuleGroupReferenceStatement": {
"ARN": "string",
"ExcludedRules": [
{
"Name": "string"
}
],
"RuleActionOverrides": [
{
"ActionToUse": {
"Allow": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Block": {
"CustomResponse": {
"CustomResponseBodyKey": "string",
"ResponseCode": number,
"ResponseHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Captcha": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Challenge": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Count": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
}
},
"Name": "string"
}
]
}
},
"Name": "string",
"OverrideAction": {
"Count": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"None": {
}
},
"Priority": number,
"VisibilityConfig": {
"CloudWatchMetricsEnabled": boolean,
"MetricName": "string",
"SampledRequestsEnabled": boolean
}
}
],
"PreProcessFirewallManagerRuleGroups": [
{
"FirewallManagerStatement": {
"ManagedRuleGroupStatement": {
"ExcludedRules": [
{
"Name": "string"
}
],
"ManagedRuleGroupConfigs": [
{
"AWSManagedRulesACFPRuleSet": {
"CreationPath": "string",
"EnableRegexInPath": boolean,
"RegistrationPagePath": "string",
"RequestInspection": {
"AddressFields": [
{
"Identifier": "string"
}
],
"EmailField": {
"Identifier": "string"
},
"PasswordField": {
"Identifier": "string"
},
"PayloadType": "string",
"PhoneNumberFields": [
{
"Identifier": "string"
}
],
"UsernameField": {
"Identifier": "string"
}
},
"ResponseInspection": {
"BodyContains": {
"FailureStrings": [ "string" ],
"SuccessStrings": [ "string" ]
},
"Header": {
"FailureValues": [ "string" ],
"Name": "string",
"SuccessValues": [ "string" ]
},
"Json": {
"FailureValues": [ "string" ],
"Identifier": "string",
"SuccessValues": [ "string" ]
},
"StatusCode": {
"FailureCodes": [ number ],
"SuccessCodes": [ number ]
}
}
},
"AWSManagedRulesATPRuleSet": {
"EnableRegexInPath": boolean,
"LoginPath": "string",
"RequestInspection": {
"PasswordField": {
"Identifier": "string"
},
"PayloadType": "string",
"UsernameField": {
"Identifier": "string"
}
},
"ResponseInspection": {
"BodyContains": {
"FailureStrings": [ "string" ],
"SuccessStrings": [ "string" ]
},
"Header": {
"FailureValues": [ "string" ],
"Name": "string",
"SuccessValues": [ "string" ]
},
"Json": {
"FailureValues": [ "string" ],
"Identifier": "string",
"SuccessValues": [ "string" ]
},
"StatusCode": {
"FailureCodes": [ number ],
"SuccessCodes": [ number ]
}
}
},
"AWSManagedRulesBotControlRuleSet": {
"EnableMachineLearning": boolean,
"InspectionLevel": "string"
},
"LoginPath": "string",
"PasswordField": {
"Identifier": "string"
},
"PayloadType": "string",
"UsernameField": {
"Identifier": "string"
}
}
],
"Name": "string",
"RuleActionOverrides": [
{
"ActionToUse": {
"Allow": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Block": {
"CustomResponse": {
"CustomResponseBodyKey": "string",
"ResponseCode": number,
"ResponseHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Captcha": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Challenge": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Count": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
}
},
"Name": "string"
}
],
"ScopeDownStatement": {
"AndStatement": {
"Statements": [
"Statement"
]
},
"ByteMatchStatement": {
"FieldToMatch": {
"AllQueryArguments": {
},
"Body": {
"OversizeHandling": "string"
},
"Cookies": {
"MatchPattern": {
"All": {
},
"ExcludedCookies": [ "string" ],
"IncludedCookies": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"HeaderOrder": {
"OversizeHandling": "string"
},
"Headers": {
"MatchPattern": {
"All": {
},
"ExcludedHeaders": [ "string" ],
"IncludedHeaders": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"JA3Fingerprint": {
"FallbackBehavior": "string"
},
"JsonBody": {
"InvalidFallbackBehavior": "string",
"MatchPattern": {
"All": {
},
"IncludedPaths": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"Method": {
},
"QueryString": {
},
"SingleHeader": {
"Name": "string"
},
"SingleQueryArgument": {
"Name": "string"
},
"UriPath": {
}
},
"PositionalConstraint": "string",
"SearchString": blob,
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"GeoMatchStatement": {
"CountryCodes": [ "string" ],
"ForwardedIPConfig": {
"FallbackBehavior": "string",
"HeaderName": "string"
}
},
"IPSetReferenceStatement": {
"ARN": "string",
"IPSetForwardedIPConfig": {
"FallbackBehavior": "string",
"HeaderName": "string",
"Position": "string"
}
},
"LabelMatchStatement": {
"Key": "string",
"Scope": "string"
},
"ManagedRuleGroupStatement": "ManagedRuleGroupStatement",
"NotStatement": {
"Statement": "Statement"
},
"OrStatement": {
"Statements": [
"Statement"
]
},
"RateBasedStatement": {
"AggregateKeyType": "string",
"CustomKeys": [
{
"Cookie": {
"Name": "string",
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"ForwardedIP": {
},
"Header": {
"Name": "string",
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"HTTPMethod": {
},
"IP": {
},
"LabelNamespace": {
"Namespace": "string"
},
"QueryArgument": {
"Name": "string",
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"QueryString": {
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"UriPath": {
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
}
}
],
"EvaluationWindowSec": number,
"ForwardedIPConfig": {
"FallbackBehavior": "string",
"HeaderName": "string"
},
"Limit": number,
"ScopeDownStatement": "Statement"
},
"RegexMatchStatement": {
"FieldToMatch": {
"AllQueryArguments": {
},
"Body": {
"OversizeHandling": "string"
},
"Cookies": {
"MatchPattern": {
"All": {
},
"ExcludedCookies": [ "string" ],
"IncludedCookies": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"HeaderOrder": {
"OversizeHandling": "string"
},
"Headers": {
"MatchPattern": {
"All": {
},
"ExcludedHeaders": [ "string" ],
"IncludedHeaders": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"JA3Fingerprint": {
"FallbackBehavior": "string"
},
"JsonBody": {
"InvalidFallbackBehavior": "string",
"MatchPattern": {
"All": {
},
"IncludedPaths": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"Method": {
},
"QueryString": {
},
"SingleHeader": {
"Name": "string"
},
"SingleQueryArgument": {
"Name": "string"
},
"UriPath": {
}
},
"RegexString": "string",
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"RegexPatternSetReferenceStatement": {
"ARN": "string",
"FieldToMatch": {
"AllQueryArguments": {
},
"Body": {
"OversizeHandling": "string"
},
"Cookies": {
"MatchPattern": {
"All": {
},
"ExcludedCookies": [ "string" ],
"IncludedCookies": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"HeaderOrder": {
"OversizeHandling": "string"
},
"Headers": {
"MatchPattern": {
"All": {
},
"ExcludedHeaders": [ "string" ],
"IncludedHeaders": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"JA3Fingerprint": {
"FallbackBehavior": "string"
},
"JsonBody": {
"InvalidFallbackBehavior": "string",
"MatchPattern": {
"All": {
},
"IncludedPaths": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"Method": {
},
"QueryString": {
},
"SingleHeader": {
"Name": "string"
},
"SingleQueryArgument": {
"Name": "string"
},
"UriPath": {
}
},
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"RuleGroupReferenceStatement": {
"ARN": "string",
"ExcludedRules": [
{
"Name": "string"
}
],
"RuleActionOverrides": [
{
"ActionToUse": {
"Allow": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Block": {
"CustomResponse": {
"CustomResponseBodyKey": "string",
"ResponseCode": number,
"ResponseHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Captcha": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Challenge": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Count": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
}
},
"Name": "string"
}
]
},
"SizeConstraintStatement": {
"ComparisonOperator": "string",
"FieldToMatch": {
"AllQueryArguments": {
},
"Body": {
"OversizeHandling": "string"
},
"Cookies": {
"MatchPattern": {
"All": {
},
"ExcludedCookies": [ "string" ],
"IncludedCookies": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"HeaderOrder": {
"OversizeHandling": "string"
},
"Headers": {
"MatchPattern": {
"All": {
},
"ExcludedHeaders": [ "string" ],
"IncludedHeaders": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"JA3Fingerprint": {
"FallbackBehavior": "string"
},
"JsonBody": {
"InvalidFallbackBehavior": "string",
"MatchPattern": {
"All": {
},
"IncludedPaths": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"Method": {
},
"QueryString": {
},
"SingleHeader": {
"Name": "string"
},
"SingleQueryArgument": {
"Name": "string"
},
"UriPath": {
}
},
"Size": number,
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"SqliMatchStatement": {
"FieldToMatch": {
"AllQueryArguments": {
},
"Body": {
"OversizeHandling": "string"
},
"Cookies": {
"MatchPattern": {
"All": {
},
"ExcludedCookies": [ "string" ],
"IncludedCookies": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"HeaderOrder": {
"OversizeHandling": "string"
},
"Headers": {
"MatchPattern": {
"All": {
},
"ExcludedHeaders": [ "string" ],
"IncludedHeaders": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"JA3Fingerprint": {
"FallbackBehavior": "string"
},
"JsonBody": {
"InvalidFallbackBehavior": "string",
"MatchPattern": {
"All": {
},
"IncludedPaths": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"Method": {
},
"QueryString": {
},
"SingleHeader": {
"Name": "string"
},
"SingleQueryArgument": {
"Name": "string"
},
"UriPath": {
}
},
"SensitivityLevel": "string",
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"XssMatchStatement": {
"FieldToMatch": {
"AllQueryArguments": {
},
"Body": {
"OversizeHandling": "string"
},
"Cookies": {
"MatchPattern": {
"All": {
},
"ExcludedCookies": [ "string" ],
"IncludedCookies": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"HeaderOrder": {
"OversizeHandling": "string"
},
"Headers": {
"MatchPattern": {
"All": {
},
"ExcludedHeaders": [ "string" ],
"IncludedHeaders": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"JA3Fingerprint": {
"FallbackBehavior": "string"
},
"JsonBody": {
"InvalidFallbackBehavior": "string",
"MatchPattern": {
"All": {
},
"IncludedPaths": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"Method": {
},
"QueryString": {
},
"SingleHeader": {
"Name": "string"
},
"SingleQueryArgument": {
"Name": "string"
},
"UriPath": {
}
},
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
}
},
"VendorName": "string",
"Version": "string"
},
"RuleGroupReferenceStatement": {
"ARN": "string",
"ExcludedRules": [
{
"Name": "string"
}
],
"RuleActionOverrides": [
{
"ActionToUse": {
"Allow": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Block": {
"CustomResponse": {
"CustomResponseBodyKey": "string",
"ResponseCode": number,
"ResponseHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Captcha": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Challenge": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Count": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
}
},
"Name": "string"
}
]
}
},
"Name": "string",
"OverrideAction": {
"Count": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"None": {
}
},
"Priority": number,
"VisibilityConfig": {
"CloudWatchMetricsEnabled": boolean,
"MetricName": "string",
"SampledRequestsEnabled": boolean
}
}
],
"RetrofittedByFirewallManager": boolean,
"Rules": [
{
"Action": {
"Allow": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Block": {
"CustomResponse": {
"CustomResponseBodyKey": "string",
"ResponseCode": number,
"ResponseHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Captcha": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Challenge": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Count": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
}
},
"CaptchaConfig": {
"ImmunityTimeProperty": {
"ImmunityTime": number
}
},
"ChallengeConfig": {
"ImmunityTimeProperty": {
"ImmunityTime": number
}
},
"Name": "string",
"OverrideAction": {
"Count": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"None": {
}
},
"Priority": number,
"RuleLabels": [
{
"Name": "string"
}
],
"Statement": {
"AndStatement": {
"Statements": [
"Statement"
]
},
"ByteMatchStatement": {
"FieldToMatch": {
"AllQueryArguments": {
},
"Body": {
"OversizeHandling": "string"
},
"Cookies": {
"MatchPattern": {
"All": {
},
"ExcludedCookies": [ "string" ],
"IncludedCookies": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"HeaderOrder": {
"OversizeHandling": "string"
},
"Headers": {
"MatchPattern": {
"All": {
},
"ExcludedHeaders": [ "string" ],
"IncludedHeaders": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"JA3Fingerprint": {
"FallbackBehavior": "string"
},
"JsonBody": {
"InvalidFallbackBehavior": "string",
"MatchPattern": {
"All": {
},
"IncludedPaths": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"Method": {
},
"QueryString": {
},
"SingleHeader": {
"Name": "string"
},
"SingleQueryArgument": {
"Name": "string"
},
"UriPath": {
}
},
"PositionalConstraint": "string",
"SearchString": blob,
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"GeoMatchStatement": {
"CountryCodes": [ "string" ],
"ForwardedIPConfig": {
"FallbackBehavior": "string",
"HeaderName": "string"
}
},
"IPSetReferenceStatement": {
"ARN": "string",
"IPSetForwardedIPConfig": {
"FallbackBehavior": "string",
"HeaderName": "string",
"Position": "string"
}
},
"LabelMatchStatement": {
"Key": "string",
"Scope": "string"
},
"ManagedRuleGroupStatement": {
"ExcludedRules": [
{
"Name": "string"
}
],
"ManagedRuleGroupConfigs": [
{
"AWSManagedRulesACFPRuleSet": {
"CreationPath": "string",
"EnableRegexInPath": boolean,
"RegistrationPagePath": "string",
"RequestInspection": {
"AddressFields": [
{
"Identifier": "string"
}
],
"EmailField": {
"Identifier": "string"
},
"PasswordField": {
"Identifier": "string"
},
"PayloadType": "string",
"PhoneNumberFields": [
{
"Identifier": "string"
}
],
"UsernameField": {
"Identifier": "string"
}
},
"ResponseInspection": {
"BodyContains": {
"FailureStrings": [ "string" ],
"SuccessStrings": [ "string" ]
},
"Header": {
"FailureValues": [ "string" ],
"Name": "string",
"SuccessValues": [ "string" ]
},
"Json": {
"FailureValues": [ "string" ],
"Identifier": "string",
"SuccessValues": [ "string" ]
},
"StatusCode": {
"FailureCodes": [ number ],
"SuccessCodes": [ number ]
}
}
},
"AWSManagedRulesATPRuleSet": {
"EnableRegexInPath": boolean,
"LoginPath": "string",
"RequestInspection": {
"PasswordField": {
"Identifier": "string"
},
"PayloadType": "string",
"UsernameField": {
"Identifier": "string"
}
},
"ResponseInspection": {
"BodyContains": {
"FailureStrings": [ "string" ],
"SuccessStrings": [ "string" ]
},
"Header": {
"FailureValues": [ "string" ],
"Name": "string",
"SuccessValues": [ "string" ]
},
"Json": {
"FailureValues": [ "string" ],
"Identifier": "string",
"SuccessValues": [ "string" ]
},
"StatusCode": {
"FailureCodes": [ number ],
"SuccessCodes": [ number ]
}
}
},
"AWSManagedRulesBotControlRuleSet": {
"EnableMachineLearning": boolean,
"InspectionLevel": "string"
},
"LoginPath": "string",
"PasswordField": {
"Identifier": "string"
},
"PayloadType": "string",
"UsernameField": {
"Identifier": "string"
}
}
],
"Name": "string",
"RuleActionOverrides": [
{
"ActionToUse": {
"Allow": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Block": {
"CustomResponse": {
"CustomResponseBodyKey": "string",
"ResponseCode": number,
"ResponseHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Captcha": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Challenge": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Count": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
}
},
"Name": "string"
}
],
"ScopeDownStatement": "Statement",
"VendorName": "string",
"Version": "string"
},
"NotStatement": {
"Statement": "Statement"
},
"OrStatement": {
"Statements": [
"Statement"
]
},
"RateBasedStatement": {
"AggregateKeyType": "string",
"CustomKeys": [
{
"Cookie": {
"Name": "string",
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"ForwardedIP": {
},
"Header": {
"Name": "string",
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"HTTPMethod": {
},
"IP": {
},
"LabelNamespace": {
"Namespace": "string"
},
"QueryArgument": {
"Name": "string",
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"QueryString": {
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"UriPath": {
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
}
}
],
"EvaluationWindowSec": number,
"ForwardedIPConfig": {
"FallbackBehavior": "string",
"HeaderName": "string"
},
"Limit": number,
"ScopeDownStatement": "Statement"
},
"RegexMatchStatement": {
"FieldToMatch": {
"AllQueryArguments": {
},
"Body": {
"OversizeHandling": "string"
},
"Cookies": {
"MatchPattern": {
"All": {
},
"ExcludedCookies": [ "string" ],
"IncludedCookies": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"HeaderOrder": {
"OversizeHandling": "string"
},
"Headers": {
"MatchPattern": {
"All": {
},
"ExcludedHeaders": [ "string" ],
"IncludedHeaders": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"JA3Fingerprint": {
"FallbackBehavior": "string"
},
"JsonBody": {
"InvalidFallbackBehavior": "string",
"MatchPattern": {
"All": {
},
"IncludedPaths": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"Method": {
},
"QueryString": {
},
"SingleHeader": {
"Name": "string"
},
"SingleQueryArgument": {
"Name": "string"
},
"UriPath": {
}
},
"RegexString": "string",
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"RegexPatternSetReferenceStatement": {
"ARN": "string",
"FieldToMatch": {
"AllQueryArguments": {
},
"Body": {
"OversizeHandling": "string"
},
"Cookies": {
"MatchPattern": {
"All": {
},
"ExcludedCookies": [ "string" ],
"IncludedCookies": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"HeaderOrder": {
"OversizeHandling": "string"
},
"Headers": {
"MatchPattern": {
"All": {
},
"ExcludedHeaders": [ "string" ],
"IncludedHeaders": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"JA3Fingerprint": {
"FallbackBehavior": "string"
},
"JsonBody": {
"InvalidFallbackBehavior": "string",
"MatchPattern": {
"All": {
},
"IncludedPaths": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"Method": {
},
"QueryString": {
},
"SingleHeader": {
"Name": "string"
},
"SingleQueryArgument": {
"Name": "string"
},
"UriPath": {
}
},
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"RuleGroupReferenceStatement": {
"ARN": "string",
"ExcludedRules": [
{
"Name": "string"
}
],
"RuleActionOverrides": [
{
"ActionToUse": {
"Allow": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Block": {
"CustomResponse": {
"CustomResponseBodyKey": "string",
"ResponseCode": number,
"ResponseHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Captcha": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Challenge": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Count": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
}
},
"Name": "string"
}
]
},
"SizeConstraintStatement": {
"ComparisonOperator": "string",
"FieldToMatch": {
"AllQueryArguments": {
},
"Body": {
"OversizeHandling": "string"
},
"Cookies": {
"MatchPattern": {
"All": {
},
"ExcludedCookies": [ "string" ],
"IncludedCookies": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"HeaderOrder": {
"OversizeHandling": "string"
},
"Headers": {
"MatchPattern": {
"All": {
},
"ExcludedHeaders": [ "string" ],
"IncludedHeaders": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"JA3Fingerprint": {
"FallbackBehavior": "string"
},
"JsonBody": {
"InvalidFallbackBehavior": "string",
"MatchPattern": {
"All": {
},
"IncludedPaths": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"Method": {
},
"QueryString": {
},
"SingleHeader": {
"Name": "string"
},
"SingleQueryArgument": {
"Name": "string"
},
"UriPath": {
}
},
"Size": number,
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"SqliMatchStatement": {
"FieldToMatch": {
"AllQueryArguments": {
},
"Body": {
"OversizeHandling": "string"
},
"Cookies": {
"MatchPattern": {
"All": {
},
"ExcludedCookies": [ "string" ],
"IncludedCookies": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"HeaderOrder": {
"OversizeHandling": "string"
},
"Headers": {
"MatchPattern": {
"All": {
},
"ExcludedHeaders": [ "string" ],
"IncludedHeaders": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"JA3Fingerprint": {
"FallbackBehavior": "string"
},
"JsonBody": {
"InvalidFallbackBehavior": "string",
"MatchPattern": {
"All": {
},
"IncludedPaths": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"Method": {
},
"QueryString": {
},
"SingleHeader": {
"Name": "string"
},
"SingleQueryArgument": {
"Name": "string"
},
"UriPath": {
}
},
"SensitivityLevel": "string",
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"XssMatchStatement": {
"FieldToMatch": {
"AllQueryArguments": {
},
"Body": {
"OversizeHandling": "string"
},
"Cookies": {
"MatchPattern": {
"All": {
},
"ExcludedCookies": [ "string" ],
"IncludedCookies": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"HeaderOrder": {
"OversizeHandling": "string"
},
"Headers": {
"MatchPattern": {
"All": {
},
"ExcludedHeaders": [ "string" ],
"IncludedHeaders": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"JA3Fingerprint": {
"FallbackBehavior": "string"
},
"JsonBody": {
"InvalidFallbackBehavior": "string",
"MatchPattern": {
"All": {
},
"IncludedPaths": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"Method": {
},
"QueryString": {
},
"SingleHeader": {
"Name": "string"
},
"SingleQueryArgument": {
"Name": "string"
},
"UriPath": {
}
},
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
}
},
"VisibilityConfig": {
"CloudWatchMetricsEnabled": boolean,
"MetricName": "string",
"SampledRequestsEnabled": boolean
}
}
],
"TokenDomains": [ "string" ],
"VisibilityConfig": {
"CloudWatchMetricsEnabled": boolean,
"MetricName": "string",
"SampledRequestsEnabled": boolean
}
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ApplicationIntegrationURL
-
The URL to use in SDK integrations with AWS managed rule groups. For example, you can use the integration SDKs with the account takeover prevention managed rule group
AWSManagedRulesATPRuleSetand the account creation fraud prevention managed rule groupAWSManagedRulesACFPRuleSet. This is only populated if you are using a rule group in your web ACL that integrates with your applications in this way. For more information, see AWS WAF client application integration in the AWS WAF Developer Guide.Type: String
- LockToken
-
A token used for optimistic locking. AWS WAF returns a token to your
getandlistrequests, 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 likeupdateanddelete. 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 aWAFOptimisticLockException. If this happens, perform anotherget, 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}$ - WebACL
-
The web ACL specification. You can modify the settings in this web ACL and use it to update this web ACL or create a new one.
Type: WebACL object
Errors
For information about the errors that are common to all actions, see Common Errors.
- WAFInternalErrorException
-
Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request.
HTTP Status Code: 500
- WAFInvalidOperationException
-
The operation isn't valid.
HTTP Status Code: 400
- WAFInvalidParameterException
-
The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
-
You specified a parameter name or value that isn't valid.
-
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
-
You tried to update a
WebACLwith aDefaultActionthat isn't among the types available at DefaultAction. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
HTTP Status Code: 400
-
- WAFNonexistentItemException
-
AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
