id
stringlengths 8
78
| source
stringclasses 743
values | chunk_id
int64 1
5.05k
| text
stringlengths 593
49.7k
|
|---|---|---|---|
waf-apiref-058 | waf-apiref.pdf | 58 | "Priority": number, "Type": "string" } ] }, "HTTPMethod": { }, "IP": { }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "LabelNamespace": { "Namespace": "string" }, "QueryArgument": { "Name": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "QueryString": { "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "UriPath": { "TextTransformations": [ { "Priority": number, GetWebACLForResource 327 AWS WAFV2 API Reference "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" }, GetWebACLForResource 328 AWS WAFV2 API Reference "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": { } }, "RegexString": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "RegexPatternSetReferenceStatement": { "ARN": "string", "FieldToMatch": { "AllQueryArguments": { GetWebACLForResource 329 AWS WAFV2 API Reference }, "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": { GetWebACLForResource 330 AWS WAFV2 API Reference }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "RuleGroupReferenceStatement": { "ARN": "string", "ExcludedRules": [ { "Name": "string" } ], "RuleActionOverrides": [ { "ActionToUse": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Block": { "CustomResponse": { GetWebACLForResource 331 AWS WAFV2 API Reference "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" } ] GetWebACLForResource 332 API Reference AWS WAFV2 }, "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" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] GetWebACLForResource 333 AWS WAFV2 API Reference }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "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" GetWebACLForResource 334 AWS WAFV2 API Reference }, "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": { GetWebACLForResource 335 AWS WAFV2 API Reference } }, "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": { |
waf-apiref-059 | waf-apiref.pdf | 59 | { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { GetWebACLForResource 335 AWS WAFV2 API Reference } }, "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" }, "JA4Fingerprint": { GetWebACLForResource 336 AWS WAFV2 API Reference "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": { } }, "TextTransformations": [ { "Priority": number, "Type": "string" } ] } }, "VendorName": "string", "Version": "string" }, "RuleGroupReferenceStatement": { "ARN": "string", "ExcludedRules": [ { "Name": "string" GetWebACLForResource 337 AWS WAFV2 API Reference } ], "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" } GetWebACLForResource 338 AWS WAFV2 API Reference ] } }, "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": [ GetWebACLForResource 339 API Reference AWS WAFV2 { "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" } ] } }, GetWebACLForResource 340 AWS WAFV2 API Reference "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": { GetWebACLForResource 341 AWS WAFV2 API Reference "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" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { GetWebACLForResource 342 AWS WAFV2 API Reference }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "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" GetWebACLForResource 343 API Reference AWS WAFV2 } }, "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" ] GetWebACLForResource 344 AWS WAFV2 API Reference }, "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" |
waf-apiref-060 | waf-apiref.pdf | 60 | "string", "PhoneNumberFields": [ { "Identifier": "string" } ], "UsernameField": { "Identifier": "string" } }, "ResponseInspection": { "BodyContains": { "FailureStrings": [ "string" ], "SuccessStrings": [ "string" ] GetWebACLForResource 344 AWS WAFV2 API Reference }, "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" ] }, GetWebACLForResource 345 AWS WAFV2 API Reference "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" } ] GetWebACLForResource 346 AWS WAFV2 API Reference } }, "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": { GetWebACLForResource 347 AWS WAFV2 API Reference "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": { }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "LabelNamespace": { "Namespace": "string" }, "QueryArgument": { "Name": "string", "TextTransformations": [ GetWebACLForResource 348 AWS WAFV2 API Reference { "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" ], GetWebACLForResource 349 AWS WAFV2 API Reference "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" }, GetWebACLForResource 350 AWS WAFV2 API Reference "UriFragment": { "FallbackBehavior": "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" GetWebACLForResource 351 API Reference AWS WAFV2 }, "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": { } }, "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "RuleGroupReferenceStatement": { "ARN": "string", "ExcludedRules": [ { GetWebACLForResource 352 AWS WAFV2 API Reference "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" GetWebACLForResource 353 AWS WAFV2 API Reference } ] } }, "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } } }, "Name": "string" } ] }, "SizeConstraintStatement": { "ComparisonOperator": "string", |
waf-apiref-061 | waf-apiref.pdf | 61 | "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" GetWebACLForResource 353 AWS WAFV2 API Reference } ] } }, "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": { }, GetWebACLForResource 354 AWS WAFV2 API Reference "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": { } }, "Size": number, "TextTransformations": [ { "Priority": number, "Type": "string" } GetWebACLForResource 355 AWS WAFV2 API Reference ] }, "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" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] GetWebACLForResource 356 AWS WAFV2 API Reference }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "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" GetWebACLForResource 357 AWS WAFV2 }, API Reference "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": { GetWebACLForResource 358 AWS WAFV2 API Reference } }, "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. WebACL The web ACL that is associated with the resource. If there is no associated resource, AWS WAF returns a null web ACL. Type: WebACL object Errors For information about the errors that are common to all actions, see Common Errors. GetWebACLForResource 359 AWS WAFV2 WAFInternalErrorException API Reference 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 WebACL with a DefaultAction that 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 WAFUnavailableEntityException AWS WAF couldn’t retrieve a resource that you specified for this operation. If you've just created a resource that you're using in this |
waf-apiref-062 | waf-apiref.pdf | 62 | 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 WAFUnavailableEntityException AWS WAF couldn’t retrieve a resource that you specified for this operation. 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. Verify the resource specifications in your request parameters and then retry the operation. HTTP Status Code: 400 GetWebACLForResource 360 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetWebACLForResource 361 AWS WAFV2 ListAPIKeys Service: AWS WAFV2 API Reference Retrieves a list of the API keys that you've defined for the specified scope. API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see AWS WAF client application integration in the AWS WAF Developer Guide. Request Syntax { "Limit": number, "NextMarker": "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. Limit The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextMarker When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. ListAPIKeys 362 AWS WAFV2 Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: .*\S.* 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 | REGIONAL Required: Yes Response Syntax { "APIKeySummaries": [ { "APIKey": "string", "CreationTimestamp": number, "TokenDomains": [ "string" ], "Version": number } ], "ApplicationIntegrationURL": "string", "NextMarker": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. ListAPIKeys 363 AWS WAFV2 API Reference The following data is returned in JSON format by the service. APIKeySummaries The array of key summaries. If you specified a Limit in your request, this might not be the full list. Type: Array of APIKeySummary objects ApplicationIntegrationURL The CAPTCHA application integration URL, for use in your JavaScript implementation. Type: String NextMarker When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: .*\S.* 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 ListAPIKeys 364 AWS WAFV2 WAFInvalidParameterException API Reference 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 |
waf-apiref-063 | waf-apiref.pdf | 63 | 1. Maximum length of 256. Pattern: .*\S.* 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 ListAPIKeys 364 AWS WAFV2 WAFInvalidParameterException API Reference 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 WebACL with a DefaultAction that 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 WAFInvalidResourceException AWS WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListAPIKeys 365 AWS WAFV2 API Reference ListAPIKeys 366 AWS WAFV2 API Reference ListAvailableManagedRuleGroups Service: AWS WAFV2 Retrieves an array of managed rule groups that are available for you to use. This list includes all AWS Managed Rules rule groups and all of the AWS Marketplace managed rule groups that you're subscribed to. Request Syntax { "Limit": number, "NextMarker": "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. Limit The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextMarker When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. Type: String ListAvailableManagedRuleGroups 367 AWS WAFV2 API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: .*\S.* 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 | REGIONAL Required: Yes Response Syntax { "ManagedRuleGroups": [ { "Description": "string", "Name": "string", "VendorName": "string", "VersioningSupported": boolean } ], "NextMarker": "string" } 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. ListAvailableManagedRuleGroups 368 AWS WAFV2 ManagedRuleGroups API Reference Array of managed rule groups that you can use. If you specified a Limit in your request, this might not be the full list. Type: Array of ManagedRuleGroupSummary objects NextMarker When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: .*\S.* 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. ListAvailableManagedRuleGroups 369 AWS WAFV2 API Reference • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL |
waf-apiref-064 | waf-apiref.pdf | 64 | 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. ListAvailableManagedRuleGroups 369 AWS WAFV2 API Reference • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that 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 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListAvailableManagedRuleGroups 370 AWS WAFV2 API Reference ListAvailableManagedRuleGroupVersions Service: AWS WAFV2 Returns a list of the available versions for the specified managed rule group. Request Syntax { "Limit": number, "Name": "string", "NextMarker": "string", "Scope": "string", "VendorName": "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. Limit The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. 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. ListAvailableManagedRuleGroupVersions 371 AWS WAFV2 Pattern: ^[\w\-]+$ Required: Yes NextMarker API Reference When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: .*\S.* 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 | REGIONAL 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. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. ListAvailableManagedRuleGroupVersions 372 API Reference AWS WAFV2 Pattern: .*\S.* Required: Yes Response Syntax { "CurrentDefaultVersion": "string", "NextMarker": "string", "Versions": [ { "LastUpdateTimestamp": number, "Name": "string" } ] } 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. CurrentDefaultVersion The name of the version that's currently set as the default. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^[\w#:\.\-/]+$ NextMarker When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. Type: String ListAvailableManagedRuleGroupVersions 373 AWS WAFV2 API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: .*\S.* Versions The versions that are currently available for the specified managed rule group. If you specified a Limit in your request, this might not be the full list. Type: Array of ManagedRuleGroupVersion objects 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 |
waf-apiref-065 | waf-apiref.pdf | 65 | 1. Maximum length of 256. Pattern: .*\S.* Versions The versions that are currently available for the specified managed rule group. If you specified a Limit in your request, this might not be the full list. Type: Array of ManagedRuleGroupVersion objects 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 WebACL with a DefaultAction that 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 ListAvailableManagedRuleGroupVersions 374 AWS WAFV2 WAFNonexistentItemException API Reference 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: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListAvailableManagedRuleGroupVersions 375 AWS WAFV2 ListIPSets Service: AWS WAFV2 API Reference Retrieves an array of IPSetSummary objects for the IP sets that you manage. Request Syntax { "Limit": number, "NextMarker": "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. Limit The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextMarker When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: .*\S.* ListIPSets 376 AWS WAFV2 Required: No Scope API Reference 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 | REGIONAL Required: Yes Response Syntax { "IPSets": [ { "ARN": "string", "Description": "string", "Id": "string", "LockToken": "string", "Name": "string" } ], "NextMarker": "string" } 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. IPSets Array of IPSets. If you specified a Limit in your request, this might not be the full list. ListIPSets 377 AWS WAFV2 API Reference Type: Array of IPSetSummary objects NextMarker When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: .*\S.* 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 |
waf-apiref-066 | waf-apiref.pdf | 66 | from the prior call in your next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: .*\S.* 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 WebACL with a DefaultAction that isn't among the types available at DefaultAction. ListIPSets 378 AWS WAFV2 API Reference • 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 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListIPSets 379 AWS WAFV2 API Reference ListLoggingConfigurations Service: AWS WAFV2 Retrieves an array of your LoggingConfiguration objects. Request Syntax { "Limit": number, "LogScope": "string", "NextMarker": "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. Limit The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No LogScope The owner of the logging configuration, which must be set to CUSTOMER for the configurations that you manage. The log scope SECURITY_LAKE indicates a configuration 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 ListLoggingConfigurations 380 AWS WAFV2 Type: String Valid Values: CUSTOMER | SECURITY_LAKE Required: No NextMarker API Reference When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: .*\S.* 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 | REGIONAL Required: Yes Response Syntax { "LoggingConfigurations": [ { "LogDestinationConfigs": [ "string" ], "LoggingFilter": { ListLoggingConfigurations 381 AWS WAFV2 API Reference "DefaultBehavior": "string", "Filters": [ { "Behavior": "string", "Conditions": [ { "ActionCondition": { "Action": "string" }, "LabelNameCondition": { "LabelName": "string" } } ], "Requirement": "string" } ] }, "LogScope": "string", "LogType": "string", "ManagedByFirewallManager": boolean, "RedactedFields": [ { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { ListLoggingConfigurations 382 AWS WAFV2 API Reference }, "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": { } } ], "ResourceArn": "string" } ], "NextMarker": "string" ListLoggingConfigurations 383 AWS WAFV2 } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. LoggingConfigurations Array of logging configurations. If you specified a Limit |
waf-apiref-067 | waf-apiref.pdf | 67 | }, "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": { } } ], "ResourceArn": "string" } ], "NextMarker": "string" ListLoggingConfigurations 383 AWS WAFV2 } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. LoggingConfigurations Array of logging configurations. If you specified a Limit in your request, this might not be the full list. Type: Array of LoggingConfiguration objects NextMarker When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: .*\S.* 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. ListLoggingConfigurations 384 AWS WAFV2 HTTP Status Code: 400 WAFInvalidParameterException API Reference 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 WebACL with a DefaultAction that 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 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListLoggingConfigurations 385 AWS WAFV2 ListManagedRuleSets Service: AWS WAFV2 Retrieves the managed rule sets that you own. API Reference 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 offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate. Request Syntax { "Limit": number, "NextMarker": "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. Limit The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No ListManagedRuleSets 386 AWS WAFV2 NextMarker API Reference When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: .*\S.* 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 | REGIONAL Required: Yes Response Syntax { "ManagedRuleSets": [ { "ARN": "string", "Description": "string", "Id": "string", "LabelNamespace": "string", "LockToken": "string", "Name": "string" ListManagedRuleSets 387 AWS WAFV2 } ], "NextMarker": "string" } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ManagedRuleSets Your managed rule sets. If you specified a Limit in your request, this might not be the full list. Type: Array of ManagedRuleSetSummary objects NextMarker When you request a list of |
waf-apiref-068 | waf-apiref.pdf | 68 | the Region endpoint us-east-1. Type: String Valid Values: CLOUDFRONT | REGIONAL Required: Yes Response Syntax { "ManagedRuleSets": [ { "ARN": "string", "Description": "string", "Id": "string", "LabelNamespace": "string", "LockToken": "string", "Name": "string" ListManagedRuleSets 387 AWS WAFV2 } ], "NextMarker": "string" } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ManagedRuleSets Your managed rule sets. If you specified a Limit in your request, this might not be the full list. Type: Array of ManagedRuleSetSummary objects NextMarker When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: .*\S.* 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. ListManagedRuleSets 388 AWS WAFV2 HTTP Status Code: 400 WAFInvalidParameterException API Reference 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 WebACL with a DefaultAction that 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 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListManagedRuleSets 389 AWS WAFV2 ListMobileSdkReleases Service: AWS WAFV2 API Reference Retrieves a list of the available releases for the mobile SDK and the specified device platform. 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. Request Syntax { "Limit": number, "NextMarker": "string", "Platform": "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. Limit The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextMarker When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. ListMobileSdkReleases 390 AWS WAFV2 Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: .*\S.* Required: No Platform The device platform to retrieve the list for. Type: String Valid Values: IOS | ANDROID Required: Yes Response Syntax { "NextMarker": "string", "ReleaseSummaries": [ { "ReleaseVersion": "string", "Timestamp": number } ] } 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. NextMarker When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. ListMobileSdkReleases 391 AWS WAFV2 Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: .*\S.* ReleaseSummaries The high level information for the available SDK releases. If you specified a Limit in your request, this might not be the full list. Type: Array of ReleaseSummary objects Errors For information about the errors that are common to all actions, see Common |
waf-apiref-069 | waf-apiref.pdf | 69 | that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. ListMobileSdkReleases 391 AWS WAFV2 Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: .*\S.* ReleaseSummaries The high level information for the available SDK releases. If you specified a Limit in your request, this might not be the full list. Type: Array of ReleaseSummary objects 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 WebACL with a DefaultAction that 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. ListMobileSdkReleases 392 AWS WAFV2 HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListMobileSdkReleases 393 AWS WAFV2 ListRegexPatternSets Service: AWS WAFV2 API Reference Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage. Request Syntax { "Limit": number, "NextMarker": "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. Limit The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextMarker When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. ListRegexPatternSets 394 AWS WAFV2 Pattern: .*\S.* Required: No Scope API Reference 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 | REGIONAL Required: Yes Response Syntax { "NextMarker": "string", "RegexPatternSets": [ { "ARN": "string", "Description": "string", "Id": "string", "LockToken": "string", "Name": "string" } ] } 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. ListRegexPatternSets 395 AWS WAFV2 NextMarker API Reference When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: .*\S.* RegexPatternSets Array of regex pattern sets. If you specified a Limit in your request, this might not be the full list. Type: Array of RegexPatternSetSummary objects 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. ListRegexPatternSets 396 AWS WAFV2 API Reference • |
waf-apiref-070 | waf-apiref.pdf | 70 | specified a Limit in your request, this might not be the full list. Type: Array of RegexPatternSetSummary objects 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. ListRegexPatternSets 396 AWS WAFV2 API Reference • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that 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 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListRegexPatternSets 397 AWS WAFV2 API Reference ListResourcesForWebACL Service: AWS WAFV2 Retrieves an array of the Amazon Resource Names (ARNs) for the resources that are associated with the specified web ACL. For Amazon CloudFront, don't use this call. Instead, use the CloudFront call ListDistributionsByWebACLId. For information, see ListDistributionsByWebACLId in the Amazon CloudFront API Reference. Required permissions for customer-managed IAM policies This call requires permissions that are specific to the protected resource type. For details, see Permissions for ListResourcesForWebACL in the AWS WAF Developer Guide. Request Syntax { "ResourceType": "string", "WebACLArn": "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. ResourceType Retrieves the web ACLs that are used by the specified resource type. For Amazon CloudFront, don't use this call. Instead, use the CloudFront call ListDistributionsByWebACLId. For information, see ListDistributionsByWebACLId in the Amazon CloudFront API Reference. Note If you don't provide a resource type, the call uses the resource type APPLICATION_LOAD_BALANCER. ListResourcesForWebACL 398 AWS WAFV2 API Reference Default: APPLICATION_LOAD_BALANCER Type: String Valid Values: APPLICATION_LOAD_BALANCER | API_GATEWAY | APPSYNC | COGNITO_USER_POOL | APP_RUNNER_SERVICE | VERIFIED_ACCESS_INSTANCE | AMPLIFY Required: No WebACLArn The Amazon Resource Name (ARN) of the web ACL. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .*\S.* Required: Yes Response Syntax { "ResourceArns": [ "string" ] } 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. ResourceArns The array of Amazon Resource Names (ARNs) of the associated resources. Type: Array of strings Length Constraints: Minimum length of 20. Maximum length of 2048. ListResourcesForWebACL 399 AWS WAFV2 Pattern: .*\S.* Errors API Reference 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 WebACL with a DefaultAction that 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 ListResourcesForWebACL 400 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListResourcesForWebACL 401 AWS WAFV2 ListRuleGroups Service: AWS |
waf-apiref-071 | waf-apiref.pdf | 71 | to a number of minutes for changes to propagate. HTTP Status Code: 400 ListResourcesForWebACL 400 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListResourcesForWebACL 401 AWS WAFV2 ListRuleGroups Service: AWS WAFV2 API Reference Retrieves an array of RuleGroupSummary objects for the rule groups that you manage. Request Syntax { "Limit": number, "NextMarker": "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. Limit The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextMarker When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. ListRuleGroups 402 AWS WAFV2 Pattern: .*\S.* Required: No Scope API Reference 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 | REGIONAL Required: Yes Response Syntax { "NextMarker": "string", "RuleGroups": [ { "ARN": "string", "Description": "string", "Id": "string", "LockToken": "string", "Name": "string" } ] } 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. ListRuleGroups 403 AWS WAFV2 NextMarker API Reference When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: .*\S.* RuleGroups Array of rule groups. If you specified a Limit in your request, this might not be the full list. Type: Array of RuleGroupSummary objects 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. ListRuleGroups 404 AWS WAFV2 API Reference • You tried to update a WebACL with a DefaultAction that 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 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListRuleGroups 405 AWS WAFV2 ListTagsForResource Service: AWS WAFV2 API Reference Retrieves the TagInfoForResource for the specified 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. You can tag |
waf-apiref-072 | waf-apiref.pdf | 72 | V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListRuleGroups 405 AWS WAFV2 ListTagsForResource Service: AWS WAFV2 API Reference Retrieves the TagInfoForResource for the specified 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. 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. Request Syntax { "Limit": number, "NextMarker": "string", "ResourceARN": "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. Limit The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextMarker When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the ListTagsForResource 406 AWS WAFV2 API Reference response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: .*\S.* Required: No ResourceARN The Amazon Resource Name (ARN) of the resource. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .*\S.* Required: Yes Response Syntax { "NextMarker": "string", "TagInfoForResource": { "ResourceARN": "string", "TagList": [ { "Key": "string", "Value": "string" } ] } } 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. ListTagsForResource 407 AWS WAFV2 NextMarker API Reference When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: .*\S.* TagInfoForResource The collection of tagging definitions for the resource. If you specified a Limit in your request, this might not be the full list. Type: TagInfoForResource 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. ListTagsForResource 408 AWS WAFV2 API Reference • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that 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 WAFTagOperationException An error occurred during the tagging operation. Retry your request. HTTP Status Code: 400 WAFTagOperationInternalErrorException AWS WAF couldn’t perform your tagging operation because of an internal error. Retry your request. HTTP Status Code: 500 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 ListTagsForResource 409 AWS WAFV2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference ListTagsForResource 410 AWS WAFV2 ListWebACLs Service: AWS WAFV2 API Reference Retrieves an array of WebACLSummary objects for the web |
waf-apiref-073 | waf-apiref.pdf | 73 | 500 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 ListTagsForResource 409 AWS WAFV2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference ListTagsForResource 410 AWS WAFV2 ListWebACLs Service: AWS WAFV2 API Reference Retrieves an array of WebACLSummary objects for the web ACLs that you manage. Request Syntax { "Limit": number, "NextMarker": "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. Limit The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No NextMarker When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. ListWebACLs 411 AWS WAFV2 Pattern: .*\S.* Required: No Scope API Reference 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 | REGIONAL Required: Yes Response Syntax { "NextMarker": "string", "WebACLs": [ { "ARN": "string", "Description": "string", "Id": "string", "LockToken": "string", "Name": "string" } ] } 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. ListWebACLs 412 AWS WAFV2 NextMarker API Reference When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: .*\S.* WebACLs Array of web ACLs. If you specified a Limit in your request, this might not be the full list. Type: Array of WebACLSummary objects 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. ListWebACLs 413 AWS WAFV2 API Reference • You tried to update a WebACL with a DefaultAction that 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 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListWebACLs 414 AWS WAFV2 API Reference PutLoggingConfiguration Service: AWS WAFV2 Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided. If you configure data protection for the web ACL, the protection applies to the data that AWS WAF sends to the logs. Note This operation completely replaces any mutable specifications that you already have for a logging configuration with the ones that you provide to this call. To modify an existing logging configuration, do the following: 1. Retrieve it by calling GetLoggingConfiguration 2. |
waf-apiref-074 | waf-apiref.pdf | 74 | • AWS SDK for Python • AWS SDK for Ruby V3 ListWebACLs 414 AWS WAFV2 API Reference PutLoggingConfiguration Service: AWS WAFV2 Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided. If you configure data protection for the web ACL, the protection applies to the data that AWS WAF sends to the logs. Note This operation completely replaces any mutable specifications that you already have for a logging configuration with the ones that you provide to this call. To modify an existing logging configuration, do the following: 1. Retrieve it by calling GetLoggingConfiguration 2. Update its settings as needed 3. Provide the complete logging configuration specification to this call Note You can define one logging destination per web ACL. You can access information about the traffic 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 configure additional settings or permissions. For configuration requirements and pricing information for each destination type, see Logging web ACL traffic in the AWS WAF Developer Guide. 2. Associate your logging destination to your web ACL using a PutLoggingConfiguration request. PutLoggingConfiguration 415 AWS WAFV2 API Reference 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 traffic information in the AWS WAF Developer Guide. Request Syntax { "LoggingConfiguration": { "LogDestinationConfigs": [ "string" ], "LoggingFilter": { "DefaultBehavior": "string", "Filters": [ { "Behavior": "string", "Conditions": [ { "ActionCondition": { "Action": "string" }, "LabelNameCondition": { "LabelName": "string" } } ], "Requirement": "string" } ] }, "LogScope": "string", "LogType": "string", "ManagedByFirewallManager": boolean, "RedactedFields": [ { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, PutLoggingConfiguration 416 AWS WAFV2 API Reference "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": { PutLoggingConfiguration 417 AWS WAFV2 API Reference "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } } ], "ResourceArn": "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. LoggingConfiguration Type: LoggingConfiguration object Required: Yes Response Syntax { "LoggingConfiguration": { "LogDestinationConfigs": [ "string" ], "LoggingFilter": { "DefaultBehavior": "string", "Filters": [ { "Behavior": "string", "Conditions": [ { "ActionCondition": { "Action": "string" PutLoggingConfiguration 418 AWS WAFV2 API Reference }, "LabelNameCondition": { "LabelName": "string" } } ], "Requirement": "string" } ] }, "LogScope": "string", "LogType": "string", "ManagedByFirewallManager": boolean, "RedactedFields": [ { "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": { PutLoggingConfiguration 419 AWS WAFV2 API Reference "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": { } } ], "ResourceArn": "string" } } 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. LoggingConfiguration PutLoggingConfiguration 420 AWS WAFV2 API Reference Type: LoggingConfiguration 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 |
waf-apiref-075 | waf-apiref.pdf | 75 | the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. LoggingConfiguration PutLoggingConfiguration 420 AWS WAFV2 API Reference Type: LoggingConfiguration 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 WebACL with a DefaultAction that 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 WAFLimitsExceededException AWS WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see AWS WAF quotas in the AWS WAF Developer Guide. HTTP Status Code: 400 PutLoggingConfiguration 421 AWS WAFV2 API Reference WAFLogDestinationPermissionIssueException The operation failed because you don't have the permissions that your logging configuration requires. For information, see Logging web ACL traffic information in the AWS WAF Developer Guide. 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 WAFOptimisticLockException AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation. HTTP Status Code: 400 WAFServiceLinkedRoleErrorException AWS WAF is not able to access the service linked role. This can be caused by a previous PutLoggingConfiguration request, which can lock the service linked role for about 20 seconds. Please try your request again. The service linked role can also be locked by a previous DeleteServiceLinkedRole request, which can lock the role for 15 minutes or more. If you recently made a call to DeleteServiceLinkedRole, wait at least 15 minutes and try the request again. If you receive this same exception again, you will have to wait additional time until the role is unlocked. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface PutLoggingConfiguration 422 API Reference AWS WAFV2 • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 PutLoggingConfiguration 423 AWS WAFV2 API Reference PutManagedRuleSetVersions Service: AWS WAFV2 Defines the versions of your managed rule set that you are offering to the customers. Customers see your offerings as managed rule groups with versioning. 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 offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate. Customers retrieve their managed rule group list by calling ListAvailableManagedRuleGroups. The name that you provide here for your managed rule set is the name the customer sees for the corresponding managed rule group. Customers can retrieve the available versions for a managed rule group by calling ListAvailableManagedRuleGroupVersions. You provide a rule group specification for each version. For each managed rule set, you must specify a version that you recommend using. To initiate the expiration of a managed rule group version, use UpdateManagedRuleSetVersionExpiryDate. Request Syntax { "Id": "string", "LockToken": "string", "Name": "string", "RecommendedVersion": "string", "Scope": "string", "VersionsToPublish": { "string" : { "AssociatedRuleGroupArn": "string", "ForecastedLifetime": number } } PutManagedRuleSetVersions 424 AWS WAFV2 } Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Id A unique identifier 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 |
waf-apiref-076 | waf-apiref.pdf | 76 | group version, use UpdateManagedRuleSetVersionExpiryDate. Request Syntax { "Id": "string", "LockToken": "string", "Name": "string", "RecommendedVersion": "string", "Scope": "string", "VersionsToPublish": { "string" : { "AssociatedRuleGroupArn": "string", "ForecastedLifetime": number } } PutManagedRuleSetVersions 424 AWS WAFV2 } Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Id A unique identifier 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 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 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: Yes Name The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set. PutManagedRuleSetVersions 425 AWS WAFV2 API Reference 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 RecommendedVersion The version of the named managed rule group that you'd like your customers to choose, from among your version offerings. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. 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 | REGIONAL Required: Yes VersionsToPublish The versions of the named managed rule group that you want to offer to your customers. PutManagedRuleSetVersions 426 AWS WAFV2 API Reference Type: String to VersionToPublish object map Key Length Constraints: Minimum length of 1. Maximum length of 64. Key Pattern: ^[\w#:\.\-/]+$ Required: No Response Syntax { "NextLockToken": "string" } 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. NextLockToken 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}$ Errors For information about the errors that are common to all actions, see Common Errors. PutManagedRuleSetVersions 427 AWS WAFV2 WAFInternalErrorException API Reference 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 WebACL with a DefaultAction that 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 WAFOptimisticLockException AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed since |
waf-apiref-077 | waf-apiref.pdf | 77 | 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 WAFOptimisticLockException AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation. HTTP Status Code: 400 PutManagedRuleSetVersions 428 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 PutManagedRuleSetVersions 429 AWS WAFV2 PutPermissionPolicy Service: AWS WAFV2 Use this to share a rule group with other accounts. API Reference This action attaches an IAM policy to the specified resource. You must be the owner of the rule group to perform this operation. This action is subject to the following restrictions: • You can attach only one policy with each PutPermissionPolicy request. • The ARN in the request must be a valid AWS WAF RuleGroup ARN and the rule group must exist in the same Region. • The user making the request must be the owner of the rule group. If a rule group has been shared with your account, you can access it through the call GetRuleGroup, and you can reference it in CreateWebACL and UpdateWebACL. Rule groups that are shared with you don't appear in your AWS WAF console rule groups listing. Request Syntax { "Policy": "string", "ResourceArn": "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. Policy The policy to attach to the specified rule group. The policy specifications must conform to the following: • The policy must be composed using IAM Policy version 2012-10-17. • The policy must include specifications for Effect, Action, and Principal. PutPermissionPolicy 430 AWS WAFV2 API Reference • Effect must specify Allow. • Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and wafv2:PutFirewallManagerRuleGroups and may optionally specify wafv2:GetRuleGroup. AWS WAF rejects any extra actions or wildcard actions in the policy. • The policy must not include a Resource parameter. For more information, see IAM Policies. Type: String Length Constraints: Minimum length of 1. Maximum length of 395000. Pattern: .*\S.* Required: Yes ResourceArn The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .*\S.* Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. 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 PutPermissionPolicy 431 AWS WAFV2 WAFInvalidParameterException API Reference 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 WebACL with a DefaultAction that 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 WAFInvalidPermissionPolicyException The operation failed because the specified policy isn't in the proper format. The policy specifications must conform to the following: • The policy must be composed using IAM Policy version 2012-10-17. • The policy must include specifications for Effect, Action, and Principal. • Effect must specify Allow. • Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and wafv2:PutFirewallManagerRuleGroups and may optionally specify wafv2:GetRuleGroup. AWS WAF rejects any extra actions or wildcard actions in the policy. • The policy must not include a Resource parameter. For more information, see IAM Policies. 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 |
waf-apiref-078 | waf-apiref.pdf | 78 | The policy must be composed using IAM Policy version 2012-10-17. • The policy must include specifications for Effect, Action, and Principal. • Effect must specify Allow. • Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and wafv2:PutFirewallManagerRuleGroups and may optionally specify wafv2:GetRuleGroup. AWS WAF rejects any extra actions or wildcard actions in the policy. • The policy must not include a Resource parameter. For more information, see IAM Policies. 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 PutPermissionPolicy 432 API Reference AWS WAFV2 Examples Share a rule group with another account This example illustrates one usage of PutPermissionPolicy. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::111111111111:user/UserName" }, "Action": [ "wafv2:CreateWebACL", "wafv2:UpdateWebACL", "wafv2:PutFirewallManagerRuleGroups", "wafv2:GetRuleGroup" ] } ] } Example put permission policy call for the CLI: This example illustrates one usage of PutPermissionPolicy. aws wafv2 put-permission-policy --resource-arn arn:aws:wafv2:us- east-1:989717579876:regional/rulegroup/rule_group_with_rules/exampleRuleGroupArn --policy '{"Version":"2012-10-17","Statement":[{"Effect":"Allow","Principal": {"AWS":"arn:aws:iam::111111111111:user/ExampleUserName"},"Action": ["wafv2:UpdateWebACL","wafv2:CreateWebACL","wafv2:PutFirewallManagerRuleGroups"]}]}' See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET PutPermissionPolicy 433 API Reference AWS WAFV2 • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 PutPermissionPolicy 434 AWS WAFV2 TagResource Service: AWS WAFV2 API Reference Associates tags with the specified 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. 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. Request Syntax { "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "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. ResourceARN The Amazon Resource Name (ARN) of the resource. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .*\S.* Required: Yes TagResource 435 AWS WAFV2 Tags API Reference An array of key:value pairs to associate with the resource. Type: Array of Tag objects Array Members: Minimum number of 1 item. Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. 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 WebACL with a DefaultAction that 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. TagResource 436 AWS WAFV2 HTTP Status Code: 400 WAFLimitsExceededException API Reference AWS WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see AWS WAF quotas in the AWS WAF Developer Guide. 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 WAFTagOperationException An error occurred during the tagging operation. Retry your request. HTTP Status Code: 400 WAFTagOperationInternalErrorException AWS WAF couldn’t perform your tagging operation because of an internal error. Retry your request. HTTP Status Code: 500 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for |
waf-apiref-079 | waf-apiref.pdf | 79 | 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 WAFTagOperationException An error occurred during the tagging operation. Retry your request. HTTP Status Code: 400 WAFTagOperationInternalErrorException AWS WAF couldn’t perform your tagging operation because of an internal error. Retry your request. HTTP Status Code: 500 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 TagResource 437 AWS WAFV2 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference TagResource 438 AWS WAFV2 UntagResource Service: AWS WAFV2 API Reference Disassociates tags from an AWS resource. Tags are key:value pairs that you can associate with AWS resources. For example, the tag key might be "customer" and the tag value might be "companyA." You can specify one or more tags to add to each container. You can add up to 50 tags to each AWS resource. Request Syntax { "ResourceARN": "string", "TagKeys": [ "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. ResourceARN The Amazon Resource Name (ARN) of the resource. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .*\S.* Required: Yes TagKeys An array of keys identifying the tags to disassociate from the resource. Type: Array of strings Array Members: Minimum number of 1 item. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ UntagResource 439 AWS WAFV2 Required: Yes Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. 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 WebACL with a DefaultAction that 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. UntagResource 440 AWS WAFV2 HTTP Status Code: 400 WAFTagOperationException API Reference An error occurred during the tagging operation. Retry your request. HTTP Status Code: 400 WAFTagOperationInternalErrorException AWS WAF couldn’t perform your tagging operation because of an internal error. Retry your request. HTTP Status Code: 500 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 UntagResource 441 AWS WAFV2 UpdateIPSet Service: AWS WAFV2 Updates the specified IPSet. Note API Reference This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call. To modify an IP set, do the following: 1. Retrieve it by calling GetIPSet 2. Update its settings as needed 3. Provide the complete IP set specification to this call Temporary inconsistencies during updates When you create or change a web ACL or other AWS WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes. The following are examples of the temporary inconsistencies that you might notice during change propagation: • After you create a web ACL, if you try to associate it with a resource, you might get an exception |
waf-apiref-080 | waf-apiref.pdf | 80 | Update its settings as needed 3. Provide the complete IP set specification to this call Temporary inconsistencies during updates When you create or change a web ACL or other AWS WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes. The following are examples of the temporary inconsistencies that you might notice during change propagation: • After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable. • After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another. • After you change a rule action setting, you might see the old action in some places and the new action in others. • After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another. Request Syntax { "Addresses": [ "string" ], UpdateIPSet 442 AWS WAFV2 API Reference "Description": "string", "Id": "string", "LockToken": "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. Addresses Contains an array of strings that specifies 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 specified 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:ffff:ffff:ffff:ffff, 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 specifications: • 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"] UpdateIPSet 443 AWS WAFV2 API Reference • INVALID specification: "Addresses": [""] INVALID Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 50. Pattern: .*\S.* Required: Yes Description A description of the IP set that helps with identification. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$ Required: No Id A unique identifier 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 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 WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. UpdateIPSet 444 AWS WAFV2 Type: String API Reference 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 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 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 | REGIONAL Required: Yes Response Syntax { "NextLockToken": "string" } UpdateIPSet 445 AWS WAFV2 Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextLockToken A token used for optimistic locking. AWS WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: |
waf-apiref-081 | waf-apiref.pdf | 81 | • API and SDKs - For all calls, use the Region endpoint us-east-1. Type: String Valid Values: CLOUDFRONT | REGIONAL Required: Yes Response Syntax { "NextLockToken": "string" } UpdateIPSet 445 AWS WAFV2 Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextLockToken A token used for optimistic locking. AWS WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken. 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}$ Errors For information about the errors that are common to all actions, see Common Errors. WAFDuplicateItemException AWS WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one. HTTP Status Code: 400 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: UpdateIPSet 446 AWS WAFV2 API Reference • 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 WebACL with a DefaultAction that 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 WAFLimitsExceededException AWS WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see AWS WAF quotas in the AWS WAF Developer Guide. 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 WAFOptimisticLockException AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET UpdateIPSet 447 API Reference AWS WAFV2 • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 UpdateIPSet 448 AWS WAFV2 API Reference UpdateManagedRuleSetVersionExpiryDate Service: AWS WAFV2 Updates the expiration information for your managed rule set. Use this to initiate the expiration of a managed rule group version. After you initiate expiration for a version, AWS WAF excludes it from the response to ListAvailableManagedRuleGroupVersions for the managed rule group. 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 offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate. Request Syntax { "ExpiryTimestamp": number, "Id": "string", "LockToken": "string", "Name": "string", "Scope": "string", "VersionToExpire": "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. ExpiryTimestamp The time that you want the version to expire. Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". UpdateManagedRuleSetVersionExpiryDate 449 AWS WAFV2 Type: Timestamp Required: Yes Id API Reference A unique identifier 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 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 |
waf-apiref-082 | waf-apiref.pdf | 82 | 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 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 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: Yes 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 UpdateManagedRuleSetVersionExpiryDate 450 AWS WAFV2 API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: Yes 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 | REGIONAL Required: Yes VersionToExpire The version that you want to remove from your list of offerings for the named managed rule group. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^[\w#:\.\-/]+$ Required: Yes Response Syntax { "ExpiringVersion": "string", "ExpiryTimestamp": number, "NextLockToken": "string" } UpdateManagedRuleSetVersionExpiryDate 451 AWS WAFV2 Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ExpiringVersion The version that is set to expire. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^[\w#:\.\-/]+$ ExpiryTimestamp The time that the version will expire. Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". Type: Timestamp NextLockToken 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}$ Errors For information about the errors that are common to all actions, see Common Errors. UpdateManagedRuleSetVersionExpiryDate 452 AWS WAFV2 WAFInternalErrorException API Reference 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 WebACL with a DefaultAction that 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 WAFOptimisticLockException AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation. HTTP Status Code: 400 UpdateManagedRuleSetVersionExpiryDate 453 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS |
waf-apiref-083 | waf-apiref.pdf | 83 | number of minutes for changes to propagate. HTTP Status Code: 400 WAFOptimisticLockException AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation. HTTP Status Code: 400 UpdateManagedRuleSetVersionExpiryDate 453 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 UpdateManagedRuleSetVersionExpiryDate 454 AWS WAFV2 API Reference UpdateRegexPatternSet Service: AWS WAFV2 Updates the specified RegexPatternSet. Note This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call. To modify a regex pattern set, do the following: 1. Retrieve it by calling GetRegexPatternSet 2. Update its settings as needed 3. Provide the complete regex pattern set specification to this call Temporary inconsistencies during updates When you create or change a web ACL or other AWS WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes. The following are examples of the temporary inconsistencies that you might notice during change propagation: • After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable. • After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another. • After you change a rule action setting, you might see the old action in some places and the new action in others. • After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another. Request Syntax { "Description": "string", UpdateRegexPatternSet 455 AWS WAFV2 API Reference "Id": "string", "LockToken": "string", "Name": "string", "RegularExpressionList": [ { "RegexString": "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. Description A description of the set that helps with identification. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$ Required: No Id A unique identifier 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 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 UpdateRegexPatternSet 456 AWS WAFV2 API Reference 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: Yes Name 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: Yes RegularExpressionList Type: Array of Regex objects Required: Yes 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 UpdateRegexPatternSet 457 AWS WAFV2 API Reference Valid Values: CLOUDFRONT | REGIONAL Required: Yes Response Syntax { "NextLockToken": "string" } 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. NextLockToken A token used for optimistic locking. AWS WAF returns this token |
waf-apiref-084 | waf-apiref.pdf | 84 | 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 UpdateRegexPatternSet 457 AWS WAFV2 API Reference Valid Values: CLOUDFRONT | REGIONAL Required: Yes Response Syntax { "NextLockToken": "string" } 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. NextLockToken A token used for optimistic locking. AWS WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken. 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}$ Errors For information about the errors that are common to all actions, see Common Errors. WAFDuplicateItemException AWS WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one. HTTP Status Code: 400 WAFInternalErrorException Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. UpdateRegexPatternSet 458 AWS WAFV2 HTTP Status Code: 500 WAFInvalidOperationException The operation isn't valid. HTTP Status Code: 400 WAFInvalidParameterException API Reference 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 WebACL with a DefaultAction that 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 WAFLimitsExceededException AWS WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see AWS WAF quotas in the AWS WAF Developer Guide. 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 WAFOptimisticLockException AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation. UpdateRegexPatternSet 459 AWS WAFV2 HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 UpdateRegexPatternSet 460 AWS WAFV2 UpdateRuleGroup Service: AWS WAFV2 Updates the specified RuleGroup. Note API Reference This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call. To modify a rule group, do the following: 1. Retrieve it by calling GetRuleGroup 2. Update its settings as needed 3. Provide the complete rule group specification to this call A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define 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 confidence in its capacity requirements. Temporary inconsistencies during updates When you create or change a web ACL or other AWS WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes. The following are examples of the temporary inconsistencies that you might notice during change propagation: • After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable. • After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another. • After you change a rule action setting, you might see the old action in some places and the new action in others. |
waf-apiref-085 | waf-apiref.pdf | 85 | minutes. The following are examples of the temporary inconsistencies that you might notice during change propagation: • After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable. • After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another. • After you change a rule action setting, you might see the old action in some places and the new action in others. • After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another. UpdateRuleGroup 461 API Reference AWS WAFV2 Request Syntax { "CustomResponseBodies": { "string" : { "Content": "string", "ContentType": "string" } }, "Description": "string", "Id": "string", "LockToken": "string", "Name": "string", "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", UpdateRuleGroup 462 AWS WAFV2 API Reference "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" UpdateRuleGroup 463 API Reference AWS WAFV2 } ] } }, "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" ], UpdateRuleGroup 464 AWS WAFV2 API Reference "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", "SearchString": blob, "TextTransformations": [ { "Priority": number, "Type": "string" } UpdateRuleGroup 465 API Reference AWS WAFV2 ] }, "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" UpdateRuleGroup 466 AWS WAFV2 API Reference }, "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" } }, UpdateRuleGroup 467 AWS WAFV2 API Reference "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", UpdateRuleGroup 468 AWS WAFV2 API Reference "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" } UpdateRuleGroup 469 AWS WAFV2 API Reference ] } |
waf-apiref-086 | waf-apiref.pdf | 86 | } } ], "Name": "string", "RuleActionOverrides": [ { "ActionToUse": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", UpdateRuleGroup 468 AWS WAFV2 API Reference "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" } UpdateRuleGroup 469 AWS WAFV2 API Reference ] } } }, "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": { UpdateRuleGroup 470 AWS WAFV2 API Reference }, "IP": { }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "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" }, UpdateRuleGroup 471 AWS WAFV2 API Reference "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" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, UpdateRuleGroup 472 AWS WAFV2 API Reference "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "RegexString": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "RegexPatternSetReferenceStatement": { "ARN": "string", "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, UpdateRuleGroup 473 AWS WAFV2 API Reference "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" UpdateRuleGroup 474 AWS WAFV2 API Reference }, "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": { UpdateRuleGroup 475 AWS WAFV2 API Reference "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": { UpdateRuleGroup 476 AWS WAFV2 API Reference "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" }, UpdateRuleGroup 477 AWS WAFV2 API Reference "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "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": |
waf-apiref-087 | waf-apiref.pdf | 87 | "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, UpdateRuleGroup 477 AWS WAFV2 API Reference "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "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" ] }, UpdateRuleGroup 478 AWS WAFV2 API Reference "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": { } }, "SensitivityLevel": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "XssMatchStatement": { UpdateRuleGroup 479 AWS WAFV2 API Reference "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" UpdateRuleGroup 480 AWS WAFV2 API Reference }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "TextTransformations": [ { "Priority": number, "Type": "string" } ] } }, "VisibilityConfig": { "CloudWatchMetricsEnabled": boolean, "MetricName": "string", "SampledRequestsEnabled": boolean } } ], "Scope": "string", "VisibilityConfig": { "CloudWatchMetricsEnabled": boolean, "MetricName": "string", "SampledRequestsEnabled": boolean } } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. UpdateRuleGroup 481 AWS WAFV2 API Reference The request accepts the following data in JSON format. 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 define these for the rule group, and then use them in the rules that you define 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 identification. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$ Required: No Id A unique identifier 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. UpdateRuleGroup 482 AWS WAFV2 API Reference Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ Required: Yes 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 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: 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 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 UpdateRuleGroup 483 AWS WAFV2 Scope API Reference Specifies whether this is for a global |
waf-apiref-088 | waf-apiref.pdf | 88 | 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 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 UpdateRuleGroup 483 AWS WAFV2 Scope API Reference 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 | REGIONAL Required: Yes VisibilityConfig Defines and enables Amazon CloudWatch metrics and web request sample collection. Type: VisibilityConfig object Required: Yes Response Syntax { "NextLockToken": "string" } 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. NextLockToken A token used for optimistic locking. AWS WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken. Type: String UpdateRuleGroup 484 AWS WAFV2 API Reference Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ Errors For information about the errors that are common to all actions, see Common Errors. WAFConfigurationWarningException The operation failed because you are inspecting the web request body, headers, or cookies without specifying how to handle oversize components. Rules that inspect the body must either provide an OversizeHandling configuration or they must be preceded by a SizeConstraintStatement that blocks the body content from being too large. Rules that inspect the headers or cookies must provide an OversizeHandling configuration. Provide the handling configuration and retry your operation. Alternately, you can suppress this warning by adding the following tag to the resource that you provide to this operation: Tag (key:WAF:OversizeFieldsHandlingConstraintOptOut, value:true). HTTP Status Code: 400 WAFDuplicateItemException AWS WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one. HTTP Status Code: 400 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 UpdateRuleGroup 485 AWS WAFV2 WAFInvalidParameterException API Reference 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 WebACL with a DefaultAction that 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 WAFLimitsExceededException AWS WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see AWS WAF quotas in the AWS WAF Developer Guide. 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 WAFOptimisticLockException AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation. HTTP Status Code: 400 WAFSubscriptionNotFoundException You tried to use a managed rule group that's available by subscription, but you aren't subscribed to it yet. UpdateRuleGroup 486 AWS WAFV2 HTTP Status Code: 400 WAFUnavailableEntityException API Reference AWS WAF couldn’t retrieve a resource that you specified for this operation. 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. Verify the resource specifications in your request parameters and then retry the operation. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK |
waf-apiref-089 | waf-apiref.pdf | 89 | HTTP Status Code: 400 WAFUnavailableEntityException API Reference AWS WAF couldn’t retrieve a resource that you specified for this operation. 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. Verify the resource specifications in your request parameters and then retry the operation. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 UpdateRuleGroup 487 AWS WAFV2 UpdateWebACL Service: AWS WAFV2 API Reference Updates the specified WebACL. While updating a web ACL, AWS WAF provides continuous coverage to the resources that you have associated with the web ACL. Note This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call. To modify a web ACL, do the following: 1. Retrieve it by calling GetWebACL 2. Update its settings as needed 3. Provide the complete web ACL specification to this call A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines 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 Verified Access instance. Temporary inconsistencies during updates When you create or change a web ACL or other AWS WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes. The following are examples of the temporary inconsistencies that you might notice during change propagation: • After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable. UpdateWebACL 488 AWS WAFV2 API Reference • After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another. • After you change a rule action setting, you might see the old action in some places and the new action in others. • After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another. Request Syntax { "AssociationConfig": { "RequestBody": { "string" : { "DefaultSizeInspectionLimit": "string" } } }, "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" ], UpdateWebACL 489 AWS WAFV2 API Reference "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", "LockToken": "string", "Name": "string", "Rules": [ { "Action": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] UpdateWebACL 490 AWS WAFV2 } }, "Block": { "CustomResponse": { "CustomResponseBodyKey": "string", "ResponseCode": number, "ResponseHeaders": [ { "Name": "string", "Value": "string" API Reference } ] } }, "Captcha": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Challenge": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } } UpdateWebACL 491 API Reference AWS WAFV2 }, "CaptchaConfig": { "ImmunityTimeProperty": { "ImmunityTime": number } }, "ChallengeConfig": { "ImmunityTimeProperty": { "ImmunityTime": number } }, "Name": "string", "OverrideAction": { "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": |
waf-apiref-090 | waf-apiref.pdf | 90 | { "CustomResponse": { "CustomResponseBodyKey": "string", "ResponseCode": number, "ResponseHeaders": [ { "Name": "string", "Value": "string" API Reference } ] } }, "Captcha": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Challenge": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } } UpdateWebACL 491 API Reference AWS WAFV2 }, "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" UpdateWebACL 492 AWS WAFV2 API Reference }, "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": { }, UpdateWebACL 493 AWS WAFV2 API Reference "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "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" UpdateWebACL 494 API Reference AWS WAFV2 } ], "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" ] UpdateWebACL 495 AWS WAFV2 API Reference }, "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" }, UpdateWebACL 496 AWS WAFV2 API Reference "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" } ] UpdateWebACL 497 AWS WAFV2 API Reference } }, "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", UpdateWebACL 498 AWS WAFV2 API Reference "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", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "QueryString": { "TextTransformations": [ { "Priority": number, UpdateWebACL 499 AWS WAFV2 API Reference "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": |
waf-apiref-091 | waf-apiref.pdf | 91 | { "Namespace": "string" }, "QueryArgument": { "Name": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "QueryString": { "TextTransformations": [ { "Priority": number, UpdateWebACL 499 AWS WAFV2 API Reference "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": { UpdateWebACL 500 AWS WAFV2 API Reference "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": { } }, "RegexString": "string", "TextTransformations": [ { "Priority": number, UpdateWebACL 501 AWS WAFV2 API Reference "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" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { UpdateWebACL 502 AWS WAFV2 API Reference "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "RuleGroupReferenceStatement": { "ARN": "string", "ExcludedRules": [ { "Name": "string" } ], "RuleActionOverrides": [ { "ActionToUse": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { UpdateWebACL 503 AWS WAFV2 API Reference "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" UpdateWebACL 504 AWS WAFV2 API Reference } ] } } }, "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" }, "JA4Fingerprint": { UpdateWebACL 505 AWS WAFV2 API Reference "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": { } }, "Size": number, "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "SqliMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { UpdateWebACL 506 AWS WAFV2 API Reference "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" UpdateWebACL 507 API Reference AWS WAFV2 }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "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" ] UpdateWebACL 508 API Reference AWS WAFV2 }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": |
waf-apiref-092 | waf-apiref.pdf | 92 | { } }, "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" ] UpdateWebACL 508 API Reference AWS WAFV2 }, "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": { } }, "TextTransformations": [ { "Priority": number, "Type": "string" } ] } }, UpdateWebACL 509 AWS WAFV2 API Reference "VisibilityConfig": { "CloudWatchMetricsEnabled": boolean, "MetricName": "string", "SampledRequestsEnabled": boolean } } ], "Scope": "string", "TokenDomains": [ "string" ], "VisibilityConfig": { "CloudWatchMetricsEnabled": boolean, "MetricName": "string", "SampledRequestsEnabled": boolean } } 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. AssociationConfig Specifies custom configurations 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 Verified 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 fixed at 8 KB (8,192 bytes). Type: AssociationConfig object UpdateWebACL 510 AWS WAFV2 Required: No CaptchaConfig API Reference Specifies 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: CaptchaConfig object Required: No ChallengeConfig Specifies 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: ChallengeConfig 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 define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL. 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 UpdateWebACL 511 AWS WAFV2 DataProtectionConfig API Reference Specifies 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 configure 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 configuration, which only affects logging. Type: DataProtectionConfig object Required: No DefaultAction The action to perform if none of the Rules contained in the WebACL match. Type: DefaultAction object Required: Yes Description A description of the web ACL that helps with identification. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$ 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: Yes UpdateWebACL 512 AWS WAFV2 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 |
waf-apiref-093 | waf-apiref.pdf | 93 | AWS WAFV2 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: 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 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 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: UpdateWebACL 513 AWS WAFV2 API Reference • 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 | REGIONAL Required: Yes TokenDomains Specifies 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 domain list, AWS WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains. Example JSON: "TokenDomains": { "mywebsite.com", "myotherwebsite.com" } Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 253. Pattern: ^[\w\.\-/]+$ Required: No VisibilityConfig Defines and enables Amazon CloudWatch metrics and web request sample collection. Type: VisibilityConfig object Required: Yes Response Syntax { "NextLockToken": "string" UpdateWebACL 514 AWS WAFV2 } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextLockToken A token used for optimistic locking. AWS WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken. 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}$ Errors For information about the errors that are common to all actions, see Common Errors. WAFConfigurationWarningException The operation failed because you are inspecting the web request body, headers, or cookies without specifying how to handle oversize components. Rules that inspect the body must either provide an OversizeHandling configuration or they must be preceded by a SizeConstraintStatement that blocks the body content from being too large. Rules that inspect the headers or cookies must provide an OversizeHandling configuration. Provide the handling configuration and retry your operation. Alternately, you can suppress this warning by adding the following tag to the resource that you provide to this operation: Tag (key:WAF:OversizeFieldsHandlingConstraintOptOut, value:true). HTTP Status Code: 400 WAFDuplicateItemException AWS WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one. UpdateWebACL 515 AWS WAFV2 HTTP Status Code: 400 WAFExpiredManagedRuleGroupVersionException API Reference The operation failed because the specified version for the managed rule group has expired. You can retrieve the available versions for the managed rule group by calling ListAvailableManagedRuleGroupVersions. HTTP Status Code: 400 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 WebACL with a DefaultAction that 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 |
waf-apiref-094 | waf-apiref.pdf | 94 | 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 WebACL with a DefaultAction that 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 WAFInvalidResourceException AWS WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again. HTTP Status Code: 400 UpdateWebACL 516 AWS WAFV2 WAFLimitsExceededException API Reference AWS WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see AWS WAF quotas in the AWS WAF Developer Guide. 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 WAFOptimisticLockException AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation. HTTP Status Code: 400 WAFSubscriptionNotFoundException You tried to use a managed rule group that's available by subscription, but you aren't subscribed to it yet. HTTP Status Code: 400 WAFUnavailableEntityException AWS WAF couldn’t retrieve a resource that you specified for this operation. 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. Verify the resource specifications in your request parameters and then retry the operation. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: UpdateWebACL 517 AWS WAFV2 • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 AWS WAF Classic The following actions are supported by AWS WAF Classic: • CreateByteMatchSet • CreateGeoMatchSet • CreateIPSet • CreateRateBasedRule • CreateRegexMatchSet • CreateRegexPatternSet • CreateRule • CreateRuleGroup • CreateSizeConstraintSet • CreateSqlInjectionMatchSet • CreateWebACL • CreateWebACLMigrationStack • CreateXssMatchSet • DeleteByteMatchSet • DeleteGeoMatchSet • DeleteIPSet AWS WAF Classic API Reference 518 API Reference AWS WAFV2 • DeleteLoggingConfiguration • DeletePermissionPolicy • DeleteRateBasedRule • DeleteRegexMatchSet • DeleteRegexPatternSet • DeleteRule • DeleteRuleGroup • DeleteSizeConstraintSet • DeleteSqlInjectionMatchSet • DeleteWebACL • DeleteXssMatchSet • GetByteMatchSet • GetChangeToken • GetChangeTokenStatus • GetGeoMatchSet • GetIPSet • GetLoggingConfiguration • GetPermissionPolicy • GetRateBasedRule • GetRateBasedRuleManagedKeys • GetRegexMatchSet • GetRegexPatternSet • GetRule • GetRuleGroup • GetSampledRequests • GetSizeConstraintSet • GetSqlInjectionMatchSet • GetWebACL • GetXssMatchSet • ListActivatedRulesInRuleGroup AWS WAF Classic 519 API Reference AWS WAFV2 • ListByteMatchSets • ListGeoMatchSets • ListIPSets • ListLoggingConfigurations • ListRateBasedRules • ListRegexMatchSets • ListRegexPatternSets • ListRuleGroups • ListRules • ListSizeConstraintSets • ListSqlInjectionMatchSets • ListSubscribedRuleGroups • ListTagsForResource • ListWebACLs • ListXssMatchSets • PutLoggingConfiguration • PutPermissionPolicy • TagResource • UntagResource • UpdateByteMatchSet • UpdateGeoMatchSet • UpdateIPSet • UpdateRateBasedRule • UpdateRegexMatchSet • UpdateRegexPatternSet • UpdateRule • UpdateRuleGroup • UpdateSizeConstraintSet • UpdateSqlInjectionMatchSet • UpdateWebACL AWS WAF Classic 520 AWS WAFV2 • UpdateXssMatchSet API Reference AWS WAF Classic 521 AWS WAFV2 CreateByteMatchSet 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. Creates a ByteMatchSet. You then use UpdateByteMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a ByteMatchSet that matches any requests with User-Agent headers that contain the string BadBot. You can then configure AWS WAF to reject those requests. To create and configure a ByteMatchSet, perform the following steps: 1. Use GetChangeToken to |
waf-apiref-095 | waf-apiref.pdf | 95 | see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Creates a ByteMatchSet. You then use UpdateByteMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a ByteMatchSet that matches any requests with User-Agent headers that contain the string BadBot. You can then configure AWS WAF to reject those requests. To create and configure a ByteMatchSet, perform the following steps: 1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateByteMatchSet request. 2. Submit a CreateByteMatchSet request. 3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request. 4. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI path) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. Request Syntax { "ChangeToken": "string", "Name": "string" CreateByteMatchSet 522 AWS WAFV2 } Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ChangeToken The value returned by the most recent call to GetChangeToken. 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 Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes Response Syntax { "ByteMatchSet": { "ByteMatchSetId": "string", "ByteMatchTuples": [ { "FieldToMatch": { "Data": "string", CreateByteMatchSet 523 AWS WAFV2 API Reference "Type": "string" }, "PositionalConstraint": "string", "TargetString": blob, "TextTransformation": "string" } ], "Name": "string" }, "ChangeToken": "string" } 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. ByteMatchSet A ByteMatchSet that contains no ByteMatchTuple objects. Type: ByteMatchSet object ChangeToken The ChangeToken that you used to submit the CreateByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Errors For information about the errors that are common to all actions, see Common Errors. WAFDisallowedNameException The name specified is invalid. CreateByteMatchSet 524 AWS WAFV2 HTTP Status Code: 400 WAFInternalErrorException API Reference The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified an invalid parameter name. • You specified an invalid value. • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE. • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT. • You tried to create a RateBasedRule with a RateKey value other than IP. • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT. • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY. • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated. HTTP Status Code: 400 WAFLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see AWS WAF Classic quotas in the AWS WAF Developer Guide. CreateByteMatchSet 525 AWS WAFV2 HTTP Status Code: 400 WAFStaleDataException API Reference The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for |
waf-apiref-096 | waf-apiref.pdf | 96 | Reference The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CreateByteMatchSet 526 AWS WAFV2 CreateGeoMatchSet 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. Creates an GeoMatchSet, which you use to specify which web requests you want to allow or block based on the country that the requests originate from. For example, if you're receiving a lot of requests from one or more countries and you want to block the requests, you can create an GeoMatchSet that contains those countries and then configure AWS WAF to block the requests. To create and configure a GeoMatchSet, perform the following steps: 1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateGeoMatchSet request. 2. Submit a CreateGeoMatchSet request. 3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateGeoMatchSet request. 4. Submit an UpdateGeoMatchSetSet request to specify the countries that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. Request Syntax { "ChangeToken": "string", "Name": "string" } CreateGeoMatchSet 527 AWS WAFV2 Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ChangeToken The value returned by the most recent call to GetChangeToken. 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 Name after you create the GeoMatchSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes Response Syntax { "ChangeToken": "string", "GeoMatchSet": { "GeoMatchConstraints": [ { "Type": "string", "Value": "string" } ], "GeoMatchSetId": "string", CreateGeoMatchSet 528 AWS WAFV2 "Name": "string" } } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ChangeToken The ChangeToken that you used to submit the CreateGeoMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* GeoMatchSet The GeoMatchSet returned in the CreateGeoMatchSet response. The GeoMatchSet contains no GeoMatchConstraints. Type: GeoMatchSet object Errors For information about the errors that are common to all actions, see Common Errors. WAFDisallowedNameException The name specified is invalid. HTTP Status Code: 400 WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 CreateGeoMatchSet 529 AWS WAFV2 WAFInvalidAccountException API Reference The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified an invalid parameter name. • You specified an invalid value. • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE. • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT. • You tried to create a RateBasedRule with a RateKey value other than IP. • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT. • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY. • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated. HTTP Status Code: 400 WAFLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of WebACL objects |
waf-apiref-097 | waf-apiref.pdf | 97 | a RateKey value other than IP. • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT. • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY. • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated. HTTP Status Code: 400 WAFLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see AWS WAF Classic quotas in the AWS WAF Developer Guide. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. CreateGeoMatchSet 530 AWS WAFV2 HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CreateGeoMatchSet 531 AWS WAFV2 CreateIPSet 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. Creates an IPSet, which you use to specify which web requests that you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an IPSet that contains those IP addresses and then configure AWS WAF to block the requests. To create and configure an IPSet, perform the following steps: 1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateIPSet request. 2. Submit a CreateIPSet request. 3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. 4. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. Request Syntax { "ChangeToken": "string", "Name": "string" CreateIPSet 532 AWS WAFV2 } Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ChangeToken The value returned by the most recent call to GetChangeToken. 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 Name after you create the IPSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes Response Syntax { "ChangeToken": "string", "IPSet": { "IPSetDescriptors": [ { "Type": "string", "Value": "string" } ], CreateIPSet 533 AWS WAFV2 API Reference "IPSetId": "string", "Name": "string" } } 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. ChangeToken The ChangeToken that you used to submit the CreateIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* IPSet The IPSet returned in the CreateIPSet response. Type: IPSet object Errors For information about the errors that are common to all actions, see Common Errors. WAFDisallowedNameException The name specified is invalid. HTTP Status Code: 400 WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 CreateIPSet 534 AWS WAFV2 WAFInvalidAccountException API Reference The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified an invalid parameter name. • You specified an invalid value. • You tried to |
waf-apiref-098 | waf-apiref.pdf | 98 | all actions, see Common Errors. WAFDisallowedNameException The name specified is invalid. HTTP Status Code: 400 WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 CreateIPSet 534 AWS WAFV2 WAFInvalidAccountException API Reference The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified an invalid parameter name. • You specified an invalid value. • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE. • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT. • You tried to create a RateBasedRule with a RateKey value other than IP. • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT. • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY. • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated. HTTP Status Code: 400 WAFLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see AWS WAF Classic quotas in the AWS WAF Developer Guide. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. CreateIPSet 535 AWS WAFV2 HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CreateIPSet 536 AWS WAFV2 CreateRateBasedRule 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. Creates a RateBasedRule. The RateBasedRule contains a RateLimit, which specifies the maximum number of requests that AWS WAF allows from a specified IP address in a five-minute period. The RateBasedRule also contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to count or block if these requests exceed the RateLimit. If you add more than one predicate to a RateBasedRule, a request not only must exceed the RateLimit, but it also must match all the conditions to be counted or blocked. For example, suppose you add the following to a RateBasedRule: • An IPSet that matches the IP address 192.0.2.44/32 • A ByteMatchSet that matches BadBot in the User-Agent header Further, you specify a RateLimit of 1,000. You then add the RateBasedRule to a WebACL and specify that you want to block requests that meet the conditions in the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions must be received at a rate of more than 1,000 requests every five minutes. If both conditions are met and the rate is exceeded, AWS WAF blocks the requests. If the rate drops below 1,000 for a five-minute period, AWS WAF no longer blocks the requests. As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule: CreateRateBasedRule 537 AWS WAFV2 API Reference • A ByteMatchSet with FieldToMatch of URI • A PositionalConstraint of STARTS_WITH • A TargetString of login Further, you specify a RateLimit of 1,000. By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site. To create and configure a RateBasedRule, perform the following steps: 1. Create and update the predicates that you want to include in the rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. 2. Use GetChangeToken to get the change token that you provide |
waf-apiref-099 | waf-apiref.pdf | 99 | the following to a RateBasedRule: CreateRateBasedRule 537 AWS WAFV2 API Reference • A ByteMatchSet with FieldToMatch of URI • A PositionalConstraint of STARTS_WITH • A TargetString of login Further, you specify a RateLimit of 1,000. By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site. To create and configure a RateBasedRule, perform the following steps: 1. Create and update the predicates that you want to include in the rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. 2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request. 3. Submit a CreateRateBasedRule request. 4. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. 5. Submit an UpdateRateBasedRule request to specify the predicates that you want to include in the rule. 6. Create and update a WebACL that contains the RateBasedRule. For more information, see CreateWebACL. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. Request Syntax { "ChangeToken": "string", "MetricName": "string", "Name": "string", "RateKey": "string", "RateLimit": number, "Tags": [ { CreateRateBasedRule 538 AWS WAFV2 "Key": "string", "Value": "string" } ] } Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ChangeToken The ChangeToken that you used to submit the CreateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. 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 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. Pattern: .*\S.* Required: Yes CreateRateBasedRule 539 AWS WAFV2 Name API Reference A friendly name or description of the 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 field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests that arrive from the same IP address are subject to the RateLimit that is specified in the RateBasedRule. Type: String Valid Values: IP Required: Yes RateLimit The maximum number of requests, which have an identical value in the field that is specified by RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule. Type: Long Valid Range: Minimum value of 100. Maximum value of 2000000000. Required: Yes Tags Type: Array of Tag objects Array Members: Minimum number of 1 item. CreateRateBasedRule 540 API Reference AWS WAFV2 Required: No Response Syntax { "ChangeToken": "string", "Rule": { "MatchPredicates": [ { "DataId": "string", "Negated": boolean, "Type": "string" } ], "MetricName": "string", "Name": "string", "RateKey": "string", "RateLimit": number, "RuleId": "string" } } 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. ChangeToken The ChangeToken that you used to submit the CreateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Rule The RateBasedRule that is returned in the CreateRateBasedRule response. CreateRateBasedRule 541 AWS WAFV2 Type: RateBasedRule object Errors API Reference For information about the errors that are common to all actions, see Common Errors. WAFBadRequestException HTTP Status Code: 400 WAFDisallowedNameException The name specified is invalid. HTTP Status Code: 400 WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified an invalid parameter name. • You specified an invalid value. • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE. • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT. • You tried to create a RateBasedRule with a RateKey value |
waf-apiref-100 | waf-apiref.pdf | 100 | 400 WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified an invalid parameter name. • You specified an invalid value. • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE. • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT. • You tried to create a RateBasedRule with a RateKey value other than IP. • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT. • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY. • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data. CreateRateBasedRule 542 AWS WAFV2 API Reference • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated. HTTP Status Code: 400 WAFLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see AWS WAF Classic quotas in the AWS WAF Developer Guide. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. HTTP Status Code: 400 WAFTagOperationException HTTP Status Code: 400 WAFTagOperationInternalErrorException HTTP Status Code: 500 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin CreateRateBasedRule 543 AWS WAFV2 • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference CreateRateBasedRule 544 AWS WAFV2 CreateRegexMatchSet 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. Creates a RegexMatchSet. You then use UpdateRegexMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a RegexMatchSet that contains a RegexMatchTuple that looks for any requests with User-Agent headers that match a RegexPatternSet with pattern B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and configure a RegexMatchSet, perform the following steps: 1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexMatchSet request. 2. Submit a CreateRegexMatchSet request. 3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet request. 4. Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI path) and the value, using a RegexPatternSet, that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. Request Syntax { "ChangeToken": "string", CreateRegexMatchSet 545 AWS WAFV2 "Name": "string" } Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ChangeToken The value returned by the most recent call to GetChangeToken. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes 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 Response Syntax { "ChangeToken": "string", "RegexMatchSet": { "Name": "string", "RegexMatchSetId": "string", "RegexMatchTuples": [ CreateRegexMatchSet 546 API Reference AWS WAFV2 { "FieldToMatch": { "Data": "string", "Type": "string" }, "RegexPatternSetId": "string", "TextTransformation": "string" } ] } } 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. ChangeToken The ChangeToken that you used to submit the CreateRegexMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. |
waf-apiref-101 | waf-apiref.pdf | 101 | of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes Response Syntax { "ChangeToken": "string", "RegexMatchSet": { "Name": "string", "RegexMatchSetId": "string", "RegexMatchTuples": [ CreateRegexMatchSet 546 API Reference AWS WAFV2 { "FieldToMatch": { "Data": "string", "Type": "string" }, "RegexPatternSetId": "string", "TextTransformation": "string" } ] } } 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. ChangeToken The ChangeToken that you used to submit the CreateRegexMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* RegexMatchSet A RegexMatchSet that contains no RegexMatchTuple objects. Type: RegexMatchSet object Errors For information about the errors that are common to all actions, see Common Errors. WAFDisallowedNameException The name specified is invalid. CreateRegexMatchSet 547 AWS WAFV2 HTTP Status Code: 400 WAFInternalErrorException API Reference The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see AWS WAF Classic quotas in the AWS WAF Developer Guide. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CreateRegexMatchSet 548 AWS WAFV2 API Reference CreateRegexMatchSet 549 AWS WAFV2 API Reference CreateRegexPatternSet 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. Creates a RegexPatternSet. You then use UpdateRegexPatternSet to specify the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and configure a RegexPatternSet, perform the following steps: 1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexPatternSet request. 2. Submit a CreateRegexPatternSet request. 3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request. 4. Submit an UpdateRegexPatternSet request to specify the string that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. Request Syntax { "ChangeToken": "string", "Name": "string" } CreateRegexPatternSet 550 AWS WAFV2 Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ChangeToken The value returned by the most recent call to GetChangeToken. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* 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: Yes Response Syntax { "ChangeToken": "string", "RegexPatternSet": { "Name": "string", "RegexPatternSetId": "string", "RegexPatternStrings": [ "string" ] } } CreateRegexPatternSet 551 AWS WAFV2 Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ChangeToken The ChangeToken that you used to submit the CreateRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* RegexPatternSet A RegexPatternSet that contains no objects. Type: RegexPatternSet object Errors For information about the errors that are common to all actions, see Common Errors. WAFDisallowedNameException The name specified is invalid. HTTP Status Code: 400 WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 CreateRegexPatternSet 552 AWS WAFV2 WAFLimitsExceededException API Reference The operation exceeds a resource limit, for example, the maximum number of WebACL |
waf-apiref-102 | waf-apiref.pdf | 102 | status of the request. For more information, see GetChangeTokenStatus. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* RegexPatternSet A RegexPatternSet that contains no objects. Type: RegexPatternSet object Errors For information about the errors that are common to all actions, see Common Errors. WAFDisallowedNameException The name specified is invalid. HTTP Status Code: 400 WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 CreateRegexPatternSet 552 AWS WAFV2 WAFLimitsExceededException API Reference The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see AWS WAF Classic quotas in the AWS WAF Developer Guide. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CreateRegexPatternSet 553 AWS WAFV2 CreateRule 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. Creates a Rule, which contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed or blocked. For example, suppose that you add the following to a Rule: • An IPSet that matches the IP address 192.0.2.44/32 • A ByteMatchSet that matches BadBot in the User-Agent header You then add the Rule to a WebACL and specify that you want to blocks requests that satisfy the Rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User- Agent header in the request must contain the value BadBot. To create and configure a Rule, perform the following steps: 1. Create and update the predicates that you want to include in the Rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. 2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request. 3. Submit a CreateRule request. 4. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. 5. Submit an UpdateRule request to specify the predicates that you want to include in the Rule. 6. Create and update a WebACL that contains the Rule. For more information, see CreateWebACL. CreateRule 554 AWS WAFV2 API Reference For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. Request Syntax { "ChangeToken": "string", "MetricName": "string", "Name": "string", "Tags": [ { "Key": "string", "Value": "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. ChangeToken The value returned by the most recent call to GetChangeToken. 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 the name of the metric after you create the Rule. Type: String CreateRule 555 AWS WAFV2 API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes 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 Tags Type: Array of Tag objects Array Members: Minimum number of 1 item. Required: No Response Syntax { "ChangeToken": "string", "Rule": { "MetricName": "string", "Name": "string", "Predicates": [ { "DataId": "string", "Negated": boolean, "Type": "string" } ], "RuleId": "string" } CreateRule 556 AWS WAFV2 } Response Elements API Reference |
waf-apiref-103 | waf-apiref.pdf | 103 | Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes 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 Tags Type: Array of Tag objects Array Members: Minimum number of 1 item. Required: No Response Syntax { "ChangeToken": "string", "Rule": { "MetricName": "string", "Name": "string", "Predicates": [ { "DataId": "string", "Negated": boolean, "Type": "string" } ], "RuleId": "string" } CreateRule 556 AWS WAFV2 } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ChangeToken The ChangeToken that you used to submit the CreateRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Rule The Rule returned in the CreateRule response. Type: Rule object Errors For information about the errors that are common to all actions, see Common Errors. WAFBadRequestException HTTP Status Code: 400 WAFDisallowedNameException The name specified is invalid. HTTP Status Code: 400 WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. CreateRule 557 AWS WAFV2 HTTP Status Code: 500 WAFInvalidParameterException API Reference The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified an invalid parameter name. • You specified an invalid value. • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE. • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT. • You tried to create a RateBasedRule with a RateKey value other than IP. • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT. • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY. • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated. HTTP Status Code: 400 WAFLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see AWS WAF Classic quotas in the AWS WAF Developer Guide. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. HTTP Status Code: 400 WAFTagOperationException HTTP Status Code: 400 CreateRule 558 AWS WAFV2 API Reference WAFTagOperationInternalErrorException HTTP Status Code: 500 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CreateRule 559 AWS WAFV2 CreateRuleGroup 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. Creates a RuleGroup. A rule group is a collection of predefined rules that you add to a web ACL. You use UpdateRuleGroup to add rules to the rule group. 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. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. Request Syntax { "ChangeToken": "string", "MetricName": "string", "Name": "string", "Tags": [ { "Key": "string", "Value": "string" } ] CreateRuleGroup 560 AWS WAFV2 } Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ChangeToken The value returned by the most recent call to GetChangeToken. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes MetricName A |
waf-apiref-104 | waf-apiref.pdf | 104 | information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. Request Syntax { "ChangeToken": "string", "MetricName": "string", "Name": "string", "Tags": [ { "Key": "string", "Value": "string" } ] CreateRuleGroup 560 AWS WAFV2 } Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ChangeToken The value returned by the most recent call to GetChangeToken. 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 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 Name after you create a RuleGroup. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. CreateRuleGroup 561 API Reference AWS WAFV2 Pattern: .*\S.* Required: Yes Tags Type: Array of Tag objects Array Members: Minimum number of 1 item. Required: No Response Syntax { "ChangeToken": "string", "RuleGroup": { "MetricName": "string", "Name": "string", "RuleGroupId": "string" } } 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. ChangeToken The ChangeToken that you used to submit the CreateRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* RuleGroup An empty RuleGroup. CreateRuleGroup 562 AWS WAFV2 Type: RuleGroup object Errors API Reference For information about the errors that are common to all actions, see Common Errors. WAFBadRequestException HTTP Status Code: 400 WAFDisallowedNameException The name specified is invalid. HTTP Status Code: 400 WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see AWS WAF Classic quotas in the AWS WAF Developer Guide. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. HTTP Status Code: 400 WAFTagOperationException HTTP Status Code: 400 WAFTagOperationInternalErrorException CreateRuleGroup 563 AWS WAFV2 HTTP Status Code: 500 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CreateRuleGroup 564 AWS WAFV2 API Reference CreateSizeConstraintSet 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. Creates a SizeConstraintSet. You then use UpdateSizeConstraintSet to identify the part of a web request that you want AWS WAF to check for length, such as the length of the User-Agent header or the length of the query string. For example, you can create a SizeConstraintSet that matches any requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those requests. To create and configure a SizeConstraintSet, perform the following steps: 1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSizeConstraintSet request. 2. Submit a CreateSizeConstraintSet request. 3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request. 4. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI path) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. Request Syntax { "ChangeToken": |
waf-apiref-105 | waf-apiref.pdf | 105 | that you provide in the ChangeToken parameter of a CreateSizeConstraintSet request. 2. Submit a CreateSizeConstraintSet request. 3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request. 4. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI path) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. Request Syntax { "ChangeToken": "string", CreateSizeConstraintSet 565 AWS WAFV2 "Name": "string" } Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ChangeToken The value returned by the most recent call to GetChangeToken. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes Name A friendly name or description of the SizeConstraintSet. You can't change Name after you create a SizeConstraintSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes Response Syntax { "ChangeToken": "string", "SizeConstraintSet": { "Name": "string", "SizeConstraints": [ { "ComparisonOperator": "string", CreateSizeConstraintSet 566 AWS WAFV2 API Reference "FieldToMatch": { "Data": "string", "Type": "string" }, "Size": number, "TextTransformation": "string" } ], "SizeConstraintSetId": "string" } } 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. ChangeToken The ChangeToken that you used to submit the CreateSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* SizeConstraintSet A SizeConstraintSet that contains no SizeConstraint objects. Type: SizeConstraintSet object Errors For information about the errors that are common to all actions, see Common Errors. WAFDisallowedNameException The name specified is invalid. CreateSizeConstraintSet 567 AWS WAFV2 HTTP Status Code: 400 WAFInternalErrorException API Reference The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified an invalid parameter name. • You specified an invalid value. • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE. • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT. • You tried to create a RateBasedRule with a RateKey value other than IP. • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT. • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY. • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated. HTTP Status Code: 400 WAFLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see AWS WAF Classic quotas in the AWS WAF Developer Guide. CreateSizeConstraintSet 568 AWS WAFV2 HTTP Status Code: 400 WAFStaleDataException API Reference The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CreateSizeConstraintSet 569 AWS WAFV2 API Reference CreateSqlInjectionMatchSet 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. Creates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS |
waf-apiref-106 | waf-apiref.pdf | 106 | AWS WAFV2 API Reference CreateSqlInjectionMatchSet 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. Creates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings. To create and configure a SqlInjectionMatchSet, perform the following steps: 1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSqlInjectionMatchSet request. 2. Submit a CreateSqlInjectionMatchSet request. 3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSqlInjectionMatchSet request. 4. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests in which you want to allow, block, or count malicious SQL code. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. Request Syntax { "ChangeToken": "string", "Name": "string" } CreateSqlInjectionMatchSet 570 AWS WAFV2 Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ChangeToken The value returned by the most recent call to GetChangeToken. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes Name A friendly name or description for the SqlInjectionMatchSet that you're creating. You can't change Name after you create the SqlInjectionMatchSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes Response Syntax { "ChangeToken": "string", "SqlInjectionMatchSet": { "Name": "string", "SqlInjectionMatchSetId": "string", "SqlInjectionMatchTuples": [ { "FieldToMatch": { "Data": "string", "Type": "string" }, CreateSqlInjectionMatchSet 571 AWS WAFV2 API Reference "TextTransformation": "string" } ] } } 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. ChangeToken The ChangeToken that you used to submit the CreateSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* SqlInjectionMatchSet A SqlInjectionMatchSet. Type: SqlInjectionMatchSet object Errors For information about the errors that are common to all actions, see Common Errors. WAFDisallowedNameException The name specified is invalid. HTTP Status Code: 400 WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. CreateSqlInjectionMatchSet 572 AWS WAFV2 HTTP Status Code: 500 WAFInvalidAccountException API Reference The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified an invalid parameter name. • You specified an invalid value. • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE. • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT. • You tried to create a RateBasedRule with a RateKey value other than IP. • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT. • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY. • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated. HTTP Status Code: 400 WAFLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see AWS WAF Classic quotas in the AWS WAF Developer Guide. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. CreateSqlInjectionMatchSet 573 AWS WAFV2 HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK |
waf-apiref-107 | waf-apiref.pdf | 107 | WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. CreateSqlInjectionMatchSet 573 AWS WAFV2 HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CreateSqlInjectionMatchSet 574 AWS WAFV2 CreateWebACL 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. Creates a WebACL, which contains the Rules that identify the Amazon CloudFront web requests that you want to allow, block, or count. AWS WAF evaluates Rules in order based on the value of Priority for each Rule. You also specify a default action, either ALLOW or BLOCK. If a web request doesn't match any of the Rules in a WebACL, AWS WAF responds to the request with the default action. To create and configure a WebACL, perform the following steps: 1. Create and update the ByteMatchSet objects and other predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet. 2. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule. 3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateWebACL request. 4. Submit a CreateWebACL request. 5. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request. 6. Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with an Amazon CloudFront distribution. CreateWebACL 575 AWS WAFV2 API Reference For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide. Request Syntax { "ChangeToken": "string", "DefaultAction": { "Type": "string" }, "MetricName": "string", "Name": "string", "Tags": [ { "Key": "string", "Value": "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. ChangeToken The value returned by the most recent call to GetChangeToken. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes DefaultAction The action that you want AWS WAF to take when a request doesn't match the criteria specified in any of the Rule objects that are associated with the WebACL. Type: WafAction object CreateWebACL 576 AWS WAFV2 Required: Yes MetricName API Reference 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: Yes Name A friendly name or description of the WebACL. You can't change Name after you create the WebACL. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes Tags Type: Array of Tag objects Array Members: Minimum number of 1 item. Required: No Response Syntax { "ChangeToken": "string", "WebACL": { "DefaultAction": { CreateWebACL 577 AWS WAFV2 API Reference "Type": "string" }, "MetricName": "string", "Name": "string", "Rules": [ { "Action": { "Type": "string" }, "ExcludedRules": [ { "RuleId": "string" } ], "OverrideAction": { "Type": "string" }, "Priority": number, "RuleId": "string", "Type": "string" } ], "WebACLArn": "string", "WebACLId": "string" } } 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. ChangeToken The ChangeToken that you used to submit the CreateWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* CreateWebACL 578 AWS WAFV2 WebACL The WebACL returned in the CreateWebACL response. API Reference Type: WebACL object Errors For information about the errors that are common to all actions, |
waf-apiref-108 | waf-apiref.pdf | 108 | } } 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. ChangeToken The ChangeToken that you used to submit the CreateWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* CreateWebACL 578 AWS WAFV2 WebACL The WebACL returned in the CreateWebACL response. API Reference Type: WebACL object Errors For information about the errors that are common to all actions, see Common Errors. WAFBadRequestException HTTP Status Code: 400 WAFDisallowedNameException The name specified is invalid. HTTP Status Code: 400 WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified an invalid parameter name. • You specified an invalid value. • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE. CreateWebACL 579 AWS WAFV2 API Reference • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT. • You tried to create a RateBasedRule with a RateKey value other than IP. • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT. • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY. • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated. HTTP Status Code: 400 WAFLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see AWS WAF Classic quotas in the AWS WAF Developer Guide. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. HTTP Status Code: 400 WAFTagOperationException HTTP Status Code: 400 WAFTagOperationInternalErrorException HTTP Status Code: 500 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: CreateWebACL 580 API Reference AWS WAFV2 • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CreateWebACL 581 AWS WAFV2 API Reference CreateWebACLMigrationStack Service: AWS WAF Classic Creates an AWS CloudFormation AWS WAFV2 template for the specified web ACL in the specified Amazon S3 bucket. Then, in CloudFormation, you create a stack from the template, to create the web ACL and its resources in AWS WAFV2. Use this to migrate your AWS WAF Classic web ACL to the latest version of AWS WAF. Note AWS WAF Classic support will end on September 30, 2025. This is part of a larger migration procedure for web ACLs from AWS WAF Classic to the latest version of AWS WAF. For the full procedure, including caveats and manual steps to complete the migration and switch over to the new web ACL, see Migrating your AWS WAF Classic resources to AWS WAF in the AWS WAF Developer Guide. Request Syntax { "IgnoreUnsupportedType": boolean, "S3BucketName": "string", "WebACLId": "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. IgnoreUnsupportedType Indicates whether to exclude entities that can't be migrated or to stop the migration. Set this to true to ignore unsupported entities in the web ACL during the migration. Otherwise, if AWS WAF encounters unsupported entities, it stops the process and throws an exception. Type: Boolean CreateWebACLMigrationStack 582 AWS WAFV2 Required: Yes S3BucketName API Reference The name of the Amazon S3 bucket to store the AWS CloudFormation template in. The S3 bucket must be configured as follows for the migration: • If the bucket is encrypted, the encryption must use Amazon S3 (SSE-S3) keys. The migration doesn't support encryption with AWS Key Management Service (SSE-KMS) keys. • The bucket name must start with aws-waf-migration-. For example, aws-waf- migration-my-web-acl. • The bucket must be in the Region where you are deploying the template. For example, for a web ACL in |
waf-apiref-109 | waf-apiref.pdf | 109 | process and throws an exception. Type: Boolean CreateWebACLMigrationStack 582 AWS WAFV2 Required: Yes S3BucketName API Reference The name of the Amazon S3 bucket to store the AWS CloudFormation template in. The S3 bucket must be configured as follows for the migration: • If the bucket is encrypted, the encryption must use Amazon S3 (SSE-S3) keys. The migration doesn't support encryption with AWS Key Management Service (SSE-KMS) keys. • The bucket name must start with aws-waf-migration-. For example, aws-waf- migration-my-web-acl. • The bucket must be in the Region where you are deploying the template. For example, for a web ACL in us-west-2, you must use an Amazon S3 bucket in us-west-2 and you must deploy the template stack to us-west-2. • The bucket policies must permit the migration process to write data. For listings of the bucket policies, see the Examples section. Type: String Length Constraints: Minimum length of 3. Maximum length of 63. Pattern: ^aws-waf-migration-[0-9A-Za-z\.\-_]* Required: Yes WebACLId The UUID of the WAF Classic web ACL that you want to migrate to WAF v2. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes Response Syntax { "S3ObjectUrl": "string" CreateWebACLMigrationStack 583 API Reference AWS WAFV2 } 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. S3ObjectUrl The URL of the template created in Amazon S3. Type: String Length Constraints: Minimum length of 1. Errors For information about the errors that are common to all actions, see Common Errors. WAFEntityMigrationException The operation failed due to a problem with the migration. The failure cause is provided in the exception, in the MigrationErrorType: • ENTITY_NOT_SUPPORTED - The web ACL has an unsupported entity but the IgnoreUnsupportedType is not set to true. • ENTITY_NOT_FOUND - The web ACL doesn't exist. • S3_BUCKET_NO_PERMISSION - You don't have permission to perform the PutObject action to the specified Amazon S3 bucket. • S3_BUCKET_NOT_ACCESSIBLE - The bucket policy doesn't allow AWS WAF to perform the PutObject action in the bucket. • S3_BUCKET_NOT_FOUND - The S3 bucket doesn't exist. • S3_BUCKET_INVALID_REGION - The S3 bucket is not in the same Region as the web ACL. • S3_INTERNAL_ERROR - AWS WAF failed to create the template in the S3 bucket for another reason. In addition, the exception includes specific details about the failure in the MigrationErrorReason. CreateWebACLMigrationStack 584 AWS WAFV2 HTTP Status Code: 400 WAFInternalErrorException API Reference The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidOperationException The operation failed because there was nothing to do. For example: • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL. • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet. • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL. • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL. • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL. HTTP Status Code: 400 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified an invalid parameter name. • You specified an invalid value. • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE. • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT. • You tried to create a RateBasedRule with a RateKey value other than IP. • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT. • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY. • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data. CreateWebACLMigrationStack 585 AWS WAFV2 API Reference • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 Examples Amazon S3 bucket policy for global Amazon CloudFront applications This example illustrates one usage of CreateWebACLMigrationStack. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "apiv2migration.waf.amazonaws.com" }, "Action": "s3:PutObject", "Resource": "arn:aws:s3:::<BUCKET_NAME>/AWSWAF/<CUSTOMER_ACCOUNT_ID>/*" } ] } Amazon S3 bucket policy for Amazon API Gateway API or Application Load Balancer applications This example illustrates one usage of CreateWebACLMigrationStack. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { CreateWebACLMigrationStack 586 AWS WAFV2 API Reference "Service": "apiv2migration.waf-regional.amazonaws.com" }, "Action": "s3:PutObject", "Resource": |
waf-apiref-110 | waf-apiref.pdf | 110 | be associated. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 Examples Amazon S3 bucket policy for global Amazon CloudFront applications This example illustrates one usage of CreateWebACLMigrationStack. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "apiv2migration.waf.amazonaws.com" }, "Action": "s3:PutObject", "Resource": "arn:aws:s3:::<BUCKET_NAME>/AWSWAF/<CUSTOMER_ACCOUNT_ID>/*" } ] } Amazon S3 bucket policy for Amazon API Gateway API or Application Load Balancer applications This example illustrates one usage of CreateWebACLMigrationStack. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { CreateWebACLMigrationStack 586 AWS WAFV2 API Reference "Service": "apiv2migration.waf-regional.amazonaws.com" }, "Action": "s3:PutObject", "Resource": "arn:aws:s3:::<BUCKET_NAME>/AWSWAF/<CUSTOMER_ACCOUNT_ID>/*" } ] } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CreateWebACLMigrationStack 587 AWS WAFV2 CreateXssMatchSet 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. Creates an XssMatchSet, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings. To create and configure an XssMatchSet, perform the following steps: 1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateXssMatchSet request. 2. Submit a CreateXssMatchSet request. 3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateXssMatchSet request. 4. Submit an UpdateXssMatchSet request to specify the parts of web requests in which you want to allow, block, or count cross-site scripting attacks. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. Request Syntax { "ChangeToken": "string", "Name": "string" } CreateXssMatchSet 588 AWS WAFV2 Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ChangeToken The value returned by the most recent call to GetChangeToken. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes Name A friendly name or description for the XssMatchSet that you're creating. You can't change Name after you create the XssMatchSet. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes Response Syntax { "ChangeToken": "string", "XssMatchSet": { "Name": "string", "XssMatchSetId": "string", "XssMatchTuples": [ { "FieldToMatch": { "Data": "string", "Type": "string" CreateXssMatchSet 589 AWS WAFV2 API Reference }, "TextTransformation": "string" } ] } } 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. ChangeToken The ChangeToken that you used to submit the CreateXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* XssMatchSet An XssMatchSet. Type: XssMatchSet object Errors For information about the errors that are common to all actions, see Common Errors. WAFDisallowedNameException The name specified is invalid. HTTP Status Code: 400 WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. CreateXssMatchSet 590 AWS WAFV2 HTTP Status Code: 500 WAFInvalidAccountException API Reference The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified an invalid parameter name. • You specified an invalid value. • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE. • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT. • You tried to create a RateBasedRule with a RateKey value other than IP. • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT. • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY. • You tried to update |
waf-apiref-111 | waf-apiref.pdf | 111 | parameter name. • You specified an invalid value. • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE. • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT. • You tried to create a RateBasedRule with a RateKey value other than IP. • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT. • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY. • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated. HTTP Status Code: 400 WAFLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see AWS WAF Classic quotas in the AWS WAF Developer Guide. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. CreateXssMatchSet 591 AWS WAFV2 HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CreateXssMatchSet 592 AWS WAFV2 DeleteByteMatchSet 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. Permanently deletes a ByteMatchSet. You can't delete a ByteMatchSet if it's still used in any Rules or if it still includes any ByteMatchTuple objects (any filters). If you just want to remove a ByteMatchSet from a Rule, use UpdateRule. To permanently delete a ByteMatchSet, perform the following steps: 1. Update the ByteMatchSet to remove filters, if any. For more information, see UpdateByteMatchSet. 2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteByteMatchSet request. 3. Submit a DeleteByteMatchSet request. Request Syntax { "ByteMatchSetId": "string", "ChangeToken": "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. DeleteByteMatchSet 593 AWS WAFV2 ByteMatchSetId API Reference The ByteMatchSetId of the ByteMatchSet that you want to delete. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes ChangeToken The value returned by the most recent call to GetChangeToken. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes Response Syntax { "ChangeToken": "string" } 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. ChangeToken The ChangeToken that you used to submit the DeleteByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. DeleteByteMatchSet 594 AWS WAFV2 Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFNonEmptyEntityException The operation failed because you tried to delete an object that isn't empty. For example: • You tried to delete a WebACL that still contains one or more Rule objects. • You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates. • You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects. • You tried to delete an IPSet that references one or more IP addresses. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 WAFReferencedItemException The operation failed because you tried to delete an object that is |
waf-apiref-112 | waf-apiref.pdf | 112 | delete an object that isn't empty. For example: • You tried to delete a WebACL that still contains one or more Rule objects. • You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates. • You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects. • You tried to delete an IPSet that references one or more IP addresses. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 WAFReferencedItemException The operation failed because you tried to delete an object that is still in use. For example: DeleteByteMatchSet 595 AWS WAFV2 API Reference • You tried to delete a ByteMatchSet that is still referenced by a Rule. • You tried to delete a Rule that is still referenced by a WebACL. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteByteMatchSet 596 AWS WAFV2 DeleteGeoMatchSet 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. Permanently deletes a GeoMatchSet. You can't delete a GeoMatchSet if it's still used in any Rules or if it still includes any countries. If you just want to remove a GeoMatchSet from a Rule, use UpdateRule. To permanently delete a GeoMatchSet from AWS WAF, perform the following steps: 1. Update the GeoMatchSet to remove any countries. For more information, see UpdateGeoMatchSet. 2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteGeoMatchSet request. 3. Submit a DeleteGeoMatchSet request. Request Syntax { "ChangeToken": "string", "GeoMatchSetId": "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. DeleteGeoMatchSet 597 AWS WAFV2 ChangeToken API Reference The value returned by the most recent call to GetChangeToken. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes GeoMatchSetId The GeoMatchSetID of the GeoMatchSet that you want to delete. GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes Response Syntax { "ChangeToken": "string" } 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. ChangeToken The ChangeToken that you used to submit the DeleteGeoMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. Type: String DeleteGeoMatchSet 598 AWS WAFV2 API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFNonEmptyEntityException The operation failed because you tried to delete an object that isn't empty. For example: • You tried to delete a WebACL that still contains one or more Rule objects. • You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates. • You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects. • You tried to delete an IPSet that references one or more IP addresses. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 WAFReferencedItemException The operation failed because you tried to delete an object that is still in use. For example: • You tried to delete a ByteMatchSet that is still referenced by a Rule. DeleteGeoMatchSet 599 AWS WAFV2 API Reference • You tried to delete a Rule that is still referenced by a WebACL. HTTP Status Code: 400 |
waf-apiref-113 | waf-apiref.pdf | 113 | tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects. • You tried to delete an IPSet that references one or more IP addresses. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 WAFReferencedItemException The operation failed because you tried to delete an object that is still in use. For example: • You tried to delete a ByteMatchSet that is still referenced by a Rule. DeleteGeoMatchSet 599 AWS WAFV2 API Reference • You tried to delete a Rule that is still referenced by a WebACL. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteGeoMatchSet 600 AWS WAFV2 DeleteIPSet 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. Permanently deletes an IPSet. You can't delete an IPSet if it's still used in any Rules or if it still includes any IP addresses. If you just want to remove an IPSet from a Rule, use UpdateRule. To permanently delete an IPSet from AWS WAF, perform the following steps: 1. Update the IPSet to remove IP address ranges, if any. For more information, see UpdateIPSet. 2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteIPSet request. 3. Submit a DeleteIPSet request. Request Syntax { "ChangeToken": "string", "IPSetId": "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. DeleteIPSet 601 AWS WAFV2 ChangeToken API Reference The value returned by the most recent call to GetChangeToken. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes IPSetId The IPSetId of the IPSet that you want to delete. IPSetId is returned by CreateIPSet and by ListIPSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes Response Syntax { "ChangeToken": "string" } 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. ChangeToken The ChangeToken that you used to submit the DeleteIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. Type: String DeleteIPSet 602 AWS WAFV2 API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFNonEmptyEntityException The operation failed because you tried to delete an object that isn't empty. For example: • You tried to delete a WebACL that still contains one or more Rule objects. • You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates. • You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects. • You tried to delete an IPSet that references one or more IP addresses. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 WAFReferencedItemException The operation failed because you tried to delete an object that is still in use. For example: • You tried to delete a ByteMatchSet that is still referenced by a Rule. DeleteIPSet 603 AWS WAFV2 API Reference • You tried to delete a Rule that is still referenced by a WebACL. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. HTTP Status Code: 400 See Also For more information about using this API in one |
waf-apiref-114 | waf-apiref.pdf | 114 | exist. HTTP Status Code: 400 WAFReferencedItemException The operation failed because you tried to delete an object that is still in use. For example: • You tried to delete a ByteMatchSet that is still referenced by a Rule. DeleteIPSet 603 AWS WAFV2 API Reference • You tried to delete a Rule that is still referenced by a WebACL. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteIPSet 604 AWS WAFV2 API Reference DeleteLoggingConfiguration 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. Permanently deletes the LoggingConfiguration from the specified web ACL. Request Syntax { "ResourceArn": "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. ResourceArn The Amazon Resource Name (ARN) of the web ACL from which you want to delete the LoggingConfiguration. Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* Required: Yes DeleteLoggingConfiguration 605 AWS WAFV2 Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin DeleteLoggingConfiguration 606 AWS WAFV2 • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference DeleteLoggingConfiguration 607 AWS WAFV2 API Reference DeletePermissionPolicy 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. Permanently deletes an IAM policy from the specified RuleGroup. The user making the request must be the owner of the RuleGroup. Request Syntax { "ResourceArn": "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. ResourceArn The Amazon Resource Name (ARN) of the RuleGroup from which you want to delete the policy. The user making the request must be the owner of the RuleGroup. Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* DeletePermissionPolicy 608 AWS WAFV2 Required: Yes Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface |
waf-apiref-115 | waf-apiref.pdf | 115 | about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 DeletePermissionPolicy 609 AWS WAFV2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference DeletePermissionPolicy 610 AWS WAFV2 DeleteRateBasedRule 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. Permanently deletes a RateBasedRule. You can't delete a rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects. If you just want to remove a rule from a WebACL, use UpdateWebACL. To permanently delete a RateBasedRule from AWS WAF, perform the following steps: 1. Update the RateBasedRule to remove predicates, if any. For more information, see UpdateRateBasedRule. 2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRateBasedRule request. 3. Submit a DeleteRateBasedRule request. Request Syntax { "ChangeToken": "string", "RuleId": "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. DeleteRateBasedRule 611 AWS WAFV2 ChangeToken API Reference The value returned by the most recent call to GetChangeToken. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes RuleId The RuleId of the RateBasedRule that you want to delete. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes Response Syntax { "ChangeToken": "string" } 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. ChangeToken The ChangeToken that you used to submit the DeleteRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. DeleteRateBasedRule 612 AWS WAFV2 Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFNonEmptyEntityException The operation failed because you tried to delete an object that isn't empty. For example: • You tried to delete a WebACL that still contains one or more Rule objects. • You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates. • You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects. • You tried to delete an IPSet that references one or more IP addresses. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 WAFReferencedItemException The operation failed because you tried to delete an object that is still in use. For example: DeleteRateBasedRule 613 AWS WAFV2 API Reference • You tried to delete a ByteMatchSet that is still referenced by a Rule. • You tried to delete a Rule that is still referenced by a WebACL. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. HTTP Status Code: 400 WAFTagOperationException HTTP Status Code: 400 WAFTagOperationInternalErrorException HTTP Status Code: 500 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java |
waf-apiref-116 | waf-apiref.pdf | 116 | You tried to delete a Rule that is still referenced by a WebACL. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. HTTP Status Code: 400 WAFTagOperationException HTTP Status Code: 400 WAFTagOperationInternalErrorException HTTP Status Code: 500 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteRateBasedRule 614 AWS WAFV2 DeleteRegexMatchSet 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. Permanently deletes a RegexMatchSet. You can't delete a RegexMatchSet if it's still used in any Rules or if it still includes any RegexMatchTuples objects (any filters). If you just want to remove a RegexMatchSet from a Rule, use UpdateRule. To permanently delete a RegexMatchSet, perform the following steps: 1. Update the RegexMatchSet to remove filters, if any. For more information, see UpdateRegexMatchSet. 2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRegexMatchSet request. 3. Submit a DeleteRegexMatchSet request. Request Syntax { "ChangeToken": "string", "RegexMatchSetId": "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. DeleteRegexMatchSet 615 AWS WAFV2 ChangeToken API Reference The value returned by the most recent call to GetChangeToken. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes RegexMatchSetId The RegexMatchSetId of the RegexMatchSet that you want to delete. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes Response Syntax { "ChangeToken": "string" } 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. ChangeToken The ChangeToken that you used to submit the DeleteRegexMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. DeleteRegexMatchSet 616 AWS WAFV2 Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFNonEmptyEntityException The operation failed because you tried to delete an object that isn't empty. For example: • You tried to delete a WebACL that still contains one or more Rule objects. • You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates. • You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects. • You tried to delete an IPSet that references one or more IP addresses. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 WAFReferencedItemException The operation failed because you tried to delete an object that is still in use. For example: DeleteRegexMatchSet 617 AWS WAFV2 API Reference • You tried to delete a ByteMatchSet that is still referenced by a Rule. • You tried to delete a Rule that is still referenced by a WebACL. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteRegexMatchSet 618 AWS WAFV2 API Reference DeleteRegexPatternSet Service: AWS WAF Classic Note AWS |
waf-apiref-117 | waf-apiref.pdf | 117 | using a change token that has already been used. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteRegexMatchSet 618 AWS WAFV2 API Reference DeleteRegexPatternSet 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. Permanently deletes a RegexPatternSet. You can't delete a RegexPatternSet if it's still used in any RegexMatchSet or if the RegexPatternSet is not empty. Request Syntax { "ChangeToken": "string", "RegexPatternSetId": "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. ChangeToken The value returned by the most recent call to GetChangeToken. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes DeleteRegexPatternSet 619 AWS WAFV2 RegexPatternSetId API Reference The RegexPatternSetId of the RegexPatternSet that you want to delete. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes Response Syntax { "ChangeToken": "string" } 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. ChangeToken The ChangeToken that you used to submit the DeleteRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Errors For information about the errors that are common to all actions, see Common Errors. DeleteRegexPatternSet 620 AWS WAFV2 WAFInternalErrorException API Reference The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFNonEmptyEntityException The operation failed because you tried to delete an object that isn't empty. For example: • You tried to delete a WebACL that still contains one or more Rule objects. • You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates. • You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects. • You tried to delete an IPSet that references one or more IP addresses. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 WAFReferencedItemException The operation failed because you tried to delete an object that is still in use. For example: • You tried to delete a ByteMatchSet that is still referenced by a Rule. • You tried to delete a Rule that is still referenced by a WebACL. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. DeleteRegexPatternSet 621 AWS WAFV2 HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteRegexPatternSet 622 AWS WAFV2 DeleteRule 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. Permanently deletes a Rule. You can't delete a Rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects. If you just want to remove a Rule from a WebACL, use UpdateWebACL. To |
waf-apiref-118 | waf-apiref.pdf | 118 | 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. Permanently deletes a Rule. You can't delete a Rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects. If you just want to remove a Rule from a WebACL, use UpdateWebACL. To permanently delete a Rule from AWS WAF, perform the following steps: 1. Update the Rule to remove predicates, if any. For more information, see UpdateRule. 2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRule request. 3. Submit a DeleteRule request. Request Syntax { "ChangeToken": "string", "RuleId": "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. DeleteRule 623 AWS WAFV2 ChangeToken API Reference The value returned by the most recent call to GetChangeToken. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes RuleId The RuleId of the Rule that you want to delete. RuleId is returned by CreateRule and by ListRules. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes Response Syntax { "ChangeToken": "string" } 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. ChangeToken The ChangeToken that you used to submit the DeleteRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. Type: String DeleteRule 624 AWS WAFV2 API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFNonEmptyEntityException The operation failed because you tried to delete an object that isn't empty. For example: • You tried to delete a WebACL that still contains one or more Rule objects. • You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates. • You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects. • You tried to delete an IPSet that references one or more IP addresses. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 WAFReferencedItemException The operation failed because you tried to delete an object that is still in use. For example: • You tried to delete a ByteMatchSet that is still referenced by a Rule. DeleteRule 625 AWS WAFV2 API Reference • You tried to delete a Rule that is still referenced by a WebACL. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. HTTP Status Code: 400 WAFTagOperationException HTTP Status Code: 400 WAFTagOperationInternalErrorException HTTP Status Code: 500 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteRule 626 AWS WAFV2 DeleteRuleGroup 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. Permanently deletes a RuleGroup. You can't delete a RuleGroup if it's still used in any WebACL objects or if it still includes any rules. If you just want to remove a RuleGroup from a WebACL, use UpdateWebACL. To permanently delete a RuleGroup from AWS WAF, perform the following steps: 1. Update the RuleGroup to remove rules, if any. For more information, see UpdateRuleGroup. 2. Use GetChangeToken to get the |
waf-apiref-119 | waf-apiref.pdf | 119 | 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. Permanently deletes a RuleGroup. You can't delete a RuleGroup if it's still used in any WebACL objects or if it still includes any rules. If you just want to remove a RuleGroup from a WebACL, use UpdateWebACL. To permanently delete a RuleGroup from AWS WAF, perform the following steps: 1. Update the RuleGroup to remove rules, if any. For more information, see UpdateRuleGroup. 2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRuleGroup request. 3. Submit a DeleteRuleGroup request. Request Syntax { "ChangeToken": "string", "RuleGroupId": "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. DeleteRuleGroup 627 AWS WAFV2 ChangeToken API Reference The value returned by the most recent call to GetChangeToken. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes RuleGroupId The RuleGroupId of the RuleGroup that you want to delete. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes Response Syntax { "ChangeToken": "string" } 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. ChangeToken The ChangeToken that you used to submit the DeleteRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. Type: String DeleteRuleGroup 628 AWS WAFV2 API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidOperationException The operation failed because there was nothing to do. For example: • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL. • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet. • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL. • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL. • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL. HTTP Status Code: 400 WAFNonEmptyEntityException The operation failed because you tried to delete an object that isn't empty. For example: • You tried to delete a WebACL that still contains one or more Rule objects. • You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates. • You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects. • You tried to delete an IPSet that references one or more IP addresses. HTTP Status Code: 400 DeleteRuleGroup 629 AWS WAFV2 WAFNonexistentItemException API Reference The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 WAFReferencedItemException The operation failed because you tried to delete an object that is still in use. For example: • You tried to delete a ByteMatchSet that is still referenced by a Rule. • You tried to delete a Rule that is still referenced by a WebACL. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. HTTP Status Code: 400 WAFTagOperationException HTTP Status Code: 400 WAFTagOperationInternalErrorException HTTP Status Code: 500 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 DeleteRuleGroup 630 AWS WAFV2 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference DeleteRuleGroup 631 AWS WAFV2 API Reference DeleteSizeConstraintSet 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. Permanently deletes a SizeConstraintSet. You can't delete a |
waf-apiref-120 | waf-apiref.pdf | 120 | for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference DeleteRuleGroup 631 AWS WAFV2 API Reference DeleteSizeConstraintSet 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. Permanently deletes a SizeConstraintSet. You can't delete a SizeConstraintSet if it's still used in any Rules or if it still includes any SizeConstraint objects (any filters). If you just want to remove a SizeConstraintSet from a Rule, use UpdateRule. To permanently delete a SizeConstraintSet, perform the following steps: 1. Update the SizeConstraintSet to remove filters, if any. For more information, see UpdateSizeConstraintSet. 2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSizeConstraintSet request. 3. Submit a DeleteSizeConstraintSet request. Request Syntax { "ChangeToken": "string", "SizeConstraintSetId": "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. DeleteSizeConstraintSet 632 AWS WAFV2 ChangeToken API Reference The value returned by the most recent call to GetChangeToken. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes SizeConstraintSetId The SizeConstraintSetId of the SizeConstraintSet that you want to delete. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes Response Syntax { "ChangeToken": "string" } 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. ChangeToken The ChangeToken that you used to submit the DeleteSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. DeleteSizeConstraintSet 633 AWS WAFV2 Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFNonEmptyEntityException The operation failed because you tried to delete an object that isn't empty. For example: • You tried to delete a WebACL that still contains one or more Rule objects. • You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates. • You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects. • You tried to delete an IPSet that references one or more IP addresses. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 WAFReferencedItemException The operation failed because you tried to delete an object that is still in use. For example: DeleteSizeConstraintSet 634 AWS WAFV2 API Reference • You tried to delete a ByteMatchSet that is still referenced by a Rule. • You tried to delete a Rule that is still referenced by a WebACL. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteSizeConstraintSet 635 AWS WAFV2 API Reference DeleteSqlInjectionMatchSet 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. Permanently deletes a SqlInjectionMatchSet. You can't delete a SqlInjectionMatchSet if it's still used in any Rules or if it still contains any SqlInjectionMatchTuple objects. If you just want to remove a SqlInjectionMatchSet from a Rule, use UpdateRule. To permanently delete a SqlInjectionMatchSet from AWS WAF, perform the following steps: 1. |
waf-apiref-121 | waf-apiref.pdf | 121 | 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. Permanently deletes a SqlInjectionMatchSet. You can't delete a SqlInjectionMatchSet if it's still used in any Rules or if it still contains any SqlInjectionMatchTuple objects. If you just want to remove a SqlInjectionMatchSet from a Rule, use UpdateRule. To permanently delete a SqlInjectionMatchSet from AWS WAF, perform the following steps: 1. Update the SqlInjectionMatchSet to remove filters, if any. For more information, see UpdateSqlInjectionMatchSet. 2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSqlInjectionMatchSet request. 3. Submit a DeleteSqlInjectionMatchSet request. Request Syntax { "ChangeToken": "string", "SqlInjectionMatchSetId": "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. DeleteSqlInjectionMatchSet 636 AWS WAFV2 ChangeToken API Reference The value returned by the most recent call to GetChangeToken. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes SqlInjectionMatchSetId The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to delete. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes Response Syntax { "ChangeToken": "string" } 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. ChangeToken The ChangeToken that you used to submit the DeleteSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. DeleteSqlInjectionMatchSet 637 AWS WAFV2 Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFNonEmptyEntityException The operation failed because you tried to delete an object that isn't empty. For example: • You tried to delete a WebACL that still contains one or more Rule objects. • You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates. • You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects. • You tried to delete an IPSet that references one or more IP addresses. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 WAFReferencedItemException The operation failed because you tried to delete an object that is still in use. For example: DeleteSqlInjectionMatchSet 638 AWS WAFV2 API Reference • You tried to delete a ByteMatchSet that is still referenced by a Rule. • You tried to delete a Rule that is still referenced by a WebACL. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteSqlInjectionMatchSet 639 AWS WAFV2 DeleteWebACL 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. Permanently deletes a WebACL. You can't delete a WebACL if it still contains any Rules. To delete a WebACL, perform the following steps: 1. Update the WebACL to remove Rules, if any. For more information, see UpdateWebACL. 2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteWebACL request. 3. Submit a DeleteWebACL request. Request Syntax { "ChangeToken": "string", "WebACLId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data |
waf-apiref-122 | waf-apiref.pdf | 122 | single set of endpoints for regional and global use. Permanently deletes a WebACL. You can't delete a WebACL if it still contains any Rules. To delete a WebACL, perform the following steps: 1. Update the WebACL to remove Rules, if any. For more information, see UpdateWebACL. 2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteWebACL request. 3. Submit a DeleteWebACL request. Request Syntax { "ChangeToken": "string", "WebACLId": "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. ChangeToken The value returned by the most recent call to GetChangeToken. DeleteWebACL 640 AWS WAFV2 Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes WebACLId The WebACLId of the WebACL that you want to delete. WebACLId is returned by CreateWebACL and by ListWebACLs. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes Response Syntax { "ChangeToken": "string" } 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. ChangeToken The ChangeToken that you used to submit the DeleteWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* DeleteWebACL 641 AWS WAFV2 Errors API Reference For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFNonEmptyEntityException The operation failed because you tried to delete an object that isn't empty. For example: • You tried to delete a WebACL that still contains one or more Rule objects. • You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates. • You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects. • You tried to delete an IPSet that references one or more IP addresses. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 WAFReferencedItemException The operation failed because you tried to delete an object that is still in use. For example: • You tried to delete a ByteMatchSet that is still referenced by a Rule. • You tried to delete a Rule that is still referenced by a WebACL. HTTP Status Code: 400 DeleteWebACL 642 AWS WAFV2 WAFStaleDataException API Reference The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. HTTP Status Code: 400 WAFTagOperationException HTTP Status Code: 400 WAFTagOperationInternalErrorException HTTP Status Code: 500 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteWebACL 643 AWS WAFV2 DeleteXssMatchSet 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. Permanently deletes an XssMatchSet. You can't delete an XssMatchSet if it's still used in any Rules or if it still contains any XssMatchTuple objects. If you just want to remove an XssMatchSet from a Rule, use UpdateRule. To permanently delete an XssMatchSet from AWS WAF, perform the following steps: 1. Update the XssMatchSet to remove filters, if any. For more information, see UpdateXssMatchSet. 2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteXssMatchSet request. 3. Submit a DeleteXssMatchSet request. Request Syntax { "ChangeToken": "string", "XssMatchSetId": "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. DeleteXssMatchSet 644 AWS WAFV2 ChangeToken API Reference The value returned by the most recent call to GetChangeToken. Type: String Length Constraints: Minimum length of 1. Maximum length of |
waf-apiref-123 | waf-apiref.pdf | 123 | steps: 1. Update the XssMatchSet to remove filters, if any. For more information, see UpdateXssMatchSet. 2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteXssMatchSet request. 3. Submit a DeleteXssMatchSet request. Request Syntax { "ChangeToken": "string", "XssMatchSetId": "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. DeleteXssMatchSet 644 AWS WAFV2 ChangeToken API Reference The value returned by the most recent call to GetChangeToken. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes XssMatchSetId The XssMatchSetId of the XssMatchSet that you want to delete. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes Response Syntax { "ChangeToken": "string" } 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. ChangeToken The ChangeToken that you used to submit the DeleteXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. Type: String DeleteXssMatchSet 645 AWS WAFV2 API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFNonEmptyEntityException The operation failed because you tried to delete an object that isn't empty. For example: • You tried to delete a WebACL that still contains one or more Rule objects. • You tried to delete a Rule that still contains one or more ByteMatchSet objects or other predicates. • You tried to delete a ByteMatchSet that contains one or more ByteMatchTuple objects. • You tried to delete an IPSet that references one or more IP addresses. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 WAFReferencedItemException The operation failed because you tried to delete an object that is still in use. For example: • You tried to delete a ByteMatchSet that is still referenced by a Rule. DeleteXssMatchSet 646 AWS WAFV2 API Reference • You tried to delete a Rule that is still referenced by a WebACL. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteXssMatchSet 647 AWS WAFV2 GetByteMatchSet 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. Returns the ByteMatchSet specified by ByteMatchSetId. Request Syntax { "ByteMatchSetId": "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. ByteMatchSetId The ByteMatchSetId of the ByteMatchSet that you want to get. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes GetByteMatchSet 648 API Reference AWS WAFV2 Response Syntax { "ByteMatchSet": { "ByteMatchSetId": "string", "ByteMatchTuples": [ { "FieldToMatch": { "Data": "string", "Type": "string" }, "PositionalConstraint": "string", "TargetString": blob, "TextTransformation": "string" } ], "Name": "string" } } 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. ByteMatchSet Information about the ByteMatchSet that you specified in the GetByteMatchSet request. For more information, see the following topics: • ByteMatchSet: Contains ByteMatchSetId, ByteMatchTuples, and Name • ByteMatchTuples: Contains an array of ByteMatchTuple objects. Each ByteMatchTuple object contains FieldToMatch, PositionalConstraint, TargetString, and TextTransformation • FieldToMatch: Contains Data and Type Type: ByteMatchSet object Errors For information about |
waf-apiref-124 | waf-apiref.pdf | 124 | { "Data": "string", "Type": "string" }, "PositionalConstraint": "string", "TargetString": blob, "TextTransformation": "string" } ], "Name": "string" } } 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. ByteMatchSet Information about the ByteMatchSet that you specified in the GetByteMatchSet request. For more information, see the following topics: • ByteMatchSet: Contains ByteMatchSetId, ByteMatchTuples, and Name • ByteMatchTuples: Contains an array of ByteMatchTuple objects. Each ByteMatchTuple object contains FieldToMatch, PositionalConstraint, TargetString, and TextTransformation • FieldToMatch: Contains Data and Type Type: ByteMatchSet object Errors For information about the errors that are common to all actions, see Common Errors. GetByteMatchSet 649 AWS WAFV2 WAFInternalErrorException API Reference The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetByteMatchSet 650 AWS WAFV2 GetChangeToken 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. When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF. Each create, update, or delete request must use a unique change token. If your application submits a GetChangeToken request and then submits a second GetChangeToken request before submitting a create, update, or delete request, the second GetChangeToken request returns the same value as the first GetChangeToken request. When you use a change token in a create, update, or delete request, the status of the change token changes to PENDING, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use GetChangeTokenStatus to determine the status of your change token. Response Syntax { "ChangeToken": "string" } 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. GetChangeToken 651 AWS WAFV2 ChangeToken API Reference The ChangeToken that you used in the request. Use this value in a GetChangeTokenStatus request to get the current status of the request. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetChangeToken 652 AWS WAFV2 API Reference GetChangeToken 653 AWS WAFV2 API Reference GetChangeTokenStatus 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. Returns the status of a ChangeToken that you got by calling GetChangeToken. ChangeTokenStatus is one of the following values: • PROVISIONED: You requested the change token by calling GetChangeToken, but you haven't used it yet in a call to create, update, or delete an AWS WAF object. • PENDING: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers. • INSYNC: Propagation is complete. Request Syntax |
waf-apiref-125 | waf-apiref.pdf | 125 | use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns the status of a ChangeToken that you got by calling GetChangeToken. ChangeTokenStatus is one of the following values: • PROVISIONED: You requested the change token by calling GetChangeToken, but you haven't used it yet in a call to create, update, or delete an AWS WAF object. • PENDING: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers. • INSYNC: Propagation is complete. Request Syntax { "ChangeToken": "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. ChangeToken The change token for which you want to get the status. This change token was previously returned in the GetChangeToken response. GetChangeTokenStatus 654 AWS WAFV2 Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes Response Syntax { "ChangeTokenStatus": "string" } 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. ChangeTokenStatus The status of the change token. Type: String Valid Values: PROVISIONED | PENDING | INSYNC Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. GetChangeTokenStatus 655 AWS WAFV2 HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetChangeTokenStatus 656 AWS WAFV2 GetGeoMatchSet 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. Returns the GeoMatchSet that is specified by GeoMatchSetId. Request Syntax { "GeoMatchSetId": "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. GeoMatchSetId The GeoMatchSetId of the GeoMatchSet that you want to get. GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes GetGeoMatchSet 657 API Reference AWS WAFV2 Response Syntax { "GeoMatchSet": { "GeoMatchConstraints": [ { "Type": "string", "Value": "string" } ], "GeoMatchSetId": "string", "Name": "string" } } 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. GeoMatchSet Information about the GeoMatchSet that you specified in the GetGeoMatchSet request. This includes the Type, which for a GeoMatchConstraint is always Country, as well as the Value, which is the identifier for a specific country. Type: GeoMatchSet object Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 GetGeoMatchSet 658 AWS WAFV2 WAFInvalidAccountException API Reference The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetGeoMatchSet 659 AWS WAFV2 GetIPSet 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 |
waf-apiref-126 | waf-apiref.pdf | 126 | SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetGeoMatchSet 659 AWS WAFV2 GetIPSet 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. Returns the IPSet that is specified by IPSetId. Request Syntax { "IPSetId": "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. IPSetId The IPSetId of the IPSet that you want to get. IPSetId is returned by CreateIPSet and by ListIPSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes GetIPSet 660 API Reference AWS WAFV2 Response Syntax { "IPSet": { "IPSetDescriptors": [ { "Type": "string", "Value": "string" } ], "IPSetId": "string", "Name": "string" } } 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. IPSet Information about the IPSet that you specified in the GetIPSet request. For more information, see the following topics: • IPSet: Contains IPSetDescriptors, IPSetId, and Name • IPSetDescriptors: Contains an array of IPSetDescriptor objects. Each IPSetDescriptor object contains Type and Value Type: IPSet object Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 GetIPSet 661 AWS WAFV2 WAFInvalidAccountException API Reference The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetIPSet 662 AWS WAFV2 API Reference GetLoggingConfiguration 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. Returns the LoggingConfiguration for the specified web ACL. Request Syntax { "ResourceArn": "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. ResourceArn The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration. Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* Required: Yes GetLoggingConfiguration 663 API Reference AWS WAFV2 Response Syntax { "LoggingConfiguration": { "LogDestinationConfigs": [ "string" ], "RedactedFields": [ { "Data": "string", "Type": "string" } ], "ResourceArn": "string" } } 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. LoggingConfiguration The LoggingConfiguration for the specified web ACL. Type: LoggingConfiguration object Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 GetLoggingConfiguration 664 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetLoggingConfiguration 665 AWS WAFV2 GetPermissionPolicy Service: |
waf-apiref-127 | waf-apiref.pdf | 127 | WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 GetLoggingConfiguration 664 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetLoggingConfiguration 665 AWS WAFV2 GetPermissionPolicy 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. Returns the IAM policy attached to the RuleGroup. Request Syntax { "ResourceArn": "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. ResourceArn The Amazon Resource Name (ARN) of the RuleGroup for which you want to get the policy. Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* Required: Yes GetPermissionPolicy 666 AWS WAFV2 Response Syntax { "Policy": "string" } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Policy The IAM policy attached to the specified RuleGroup. Type: String Length Constraints: Minimum length of 1. Maximum length of 395000. Pattern: .*\S.* Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: GetPermissionPolicy 667 API Reference AWS WAFV2 • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetPermissionPolicy 668 AWS WAFV2 GetRateBasedRule 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. Returns the RateBasedRule that is specified by the RuleId that you included in the GetRateBasedRule request. Request Syntax { "RuleId": "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. RuleId The RuleId of the RateBasedRule that you want to get. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes GetRateBasedRule 669 API Reference AWS WAFV2 Response Syntax { "Rule": { "MatchPredicates": [ { "DataId": "string", "Negated": boolean, "Type": "string" } ], "MetricName": "string", "Name": "string", "RateKey": "string", "RateLimit": number, "RuleId": "string" } } 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. Rule Information about the RateBasedRule that you specified in the GetRateBasedRule request. Type: RateBasedRule object Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 GetRateBasedRule 670 AWS WAFV2 WAFInvalidAccountException API Reference The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 |
waf-apiref-128 | waf-apiref.pdf | 128 | HTTP Status Code: 500 GetRateBasedRule 670 AWS WAFV2 WAFInvalidAccountException API Reference The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetRateBasedRule 671 AWS WAFV2 API Reference GetRateBasedRuleManagedKeys 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. Returns an array of IP addresses currently being blocked by the RateBasedRule that is specified by the RuleId. The maximum number of managed keys that will be blocked is 10,000. If more than 10,000 addresses exceed the rate limit, the 10,000 addresses with the highest rates will be blocked. Request Syntax { "NextMarker": "string", "RuleId": "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. NextMarker A null value and not currently used. Do not include this in your request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* GetRateBasedRuleManagedKeys 672 AWS WAFV2 Required: No RuleId API Reference The RuleId of the RateBasedRule for which you want to get a list of ManagedKeys. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes Response Syntax { "ManagedKeys": [ "string" ], "NextMarker": "string" } 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. ManagedKeys An array of IP addresses that currently are blocked by the specified RateBasedRule. Type: Array of strings NextMarker A null value and not currently used. Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* GetRateBasedRuleManagedKeys 673 AWS WAFV2 Errors API Reference For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified an invalid parameter name. • You specified an invalid value. • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE. • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT. • You tried to create a RateBasedRule with a RateKey value other than IP. • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT. • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY. • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. GetRateBasedRuleManagedKeys 674 AWS WAFV2 HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetRateBasedRuleManagedKeys 675 AWS WAFV2 GetRegexMatchSet 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 , |
waf-apiref-129 | waf-apiref.pdf | 129 | Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetRateBasedRuleManagedKeys 675 AWS WAFV2 GetRegexMatchSet 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. Returns the RegexMatchSet specified by RegexMatchSetId. Request Syntax { "RegexMatchSetId": "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. RegexMatchSetId The RegexMatchSetId of the RegexMatchSet that you want to get. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes GetRegexMatchSet 676 API Reference AWS WAFV2 Response Syntax { "RegexMatchSet": { "Name": "string", "RegexMatchSetId": "string", "RegexMatchTuples": [ { "FieldToMatch": { "Data": "string", "Type": "string" }, "RegexPatternSetId": "string", "TextTransformation": "string" } ] } } 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. RegexMatchSet Information about the RegexMatchSet that you specified in the GetRegexMatchSet request. For more information, see RegexMatchTuple. Type: RegexMatchSet object Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 GetRegexMatchSet 677 AWS WAFV2 WAFInvalidAccountException API Reference The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetRegexMatchSet 678 AWS WAFV2 GetRegexPatternSet 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. Returns the RegexPatternSet specified by RegexPatternSetId. Request Syntax { "RegexPatternSetId": "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. RegexPatternSetId The RegexPatternSetId of the RegexPatternSet that you want to get. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes GetRegexPatternSet 679 API Reference AWS WAFV2 Response Syntax { "RegexPatternSet": { "Name": "string", "RegexPatternSetId": "string", "RegexPatternStrings": [ "string" ] } } 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. RegexPatternSet Information about the RegexPatternSet that you specified in the GetRegexPatternSet request, including the identifier of the pattern set and the regular expression patterns you want AWS WAF to search for. Type: RegexPatternSet object Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 GetRegexPatternSet 680 AWS WAFV2 WAFNonexistentItemException API Reference The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK |
waf-apiref-130 | waf-apiref.pdf | 130 | 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 GetRegexPatternSet 680 AWS WAFV2 WAFNonexistentItemException API Reference The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetRegexPatternSet 681 AWS WAFV2 GetRule 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. Returns the Rule that is specified by the RuleId that you included in the GetRule request. Request Syntax { "RuleId": "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. RuleId The RuleId of the Rule that you want to get. RuleId is returned by CreateRule and by ListRules. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes GetRule 682 API Reference AWS WAFV2 Response Syntax { "Rule": { "MetricName": "string", "Name": "string", "Predicates": [ { "DataId": "string", "Negated": boolean, "Type": "string" } ], "RuleId": "string" } } 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. Rule Information about the Rule that you specified in the GetRule request. For more information, see the following topics: • Rule: Contains MetricName, Name, an array of Predicate objects, and RuleId • Predicate: Each Predicate object contains DataId, Negated, and Type Type: Rule object Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. GetRule 683 AWS WAFV2 HTTP Status Code: 500 WAFInvalidAccountException API Reference The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetRule 684 AWS WAFV2 GetRuleGroup 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. Returns the RuleGroup that is specified by the RuleGroupId that you included in the GetRuleGroup request. To view the rules in a rule group, use ListActivatedRulesInRuleGroup. Request Syntax { "RuleGroupId": "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. RuleGroupId The RuleGroupId of the RuleGroup that you want to get. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* GetRuleGroup 685 API Reference AWS WAFV2 Required: Yes Response Syntax { "RuleGroup": { "MetricName": "string", "Name": "string", "RuleGroupId": "string" } } 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. RuleGroup Information about the RuleGroup that you specified in the GetRuleGroup request. Type: RuleGroup object Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFNonexistentItemException The operation |
waf-apiref-131 | waf-apiref.pdf | 131 | API Reference AWS WAFV2 Required: Yes Response Syntax { "RuleGroup": { "MetricName": "string", "Name": "string", "RuleGroupId": "string" } } 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. RuleGroup Information about the RuleGroup that you specified in the GetRuleGroup request. Type: RuleGroup object Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 GetRuleGroup 686 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetRuleGroup 687 AWS WAFV2 GetSampledRequests 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. Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours. GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as an Amazon CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample. Request Syntax { "MaxItems": number, "RuleId": "string", "TimeWindow": { "EndTime": number, "StartTime": number }, "WebAclId": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. GetSampledRequests 688 AWS WAFV2 API Reference The request accepts the following data in JSON format. MaxItems The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received during the time range. If your resource received fewer requests than the value of MaxItems, GetSampledRequests returns information about all of them. Type: Long Valid Range: Minimum value of 1. Maximum value of 500. Required: Yes RuleId RuleId is one of three values: • The RuleId of the Rule or the RuleGroupId of the RuleGroup for which you want GetSampledRequests to return a sample of requests. • Default_Action, which causes GetSampledRequests to return a sample of the requests that didn't match any of the rules in the specified WebACL. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes TimeWindow The start date and time and the end date and time of the range for which you want GetSampledRequests to return a sample of 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. Type: TimeWindow object Required: Yes WebAclId The WebACLId of the WebACL for which you want GetSampledRequests to return a sample of requests. GetSampledRequests 689 AWS WAFV2 Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes Response Syntax { "PopulationSize": number, "SampledRequests": [ { "Action": "string", "Request": { "ClientIP": "string", "Country": "string", "Headers": [ { "Name": "string", "Value": "string" } ], "HTTPVersion": "string", "Method": "string", "URI": "string" }, "RuleWithinRuleGroup": "string", "Timestamp": number, "Weight": number } ], "TimeWindow": { "EndTime": number, "StartTime": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. GetSampledRequests 690 AWS WAFV2 API Reference The following data is returned in JSON format by the service. PopulationSize The total number of requests from which GetSampledRequests got a sample of MaxItems requests. If PopulationSize is less than MaxItems, the sample includes every request that your AWS resource received during the specified time range. Type: Long SampledRequests A complex type that contains detailed information about each of the requests in the sample. Type: Array of SampledHTTPRequest objects TimeWindow Usually, TimeWindow is |
waf-apiref-132 | waf-apiref.pdf | 132 | number, "StartTime": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. GetSampledRequests 690 AWS WAFV2 API Reference The following data is returned in JSON format by the service. PopulationSize The total number of requests from which GetSampledRequests got a sample of MaxItems requests. If PopulationSize is less than MaxItems, the sample includes every request that your AWS resource received during the specified time range. Type: Long SampledRequests A complex type that contains detailed information about each of the requests in the sample. Type: Array of SampledHTTPRequest objects TimeWindow Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. However, if your AWS resource received more than 5,000 requests during the time range that you specified in the request, GetSampledRequests returns the time range for the first 5,000 requests. Times are in Coordinated Universal Time (UTC) format. Type: TimeWindow object Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 GetSampledRequests 691 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetSampledRequests 692 AWS WAFV2 GetSizeConstraintSet 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. Returns the SizeConstraintSet specified by SizeConstraintSetId. Request Syntax { "SizeConstraintSetId": "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. SizeConstraintSetId The SizeConstraintSetId of the SizeConstraintSet that you want to get. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes GetSizeConstraintSet 693 API Reference AWS WAFV2 Response Syntax { "SizeConstraintSet": { "Name": "string", "SizeConstraints": [ { "ComparisonOperator": "string", "FieldToMatch": { "Data": "string", "Type": "string" }, "Size": number, "TextTransformation": "string" } ], "SizeConstraintSetId": "string" } } 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. SizeConstraintSet Information about the SizeConstraintSet that you specified in the GetSizeConstraintSet request. For more information, see the following topics: • SizeConstraintSet: Contains SizeConstraintSetId, SizeConstraints, and Name • SizeConstraints: Contains an array of SizeConstraint objects. Each SizeConstraint object contains FieldToMatch, TextTransformation, ComparisonOperator, and Size • FieldToMatch: Contains Data and Type Type: SizeConstraintSet object Errors For information about the errors that are common to all actions, see Common Errors. GetSizeConstraintSet 694 AWS WAFV2 WAFInternalErrorException API Reference The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetSizeConstraintSet 695 AWS WAFV2 API Reference GetSqlInjectionMatchSet 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. Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId. Request Syntax { "SqlInjectionMatchSetId": "string" } Request Parameters For information about the parameters that are common to all |
waf-apiref-133 | waf-apiref.pdf | 133 | AWS WAFV2 API Reference GetSqlInjectionMatchSet 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. Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId. Request Syntax { "SqlInjectionMatchSetId": "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. SqlInjectionMatchSetId The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to get. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes GetSqlInjectionMatchSet 696 API Reference AWS WAFV2 Response Syntax { "SqlInjectionMatchSet": { "Name": "string", "SqlInjectionMatchSetId": "string", "SqlInjectionMatchTuples": [ { "FieldToMatch": { "Data": "string", "Type": "string" }, "TextTransformation": "string" } ] } } 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. SqlInjectionMatchSet Information about the SqlInjectionMatchSet that you specified in the GetSqlInjectionMatchSet request. For more information, see the following topics: • SqlInjectionMatchSet: Contains Name, SqlInjectionMatchSetId, and an array of SqlInjectionMatchTuple objects • SqlInjectionMatchTuple: Each SqlInjectionMatchTuple object contains FieldToMatch and TextTransformation • FieldToMatch: Contains Data and Type Type: SqlInjectionMatchSet object Errors For information about the errors that are common to all actions, see Common Errors. GetSqlInjectionMatchSet 697 AWS WAFV2 WAFInternalErrorException API Reference The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetSqlInjectionMatchSet 698 AWS WAFV2 GetWebACL 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. Returns the WebACL that is specified by WebACLId. Request Syntax { "WebACLId": "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. WebACLId The WebACLId of the WebACL that you want to get. WebACLId is returned by CreateWebACL and by ListWebACLs. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes GetWebACL 699 API Reference AWS WAFV2 Response Syntax { "WebACL": { "DefaultAction": { "Type": "string" }, "MetricName": "string", "Name": "string", "Rules": [ { "Action": { "Type": "string" }, "ExcludedRules": [ { "RuleId": "string" } ], "OverrideAction": { "Type": "string" }, "Priority": number, "RuleId": "string", "Type": "string" } ], "WebACLArn": "string", "WebACLId": "string" } } 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. WebACL Information about the WebACL that you specified in the GetWebACL request. For more information, see the following topics: GetWebACL 700 AWS WAFV2 API Reference • WebACL: Contains DefaultAction, MetricName, Name, an array of Rule objects, and WebACLId • DefaultAction (Data type is WafAction): Contains Type • Rules: Contains an array of ActivatedRule objects, which contain Action, Priority, and RuleId • Action: Contains Type Type: WebACL object Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • |
waf-apiref-134 | waf-apiref.pdf | 134 | Contains Type Type: WebACL object Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET GetWebACL 701 API Reference AWS WAFV2 • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetWebACL 702 AWS WAFV2 GetXssMatchSet 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. Returns the XssMatchSet that is specified by XssMatchSetId. Request Syntax { "XssMatchSetId": "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. XssMatchSetId The XssMatchSetId of the XssMatchSet that you want to get. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes GetXssMatchSet 703 API Reference AWS WAFV2 Response Syntax { "XssMatchSet": { "Name": "string", "XssMatchSetId": "string", "XssMatchTuples": [ { "FieldToMatch": { "Data": "string", "Type": "string" }, "TextTransformation": "string" } ] } } 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. XssMatchSet Information about the XssMatchSet that you specified in the GetXssMatchSet request. For more information, see the following topics: • XssMatchSet: Contains Name, XssMatchSetId, and an array of XssMatchTuple objects • XssMatchTuple: Each XssMatchTuple object contains FieldToMatch and TextTransformation • FieldToMatch: Contains Data and Type Type: XssMatchSet object Errors For information about the errors that are common to all actions, see Common Errors. GetXssMatchSet 704 AWS WAFV2 WAFInternalErrorException API Reference The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetXssMatchSet 705 AWS WAFV2 API Reference ListActivatedRulesInRuleGroup 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. Returns an array of ActivatedRule objects. Request Syntax { "Limit": number, "NextMarker": "string", "RuleGroupId": "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. Limit Specifies the number of ActivatedRules that you want AWS WAF to return for this request. If you have more ActivatedRules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of ActivatedRules. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100. Required: No ListActivatedRulesInRuleGroup 706 AWS WAFV2 NextMarker API Reference If you specify a value for Limit and you have more ActivatedRules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ActivatedRules. For the second and subsequent ListActivatedRulesInRuleGroup requests, specify the value of NextMarker |
waf-apiref-135 | waf-apiref.pdf | 135 | for this request. If you have more ActivatedRules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of ActivatedRules. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100. Required: No ListActivatedRulesInRuleGroup 706 AWS WAFV2 NextMarker API Reference If you specify a value for Limit and you have more ActivatedRules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ActivatedRules. For the second and subsequent ListActivatedRulesInRuleGroup requests, specify the value of NextMarker from the previous response to get information about another batch of ActivatedRules. Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* Required: No RuleGroupId The RuleGroupId of the RuleGroup for which you want to get a list of ActivatedRule objects. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: No Response Syntax { "ActivatedRules": [ { "Action": { "Type": "string" }, "ExcludedRules": [ { "RuleId": "string" } ], "OverrideAction": { "Type": "string" ListActivatedRulesInRuleGroup 707 AWS WAFV2 API Reference }, "Priority": number, "RuleId": "string", "Type": "string" } ], "NextMarker": "string" } 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. ActivatedRules An array of ActivatedRules objects. Type: Array of ActivatedRule objects NextMarker If you have more ActivatedRules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more ActivatedRules, submit another ListActivatedRulesInRuleGroup request, and specify the NextMarker value from the response in the NextMarker value in the next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. ListActivatedRulesInRuleGroup 708 AWS WAFV2 HTTP Status Code: 500 WAFInvalidParameterException API Reference The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified an invalid parameter name. • You specified an invalid value. • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE. • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT. • You tried to create a RateBasedRule with a RateKey value other than IP. • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT. • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY. • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 ListActivatedRulesInRuleGroup 709 AWS WAFV2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference ListActivatedRulesInRuleGroup 710 AWS WAFV2 ListByteMatchSets 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. Returns an array of ByteMatchSetSummary objects. Request Syntax { "Limit": number, "NextMarker": "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. Limit Specifies the number of ByteMatchSet objects that you want AWS WAF to return for this request. If you have more ByteMatchSets objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of ByteMatchSet objects. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100. Required: No ListByteMatchSets 711 AWS WAFV2 NextMarker API Reference If you specify a value for Limit and you have more ByteMatchSets than the value of Limit, AWS WAF returns a NextMarker |
waf-apiref-136 | waf-apiref.pdf | 136 | Parameters. The request accepts the following data in JSON format. Limit Specifies the number of ByteMatchSet objects that you want AWS WAF to return for this request. If you have more ByteMatchSets objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of ByteMatchSet objects. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100. Required: No ListByteMatchSets 711 AWS WAFV2 NextMarker API Reference If you specify a value for Limit and you have more ByteMatchSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ByteMatchSets. For the second and subsequent ListByteMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of ByteMatchSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* Required: No Response Syntax { "ByteMatchSets": [ { "ByteMatchSetId": "string", "Name": "string" } ], "NextMarker": "string" } 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. ByteMatchSets An array of ByteMatchSetSummary objects. Type: Array of ByteMatchSetSummary objects ListByteMatchSets 712 AWS WAFV2 NextMarker API Reference If you have more ByteMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more ByteMatchSet objects, submit another ListByteMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 ListByteMatchSets 713 AWS WAFV2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference ListByteMatchSets 714 AWS WAFV2 ListGeoMatchSets 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. Returns an array of GeoMatchSetSummary objects in the response. Request Syntax { "Limit": number, "NextMarker": "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. Limit Specifies the number of GeoMatchSet objects that you want AWS WAF to return for this request. If you have more GeoMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of GeoMatchSet objects. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100. Required: No ListGeoMatchSets 715 AWS WAFV2 NextMarker API Reference If you specify a value for Limit and you have more GeoMatchSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of GeoMatchSet objects. For the second and subsequent ListGeoMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of GeoMatchSet objects. Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* Required: No Response Syntax { "GeoMatchSets": [ { "GeoMatchSetId": "string", "Name": "string" } ], "NextMarker": "string" } 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. GeoMatchSets An array of GeoMatchSetSummary objects. Type: Array of GeoMatchSetSummary objects ListGeoMatchSets 716 AWS WAFV2 NextMarker API Reference If you have more GeoMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more GeoMatchSet objects, submit another ListGeoMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* Errors |
waf-apiref-137 | waf-apiref.pdf | 137 | the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. GeoMatchSets An array of GeoMatchSetSummary objects. Type: Array of GeoMatchSetSummary objects ListGeoMatchSets 716 AWS WAFV2 NextMarker API Reference If you have more GeoMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more GeoMatchSet objects, submit another ListGeoMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 ListGeoMatchSets 717 AWS WAFV2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference ListGeoMatchSets 718 AWS WAFV2 ListIPSets 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. Returns an array of IPSetSummary objects in the response. Request Syntax { "Limit": number, "NextMarker": "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. Limit Specifies the number of IPSet objects that you want AWS WAF to return for this request. If you have more IPSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of IPSet objects. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100. Required: No ListIPSets 719 AWS WAFV2 NextMarker API Reference AWS WAF returns a NextMarker value in the response that allows you to list another group of IPSets. For the second and subsequent ListIPSets requests, specify the value of NextMarker from the previous response to get information about another batch of IPSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* Required: No Response Syntax { "IPSets": [ { "IPSetId": "string", "Name": "string" } ], "NextMarker": "string" } 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. IPSets An array of IPSetSummary objects. Type: Array of IPSetSummary objects NextMarker To list more IPSet objects, submit another ListIPSets request, and in the next request use the NextMarker response value as the NextMarker value. ListIPSets 720 AWS WAFV2 Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python ListIPSets 721 AWS WAFV2 • AWS SDK for Ruby V3 API Reference ListIPSets 722 AWS WAFV2 API Reference ListLoggingConfigurations 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. Returns an array |
waf-apiref-138 | waf-apiref.pdf | 138 | SDK for PHP V3 • AWS SDK for Python ListIPSets 721 AWS WAFV2 • AWS SDK for Ruby V3 API Reference ListIPSets 722 AWS WAFV2 API Reference ListLoggingConfigurations 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. Returns an array of LoggingConfiguration objects. Request Syntax { "Limit": number, "NextMarker": "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. Limit Specifies the number of LoggingConfigurations that you want AWS WAF to return for this request. If you have more LoggingConfigurations than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of LoggingConfigurations. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100. Required: No ListLoggingConfigurations 723 AWS WAFV2 NextMarker API Reference If you specify a value for Limit and you have more LoggingConfigurations than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of LoggingConfigurations. For the second and subsequent ListLoggingConfigurations requests, specify the value of NextMarker from the previous response to get information about another batch of ListLoggingConfigurations. Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* Required: No Response Syntax { "LoggingConfigurations": [ { "LogDestinationConfigs": [ "string" ], "RedactedFields": [ { "Data": "string", "Type": "string" } ], "ResourceArn": "string" } ], "NextMarker": "string" } 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. ListLoggingConfigurations 724 AWS WAFV2 LoggingConfigurations An array of LoggingConfiguration objects. Type: Array of LoggingConfiguration objects NextMarker API Reference If you have more LoggingConfigurations than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more LoggingConfigurations, submit another ListLoggingConfigurations request, and specify the NextMarker value from the response in the NextMarker value in the next request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified an invalid parameter name. • You specified an invalid value. • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE. • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT. • You tried to create a RateBasedRule with a RateKey value other than IP. ListLoggingConfigurations 725 AWS WAFV2 API Reference • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT. • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY. • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListLoggingConfigurations 726 AWS WAFV2 ListRateBasedRules 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. Returns an array of RuleSummary objects. Request Syntax { "Limit": number, "NextMarker": "string" } Request Parameters For information about the parameters that are common to all actions, |
waf-apiref-139 | waf-apiref.pdf | 139 | WAFV2 ListRateBasedRules 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. Returns an array of RuleSummary objects. Request Syntax { "Limit": number, "NextMarker": "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. Limit Specifies the number of Rules that you want AWS WAF to return for this request. If you have more Rules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100. Required: No ListRateBasedRules 727 AWS WAFV2 NextMarker API Reference If you specify a value for Limit and you have more Rules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of Rules. For the second and subsequent ListRateBasedRules requests, specify the value of NextMarker from the previous response to get information about another batch of Rules. Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* Required: No Response Syntax { "NextMarker": "string", "Rules": [ { "Name": "string", "RuleId": "string" } ] } 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. NextMarker If you have more Rules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more Rules, submit another ListRateBasedRules request, and specify the NextMarker value from the response in the NextMarker value in the next request. Type: String ListRateBasedRules 728 AWS WAFV2 API Reference Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* Rules An array of RuleSummary objects. Type: Array of RuleSummary objects Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin ListRateBasedRules 729 AWS WAFV2 • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference ListRateBasedRules 730 AWS WAFV2 ListRegexMatchSets 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. Returns an array of RegexMatchSetSummary objects. Request Syntax { "Limit": number, "NextMarker": "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. Limit Specifies the number of RegexMatchSet objects that you want AWS WAF to return for this request. If you have more RegexMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RegexMatchSet objects. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100. Required: No ListRegexMatchSets 731 AWS WAFV2 NextMarker API Reference If you specify a value for Limit and you have more RegexMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ByteMatchSets. For the second and subsequent ListRegexMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of RegexMatchSet objects. Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* Required: No Response Syntax { "NextMarker": "string", "RegexMatchSets": [ { "Name": "string", "RegexMatchSetId": "string" } ] } Response Elements If the action is successful, the service sends back an |
waf-apiref-140 | waf-apiref.pdf | 140 | value for Limit and you have more RegexMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ByteMatchSets. For the second and subsequent ListRegexMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of RegexMatchSet objects. Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* Required: No Response Syntax { "NextMarker": "string", "RegexMatchSets": [ { "Name": "string", "RegexMatchSetId": "string" } ] } 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. NextMarker If you have more RegexMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RegexMatchSet objects, submit another ListRegexMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request. ListRegexMatchSets 732 AWS WAFV2 Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* RegexMatchSets An array of RegexMatchSetSummary objects. Type: Array of RegexMatchSetSummary objects Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 ListRegexMatchSets 733 AWS WAFV2 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference ListRegexMatchSets 734 AWS WAFV2 ListRegexPatternSets 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. Returns an array of RegexPatternSetSummary objects. Request Syntax { "Limit": number, "NextMarker": "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. Limit Specifies the number of RegexPatternSet objects that you want AWS WAF to return for this request. If you have more RegexPatternSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RegexPatternSet objects. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100. Required: No ListRegexPatternSets 735 AWS WAFV2 NextMarker API Reference If you specify a value for Limit and you have more RegexPatternSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of RegexPatternSet objects. For the second and subsequent ListRegexPatternSets requests, specify the value of NextMarker from the previous response to get information about another batch of RegexPatternSet objects. Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* Required: No Response Syntax { "NextMarker": "string", "RegexPatternSets": [ { "Name": "string", "RegexPatternSetId": "string" } ] } 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. NextMarker If you have more RegexPatternSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RegexPatternSet objects, submit another ListRegexPatternSets request, and specify the NextMarker value from the response in the NextMarker value in the next request. ListRegexPatternSets 736 AWS WAFV2 Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* RegexPatternSets An array of RegexPatternSetSummary objects. Type: Array of RegexPatternSetSummary objects Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command |
waf-apiref-141 | waf-apiref.pdf | 141 | Maximum length of 1224. Pattern: .*\S.* RegexPatternSets An array of RegexPatternSetSummary objects. Type: Array of RegexPatternSetSummary objects Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 ListRegexPatternSets 737 AWS WAFV2 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference ListRegexPatternSets 738 AWS WAFV2 ListRuleGroups 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. Returns an array of RuleGroup objects. Request Syntax { "Limit": number, "NextMarker": "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. Limit Specifies the number of RuleGroups that you want AWS WAF to return for this request. If you have more RuleGroups than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RuleGroups. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100. Required: No ListRuleGroups 739 AWS WAFV2 NextMarker API Reference If you specify a value for Limit and you have more RuleGroups than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of RuleGroups. For the second and subsequent ListRuleGroups requests, specify the value of NextMarker from the previous response to get information about another batch of RuleGroups. Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* Required: No Response Syntax { "NextMarker": "string", "RuleGroups": [ { "Name": "string", "RuleGroupId": "string" } ] } 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. NextMarker If you have more RuleGroups than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RuleGroups, submit another ListRuleGroups request, and specify the NextMarker value from the response in the NextMarker value in the next request. ListRuleGroups 740 AWS WAFV2 Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* RuleGroups An array of RuleGroup objects. Type: Array of RuleGroupSummary objects Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListRuleGroups 741 AWS WAFV2 API Reference ListRuleGroups 742 AWS WAFV2 ListRules 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. Returns an array of RuleSummary objects. Request Syntax { "Limit": number, "NextMarker": "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. Limit Specifies the number of Rules that you want AWS WAF to return for this request. If you have more Rules than the number that you specify for Limit, the response includes a NextMarker value |
waf-apiref-142 | waf-apiref.pdf | 142 | WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. Returns an array of RuleSummary objects. Request Syntax { "Limit": number, "NextMarker": "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. Limit Specifies the number of Rules that you want AWS WAF to return for this request. If you have more Rules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100. Required: No ListRules 743 AWS WAFV2 NextMarker API Reference If you specify a value for Limit and you have more Rules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of Rules. For the second and subsequent ListRules requests, specify the value of NextMarker from the previous response to get information about another batch of Rules. Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* Required: No Response Syntax { "NextMarker": "string", "Rules": [ { "Name": "string", "RuleId": "string" } ] } 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. NextMarker If you have more Rules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more Rules, submit another ListRules request, and specify the NextMarker value from the response in the NextMarker value in the next request. Type: String ListRules 744 AWS WAFV2 API Reference Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* Rules An array of RuleSummary objects. Type: Array of RuleSummary objects Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin ListRules 745 AWS WAFV2 • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference ListRules 746 AWS WAFV2 ListSizeConstraintSets 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. Returns an array of SizeConstraintSetSummary objects. Request Syntax { "Limit": number, "NextMarker": "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. Limit Specifies the number of SizeConstraintSet objects that you want AWS WAF to return for this request. If you have more SizeConstraintSets objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of SizeConstraintSet objects. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100. Required: No ListSizeConstraintSets 747 AWS WAFV2 NextMarker API Reference If you specify a value for Limit and you have more SizeConstraintSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of SizeConstraintSets. For the second and subsequent ListSizeConstraintSets requests, specify the value of NextMarker from the previous response to get information about another batch of SizeConstraintSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* Required: No Response Syntax { "NextMarker": "string", "SizeConstraintSets": [ { "Name": "string", "SizeConstraintSetId": "string" } ] } 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. NextMarker If you have more SizeConstraintSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more SizeConstraintSet objects, submit another ListSizeConstraintSets request, and specify |
waf-apiref-143 | waf-apiref.pdf | 143 | to get information about another batch of SizeConstraintSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* Required: No Response Syntax { "NextMarker": "string", "SizeConstraintSets": [ { "Name": "string", "SizeConstraintSetId": "string" } ] } 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. NextMarker If you have more SizeConstraintSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more SizeConstraintSet objects, submit another ListSizeConstraintSets request, and specify the NextMarker value from the response in the NextMarker value in the next request. ListSizeConstraintSets 748 AWS WAFV2 Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* SizeConstraintSets An array of SizeConstraintSetSummary objects. Type: Array of SizeConstraintSetSummary objects Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 ListSizeConstraintSets 749 AWS WAFV2 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference ListSizeConstraintSets 750 AWS WAFV2 API Reference ListSqlInjectionMatchSets 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. Returns an array of SqlInjectionMatchSet objects. Request Syntax { "Limit": number, "NextMarker": "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. Limit Specifies the number of SqlInjectionMatchSet objects that you want AWS WAF to return for this request. If you have more SqlInjectionMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100. Required: No ListSqlInjectionMatchSets 751 AWS WAFV2 NextMarker API Reference If you specify a value for Limit and you have more SqlInjectionMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of SqlInjectionMatchSets. For the second and subsequent ListSqlInjectionMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of SqlInjectionMatchSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* Required: No Response Syntax { "NextMarker": "string", "SqlInjectionMatchSets": [ { "Name": "string", "SqlInjectionMatchSetId": "string" } ] } 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. NextMarker If you have more SqlInjectionMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more SqlInjectionMatchSet objects, submit another ListSqlInjectionMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request. ListSqlInjectionMatchSets 752 AWS WAFV2 Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* SqlInjectionMatchSets An array of SqlInjectionMatchSetSummary objects. Type: Array of SqlInjectionMatchSetSummary objects Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 ListSqlInjectionMatchSets 753 AWS WAFV2 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS |
waf-apiref-144 | waf-apiref.pdf | 144 | Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 ListSqlInjectionMatchSets 753 AWS WAFV2 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference ListSqlInjectionMatchSets 754 AWS WAFV2 API Reference ListSubscribedRuleGroups 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. Returns an array of RuleGroup objects that you are subscribed to. Request Syntax { "Limit": number, "NextMarker": "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. Limit Specifies the number of subscribed rule groups that you want AWS WAF to return for this request. If you have more objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of objects. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100. Required: No ListSubscribedRuleGroups 755 AWS WAFV2 NextMarker API Reference If you specify a value for Limit and you have more ByteMatchSetssubscribed rule groups than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of subscribed rule groups. For the second and subsequent ListSubscribedRuleGroupsRequest requests, specify the value of NextMarker from the previous response to get information about another batch of subscribed rule groups. Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* Required: No Response Syntax { "NextMarker": "string", "RuleGroups": [ { "MetricName": "string", "Name": "string", "RuleGroupId": "string" } ] } 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. NextMarker If you have more objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more objects, submit another ListSubscribedRuleGroups request, and specify the NextMarker value from the response in the NextMarker value in the next request. ListSubscribedRuleGroups 756 AWS WAFV2 Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* RuleGroups An array of RuleGroup objects. Type: Array of SubscribedRuleGroupSummary objects Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 ListSubscribedRuleGroups 757 AWS WAFV2 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference ListSubscribedRuleGroups 758 AWS WAFV2 ListTagsForResource 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. Retrieves the tags associated with the specified 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 |
waf-apiref-145 | waf-apiref.pdf | 145 | global use. Retrieves the tags associated with the specified 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. Request Syntax { "Limit": number, "NextMarker": "string", "ResourceARN": "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. Limit Type: Integer ListTagsForResource 759 AWS WAFV2 API Reference Valid Range: Minimum value of 0. Maximum value of 100. Required: No NextMarker Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* Required: No ResourceARN Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* Required: Yes Response Syntax { "NextMarker": "string", "TagInfoForResource": { "ResourceARN": "string", "TagList": [ { "Key": "string", "Value": "string" } ] } } Response Elements If the action is successful, the service sends back an HTTP 200 response. ListTagsForResource 760 AWS WAFV2 API Reference The following data is returned in JSON format by the service. NextMarker Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* TagInfoForResource Type: TagInfoForResource object Errors For information about the errors that are common to all actions, see Common Errors. WAFBadRequestException HTTP Status Code: 400 WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified an invalid parameter name. • You specified an invalid value. • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE. • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT. ListTagsForResource 761 AWS WAFV2 API Reference • You tried to create a RateBasedRule with a RateKey value other than IP. • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT. • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY. • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 WAFTagOperationException HTTP Status Code: 400 WAFTagOperationInternalErrorException HTTP Status Code: 500 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 ListTagsForResource 762 AWS WAFV2 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference ListTagsForResource 763 AWS WAFV2 ListWebACLs 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. Returns an array of WebACLSummary objects in the response. Request Syntax { "Limit": number, "NextMarker": "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. Limit Specifies the number of WebACL objects that you want AWS WAF to return for this request. If you have more WebACL objects than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of WebACL objects. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100. Required: No ListWebACLs 764 AWS WAFV2 NextMarker API Reference If you specify a value for Limit and you have more WebACL objects than the number that you specify for Limit, AWS WAF returns a NextMarker value in the response that allows |
waf-apiref-146 | waf-apiref.pdf | 146 | Specifies the number of WebACL objects that you want AWS WAF to return for this request. If you have more WebACL objects than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of WebACL objects. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100. Required: No ListWebACLs 764 AWS WAFV2 NextMarker API Reference If you specify a value for Limit and you have more WebACL objects than the number that you specify for Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of WebACL objects. For the second and subsequent ListWebACLs requests, specify the value of NextMarker from the previous response to get information about another batch of WebACL objects. Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* Required: No Response Syntax { "NextMarker": "string", "WebACLs": [ { "Name": "string", "WebACLId": "string" } ] } 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. NextMarker If you have more WebACL objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more WebACL objects, submit another ListWebACLs request, and specify the NextMarker value from the response in the NextMarker value in the next request. ListWebACLs 765 AWS WAFV2 Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* WebACLs An array of WebACLSummary objects. Type: Array of WebACLSummary objects Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 ListWebACLs 766 AWS WAFV2 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference ListWebACLs 767 AWS WAFV2 ListXssMatchSets 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. Returns an array of XssMatchSet objects. Request Syntax { "Limit": number, "NextMarker": "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. Limit Specifies the number of XssMatchSet objects that you want AWS WAF to return for this request. If you have more XssMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100. Required: No ListXssMatchSets 768 AWS WAFV2 NextMarker API Reference If you specify a value for Limit and you have more XssMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of XssMatchSets. For the second and subsequent ListXssMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of XssMatchSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* Required: No Response Syntax { "NextMarker": "string", "XssMatchSets": [ { "Name": "string", "XssMatchSetId": "string" } ] } 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. NextMarker If you have more XssMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more XssMatchSet objects, submit another ListXssMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request. ListXssMatchSets 769 AWS WAFV2 Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* XssMatchSets An array of XssMatchSetSummary objects. Type: Array of XssMatchSetSummary objects Errors For information about the errors that are common to |
waf-apiref-147 | waf-apiref.pdf | 147 | following data is returned in JSON format by the service. NextMarker If you have more XssMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more XssMatchSet objects, submit another ListXssMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request. ListXssMatchSets 769 AWS WAFV2 Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* XssMatchSets An array of XssMatchSetSummary objects. Type: Array of XssMatchSetSummary objects Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 ListXssMatchSets 770 AWS WAFV2 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference ListXssMatchSets 771 AWS WAFV2 API Reference PutLoggingConfiguration 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. Associates a LoggingConfiguration with a specified web ACL. You can access information about all traffic that AWS WAF inspects using the following steps: 1. Create an Amazon Data Firehose. Create the data firehose with a PUT source and in the region that you are operating. However, if you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia). Give the data firehose a name that starts with the prefix aws-waf-logs-. For example, aws- waf-logs-us-east-2-analytics. Note Do not create the data firehose using a Kinesis stream as your source. 2. Associate that firehose to your web ACL using a PutLoggingConfiguration request. When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide. PutLoggingConfiguration 772 API Reference AWS WAFV2 Request Syntax { "LoggingConfiguration": { "LogDestinationConfigs": [ "string" ], "RedactedFields": [ { "Data": "string", "Type": "string" } ], "ResourceArn": "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. LoggingConfiguration The Amazon Data Firehose that contains the inspected traffic information, the redacted fields details, and the Amazon Resource Name (ARN) of the web ACL to monitor. Note When specifying Type in RedactedFields, you must use one of the following values: URI, QUERY_STRING, HEADER, or METHOD. Type: LoggingConfiguration object Required: Yes Response Syntax { "LoggingConfiguration": { PutLoggingConfiguration 773 AWS WAFV2 API Reference "LogDestinationConfigs": [ "string" ], "RedactedFields": [ { "Data": "string", "Type": "string" } ], "ResourceArn": "string" } } 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. LoggingConfiguration The LoggingConfiguration that you submitted in the request. Type: LoggingConfiguration object Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 WAFServiceLinkedRoleErrorException AWS WAF is not able to access the service linked role. This can be caused by a previous PutLoggingConfiguration request, which can lock the service linked role for about 20 PutLoggingConfiguration 774 AWS WAFV2 API Reference seconds. Please try your request again. The service linked role can also be locked by a previous DeleteServiceLinkedRole request, which can lock the role for 15 minutes or more. If you recently made a DeleteServiceLinkedRole, wait at least 15 minutes and try the request again. If you receive this same exception again, you will have to wait additional time until the role is unlocked. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change |
waf-apiref-148 | waf-apiref.pdf | 148 | lock the service linked role for about 20 PutLoggingConfiguration 774 AWS WAFV2 API Reference seconds. Please try your request again. The service linked role can also be locked by a previous DeleteServiceLinkedRole request, which can lock the role for 15 minutes or more. If you recently made a DeleteServiceLinkedRole, wait at least 15 minutes and try the request again. If you receive this same exception again, you will have to wait additional time until the role is unlocked. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 PutLoggingConfiguration 775 AWS WAFV2 PutPermissionPolicy 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. Attaches an IAM policy to the specified resource. The only supported use for this action is to share a RuleGroup across accounts. The PutPermissionPolicy is subject to the following restrictions: • You can attach only one policy with each PutPermissionPolicy request. • The policy must include an Effect, Action and Principal. • Effect must specify Allow. • The Action in the policy must be waf:UpdateWebACL, waf-regional:UpdateWebACL, waf:GetRuleGroup and waf-regional:GetRuleGroup . Any extra or wildcard actions in the policy will be rejected. • The policy cannot include a Resource parameter. • The ARN in the request must be a valid RuleGroup ARN and the RuleGroup must exist in the same region. • The user making the request must be the owner of the RuleGroup. • Your policy must be composed using IAM Policy version 2012-10-17. For more information, see Policies and permissions in IAM. An example of a valid policy parameter is shown in the Examples section below. Request Syntax { PutPermissionPolicy 776 AWS WAFV2 "Policy": "string", "ResourceArn": "string" } Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Policy The policy to attach to the specified RuleGroup. Type: String Length Constraints: Minimum length of 1. Maximum length of 395000. Pattern: .*\S.* Required: Yes ResourceArn The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy. Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. PutPermissionPolicy 777 AWS WAFV2 WAFInternalErrorException API Reference The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidPermissionPolicyException The operation failed because the specified policy is not in the proper format. The policy is subject to the following restrictions: • You can attach only one policy with each PutPermissionPolicy request. • The policy must include an Effect, Action and Principal. • Effect must specify Allow. • The Action in the policy must be waf:UpdateWebACL, waf-regional:UpdateWebACL, waf:GetRuleGroup and waf-regional:GetRuleGroup . Any extra or wildcard actions in the policy will be rejected. • The policy cannot include a Resource parameter. • The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region. • The user making the request must be the owner of the RuleGroup. • Your policy must be composed using IAM Policy version 2012-10-17. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. HTTP Status Code: 400 PutPermissionPolicy 778 API Reference AWS WAFV2 Examples Example policy parameter - No escape characters This example illustrates one usage of PutPermissionPolicy. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::111111111111:user/MyUserName" }, "Action": [ "waf:UpdateWebACL", "waf-regional:UpdateWebACL", "waf:GetRuleGroup", "waf-regional:GetRuleGroup" ] } ] } Example policy parameter - () This |
waf-apiref-149 | waf-apiref.pdf | 149 | IAM Policy version 2012-10-17. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. HTTP Status Code: 400 PutPermissionPolicy 778 API Reference AWS WAFV2 Examples Example policy parameter - No escape characters This example illustrates one usage of PutPermissionPolicy. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "AWS": "arn:aws:iam::111111111111:user/MyUserName" }, "Action": [ "waf:UpdateWebACL", "waf-regional:UpdateWebACL", "waf:GetRuleGroup", "waf-regional:GetRuleGroup" ] } ] } Example policy parameter - () This example illustrates one usage of PutPermissionPolicy. {\"Version\":\"2012-10-17\",\"Statement\":[{\"Effect\":\"Allow\",\"Principal\":{\"AWS \":\"arn:aws:iam::111111111111:user\/MyUserName\"},\"Action\":[\"waf:UpdateWebACL\", \"waf-regional:UpdateWebACL\",\"waf:GetRuleGroup\",\"waf-regional:GetRuleGroup\"]}]} See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ PutPermissionPolicy 779 AWS WAFV2 • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference PutPermissionPolicy 780 AWS WAFV2 TagResource 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. Associates tags with the specified 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 use this action to tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules. Request Syntax { "ResourceARN": "string", "Tags": [ { "Key": "string", "Value": "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. TagResource 781 AWS WAFV2 ResourceARN Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. API Reference Pattern: .*\S.* Required: Yes Tags Type: Array of Tag objects Array Members: Minimum number of 1 item. Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. WAFBadRequestException HTTP Status Code: 400 WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified an invalid parameter name. • You specified an invalid value. TagResource 782 AWS WAFV2 API Reference • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE. • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT. • You tried to create a RateBasedRule with a RateKey value other than IP. • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT. • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY. • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated. HTTP Status Code: 400 WAFLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see AWS WAF Classic quotas in the AWS WAF Developer Guide. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 WAFTagOperationException HTTP Status Code: 400 WAFTagOperationInternalErrorException HTTP Status Code: 500 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: TagResource 783 API Reference AWS WAFV2 • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for |
waf-apiref-150 | waf-apiref.pdf | 150 | AWS account. For more information, see AWS WAF Classic quotas in the AWS WAF Developer Guide. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 WAFTagOperationException HTTP Status Code: 400 WAFTagOperationInternalErrorException HTTP Status Code: 500 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: TagResource 783 API Reference AWS WAFV2 • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 TagResource 784 AWS WAFV2 UntagResource 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. Request Syntax { "ResourceARN": "string", "TagKeys": [ "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. ResourceARN Type: String Length Constraints: Minimum length of 1. Maximum length of 1224. Pattern: .*\S.* Required: Yes TagKeys Type: Array of strings UntagResource 785 AWS WAFV2 API Reference Array Members: Minimum number of 1 item. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. WAFBadRequestException HTTP Status Code: 400 WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified an invalid parameter name. • You specified an invalid value. • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE. • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT. • You tried to create a RateBasedRule with a RateKey value other than IP. • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT. UntagResource 786 AWS WAFV2 API Reference • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY. • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 WAFTagOperationException HTTP Status Code: 400 WAFTagOperationInternalErrorException HTTP Status Code: 500 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 UntagResource 787 AWS WAFV2 API Reference UntagResource 788 AWS WAFV2 UpdateByteMatchSet 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. Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values: • Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate object, you delete the existing object and add a new one. • 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 bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS |
waf-apiref-151 | waf-apiref.pdf | 151 | For each ByteMatchTuple object, you specify the following values: • Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate object, you delete the existing object and add a new one. • 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 bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or AWS SDKs, see TargetString in the ByteMatchTuple data type. • Where to look, such as at the beginning or the end of a query string. • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string. For example, you can add a ByteMatchSetUpdate object that matches web requests in which User-Agent headers contain the string BadBot. You can then configure AWS WAF to block those requests. To create and configure a ByteMatchSet, perform the following steps: 1. Create a ByteMatchSet. For more information, see CreateByteMatchSet. 2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request. UpdateByteMatchSet 789 AWS WAFV2 API Reference 3. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI path) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. Request Syntax { "ByteMatchSetId": "string", "ChangeToken": "string", "Updates": [ { "Action": "string", "ByteMatchTuple": { "FieldToMatch": { "Data": "string", "Type": "string" }, "PositionalConstraint": "string", "TargetString": blob, "TextTransformation": "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. ByteMatchSetId The ByteMatchSetId of the ByteMatchSet that you want to update. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. UpdateByteMatchSet 790 API Reference AWS WAFV2 Pattern: .*\S.* Required: Yes ChangeToken The value returned by the most recent call to GetChangeToken. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes Updates An array of ByteMatchSetUpdate objects that you want to insert into or delete from a ByteMatchSet. For more information, see the applicable data types: • ByteMatchSetUpdate: Contains Action and ByteMatchTuple • ByteMatchTuple: Contains FieldToMatch, PositionalConstraint, TargetString, and TextTransformation • FieldToMatch: Contains Data and Type Type: Array of ByteMatchSetUpdate objects Array Members: Minimum number of 1 item. Required: Yes Response Syntax { "ChangeToken": "string" } 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. UpdateByteMatchSet 791 AWS WAFV2 ChangeToken API Reference The ChangeToken that you used to submit the UpdateByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFInvalidOperationException The operation failed because there was nothing to do. For example: • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL. • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet. • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL. • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL. • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL. UpdateByteMatchSet 792 AWS WAFV2 HTTP Status Code: 400 WAFInvalidParameterException API Reference The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified an invalid parameter name. • You specified an invalid value. • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE. • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT. • You tried to create a RateBasedRule with a |
waf-apiref-152 | waf-apiref.pdf | 152 | add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL. UpdateByteMatchSet 792 AWS WAFV2 HTTP Status Code: 400 WAFInvalidParameterException API Reference The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified an invalid parameter name. • You specified an invalid value. • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE. • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT. • You tried to create a RateBasedRule with a RateKey value other than IP. • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT. • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY. • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated. HTTP Status Code: 400 WAFLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see AWS WAF Classic quotas in the AWS WAF Developer Guide. HTTP Status Code: 400 WAFNonexistentContainerException The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example: • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist. • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist. • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist. UpdateByteMatchSet 793 AWS WAFV2 API Reference • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 UpdateByteMatchSet 794 AWS WAFV2 UpdateGeoMatchSet 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. Inserts or deletes GeoMatchConstraint objects in an GeoMatchSet. For each GeoMatchConstraint object, you specify the following values: • Whether to insert or delete the object from the array. If you want to change an GeoMatchConstraint object, you delete the existing object and add a new one. • The Type. The only valid value for Type is Country. • The Value, which is a two character code for the country to add to the GeoMatchConstraint object. Valid codes are listed in GeoMatchConstraint:Value. To create and configure an GeoMatchSet, perform the following steps: 1. Submit a CreateGeoMatchSet request. 2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateGeoMatchSet request. 3. Submit an UpdateGeoMatchSet request to specify the country that you want AWS WAF to watch for. When you update an GeoMatchSet, you specify the country that you want to add and/or the country that you want to delete. If you want to change a country, you delete the existing country and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. UpdateGeoMatchSet 795 API Reference AWS WAFV2 Request Syntax { "ChangeToken": "string", "GeoMatchSetId": "string", "Updates": [ { "Action": "string", "GeoMatchConstraint": { "Type": "string", "Value": "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. ChangeToken The value returned by the most recent call to GetChangeToken. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes GeoMatchSetId |
waf-apiref-153 | waf-apiref.pdf | 153 | how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. UpdateGeoMatchSet 795 API Reference AWS WAFV2 Request Syntax { "ChangeToken": "string", "GeoMatchSetId": "string", "Updates": [ { "Action": "string", "GeoMatchConstraint": { "Type": "string", "Value": "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. ChangeToken The value returned by the most recent call to GetChangeToken. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes GeoMatchSetId The GeoMatchSetId of the GeoMatchSet that you want to update. GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. UpdateGeoMatchSet 796 AWS WAFV2 Pattern: .*\S.* Required: Yes Updates API Reference An array of GeoMatchSetUpdate objects that you want to insert into or delete from an GeoMatchSet. For more information, see the applicable data types: • GeoMatchSetUpdate: Contains Action and GeoMatchConstraint • GeoMatchConstraint: Contains Type and Value You can have only one Type and Value per GeoMatchConstraint. To add multiple countries, include multiple GeoMatchSetUpdate objects in your request. Type: Array of GeoMatchSetUpdate objects Array Members: Minimum number of 1 item. Required: Yes Response Syntax { "ChangeToken": "string" } 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. ChangeToken The ChangeToken that you used to submit the UpdateGeoMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. UpdateGeoMatchSet 797 AWS WAFV2 Pattern: .*\S.* Errors API Reference For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFInvalidOperationException The operation failed because there was nothing to do. For example: • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL. • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet. • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL. • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL. • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL. HTTP Status Code: 400 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified an invalid parameter name. • You specified an invalid value. UpdateGeoMatchSet 798 AWS WAFV2 API Reference • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE. • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT. • You tried to create a RateBasedRule with a RateKey value other than IP. • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT. • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY. • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated. HTTP Status Code: 400 WAFLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see AWS WAF Classic quotas in the AWS WAF Developer Guide. HTTP Status Code: 400 WAFNonexistentContainerException The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example: • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist. • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist. • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist. • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. UpdateGeoMatchSet 799 AWS WAFV2 HTTP Status Code: 400 WAFReferencedItemException API Reference The operation failed because you tried to |
waf-apiref-154 | waf-apiref.pdf | 154 | Rule to or delete a Rule from a WebACL that doesn't exist. • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist. • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist. • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. UpdateGeoMatchSet 799 AWS WAFV2 HTTP Status Code: 400 WAFReferencedItemException API Reference The operation failed because you tried to delete an object that is still in use. For example: • You tried to delete a ByteMatchSet that is still referenced by a Rule. • You tried to delete a Rule that is still referenced by a WebACL. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 UpdateGeoMatchSet 800 AWS WAFV2 UpdateIPSet 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. Inserts or deletes IPSetDescriptor objects in an IPSet. For each IPSetDescriptor object, you specify the following values: • Whether to insert or delete the object from the array. If you want to change an IPSetDescriptor object, you delete the existing object and add a new one. • The IP address version, IPv4 or IPv6. • The IP address in CIDR notation, for example, 192.0.2.0/24 (for the range of IP addresses from 192.0.2.0 to 192.0.2.255) or 192.0.2.44/32 (for the individual IP address 192.0.2.44). 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. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. IPv6 addresses can be represented using any of the following formats: • 1111:0000:0000:0000:0000:0000:0000:0111/128 • 1111:0:0:0:0:0:0:0111/128 • 1111::0111/128 • 1111::111/128 You use an IPSet to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests UpdateIPSet 801 AWS WAFV2 API Reference from one or a small number of IP addresses and you want to block the requests, you can create an IPSet that specifies those IP addresses, and then configure AWS WAF to block the requests. To create and configure an IPSet, perform the following steps: 1. Submit a CreateIPSet request. 2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. 3. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for. When you update an IPSet, you specify the IP addresses that you want to add and the IP addresses that you want to delete. If you want to change an IP address, delete the existing IP address and add the new one. You can update a maximum of 1,000 addresses in a single request. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide. Request Syntax { "ChangeToken": "string", "IPSetId": "string", "Updates": [ { "Action": "string", "IPSetDescriptor": { "Type": "string", "Value": "string" } } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. UpdateIPSet 802 AWS WAFV2 API Reference The request accepts the following data in JSON format. ChangeToken The value returned by the most recent call to GetChangeToken. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes IPSetId The IPSetId of the IPSet that you want to update. IPSetId is returned by CreateIPSet and by ListIPSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes Updates An array of IPSetUpdate objects that you want to insert into or delete from an IPSet. For more information, |
waf-apiref-155 | waf-apiref.pdf | 155 | see Common Parameters. UpdateIPSet 802 AWS WAFV2 API Reference The request accepts the following data in JSON format. ChangeToken The value returned by the most recent call to GetChangeToken. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes IPSetId The IPSetId of the IPSet that you want to update. IPSetId is returned by CreateIPSet and by ListIPSets. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes Updates An array of IPSetUpdate objects that you want to insert into or delete from an IPSet. For more information, see the applicable data types: • IPSetUpdate: Contains Action and IPSetDescriptor • IPSetDescriptor: Contains Type and Value You can specify a maximum of 1,000 addresses in a single request, for example, in a single request you can insert 999 addresses and delete 1 address, but you can't insert 999 addresses and delete 2 addresses. Type: Array of IPSetUpdate objects Array Members: Minimum number of 1 item. Required: Yes UpdateIPSet 803 AWS WAFV2 Response Syntax { "ChangeToken": "string" } Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ChangeToken The ChangeToken that you used to submit the UpdateIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFInvalidOperationException The operation failed because there was nothing to do. For example: UpdateIPSet 804 AWS WAFV2 API Reference • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL. • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet. • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL. • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL. • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL. HTTP Status Code: 400 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified an invalid parameter name. • You specified an invalid value. • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE. • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT. • You tried to create a RateBasedRule with a RateKey value other than IP. • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT. • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY. • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated. HTTP Status Code: 400 WAFLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see AWS WAF Classic quotas in the AWS WAF Developer Guide. UpdateIPSet 805 AWS WAFV2 API Reference HTTP Status Code: 400 WAFNonexistentContainerException The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example: • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist. • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist. • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist. • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 WAFReferencedItemException The operation failed because you tried to delete an object that is still in use. For example: • You tried to delete a ByteMatchSet that is still referenced by a Rule. • You tried to delete a Rule that is still referenced by a WebACL. HTTP Status Code: 400 WAFStaleDataException The |
waf-apiref-156 | waf-apiref.pdf | 156 | to or delete an IP address from an IPSet that doesn't exist. • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 WAFReferencedItemException The operation failed because you tried to delete an object that is still in use. For example: • You tried to delete a ByteMatchSet that is still referenced by a Rule. • You tried to delete a Rule that is still referenced by a WebACL. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface UpdateIPSet 806 API Reference AWS WAFV2 • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 UpdateIPSet 807 AWS WAFV2 UpdateRateBasedRule 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. Inserts or deletes Predicate objects in a rule and updates the RateLimit in the rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to block or count. The RateLimit specifies the number of requests every five minutes that triggers the rule. If you add more than one predicate to a RateBasedRule, a request must match all the predicates and exceed the RateLimit to be counted or blocked. For example, suppose you add the following to a RateBasedRule: • An IPSet that matches the IP address 192.0.2.44/32 • A ByteMatchSet that matches BadBot in the User-Agent header Further, you specify a RateLimit of 1,000. You then add the RateBasedRule to a WebACL and specify that you want to block requests that satisfy the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions much be received at a rate of more than 1,000 every five minutes. If the rate drops below this limit, AWS WAF no longer blocks the requests. As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule: • A ByteMatchSet with FieldToMatch of URI UpdateRateBasedRule 808 AWS WAFV2 API Reference • A PositionalConstraint of STARTS_WITH • A TargetString of login Further, you specify a RateLimit of 1,000. By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site. Request Syntax { "ChangeToken": "string", "RateLimit": number, "RuleId": "string", "Updates": [ { "Action": "string", "Predicate": { "DataId": "string", "Negated": boolean, "Type": "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. ChangeToken The value returned by the most recent call to GetChangeToken. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* UpdateRateBasedRule 809 AWS WAFV2 Required: Yes RateLimit API Reference The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule. Type: Long Valid Range: Minimum value of 100. Maximum value of 2000000000. Required: Yes RuleId The RuleId of the RateBasedRule that you want to update. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes Updates An array of RuleUpdate objects that you want to insert into or delete from a RateBasedRule. Type: Array of RuleUpdate objects Required: Yes Response Syntax { "ChangeToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. UpdateRateBasedRule 810 AWS WAFV2 API Reference The following data is returned |
waf-apiref-157 | waf-apiref.pdf | 157 | value of 100. Maximum value of 2000000000. Required: Yes RuleId The RuleId of the RateBasedRule that you want to update. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes Updates An array of RuleUpdate objects that you want to insert into or delete from a RateBasedRule. Type: Array of RuleUpdate objects Required: Yes Response Syntax { "ChangeToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. UpdateRateBasedRule 810 AWS WAFV2 API Reference The following data is returned in JSON format by the service. ChangeToken The ChangeToken that you used to submit the UpdateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException The operation failed because of a system problem, even though the request was valid. Retry your request. HTTP Status Code: 500 WAFInvalidAccountException The operation failed because you tried to create, update, or delete an object by using an invalid account identifier. HTTP Status Code: 400 WAFInvalidOperationException The operation failed because there was nothing to do. For example: • You tried to remove a Rule from a WebACL, but the Rule isn't in the specified WebACL. • You tried to remove an IP address from an IPSet, but the IP address isn't in the specified IPSet. • You tried to remove a ByteMatchTuple from a ByteMatchSet, but the ByteMatchTuple isn't in the specified WebACL. • You tried to add a Rule to a WebACL, but the Rule already exists in the specified WebACL. UpdateRateBasedRule 811 AWS WAFV2 API Reference • You tried to add a ByteMatchTuple to a ByteMatchSet, but the ByteMatchTuple already exists in the specified WebACL. HTTP Status Code: 400 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified an invalid parameter name. • You specified an invalid value. • You tried to update an object (ByteMatchSet, IPSet, Rule, or WebACL) using an action other than INSERT or DELETE. • You tried to create a WebACL with a DefaultAction Type other than ALLOW, BLOCK, or COUNT. • You tried to create a RateBasedRule with a RateKey value other than IP. • You tried to update a WebACL with a WafAction Type other than ALLOW, BLOCK, or COUNT. • You tried to update a ByteMatchSet with a FieldToMatch Type other than HEADER, METHOD, QUERY_STRING, URI, or BODY. • You tried to update a ByteMatchSet with a Field of HEADER but no value for Data. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL cannot be associated. HTTP Status Code: 400 WAFLimitsExceededException The operation exceeds a resource limit, for example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see AWS WAF Classic quotas in the AWS WAF Developer Guide. HTTP Status Code: 400 WAFNonexistentContainerException The operation failed because you tried to add an object to or delete an object from another object that doesn't exist. For example: • You tried to add a Rule to or delete a Rule from a WebACL that doesn't exist. UpdateRateBasedRule 812 AWS WAFV2 API Reference • You tried to add a ByteMatchSet to or delete a ByteMatchSet from a Rule that doesn't exist. • You tried to add an IP address to or delete an IP address from an IPSet that doesn't exist. • You tried to add a ByteMatchTuple to or delete a ByteMatchTuple from a ByteMatchSet that doesn't exist. HTTP Status Code: 400 WAFNonexistentItemException The operation failed because the referenced object doesn't exist. HTTP Status Code: 400 WAFReferencedItemException The operation failed because you tried to delete an object that is still in use. For example: • You tried to delete a ByteMatchSet that is still referenced by a Rule. • You tried to delete a Rule that is still referenced by a WebACL. HTTP Status Code: 400 WAFStaleDataException The operation failed because you tried to create, update, or delete an object by using a change token that has already been used. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 UpdateRateBasedRule 813 AWS WAFV2 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.