GetWebACL
Retrieves the specified WebACL.
Request Syntax
{
"ARN": "string",
"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.
- ARN
-
The Amazon Resource Name (ARN) of the web ACL that you want to retrieve.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
.*\S.*Required: No
- 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: 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
- Scope
-
Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an AWS Amplify application, use
CLOUDFRONT.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: No
-
Response Syntax
{
"ApplicationIntegrationURL": "string",
"LockToken": "string",
"WebACL": {
"ApplicationConfig": {
"Attributes": [
{
"Name": "string",
"Values": [ "string" ]
}
]
},
"ARN": "string",
"AssociationConfig": {
"RequestBody": {
"string" : {
"DefaultSizeInspectionLimit": "string"
}
}
},
"Capacity": number,
"CaptchaConfig": {
"ImmunityTimeProperty": {
"ImmunityTime": number
}
},
"ChallengeConfig": {
"ImmunityTimeProperty": {
"ImmunityTime": number
}
},
"CustomResponseBodies": {
"string" : {
"Content": "string",
"ContentType": "string"
}
},
"DataProtectionConfig": {
"DataProtections": [
{
"Action": "string",
"ExcludeRateBasedDetails": boolean,
"ExcludeRuleMatchDetails": boolean,
"Field": {
"FieldKeys": [ "string" ],
"FieldType": "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,
"MonetizationConfig": {
"CryptoConfig": {
"PaymentNetworks": [
{
"Chain": "string",
"Prices": [
{
"Amount": "string",
"Currency": "string"
}
],
"WalletAddress": "string"
}
]
},
"CurrencyMode": "string"
},
"Name": "string",
"OnSourceDDoSProtectionConfig": {
"ALBLowReputationMode": "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 ]
}
}
},
"AWSManagedRulesAntiDDoSRuleSet": {
"ClientSideActionConfig": {
"Challenge": {
"ExemptUriRegularExpressions": [
{
"RegexString": "string"
}
],
"Sensitivity": "string",
"UsageOfAction": "string"
}
},
"SensitivityToBlock": "string"
},
"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"
}
]
}
},
"Monetize": {
"PriceMultiplier": "string"
}
},
"Name": "string"
}
],
"ScopeDownStatement": {
"AndStatement": {
"Statements": [
"Statement"
]
},
"AsnMatchStatement": {
"AsnList": [ number ],
"ForwardedIPConfig": {
"FallbackBehavior": "string",
"HeaderName": "string"
}
},
"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"
},
"JA4Fingerprint": {
"FallbackBehavior": "string"
},
"JsonBody": {
"InvalidFallbackBehavior": "string",
"MatchPattern": {
"All": {
},
"IncludedPaths": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"Method": {
},
"QueryString": {
},
"SingleHeader": {
"Name": "string"
},
"SingleQueryArgument": {
"Name": "string"
},
"UriFragment": {
"FallbackBehavior": "string"
},
"UriPath": {
}
},
"PositionalConstraint": "string",
"PreParseTextTransformations": [
{
"Priority": number,
"Type": "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": [
{
"ASN": {
},
"Cookie": {
"Name": "string",
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"ForwardedIP": {
},
"Header": {
"Name": "string",
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"HTTPMethod": {
},
"IP": {
},
"JA3Fingerprint": {
"FallbackBehavior": "string"
},
"JA4Fingerprint": {
"FallbackBehavior": "string"
},
"LabelNamespace": {
"Namespace": "string"
},
"QueryArgument": {
"Name": "string",
"