Table of Contents
A low-level client representing AWS WAFV2:
import boto3
client = boto3.client('wafv2')
These are the available methods:
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Associates a Web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
For AWS CloudFront, you can associate the Web ACL by providing the ARN of the WebACL to the CloudFront API call UpdateDistribution . For information, see UpdateDistribution .
See also: AWS API Documentation
Request Syntax
response = client.associate_web_acl(
WebACLArn='string',
ResourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the Web ACL that you want to associate with the resource.
[REQUIRED]
The Amazon Resource Name (ARN) of the resource to associate with the web ACL.
The ARN must be in one of the following formats:
dict
Response Syntax
{}
Response Structure
Check if an operation can be paginated.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. You can use this to check the capacity requirements for the rules you want to use in a RuleGroup or WebACL .
AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
See also: AWS API Documentation
Request Syntax
response = client.check_capacity(
Scope='CLOUDFRONT'|'REGIONAL',
Rules=[
{
'Name': 'string',
'Priority': 123,
'Statement': {
'ByteMatchStatement': {
'SearchString': b'bytes',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {}
,
'Method': {}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
],
'PositionalConstraint': 'EXACTLY'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CONTAINS_WORD'
},
'SqliMatchStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {}
,
'Method': {}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
]
},
'XssMatchStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {}
,
'Method': {}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
]
},
'SizeConstraintStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {}
,
'Method': {}
},
'ComparisonOperator': 'EQ'|'NE'|'LE'|'LT'|'GE'|'GT',
'Size': 123,
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
]
},
'GeoMatchStatement': {
'CountryCodes': [
'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CD'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KP'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'US'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW',
]
},
'RuleGroupReferenceStatement': {
'ARN': 'string',
'ExcludedRules': [
{
'Name': 'string'
},
]
},
'IPSetReferenceStatement': {
'ARN': 'string'
},
'RegexPatternSetReferenceStatement': {
'ARN': 'string',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {}
,
'Method': {}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
]
},
'RateBasedStatement': {
'Limit': 123,
'AggregateKeyType': 'IP',
'ScopeDownStatement': {'... recursive ...'}
},
'AndStatement': {
'Statements': [
{'... recursive ...'},
]
},
'OrStatement': {
'Statements': [
{'... recursive ...'},
]
},
'NotStatement': {
'Statement': {'... recursive ...'}
},
'ManagedRuleGroupStatement': {
'VendorName': 'string',
'Name': 'string',
'ExcludedRules': [
{
'Name': 'string'
},
]
}
},
'Action': {
'Block': {}
,
'Allow': {}
,
'Count': {}
},
'OverrideAction': {
'Count': {}
,
'None': {}
},
'VisibilityConfig': {
'SampledRequestsEnabled': True|False,
'CloudWatchMetricsEnabled': True|False,
'MetricName': 'string'
}
},
]
)
[REQUIRED]
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
[REQUIRED]
An array of Rule that you're configuring to use in a rule group or web ACL.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
A single rule, which you can use in a WebACL or RuleGroup to identify web requests that you want to allow, block, or count. 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.
A friendly name of the rule. You can't change the name of a Rule after you create it.
If you define more than one Rule in a WebACL , AWS WAF evaluates each request against the Rules in order based on the value of Priority . AWS WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.
The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement .
A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement.
A string value that you want AWS WAF to search for. AWS WAF searches only in the part of web requests that you designate for inspection in FieldToMatch . The maximum length of the value is 50 bytes.
Valid values depend on the areas that you specify for inspection in FieldToMatch :
If SearchString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.
If you're using the AWS WAF API
Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.
For example, suppose the value of Type is HEADER and the value of Data is User-Agent . If you want to search the User-Agent header for the value BadBot , you base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90 , in the value of SearchString .
If you're using the AWS CLI or one of the AWS SDKs
The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
The name of the query header to inspect.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
The name of the query argument to inspect.
Inspect all query arguments.
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
The area within the portion of a web request that you want AWS WAF to search for SearchString . Valid values include the following:
CONTAINS
The specified part of the web request must include the value of SearchString , but the location doesn't matter.
CONTAINS_WORD
The specified part of the web request must include the value of SearchString , and SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, SearchString must be a word, which means that both of the following are true:
EXACTLY
The value of the specified part of the web request must exactly match the value of SearchString .
STARTS_WITH
The value of SearchString must appear at the beginning of the specified part of the web request.
ENDS_WITH
The value of SearchString must appear at the end of the specified part of the web request.
Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
The name of the query header to inspect.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
The name of the query argument to inspect.
Inspect all query arguments.
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings.
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
The name of the query header to inspect.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
The name of the query argument to inspect.
Inspect all query arguments.
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.
If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes.
If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
The name of the query header to inspect.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
The name of the query argument to inspect.
Inspect all query arguments.
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
The operator to use to compare the request part to the size setting.
The size, in byte, to compare to the request part, after any transformations.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
A rule statement used to identify web requests based on country of origin.
An array of two-character country codes, for example, [ "US", "CN" ] , from the alpha-2 country ISO codes of the ISO 3166 international standard.
A rule statement used to run the rules that are defined in a RuleGroup . To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.
You cannot nest a RuleGroupReferenceStatement , for example for use inside a NotStatement or OrStatement . It can only be referenced as a top-level statement within a rule.
The Amazon Resource Name (ARN) of the entity.
The names of rules that are in the referenced rule group, but that you want AWS WAF to exclude from processing for this rule statement.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Specifies a single rule to exclude from the rule group. Excluding a rule overrides its action setting for the rule group in the web ACL, setting it to COUNT . This effectively excludes the rule from acting on web requests.
The name of the rule to exclude.
A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet .
Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
The Amazon Resource Name (ARN) of the IPSet that this statement references.
A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet .
Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
The name of the query header to inspect.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
The name of the query argument to inspect.
Inspect all query arguments.
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.
When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.
You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:
In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.
You cannot nest a RateBasedStatement , for example for use inside a NotStatement or OrStatement . It can only be referenced as a top-level statement within a rule.
The limit on requests per 5-minute period for a single originating IP address. If the statement includes a ScopDownStatement , this limit is applied only to the requests that match the statement.
Setting that indicates how to aggregate the request counts. Currently, you must set this to IP . The request counts are aggregated on IP addresses.
An optional nested statement that narrows the scope of the rate-based statement to matching web requests. This can be any nestable statement, and you can nest statements at any level below this scope-down statement.
A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement .
The statements to combine with AND logic. You can use any statements that can be nested.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
The processing guidance for a Rule , used by AWS WAF to determine whether a web request matches the rule.
A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement .
The statements to combine with OR logic. You can use any statements that can be nested.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
The processing guidance for a Rule , used by AWS WAF to determine whether a web request matches the rule.
A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement .
The statement to negate. You can use any statement that can be nested.
A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups .
You can't nest a ManagedRuleGroupStatement , for example for use inside a NotStatement or OrStatement . It can only be referenced as a top-level statement within a rule.
The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Specifies a single rule to exclude from the rule group. Excluding a rule overrides its action setting for the rule group in the web ACL, setting it to COUNT . This effectively excludes the rule from acting on web requests.
The name of the rule to exclude.
The action that AWS WAF should take on a web request when it matches the rule's statement. Settings at the web ACL level can override the rule action setting.
Instructs AWS WAF to block the web request.
Instructs AWS WAF to allow the web request.
Instructs AWS WAF to count the web request and allow it.
The action to use to override the rule's Action setting. You can use no override action, in which case the rule action is in effect, or count action, in which case, if the rule matches a web request, it only counts the match.
Override the rule action setting to count.
Don't override the rule action setting.
Defines and enables Amazon CloudWatch metrics and web request sample collection.
A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.
A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics .
A friendly name of the CloudWatch metric. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with length from one to 128 characters. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action." You can't change a MetricName after you create a VisibilityConfig .
dict
Response Syntax
{
'Capacity': 123
}
Response Structure
(dict) --
Capacity (integer) --
The capacity required by the rules and scope.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Creates an IPSet , which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're receiving a lot of requests from a ranges of IP addresses, you can configure AWS WAF to block them using an IPSet that lists those IP addresses.
See also: AWS API Documentation
Request Syntax
response = client.create_ip_set(
Name='string',
Scope='CLOUDFRONT'|'REGIONAL',
Description='string',
IPAddressVersion='IPV4'|'IPV6',
Addresses=[
'string',
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
A friendly name of the IP set. You cannot change the name of an IPSet after you create it.
[REQUIRED]
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
[REQUIRED]
Specify IPV4 or IPV6.
[REQUIRED]
Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all address ranges for IP versions IPv4 and IPv6.
Examples:
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing .
An array of key:value pairs to associate with the resource.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
A collection of key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each AWS resource.
Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
dict
Response Syntax
{
'Summary': {
'Name': 'string',
'Id': 'string',
'Description': 'string',
'LockToken': 'string',
'ARN': 'string'
}
}
Response Structure
(dict) --
Summary (dict) --
High-level information about an IPSet , returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an IPSet , and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule .
Name (string) --
A friendly name of the IP set. You cannot change the name of an IPSet after you create it.
Id (string) --
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.
Description (string) --
A friendly description of the IP set. You cannot change the description of an IP set after you create it.
LockToken (string) --
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.
ARN (string) --
The Amazon Resource Name (ARN) of the entity.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Creates a RegexPatternSet , which you reference in a RegexPatternSetReferenceStatement , to have AWS WAF inspect a web request component for the specified patterns.
See also: AWS API Documentation
Request Syntax
response = client.create_regex_pattern_set(
Name='string',
Scope='CLOUDFRONT'|'REGIONAL',
Description='string',
RegularExpressionList=[
{
'RegexString': 'string'
},
],
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
A friendly name of the set. You cannot change the name after you create the set.
[REQUIRED]
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
[REQUIRED]
Array of regular expression strings.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
A single regular expression. This is used in a RegexPatternSet .
The string representing the regular expression.
An array of key:value pairs to associate with the resource.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
A collection of key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each AWS resource.
Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
dict
Response Syntax
{
'Summary': {
'Name': 'string',
'Id': 'string',
'Description': 'string',
'LockToken': 'string',
'ARN': 'string'
}
}
Response Structure
(dict) --
Summary (dict) --
High-level information about a RegexPatternSet , returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RegexPatternSet , and the ARN, that you provide to the RegexPatternSetReferenceStatement to use the pattern set in a Rule .
Name (string) --
A friendly name of the data type instance. You cannot change the name after you create the instance.
Id (string) --
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.
Description (string) --
A friendly description of the set. You cannot change the description of a set after you create it.
LockToken (string) --
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.
ARN (string) --
The Amazon Resource Name (ARN) of the entity.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Creates a RuleGroup per the specifications provided.
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.
See also: AWS API Documentation
Request Syntax
response = client.create_rule_group(
Name='string',
Scope='CLOUDFRONT'|'REGIONAL',
Capacity=123,
Description='string',
Rules=[
{
'Name': 'string',
'Priority': 123,
'Statement': {
'ByteMatchStatement': {
'SearchString': b'bytes',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {}
,
'Method': {}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
],
'PositionalConstraint': 'EXACTLY'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CONTAINS_WORD'
},
'SqliMatchStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {}
,
'Method': {}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
]
},
'XssMatchStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {}
,
'Method': {}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
]
},
'SizeConstraintStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {}
,
'Method': {}
},
'ComparisonOperator': 'EQ'|'NE'|'LE'|'LT'|'GE'|'GT',
'Size': 123,
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
]
},
'GeoMatchStatement': {
'CountryCodes': [
'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CD'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KP'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'US'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW',
]
},
'RuleGroupReferenceStatement': {
'ARN': 'string',
'ExcludedRules': [
{
'Name': 'string'
},
]
},
'IPSetReferenceStatement': {
'ARN': 'string'
},
'RegexPatternSetReferenceStatement': {
'ARN': 'string',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {}
,
'Method': {}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
]
},
'RateBasedStatement': {
'Limit': 123,
'AggregateKeyType': 'IP',
'ScopeDownStatement': {'... recursive ...'}
},
'AndStatement': {
'Statements': [
{'... recursive ...'},
]
},
'OrStatement': {
'Statements': [
{'... recursive ...'},
]
},
'NotStatement': {
'Statement': {'... recursive ...'}
},
'ManagedRuleGroupStatement': {
'VendorName': 'string',
'Name': 'string',
'ExcludedRules': [
{
'Name': 'string'
},
]
}
},
'Action': {
'Block': {}
,
'Allow': {}
,
'Count': {}
},
'OverrideAction': {
'Count': {}
,
'None': {}
},
'VisibilityConfig': {
'SampledRequestsEnabled': True|False,
'CloudWatchMetricsEnabled': True|False,
'MetricName': 'string'
}
},
],
VisibilityConfig={
'SampledRequestsEnabled': True|False,
'CloudWatchMetricsEnabled': True|False,
'MetricName': 'string'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
A friendly name of the rule group. You cannot change the name of a rule group after you create it.
[REQUIRED]
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
[REQUIRED]
The web ACL capacity units (WCUs) required for this rule group.
When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, AWS WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity .
AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
The Rule statements used to identify the web requests that you want to allow, block, or count. 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.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
A single rule, which you can use in a WebACL or RuleGroup to identify web requests that you want to allow, block, or count. 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.
A friendly name of the rule. You can't change the name of a Rule after you create it.
If you define more than one Rule in a WebACL , AWS WAF evaluates each request against the Rules in order based on the value of Priority . AWS WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.
The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement .
A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement.
A string value that you want AWS WAF to search for. AWS WAF searches only in the part of web requests that you designate for inspection in FieldToMatch . The maximum length of the value is 50 bytes.
Valid values depend on the areas that you specify for inspection in FieldToMatch :
If SearchString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.
If you're using the AWS WAF API
Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.
For example, suppose the value of Type is HEADER and the value of Data is User-Agent . If you want to search the User-Agent header for the value BadBot , you base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90 , in the value of SearchString .
If you're using the AWS CLI or one of the AWS SDKs
The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
The name of the query header to inspect.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
The name of the query argument to inspect.
Inspect all query arguments.
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
The area within the portion of a web request that you want AWS WAF to search for SearchString . Valid values include the following:
CONTAINS
The specified part of the web request must include the value of SearchString , but the location doesn't matter.
CONTAINS_WORD
The specified part of the web request must include the value of SearchString , and SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, SearchString must be a word, which means that both of the following are true:
EXACTLY
The value of the specified part of the web request must exactly match the value of SearchString .
STARTS_WITH
The value of SearchString must appear at the beginning of the specified part of the web request.
ENDS_WITH
The value of SearchString must appear at the end of the specified part of the web request.
Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
The name of the query header to inspect.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
The name of the query argument to inspect.
Inspect all query arguments.
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings.
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
The name of the query header to inspect.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
The name of the query argument to inspect.
Inspect all query arguments.
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.
If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes.
If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
The name of the query header to inspect.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
The name of the query argument to inspect.
Inspect all query arguments.
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
The operator to use to compare the request part to the size setting.
The size, in byte, to compare to the request part, after any transformations.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
A rule statement used to identify web requests based on country of origin.
An array of two-character country codes, for example, [ "US", "CN" ] , from the alpha-2 country ISO codes of the ISO 3166 international standard.
A rule statement used to run the rules that are defined in a RuleGroup . To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.
You cannot nest a RuleGroupReferenceStatement , for example for use inside a NotStatement or OrStatement . It can only be referenced as a top-level statement within a rule.
The Amazon Resource Name (ARN) of the entity.
The names of rules that are in the referenced rule group, but that you want AWS WAF to exclude from processing for this rule statement.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Specifies a single rule to exclude from the rule group. Excluding a rule overrides its action setting for the rule group in the web ACL, setting it to COUNT . This effectively excludes the rule from acting on web requests.
The name of the rule to exclude.
A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet .
Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
The Amazon Resource Name (ARN) of the IPSet that this statement references.
A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet .
Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
The name of the query header to inspect.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
The name of the query argument to inspect.
Inspect all query arguments.
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.
When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.
You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:
In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.
You cannot nest a RateBasedStatement , for example for use inside a NotStatement or OrStatement . It can only be referenced as a top-level statement within a rule.
The limit on requests per 5-minute period for a single originating IP address. If the statement includes a ScopDownStatement , this limit is applied only to the requests that match the statement.
Setting that indicates how to aggregate the request counts. Currently, you must set this to IP . The request counts are aggregated on IP addresses.
An optional nested statement that narrows the scope of the rate-based statement to matching web requests. This can be any nestable statement, and you can nest statements at any level below this scope-down statement.
A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement .
The statements to combine with AND logic. You can use any statements that can be nested.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
The processing guidance for a Rule , used by AWS WAF to determine whether a web request matches the rule.
A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement .
The statements to combine with OR logic. You can use any statements that can be nested.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
The processing guidance for a Rule , used by AWS WAF to determine whether a web request matches the rule.
A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement .
The statement to negate. You can use any statement that can be nested.
A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups .
You can't nest a ManagedRuleGroupStatement , for example for use inside a NotStatement or OrStatement . It can only be referenced as a top-level statement within a rule.
The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Specifies a single rule to exclude from the rule group. Excluding a rule overrides its action setting for the rule group in the web ACL, setting it to COUNT . This effectively excludes the rule from acting on web requests.
The name of the rule to exclude.
The action that AWS WAF should take on a web request when it matches the rule's statement. Settings at the web ACL level can override the rule action setting.
Instructs AWS WAF to block the web request.
Instructs AWS WAF to allow the web request.
Instructs AWS WAF to count the web request and allow it.
The action to use to override the rule's Action setting. You can use no override action, in which case the rule action is in effect, or count action, in which case, if the rule matches a web request, it only counts the match.
Override the rule action setting to count.
Don't override the rule action setting.
Defines and enables Amazon CloudWatch metrics and web request sample collection.
A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.
A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics .
A friendly name of the CloudWatch metric. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with length from one to 128 characters. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action." You can't change a MetricName after you create a VisibilityConfig .
[REQUIRED]
Defines and enables Amazon CloudWatch metrics and web request sample collection.
A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.
A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics .
A friendly name of the CloudWatch metric. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with length from one to 128 characters. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action." You can't change a MetricName after you create a VisibilityConfig .
An array of key:value pairs to associate with the resource.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
A collection of key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each AWS resource.
Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
dict
Response Syntax
{
'Summary': {
'Name': 'string',
'Id': 'string',
'Description': 'string',
'LockToken': 'string',
'ARN': 'string'
}
}
Response Structure
(dict) --
Summary (dict) --
High-level information about a RuleGroup , returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RuleGroup , and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule .
Name (string) --
A friendly name of the data type instance. You cannot change the name after you create the instance.
Id (string) --
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.
Description (string) --
A friendly description of the rule group. You cannot change the description of a rule group after you create it.
LockToken (string) --
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.
ARN (string) --
The Amazon Resource Name (ARN) of the entity.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Creates a WebACL per the specifications provided.
A Web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. 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 resources can be Amazon CloudFront, an Amazon API Gateway API, or an Application Load Balancer.
See also: AWS API Documentation
Request Syntax
response = client.create_web_acl(
Name='string',
Scope='CLOUDFRONT'|'REGIONAL',
DefaultAction={
'Block': {}
,
'Allow': {}
},
Description='string',
Rules=[
{
'Name': 'string',
'Priority': 123,
'Statement': {
'ByteMatchStatement': {
'SearchString': b'bytes',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {}
,
'Method': {}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
],
'PositionalConstraint': 'EXACTLY'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CONTAINS_WORD'
},
'SqliMatchStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {}
,
'Method': {}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
]
},
'XssMatchStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {}
,
'Method': {}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
]
},
'SizeConstraintStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {}
,
'Method': {}
},
'ComparisonOperator': 'EQ'|'NE'|'LE'|'LT'|'GE'|'GT',
'Size': 123,
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
]
},
'GeoMatchStatement': {
'CountryCodes': [
'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CD'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KP'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'US'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW',
]
},
'RuleGroupReferenceStatement': {
'ARN': 'string',
'ExcludedRules': [
{
'Name': 'string'
},
]
},
'IPSetReferenceStatement': {
'ARN': 'string'
},
'RegexPatternSetReferenceStatement': {
'ARN': 'string',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {}
,
'Method': {}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
]
},
'RateBasedStatement': {
'Limit': 123,
'AggregateKeyType': 'IP',
'ScopeDownStatement': {'... recursive ...'}
},
'AndStatement': {
'Statements': [
{'... recursive ...'},
]
},
'OrStatement': {
'Statements': [
{'... recursive ...'},
]
},
'NotStatement': {
'Statement': {'... recursive ...'}
},
'ManagedRuleGroupStatement': {
'VendorName': 'string',
'Name': 'string',
'ExcludedRules': [
{
'Name': 'string'
},
]
}
},
'Action': {
'Block': {}
,
'Allow': {}
,
'Count': {}
},
'OverrideAction': {
'Count': {}
,
'None': {}
},
'VisibilityConfig': {
'SampledRequestsEnabled': True|False,
'CloudWatchMetricsEnabled': True|False,
'MetricName': 'string'
}
},
],
VisibilityConfig={
'SampledRequestsEnabled': True|False,
'CloudWatchMetricsEnabled': True|False,
'MetricName': 'string'
},
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
A friendly name of the Web ACL. You cannot change the name of a Web ACL after you create it.
[REQUIRED]
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
[REQUIRED]
The action to perform if none of the Rules contained in the WebACL match.
Specifies that AWS WAF should block requests by default.
Specifies that AWS WAF should allow requests by default.
The Rule statements used to identify the web requests that you want to allow, block, or count. 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.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
A single rule, which you can use in a WebACL or RuleGroup to identify web requests that you want to allow, block, or count. 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.
A friendly name of the rule. You can't change the name of a Rule after you create it.
If you define more than one Rule in a WebACL , AWS WAF evaluates each request against the Rules in order based on the value of Priority . AWS WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.
The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement .
A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement.
A string value that you want AWS WAF to search for. AWS WAF searches only in the part of web requests that you designate for inspection in FieldToMatch . The maximum length of the value is 50 bytes.
Valid values depend on the areas that you specify for inspection in FieldToMatch :
If SearchString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.
If you're using the AWS WAF API
Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.
For example, suppose the value of Type is HEADER and the value of Data is User-Agent . If you want to search the User-Agent header for the value BadBot , you base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90 , in the value of SearchString .
If you're using the AWS CLI or one of the AWS SDKs
The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
The name of the query header to inspect.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
The name of the query argument to inspect.
Inspect all query arguments.
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
The area within the portion of a web request that you want AWS WAF to search for SearchString . Valid values include the following:
CONTAINS
The specified part of the web request must include the value of SearchString , but the location doesn't matter.
CONTAINS_WORD
The specified part of the web request must include the value of SearchString , and SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, SearchString must be a word, which means that both of the following are true:
EXACTLY
The value of the specified part of the web request must exactly match the value of SearchString .
STARTS_WITH
The value of SearchString must appear at the beginning of the specified part of the web request.
ENDS_WITH
The value of SearchString must appear at the end of the specified part of the web request.
Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
The name of the query header to inspect.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
The name of the query argument to inspect.
Inspect all query arguments.
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings.
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
The name of the query header to inspect.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
The name of the query argument to inspect.
Inspect all query arguments.
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.
If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes.
If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
The name of the query header to inspect.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
The name of the query argument to inspect.
Inspect all query arguments.
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
The operator to use to compare the request part to the size setting.
The size, in byte, to compare to the request part, after any transformations.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
A rule statement used to identify web requests based on country of origin.
An array of two-character country codes, for example, [ "US", "CN" ] , from the alpha-2 country ISO codes of the ISO 3166 international standard.
A rule statement used to run the rules that are defined in a RuleGroup . To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.
You cannot nest a RuleGroupReferenceStatement , for example for use inside a NotStatement or OrStatement . It can only be referenced as a top-level statement within a rule.
The Amazon Resource Name (ARN) of the entity.
The names of rules that are in the referenced rule group, but that you want AWS WAF to exclude from processing for this rule statement.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Specifies a single rule to exclude from the rule group. Excluding a rule overrides its action setting for the rule group in the web ACL, setting it to COUNT . This effectively excludes the rule from acting on web requests.
The name of the rule to exclude.
A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet .
Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
The Amazon Resource Name (ARN) of the IPSet that this statement references.
A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet .
Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
The name of the query header to inspect.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
The name of the query argument to inspect.
Inspect all query arguments.
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.
When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.
You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:
In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.
You cannot nest a RateBasedStatement , for example for use inside a NotStatement or OrStatement . It can only be referenced as a top-level statement within a rule.
The limit on requests per 5-minute period for a single originating IP address. If the statement includes a ScopDownStatement , this limit is applied only to the requests that match the statement.
Setting that indicates how to aggregate the request counts. Currently, you must set this to IP . The request counts are aggregated on IP addresses.
An optional nested statement that narrows the scope of the rate-based statement to matching web requests. This can be any nestable statement, and you can nest statements at any level below this scope-down statement.
A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement .
The statements to combine with AND logic. You can use any statements that can be nested.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
The processing guidance for a Rule , used by AWS WAF to determine whether a web request matches the rule.
A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement .
The statements to combine with OR logic. You can use any statements that can be nested.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
The processing guidance for a Rule , used by AWS WAF to determine whether a web request matches the rule.
A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement .
The statement to negate. You can use any statement that can be nested.
A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups .
You can't nest a ManagedRuleGroupStatement , for example for use inside a NotStatement or OrStatement . It can only be referenced as a top-level statement within a rule.
The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Specifies a single rule to exclude from the rule group. Excluding a rule overrides its action setting for the rule group in the web ACL, setting it to COUNT . This effectively excludes the rule from acting on web requests.
The name of the rule to exclude.
The action that AWS WAF should take on a web request when it matches the rule's statement. Settings at the web ACL level can override the rule action setting.
Instructs AWS WAF to block the web request.
Instructs AWS WAF to allow the web request.
Instructs AWS WAF to count the web request and allow it.
The action to use to override the rule's Action setting. You can use no override action, in which case the rule action is in effect, or count action, in which case, if the rule matches a web request, it only counts the match.
Override the rule action setting to count.
Don't override the rule action setting.
Defines and enables Amazon CloudWatch metrics and web request sample collection.
A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.
A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics .
A friendly name of the CloudWatch metric. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with length from one to 128 characters. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action." You can't change a MetricName after you create a VisibilityConfig .
[REQUIRED]
Defines and enables Amazon CloudWatch metrics and web request sample collection.
A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.
A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics .
A friendly name of the CloudWatch metric. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with length from one to 128 characters. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action." You can't change a MetricName after you create a VisibilityConfig .
An array of key:value pairs to associate with the resource.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
A collection of key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each AWS resource.
Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
dict
Response Syntax
{
'Summary': {
'Name': 'string',
'Id': 'string',
'Description': 'string',
'LockToken': 'string',
'ARN': 'string'
}
}
Response Structure
(dict) --
Summary (dict) --
High-level information about a WebACL , returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a WebACL , and the ARN, that you provide to operations like AssociateWebACL .
Name (string) --
A friendly name of the Web ACL. You cannot change the name of a Web ACL after you create it.
Id (string) --
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.
Description (string) --
A friendly description of the Web ACL. You cannot change the description of a Web ACL after you create it.
LockToken (string) --
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.
ARN (string) --
The Amazon Resource Name (ARN) of the entity.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Deletes the specified IPSet .
See also: AWS API Documentation
Request Syntax
response = client.delete_ip_set(
Name='string',
Scope='CLOUDFRONT'|'REGIONAL',
Id='string',
LockToken='string'
)
[REQUIRED]
A friendly name of the IP set. You cannot change the name of an IPSet after you create it.
[REQUIRED]
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
[REQUIRED]
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.
[REQUIRED]
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.
dict
Response Syntax
{}
Response Structure
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Deletes the LoggingConfiguration from the specified web ACL.
See also: AWS API Documentation
Request Syntax
response = client.delete_logging_configuration(
ResourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the web ACL from which you want to delete the LoggingConfiguration .
{}
Response Structure
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Deletes the specified RegexPatternSet .
See also: AWS API Documentation
Request Syntax
response = client.delete_regex_pattern_set(
Name='string',
Scope='CLOUDFRONT'|'REGIONAL',
Id='string',
LockToken='string'
)
[REQUIRED]
A friendly name of the set. You cannot change the name after you create the set.
[REQUIRED]
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
[REQUIRED]
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.
[REQUIRED]
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.
dict
Response Syntax
{}
Response Structure
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Deletes the specified RuleGroup .
See also: AWS API Documentation
Request Syntax
response = client.delete_rule_group(
Name='string',
Scope='CLOUDFRONT'|'REGIONAL',
Id='string',
LockToken='string'
)
[REQUIRED]
A friendly name of the rule group. You cannot change the name of a rule group after you create it.
[REQUIRED]
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
[REQUIRED]
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.
[REQUIRED]
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.
dict
Response Syntax
{}
Response Structure
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Deletes the specified WebACL .
See also: AWS API Documentation
Request Syntax
response = client.delete_web_acl(
Name='string',
Scope='CLOUDFRONT'|'REGIONAL',
Id='string',
LockToken='string'
)
[REQUIRED]
A friendly name of the Web ACL. You cannot change the name of a Web ACL after you create it.
[REQUIRED]
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
[REQUIRED]
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.
[REQUIRED]
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.
dict
Response Syntax
{}
Response Structure
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Provides high-level information for a managed rule group, including descriptions of the rules.
See also: AWS API Documentation
Request Syntax
response = client.describe_managed_rule_group(
VendorName='string',
Name='string',
Scope='CLOUDFRONT'|'REGIONAL'
)
[REQUIRED]
The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
[REQUIRED]
The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
[REQUIRED]
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
dict
Response Syntax
{
'Capacity': 123,
'Rules': [
{
'Name': 'string',
'Action': {
'Block': {},
'Allow': {},
'Count': {}
}
},
]
}
Response Structure
(dict) --
Capacity (integer) --
The web ACL capacity units (WCUs) required for this rule group. AWS WAF uses web ACL capacity units (WCU) to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect each rule's relative cost. Rule group capacity is fixed at creation, so users can plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
Rules (list) --
(dict) --
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
High-level information about a Rule , returned by operations like DescribeManagedRuleGroup . This provides information like the ID, that you can use to retrieve and manage a RuleGroup , and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule .
Name (string) --
The name of the rule.
Action (dict) --
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
The action that AWS WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting.
Block (dict) --
Instructs AWS WAF to block the web request.
Allow (dict) --
Instructs AWS WAF to allow the web request.
Count (dict) --
Instructs AWS WAF to count the web request and allow it.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Disassociates a Web ACL from a regional application resource. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
For AWS CloudFront, you can disassociate the Web ACL by providing an empty web ACL ARN in the CloudFront API call UpdateDistribution . For information, see UpdateDistribution .
See also: AWS API Documentation
Request Syntax
response = client.disassociate_web_acl(
ResourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource to disassociate from the web ACL.
The ARN must be in one of the following formats:
{}
Response Structure
Generate a presigned url given a client, its method, and arguments
The presigned url
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Retrieves the specified IPSet .
See also: AWS API Documentation
Request Syntax
response = client.get_ip_set(
Name='string',
Scope='CLOUDFRONT'|'REGIONAL',
Id='string'
)
[REQUIRED]
A friendly name of the IP set. You cannot change the name of an IPSet after you create it.
[REQUIRED]
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
[REQUIRED]
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.
dict
Response Syntax
{
'IPSet': {
'Name': 'string',
'Id': 'string',
'ARN': 'string',
'Description': 'string',
'IPAddressVersion': 'IPV4'|'IPV6',
'Addresses': [
'string',
]
},
'LockToken': 'string'
}
Response Structure
(dict) --
IPSet (dict) --
Name (string) --
A friendly name of the IP set. You cannot change the name of an IPSet after you create it.
Id (string) --
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.
ARN (string) --
The Amazon Resource Name (ARN) of the entity.
Description (string) --
A friendly description of the IP set. You cannot change the description of an IP set after you create it.
IPAddressVersion (string) --
Specify IPV4 or IPV6.
Addresses (list) --
Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all address ranges for IP versions IPv4 and IPv6.
Examples:
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing .
LockToken (string) --
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.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Returns the LoggingConfiguration for the specified web ACL.
See also: AWS API Documentation
Request Syntax
response = client.get_logging_configuration(
ResourceArn='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration .
{
'LoggingConfiguration': {
'ResourceArn': 'string',
'LogDestinationConfigs': [
'string',
],
'RedactedFields': [
{
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {},
'UriPath': {},
'QueryString': {},
'Body': {},
'Method': {}
},
]
}
}
Response Structure
The LoggingConfiguration for the specified web ACL.
The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs .
The Amazon Kinesis Data Firehose Amazon Resource Name (ARNs) that you want to associate with the web ACL.
The parts of the request that you want to keep out of the logs. For example, if you redact the cookie field, the cookie field in the firehose will be xxx .
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
The part of a web request that you want AWS WAF to inspect. Include the FieldToMatch types that you want to inspect, with additional specifications as needed, according to the type.
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
The name of the query header to inspect.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
The name of the query argument to inspect.
Inspect all query arguments.
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
Create a paginator for an operation.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Retrieves the keys that are currently blocked by a rate-based rule. The maximum number of managed keys that can be blocked for a single rate-based rule is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked.
See also: AWS API Documentation
Request Syntax
response = client.get_rate_based_statement_managed_keys(
Scope='CLOUDFRONT'|'REGIONAL',
WebACLName='string',
WebACLId='string',
RuleName='string'
)
[REQUIRED]
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
[REQUIRED]
A friendly name of the Web ACL. You cannot change the name of a Web ACL after you create it.
[REQUIRED]
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.
[REQUIRED]
The name of the rate-based rule to get the keys for.
dict
Response Syntax
{
'ManagedKeysIPV4': {
'IPAddressVersion': 'IPV4'|'IPV6',
'Addresses': [
'string',
]
},
'ManagedKeysIPV6': {
'IPAddressVersion': 'IPV4'|'IPV6',
'Addresses': [
'string',
]
}
}
Response Structure
(dict) --
ManagedKeysIPV4 (dict) --
The keys that are of Internet Protocol version 4 (IPv4).
IPAddressVersion (string) --
Addresses (list) --
The IP addresses that are currently blocked.
ManagedKeysIPV6 (dict) --
The keys that are of Internet Protocol version 6 (IPv6).
IPAddressVersion (string) --
Addresses (list) --
The IP addresses that are currently blocked.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Retrieves the specified RegexPatternSet .
See also: AWS API Documentation
Request Syntax
response = client.get_regex_pattern_set(
Name='string',
Scope='CLOUDFRONT'|'REGIONAL',
Id='string'
)
[REQUIRED]
A friendly name of the set. You cannot change the name after you create the set.
[REQUIRED]
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
[REQUIRED]
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.
dict
Response Syntax
{
'RegexPatternSet': {
'Name': 'string',
'Id': 'string',
'ARN': 'string',
'Description': 'string',
'RegularExpressionList': [
{
'RegexString': 'string'
},
]
},
'LockToken': 'string'
}
Response Structure
(dict) --
RegexPatternSet (dict) --
Name (string) --
A friendly name of the set. You cannot change the name after you create the set.
Id (string) --
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.
ARN (string) --
The Amazon Resource Name (ARN) of the entity.
Description (string) --
A friendly description of the set. You cannot change the description of a set after you create it.
RegularExpressionList (list) --
The regular expression patterns in the set.
(dict) --
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
A single regular expression. This is used in a RegexPatternSet .
RegexString (string) --
The string representing the regular expression.
LockToken (string) --
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.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Retrieves the specified RuleGroup .
See also: AWS API Documentation
Request Syntax
response = client.get_rule_group(
Name='string',
Scope='CLOUDFRONT'|'REGIONAL',
Id='string'
)
[REQUIRED]
A friendly name of the rule group. You cannot change the name of a rule group after you create it.
[REQUIRED]
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
[REQUIRED]
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.
dict
Response Syntax
{
'RuleGroup': {
'Name': 'string',
'Id': 'string',
'Capacity': 123,
'ARN': 'string',
'Description': 'string',
'Rules': [
{
'Name': 'string',
'Priority': 123,
'Statement': {
'ByteMatchStatement': {
'SearchString': b'bytes',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {},
'UriPath': {},
'QueryString': {},
'Body': {},
'Method': {}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
],
'PositionalConstraint': 'EXACTLY'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CONTAINS_WORD'
},
'SqliMatchStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {},
'UriPath': {},
'QueryString': {},
'Body': {},
'Method': {}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
]
},
'XssMatchStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {},
'UriPath': {},
'QueryString': {},
'Body': {},
'Method': {}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
]
},
'SizeConstraintStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {},
'UriPath': {},
'QueryString': {},
'Body': {},
'Method': {}
},
'ComparisonOperator': 'EQ'|'NE'|'LE'|'LT'|'GE'|'GT',
'Size': 123,
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
]
},
'GeoMatchStatement': {
'CountryCodes': [
'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CD'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KP'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'US'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW',
]
},
'RuleGroupReferenceStatement': {
'ARN': 'string',
'ExcludedRules': [
{
'Name': 'string'
},
]
},
'IPSetReferenceStatement': {
'ARN': 'string'
},
'RegexPatternSetReferenceStatement': {
'ARN': 'string',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {},
'UriPath': {},
'QueryString': {},
'Body': {},
'Method': {}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
]
},
'RateBasedStatement': {
'Limit': 123,
'AggregateKeyType': 'IP',
'ScopeDownStatement': {'... recursive ...'}
},
'AndStatement': {
'Statements': [
{'... recursive ...'},
]
},
'OrStatement': {
'Statements': [
{'... recursive ...'},
]
},
'NotStatement': {
'Statement': {'... recursive ...'}
},
'ManagedRuleGroupStatement': {
'VendorName': 'string',
'Name': 'string',
'ExcludedRules': [
{
'Name': 'string'
},
]
}
},
'Action': {
'Block': {},
'Allow': {},
'Count': {}
},
'OverrideAction': {
'Count': {},
'None': {}
},
'VisibilityConfig': {
'SampledRequestsEnabled': True|False,
'CloudWatchMetricsEnabled': True|False,
'MetricName': 'string'
}
},
],
'VisibilityConfig': {
'SampledRequestsEnabled': True|False,
'CloudWatchMetricsEnabled': True|False,
'MetricName': 'string'
}
},
'LockToken': 'string'
}
Response Structure
(dict) --
RuleGroup (dict) --
Name (string) --
A friendly name of the rule group. You cannot change the name of a rule group after you create it.
Id (string) --
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.
Capacity (integer) --
The web ACL capacity units (WCUs) required for this rule group.
When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, AWS WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity .
AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
ARN (string) --
The Amazon Resource Name (ARN) of the entity.
Description (string) --
A friendly description of the rule group. You cannot change the description of a rule group after you create it.
Rules (list) --
The Rule statements used to identify the web requests that you want to allow, block, or count. 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.
(dict) --
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
A single rule, which you can use in a WebACL or RuleGroup to identify web requests that you want to allow, block, or count. 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.
Name (string) --
A friendly name of the rule. You can't change the name of a Rule after you create it.
Priority (integer) --
If you define more than one Rule in a WebACL , AWS WAF evaluates each request against the Rules in order based on the value of Priority . AWS WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.
Statement (dict) --
The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement .
ByteMatchStatement (dict) --
A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement.
SearchString (bytes) --
A string value that you want AWS WAF to search for. AWS WAF searches only in the part of web requests that you designate for inspection in FieldToMatch . The maximum length of the value is 50 bytes.
Valid values depend on the areas that you specify for inspection in FieldToMatch :
If SearchString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.
If you're using the AWS WAF API
Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.
For example, suppose the value of Type is HEADER and the value of Data is User-Agent . If you want to search the User-Agent header for the value BadBot , you base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90 , in the value of SearchString .
If you're using the AWS CLI or one of the AWS SDKs
The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.
FieldToMatch (dict) --
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
SingleHeader (dict) --
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
Name (string) --
The name of the query header to inspect.
SingleQueryArgument (dict) --
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
Name (string) --
The name of the query argument to inspect.
AllQueryArguments (dict) --
Inspect all query arguments.
UriPath (dict) --
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
QueryString (dict) --
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Body (dict) --
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Method (dict) --
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
TextTransformations (list) --
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
(dict) --
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Priority (integer) --
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
Type (string) --
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
PositionalConstraint (string) --
The area within the portion of a web request that you want AWS WAF to search for SearchString . Valid values include the following:
CONTAINS
The specified part of the web request must include the value of SearchString , but the location doesn't matter.
CONTAINS_WORD
The specified part of the web request must include the value of SearchString , and SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, SearchString must be a word, which means that both of the following are true:
EXACTLY
The value of the specified part of the web request must exactly match the value of SearchString .
STARTS_WITH
The value of SearchString must appear at the beginning of the specified part of the web request.
ENDS_WITH
The value of SearchString must appear at the end of the specified part of the web request.
SqliMatchStatement (dict) --
Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.
FieldToMatch (dict) --
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
SingleHeader (dict) --
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
Name (string) --
The name of the query header to inspect.
SingleQueryArgument (dict) --
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
Name (string) --
The name of the query argument to inspect.
AllQueryArguments (dict) --
Inspect all query arguments.
UriPath (dict) --
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
QueryString (dict) --
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Body (dict) --
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Method (dict) --
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
TextTransformations (list) --
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
(dict) --
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Priority (integer) --
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
Type (string) --
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
XssMatchStatement (dict) --
A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings.
FieldToMatch (dict) --
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
SingleHeader (dict) --
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
Name (string) --
The name of the query header to inspect.
SingleQueryArgument (dict) --
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
Name (string) --
The name of the query argument to inspect.
AllQueryArguments (dict) --
Inspect all query arguments.
UriPath (dict) --
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
QueryString (dict) --
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Body (dict) --
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Method (dict) --
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
TextTransformations (list) --
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
(dict) --
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Priority (integer) --
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
Type (string) --
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
SizeConstraintStatement (dict) --
A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.
If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes.
If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
FieldToMatch (dict) --
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
SingleHeader (dict) --
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
Name (string) --
The name of the query header to inspect.
SingleQueryArgument (dict) --
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
Name (string) --
The name of the query argument to inspect.
AllQueryArguments (dict) --
Inspect all query arguments.
UriPath (dict) --
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
QueryString (dict) --
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Body (dict) --
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Method (dict) --
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
ComparisonOperator (string) --
The operator to use to compare the request part to the size setting.
Size (integer) --
The size, in byte, to compare to the request part, after any transformations.
TextTransformations (list) --
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
(dict) --
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Priority (integer) --
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
Type (string) --
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
GeoMatchStatement (dict) --
A rule statement used to identify web requests based on country of origin.
CountryCodes (list) --
An array of two-character country codes, for example, [ "US", "CN" ] , from the alpha-2 country ISO codes of the ISO 3166 international standard.
RuleGroupReferenceStatement (dict) --
A rule statement used to run the rules that are defined in a RuleGroup . To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.
You cannot nest a RuleGroupReferenceStatement , for example for use inside a NotStatement or OrStatement . It can only be referenced as a top-level statement within a rule.
ARN (string) --
The Amazon Resource Name (ARN) of the entity.
ExcludedRules (list) --
The names of rules that are in the referenced rule group, but that you want AWS WAF to exclude from processing for this rule statement.
(dict) --
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Specifies a single rule to exclude from the rule group. Excluding a rule overrides its action setting for the rule group in the web ACL, setting it to COUNT . This effectively excludes the rule from acting on web requests.
Name (string) --
The name of the rule to exclude.
IPSetReferenceStatement (dict) --
A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet .
Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
ARN (string) --
The Amazon Resource Name (ARN) of the IPSet that this statement references.
RegexPatternSetReferenceStatement (dict) --
A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet .
Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
ARN (string) --
The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.
FieldToMatch (dict) --
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
SingleHeader (dict) --
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
Name (string) --
The name of the query header to inspect.
SingleQueryArgument (dict) --
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
Name (string) --
The name of the query argument to inspect.
AllQueryArguments (dict) --
Inspect all query arguments.
UriPath (dict) --
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
QueryString (dict) --
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Body (dict) --
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Method (dict) --
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
TextTransformations (list) --
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
(dict) --
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Priority (integer) --
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
Type (string) --
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
RateBasedStatement (dict) --
A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.
When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.
You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:
In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.
You cannot nest a RateBasedStatement , for example for use inside a NotStatement or OrStatement . It can only be referenced as a top-level statement within a rule.
Limit (integer) --
The limit on requests per 5-minute period for a single originating IP address. If the statement includes a ScopDownStatement , this limit is applied only to the requests that match the statement.
AggregateKeyType (string) --
Setting that indicates how to aggregate the request counts. Currently, you must set this to IP . The request counts are aggregated on IP addresses.
ScopeDownStatement (dict) --
An optional nested statement that narrows the scope of the rate-based statement to matching web requests. This can be any nestable statement, and you can nest statements at any level below this scope-down statement.
AndStatement (dict) --
A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement .
Statements (list) --
The statements to combine with AND logic. You can use any statements that can be nested.
(dict) --
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
The processing guidance for a Rule , used by AWS WAF to determine whether a web request matches the rule.
OrStatement (dict) --
A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement .
Statements (list) --
The statements to combine with OR logic. You can use any statements that can be nested.
(dict) --
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
The processing guidance for a Rule , used by AWS WAF to determine whether a web request matches the rule.
NotStatement (dict) --
A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement .
Statement (dict) --
The statement to negate. You can use any statement that can be nested.
ManagedRuleGroupStatement (dict) --
A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups .
You can't nest a ManagedRuleGroupStatement , for example for use inside a NotStatement or OrStatement . It can only be referenced as a top-level statement within a rule.
VendorName (string) --
The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
Name (string) --
The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
ExcludedRules (list) --
The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests.
(dict) --
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Specifies a single rule to exclude from the rule group. Excluding a rule overrides its action setting for the rule group in the web ACL, setting it to COUNT . This effectively excludes the rule from acting on web requests.
Name (string) --
The name of the rule to exclude.
Action (dict) --
The action that AWS WAF should take on a web request when it matches the rule's statement. Settings at the web ACL level can override the rule action setting.
Block (dict) --
Instructs AWS WAF to block the web request.
Allow (dict) --
Instructs AWS WAF to allow the web request.
Count (dict) --
Instructs AWS WAF to count the web request and allow it.
OverrideAction (dict) --
The action to use to override the rule's Action setting. You can use no override action, in which case the rule action is in effect, or count action, in which case, if the rule matches a web request, it only counts the match.
Count (dict) --
Override the rule action setting to count.
None (dict) --
Don't override the rule action setting.
VisibilityConfig (dict) --
Defines and enables Amazon CloudWatch metrics and web request sample collection.
SampledRequestsEnabled (boolean) --
A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.
CloudWatchMetricsEnabled (boolean) --
A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics .
MetricName (string) --
A friendly name of the CloudWatch metric. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with length from one to 128 characters. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action." You can't change a MetricName after you create a VisibilityConfig .
VisibilityConfig (dict) --
Defines and enables Amazon CloudWatch metrics and web request sample collection.
SampledRequestsEnabled (boolean) --
A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.
CloudWatchMetricsEnabled (boolean) --
A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics .
MetricName (string) --
A friendly name of the CloudWatch metric. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with length from one to 128 characters. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action." You can't change a MetricName after you create a VisibilityConfig .
LockToken (string) --
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.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
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 a 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.
See also: AWS API Documentation
Request Syntax
response = client.get_sampled_requests(
WebAclArn='string',
RuleMetricName='string',
Scope='CLOUDFRONT'|'REGIONAL',
TimeWindow={
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
},
MaxItems=123
)
[REQUIRED]
The Amazon resource name (ARN) of the WebACL for which you want a sample of requests.
[REQUIRED]
The metric name assigned to the Rule or RuleGroup for which you want a sample of requests.
[REQUIRED]
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
[REQUIRED]
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. Specify the date and time in the following format: "2016-09-27T14:50Z" . You can specify any time range in the previous three hours.
The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: "2016-09-27T14:50Z" . You can specify any time range in the previous three hours.
The end of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: "2016-09-27T14:50Z" . You can specify any time range in the previous three hours.
[REQUIRED]
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.
dict
Response Syntax
{
'SampledRequests': [
{
'Request': {
'ClientIP': 'string',
'Country': 'string',
'URI': 'string',
'Method': 'string',
'HTTPVersion': 'string',
'Headers': [
{
'Name': 'string',
'Value': 'string'
},
]
},
'Weight': 123,
'Timestamp': datetime(2015, 1, 1),
'Action': 'string',
'RuleNameWithinRuleGroup': 'string'
},
],
'PopulationSize': 123,
'TimeWindow': {
'StartTime': datetime(2015, 1, 1),
'EndTime': datetime(2015, 1, 1)
}
}
Response Structure
(dict) --
SampledRequests (list) --
A complex type that contains detailed information about each of the requests in the sample.
(dict) --
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Represents a single sampled web request. The response from GetSampledRequests includes a SampledHTTPRequests complex type that appears as SampledRequests in the response syntax. SampledHTTPRequests contains an array of SampledHTTPRequest objects.
Request (dict) --
A complex type that contains detailed information about the request.
ClientIP (string) --
The IP address that the request originated from. If the web ACL is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs:
Country (string) --
The two-letter country code for the country that the request originated from. For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2 .
URI (string) --
The URI path of the request, which identifies the resource, for example, /images/daily-ad.jpg .
Method (string) --
The HTTP method specified in the sampled web request.
HTTPVersion (string) --
The HTTP version specified in the sampled web request, for example, HTTP/1.1 .
Headers (list) --
A complex type that contains the name and value for each header in the sampled web request.
(dict) --
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Part of the response from GetSampledRequests . This is a complex type that appears as Headers in the response syntax. HTTPHeader contains the names and values of all of the headers that appear in one of the web requests.
Name (string) --
The name of the HTTP header.
Value (string) --
The value of the HTTP header.
Weight (integer) --
A value that indicates how one result in the response relates proportionally to other results in the response. For example, a result that has a weight of 2 represents roughly twice as many web requests as a result that has a weight of 1 .
Timestamp (datetime) --
The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds).
Action (string) --
The action for the Rule that the request matched: ALLOW , BLOCK , or COUNT .
RuleNameWithinRuleGroup (string) --
The name of the Rule that the request matched. For managed rule groups, the format for this name is <vendor name>#<managed rule group name>#<rule name> . For your own rule groups, the format for this name is <rule group name>#<rule name> . If the rule is not in a rule group, the format is <rule name> .
PopulationSize (integer) --
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.
TimeWindow (dict) --
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.
StartTime (datetime) --
The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: "2016-09-27T14:50Z" . You can specify any time range in the previous three hours.
EndTime (datetime) --
The end of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: "2016-09-27T14:50Z" . You can specify any time range in the previous three hours.
Returns an object that can wait for some condition.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Retrieves the specified WebACL .
See also: AWS API Documentation
Request Syntax
response = client.get_web_acl(
Name='string',
Scope='CLOUDFRONT'|'REGIONAL',
Id='string'
)
[REQUIRED]
A friendly name of the Web ACL. You cannot change the name of a Web ACL after you create it.
[REQUIRED]
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
[REQUIRED]
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.
dict
Response Syntax
{
'WebACL': {
'Name': 'string',
'Id': 'string',
'ARN': 'string',
'DefaultAction': {
'Block': {},
'Allow': {}
},
'Description': 'string',
'Rules': [
{
'Name': 'string',
'Priority': 123,
'Statement': {
'ByteMatchStatement': {
'SearchString': b'bytes',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {},
'UriPath': {},
'QueryString': {},
'Body': {},
'Method': {}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
],
'PositionalConstraint': 'EXACTLY'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CONTAINS_WORD'
},
'SqliMatchStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {},
'UriPath': {},
'QueryString': {},
'Body': {},
'Method': {}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
]
},
'XssMatchStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {},
'UriPath': {},
'QueryString': {},
'Body': {},
'Method': {}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
]
},
'SizeConstraintStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {},
'UriPath': {},
'QueryString': {},
'Body': {},
'Method': {}
},
'ComparisonOperator': 'EQ'|'NE'|'LE'|'LT'|'GE'|'GT',
'Size': 123,
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
]
},
'GeoMatchStatement': {
'CountryCodes': [
'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CD'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KP'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'US'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW',
]
},
'RuleGroupReferenceStatement': {
'ARN': 'string',
'ExcludedRules': [
{
'Name': 'string'
},
]
},
'IPSetReferenceStatement': {
'ARN': 'string'
},
'RegexPatternSetReferenceStatement': {
'ARN': 'string',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {},
'UriPath': {},
'QueryString': {},
'Body': {},
'Method': {}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
]
},
'RateBasedStatement': {
'Limit': 123,
'AggregateKeyType': 'IP',
'ScopeDownStatement': {'... recursive ...'}
},
'AndStatement': {
'Statements': [
{'... recursive ...'},
]
},
'OrStatement': {
'Statements': [
{'... recursive ...'},
]
},
'NotStatement': {
'Statement': {'... recursive ...'}
},
'ManagedRuleGroupStatement': {
'VendorName': 'string',
'Name': 'string',
'ExcludedRules': [
{
'Name': 'string'
},
]
}
},
'Action': {
'Block': {},
'Allow': {},
'Count': {}
},
'OverrideAction': {
'Count': {},
'None': {}
},
'VisibilityConfig': {
'SampledRequestsEnabled': True|False,
'CloudWatchMetricsEnabled': True|False,
'MetricName': 'string'
}
},
],
'VisibilityConfig': {
'SampledRequestsEnabled': True|False,
'CloudWatchMetricsEnabled': True|False,
'MetricName': 'string'
},
'Capacity': 123
},
'LockToken': 'string'
}
Response Structure
(dict) --
WebACL (dict) --
The Web ACL specification. You can modify the settings in this Web ACL and use it to update this Web ACL or create a new one.
Name (string) --
A friendly name of the Web ACL. You cannot change the name of a Web ACL after you create it.
Id (string) --
A unique identifier for the WebACL . This ID is returned in the responses to create and list commands. You use this ID to do things like get, update, and delete a WebACL .
ARN (string) --
The Amazon Resource Name (ARN) of the Web ACL that you want to associate with the resource.
DefaultAction (dict) --
The action to perform if none of the Rules contained in the WebACL match.
Block (dict) --
Specifies that AWS WAF should block requests by default.
Allow (dict) --
Specifies that AWS WAF should allow requests by default.
Description (string) --
A friendly description of the Web ACL. You cannot change the description of a Web ACL after you create it.
Rules (list) --
The Rule statements used to identify the web requests that you want to allow, block, or count. 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.
(dict) --
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
A single rule, which you can use in a WebACL or RuleGroup to identify web requests that you want to allow, block, or count. 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.
Name (string) --
A friendly name of the rule. You can't change the name of a Rule after you create it.
Priority (integer) --
If you define more than one Rule in a WebACL , AWS WAF evaluates each request against the Rules in order based on the value of Priority . AWS WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.
Statement (dict) --
The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement .
ByteMatchStatement (dict) --
A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement.
SearchString (bytes) --
A string value that you want AWS WAF to search for. AWS WAF searches only in the part of web requests that you designate for inspection in FieldToMatch . The maximum length of the value is 50 bytes.
Valid values depend on the areas that you specify for inspection in FieldToMatch :
If SearchString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.
If you're using the AWS WAF API
Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.
For example, suppose the value of Type is HEADER and the value of Data is User-Agent . If you want to search the User-Agent header for the value BadBot , you base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90 , in the value of SearchString .
If you're using the AWS CLI or one of the AWS SDKs
The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.
FieldToMatch (dict) --
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
SingleHeader (dict) --
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
Name (string) --
The name of the query header to inspect.
SingleQueryArgument (dict) --
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
Name (string) --
The name of the query argument to inspect.
AllQueryArguments (dict) --
Inspect all query arguments.
UriPath (dict) --
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
QueryString (dict) --
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Body (dict) --
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Method (dict) --
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
TextTransformations (list) --
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
(dict) --
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Priority (integer) --
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
Type (string) --
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
PositionalConstraint (string) --
The area within the portion of a web request that you want AWS WAF to search for SearchString . Valid values include the following:
CONTAINS
The specified part of the web request must include the value of SearchString , but the location doesn't matter.
CONTAINS_WORD
The specified part of the web request must include the value of SearchString , and SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, SearchString must be a word, which means that both of the following are true:
EXACTLY
The value of the specified part of the web request must exactly match the value of SearchString .
STARTS_WITH
The value of SearchString must appear at the beginning of the specified part of the web request.
ENDS_WITH
The value of SearchString must appear at the end of the specified part of the web request.
SqliMatchStatement (dict) --
Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.
FieldToMatch (dict) --
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
SingleHeader (dict) --
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
Name (string) --
The name of the query header to inspect.
SingleQueryArgument (dict) --
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
Name (string) --
The name of the query argument to inspect.
AllQueryArguments (dict) --
Inspect all query arguments.
UriPath (dict) --
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
QueryString (dict) --
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Body (dict) --
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Method (dict) --
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
TextTransformations (list) --
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
(dict) --
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Priority (integer) --
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
Type (string) --
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
XssMatchStatement (dict) --
A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings.
FieldToMatch (dict) --
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
SingleHeader (dict) --
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
Name (string) --
The name of the query header to inspect.
SingleQueryArgument (dict) --
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
Name (string) --
The name of the query argument to inspect.
AllQueryArguments (dict) --
Inspect all query arguments.
UriPath (dict) --
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
QueryString (dict) --
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Body (dict) --
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Method (dict) --
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
TextTransformations (list) --
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
(dict) --
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Priority (integer) --
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
Type (string) --
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
SizeConstraintStatement (dict) --
A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.
If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes.
If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
FieldToMatch (dict) --
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
SingleHeader (dict) --
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
Name (string) --
The name of the query header to inspect.
SingleQueryArgument (dict) --
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
Name (string) --
The name of the query argument to inspect.
AllQueryArguments (dict) --
Inspect all query arguments.
UriPath (dict) --
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
QueryString (dict) --
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Body (dict) --
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Method (dict) --
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
ComparisonOperator (string) --
The operator to use to compare the request part to the size setting.
Size (integer) --
The size, in byte, to compare to the request part, after any transformations.
TextTransformations (list) --
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
(dict) --
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Priority (integer) --
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
Type (string) --
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
GeoMatchStatement (dict) --
A rule statement used to identify web requests based on country of origin.
CountryCodes (list) --
An array of two-character country codes, for example, [ "US", "CN" ] , from the alpha-2 country ISO codes of the ISO 3166 international standard.
RuleGroupReferenceStatement (dict) --
A rule statement used to run the rules that are defined in a RuleGroup . To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.
You cannot nest a RuleGroupReferenceStatement , for example for use inside a NotStatement or OrStatement . It can only be referenced as a top-level statement within a rule.
ARN (string) --
The Amazon Resource Name (ARN) of the entity.
ExcludedRules (list) --
The names of rules that are in the referenced rule group, but that you want AWS WAF to exclude from processing for this rule statement.
(dict) --
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Specifies a single rule to exclude from the rule group. Excluding a rule overrides its action setting for the rule group in the web ACL, setting it to COUNT . This effectively excludes the rule from acting on web requests.
Name (string) --
The name of the rule to exclude.
IPSetReferenceStatement (dict) --
A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet .
Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
ARN (string) --
The Amazon Resource Name (ARN) of the IPSet that this statement references.
RegexPatternSetReferenceStatement (dict) --
A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet .
Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
ARN (string) --
The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.
FieldToMatch (dict) --
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
SingleHeader (dict) --
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
Name (string) --
The name of the query header to inspect.
SingleQueryArgument (dict) --
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
Name (string) --
The name of the query argument to inspect.
AllQueryArguments (dict) --
Inspect all query arguments.
UriPath (dict) --
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
QueryString (dict) --
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Body (dict) --
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Method (dict) --
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
TextTransformations (list) --
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
(dict) --
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Priority (integer) --
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
Type (string) --
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
RateBasedStatement (dict) --
A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.
When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.
You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:
In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.
You cannot nest a RateBasedStatement , for example for use inside a NotStatement or OrStatement . It can only be referenced as a top-level statement within a rule.
Limit (integer) --
The limit on requests per 5-minute period for a single originating IP address. If the statement includes a ScopDownStatement , this limit is applied only to the requests that match the statement.
AggregateKeyType (string) --
Setting that indicates how to aggregate the request counts. Currently, you must set this to IP . The request counts are aggregated on IP addresses.
ScopeDownStatement (dict) --
An optional nested statement that narrows the scope of the rate-based statement to matching web requests. This can be any nestable statement, and you can nest statements at any level below this scope-down statement.
AndStatement (dict) --
A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement .
Statements (list) --
The statements to combine with AND logic. You can use any statements that can be nested.
(dict) --
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
The processing guidance for a Rule , used by AWS WAF to determine whether a web request matches the rule.
OrStatement (dict) --
A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement .
Statements (list) --
The statements to combine with OR logic. You can use any statements that can be nested.
(dict) --
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
The processing guidance for a Rule , used by AWS WAF to determine whether a web request matches the rule.
NotStatement (dict) --
A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement .
Statement (dict) --
The statement to negate. You can use any statement that can be nested.
ManagedRuleGroupStatement (dict) --
A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups .
You can't nest a ManagedRuleGroupStatement , for example for use inside a NotStatement or OrStatement . It can only be referenced as a top-level statement within a rule.
VendorName (string) --
The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
Name (string) --
The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
ExcludedRules (list) --
The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests.
(dict) --
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Specifies a single rule to exclude from the rule group. Excluding a rule overrides its action setting for the rule group in the web ACL, setting it to COUNT . This effectively excludes the rule from acting on web requests.
Name (string) --
The name of the rule to exclude.
Action (dict) --
The action that AWS WAF should take on a web request when it matches the rule's statement. Settings at the web ACL level can override the rule action setting.
Block (dict) --
Instructs AWS WAF to block the web request.
Allow (dict) --
Instructs AWS WAF to allow the web request.
Count (dict) --
Instructs AWS WAF to count the web request and allow it.
OverrideAction (dict) --
The action to use to override the rule's Action setting. You can use no override action, in which case the rule action is in effect, or count action, in which case, if the rule matches a web request, it only counts the match.
Count (dict) --
Override the rule action setting to count.
None (dict) --
Don't override the rule action setting.
VisibilityConfig (dict) --
Defines and enables Amazon CloudWatch metrics and web request sample collection.
SampledRequestsEnabled (boolean) --
A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.
CloudWatchMetricsEnabled (boolean) --
A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics .
MetricName (string) --
A friendly name of the CloudWatch metric. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with length from one to 128 characters. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action." You can't change a MetricName after you create a VisibilityConfig .
VisibilityConfig (dict) --
Defines and enables Amazon CloudWatch metrics and web request sample collection.
SampledRequestsEnabled (boolean) --
A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.
CloudWatchMetricsEnabled (boolean) --
A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics .
MetricName (string) --
A friendly name of the CloudWatch metric. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with length from one to 128 characters. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action." You can't change a MetricName after you create a VisibilityConfig .
Capacity (integer) --
The web ACL capacity units (WCUs) currently being used by this web ACL.
AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
LockToken (string) --
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.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Retrieves the WebACL for the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.get_web_acl_for_resource(
ResourceArn='string'
)
[REQUIRED]
The ARN (Amazon Resource Name) of the resource.
{
'WebACL': {
'Name': 'string',
'Id': 'string',
'ARN': 'string',
'DefaultAction': {
'Block': {},
'Allow': {}
},
'Description': 'string',
'Rules': [
{
'Name': 'string',
'Priority': 123,
'Statement': {
'ByteMatchStatement': {
'SearchString': b'bytes',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {},
'UriPath': {},
'QueryString': {},
'Body': {},
'Method': {}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
],
'PositionalConstraint': 'EXACTLY'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CONTAINS_WORD'
},
'SqliMatchStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {},
'UriPath': {},
'QueryString': {},
'Body': {},
'Method': {}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
]
},
'XssMatchStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {},
'UriPath': {},
'QueryString': {},
'Body': {},
'Method': {}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
]
},
'SizeConstraintStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {},
'UriPath': {},
'QueryString': {},
'Body': {},
'Method': {}
},
'ComparisonOperator': 'EQ'|'NE'|'LE'|'LT'|'GE'|'GT',
'Size': 123,
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
]
},
'GeoMatchStatement': {
'CountryCodes': [
'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CD'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KP'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'US'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW',
]
},
'RuleGroupReferenceStatement': {
'ARN': 'string',
'ExcludedRules': [
{
'Name': 'string'
},
]
},
'IPSetReferenceStatement': {
'ARN': 'string'
},
'RegexPatternSetReferenceStatement': {
'ARN': 'string',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {},
'UriPath': {},
'QueryString': {},
'Body': {},
'Method': {}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
]
},
'RateBasedStatement': {
'Limit': 123,
'AggregateKeyType': 'IP',
'ScopeDownStatement': {'... recursive ...'}
},
'AndStatement': {
'Statements': [
{'... recursive ...'},
]
},
'OrStatement': {
'Statements': [
{'... recursive ...'},
]
},
'NotStatement': {
'Statement': {'... recursive ...'}
},
'ManagedRuleGroupStatement': {
'VendorName': 'string',
'Name': 'string',
'ExcludedRules': [
{
'Name': 'string'
},
]
}
},
'Action': {
'Block': {},
'Allow': {},
'Count': {}
},
'OverrideAction': {
'Count': {},
'None': {}
},
'VisibilityConfig': {
'SampledRequestsEnabled': True|False,
'CloudWatchMetricsEnabled': True|False,
'MetricName': 'string'
}
},
],
'VisibilityConfig': {
'SampledRequestsEnabled': True|False,
'CloudWatchMetricsEnabled': True|False,
'MetricName': 'string'
},
'Capacity': 123
}
}
Response Structure
The Web ACL that is associated with the resource. If there is no associated resource, AWS WAF returns a null Web ACL.
A friendly name of the Web ACL. You cannot change the name of a Web ACL after you create it.
A unique identifier for the WebACL . This ID is returned in the responses to create and list commands. You use this ID to do things like get, update, and delete a WebACL .
The Amazon Resource Name (ARN) of the Web ACL that you want to associate with the resource.
The action to perform if none of the Rules contained in the WebACL match.
Specifies that AWS WAF should block requests by default.
Specifies that AWS WAF should allow requests by default.
A friendly description of the Web ACL. You cannot change the description of a Web ACL after you create it.
The Rule statements used to identify the web requests that you want to allow, block, or count. 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.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
A single rule, which you can use in a WebACL or RuleGroup to identify web requests that you want to allow, block, or count. 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.
A friendly name of the rule. You can't change the name of a Rule after you create it.
If you define more than one Rule in a WebACL , AWS WAF evaluates each request against the Rules in order based on the value of Priority . AWS WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.
The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement .
A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement.
A string value that you want AWS WAF to search for. AWS WAF searches only in the part of web requests that you designate for inspection in FieldToMatch . The maximum length of the value is 50 bytes.
Valid values depend on the areas that you specify for inspection in FieldToMatch :
If SearchString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.
If you're using the AWS WAF API
Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.
For example, suppose the value of Type is HEADER and the value of Data is User-Agent . If you want to search the User-Agent header for the value BadBot , you base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90 , in the value of SearchString .
If you're using the AWS CLI or one of the AWS SDKs
The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
The name of the query header to inspect.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
The name of the query argument to inspect.
Inspect all query arguments.
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
The area within the portion of a web request that you want AWS WAF to search for SearchString . Valid values include the following:
CONTAINS
The specified part of the web request must include the value of SearchString , but the location doesn't matter.
CONTAINS_WORD
The specified part of the web request must include the value of SearchString , and SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, SearchString must be a word, which means that both of the following are true:
EXACTLY
The value of the specified part of the web request must exactly match the value of SearchString .
STARTS_WITH
The value of SearchString must appear at the beginning of the specified part of the web request.
ENDS_WITH
The value of SearchString must appear at the end of the specified part of the web request.
Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
The name of the query header to inspect.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
The name of the query argument to inspect.
Inspect all query arguments.
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings.
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
The name of the query header to inspect.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
The name of the query argument to inspect.
Inspect all query arguments.
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.
If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes.
If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
The name of the query header to inspect.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
The name of the query argument to inspect.
Inspect all query arguments.
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
The operator to use to compare the request part to the size setting.
The size, in byte, to compare to the request part, after any transformations.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
A rule statement used to identify web requests based on country of origin.
An array of two-character country codes, for example, [ "US", "CN" ] , from the alpha-2 country ISO codes of the ISO 3166 international standard.
A rule statement used to run the rules that are defined in a RuleGroup . To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.
You cannot nest a RuleGroupReferenceStatement , for example for use inside a NotStatement or OrStatement . It can only be referenced as a top-level statement within a rule.
The Amazon Resource Name (ARN) of the entity.
The names of rules that are in the referenced rule group, but that you want AWS WAF to exclude from processing for this rule statement.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Specifies a single rule to exclude from the rule group. Excluding a rule overrides its action setting for the rule group in the web ACL, setting it to COUNT . This effectively excludes the rule from acting on web requests.
The name of the rule to exclude.
A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet .
Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
The Amazon Resource Name (ARN) of the IPSet that this statement references.
A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet .
Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
The name of the query header to inspect.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
The name of the query argument to inspect.
Inspect all query arguments.
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.
When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.
You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:
In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.
You cannot nest a RateBasedStatement , for example for use inside a NotStatement or OrStatement . It can only be referenced as a top-level statement within a rule.
The limit on requests per 5-minute period for a single originating IP address. If the statement includes a ScopDownStatement , this limit is applied only to the requests that match the statement.
Setting that indicates how to aggregate the request counts. Currently, you must set this to IP . The request counts are aggregated on IP addresses.
An optional nested statement that narrows the scope of the rate-based statement to matching web requests. This can be any nestable statement, and you can nest statements at any level below this scope-down statement.
A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement .
The statements to combine with AND logic. You can use any statements that can be nested.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
The processing guidance for a Rule , used by AWS WAF to determine whether a web request matches the rule.
A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement .
The statements to combine with OR logic. You can use any statements that can be nested.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
The processing guidance for a Rule , used by AWS WAF to determine whether a web request matches the rule.
A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement .
The statement to negate. You can use any statement that can be nested.
A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups .
You can't nest a ManagedRuleGroupStatement , for example for use inside a NotStatement or OrStatement . It can only be referenced as a top-level statement within a rule.
The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Specifies a single rule to exclude from the rule group. Excluding a rule overrides its action setting for the rule group in the web ACL, setting it to COUNT . This effectively excludes the rule from acting on web requests.
The name of the rule to exclude.
The action that AWS WAF should take on a web request when it matches the rule's statement. Settings at the web ACL level can override the rule action setting.
Instructs AWS WAF to block the web request.
Instructs AWS WAF to allow the web request.
Instructs AWS WAF to count the web request and allow it.
The action to use to override the rule's Action setting. You can use no override action, in which case the rule action is in effect, or count action, in which case, if the rule matches a web request, it only counts the match.
Override the rule action setting to count.
Don't override the rule action setting.
Defines and enables Amazon CloudWatch metrics and web request sample collection.
A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.
A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics .
A friendly name of the CloudWatch metric. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with length from one to 128 characters. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action." You can't change a MetricName after you create a VisibilityConfig .
Defines and enables Amazon CloudWatch metrics and web request sample collection.
A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.
A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics .
A friendly name of the CloudWatch metric. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with length from one to 128 characters. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action." You can't change a MetricName after you create a VisibilityConfig .
The web ACL capacity units (WCUs) currently being used by this web ACL.
AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Retrieves an array of managed rule groups that are available for you to use. This list includes all AWS Managed Rules rule groups and the AWS Marketplace managed rule groups that you're subscribed to.
See also: AWS API Documentation
Request Syntax
response = client.list_available_managed_rule_groups(
Scope='CLOUDFRONT'|'REGIONAL',
NextMarker='string',
Limit=123
)
[REQUIRED]
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
dict
Response Syntax
{
'NextMarker': 'string',
'ManagedRuleGroups': [
{
'VendorName': 'string',
'Name': 'string',
'Description': 'string'
},
]
}
Response Structure
(dict) --
NextMarker (string) --
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.
ManagedRuleGroups (list) --
(dict) --
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
High-level information about a managed rule group, returned by ListAvailableManagedRuleGroups . This provides information like the name and vendor name, that you provide when you add a ManagedRuleGroupStatement to a web ACL. Managed rule groups include AWS Managed Rules rule groups, which are free of charge to AWS WAF customers, and AWS Marketplace managed rule groups, which you can subscribe to through AWS Marketplace.
VendorName (string) --
The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
Name (string) --
The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
Description (string) --
The description of the managed rule group, provided by AWS Managed Rules or the AWS Marketplace seller who manages it.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Retrieves an array of IPSetSummary objects for the IP sets that you manage.
See also: AWS API Documentation
Request Syntax
response = client.list_ip_sets(
Scope='CLOUDFRONT'|'REGIONAL',
NextMarker='string',
Limit=123
)
[REQUIRED]
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
dict
Response Syntax
{
'NextMarker': 'string',
'IPSets': [
{
'Name': 'string',
'Id': 'string',
'Description': 'string',
'LockToken': 'string',
'ARN': 'string'
},
]
}
Response Structure
(dict) --
NextMarker (string) --
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.
IPSets (list) --
Array of IPSets. This may not be the full list of IPSets that you have defined. See the Limit specification for this request.
(dict) --
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
High-level information about an IPSet , returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an IPSet , and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule .
Name (string) --
A friendly name of the IP set. You cannot change the name of an IPSet after you create it.
Id (string) --
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.
Description (string) --
A friendly description of the IP set. You cannot change the description of an IP set after you create it.
LockToken (string) --
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.
ARN (string) --
The Amazon Resource Name (ARN) of the entity.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Retrieves an array of your LoggingConfiguration objects.
See also: AWS API Documentation
Request Syntax
response = client.list_logging_configurations(
Scope='CLOUDFRONT'|'REGIONAL',
NextMarker='string',
Limit=123
)
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
dict
Response Syntax
{
'LoggingConfigurations': [
{
'ResourceArn': 'string',
'LogDestinationConfigs': [
'string',
],
'RedactedFields': [
{
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {},
'UriPath': {},
'QueryString': {},
'Body': {},
'Method': {}
},
]
},
],
'NextMarker': 'string'
}
Response Structure
(dict) --
LoggingConfigurations (list) --
(dict) --
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Defines an association between Amazon Kinesis Data Firehose destinations and a web ACL resource, for logging from AWS WAF. As part of the association, you can specify parts of the standard logging fields to keep out of the logs.
ResourceArn (string) --
The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs .
LogDestinationConfigs (list) --
The Amazon Kinesis Data Firehose Amazon Resource Name (ARNs) that you want to associate with the web ACL.
RedactedFields (list) --
The parts of the request that you want to keep out of the logs. For example, if you redact the cookie field, the cookie field in the firehose will be xxx .
(dict) --
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
The part of a web request that you want AWS WAF to inspect. Include the FieldToMatch types that you want to inspect, with additional specifications as needed, according to the type.
SingleHeader (dict) --
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
Name (string) --
The name of the query header to inspect.
SingleQueryArgument (dict) --
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
Name (string) --
The name of the query argument to inspect.
AllQueryArguments (dict) --
Inspect all query arguments.
UriPath (dict) --
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
QueryString (dict) --
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Body (dict) --
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Method (dict) --
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
NextMarker (string) --
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.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage.
See also: AWS API Documentation
Request Syntax
response = client.list_regex_pattern_sets(
Scope='CLOUDFRONT'|'REGIONAL',
NextMarker='string',
Limit=123
)
[REQUIRED]
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
dict
Response Syntax
{
'NextMarker': 'string',
'RegexPatternSets': [
{
'Name': 'string',
'Id': 'string',
'Description': 'string',
'LockToken': 'string',
'ARN': 'string'
},
]
}
Response Structure
(dict) --
NextMarker (string) --
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.
RegexPatternSets (list) --
(dict) --
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
High-level information about a RegexPatternSet , returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RegexPatternSet , and the ARN, that you provide to the RegexPatternSetReferenceStatement to use the pattern set in a Rule .
Name (string) --
A friendly name of the data type instance. You cannot change the name after you create the instance.
Id (string) --
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.
Description (string) --
A friendly description of the set. You cannot change the description of a set after you create it.
LockToken (string) --
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.
ARN (string) --
The Amazon Resource Name (ARN) of the entity.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that are associated with the specified web ACL. If you want the list of AWS CloudFront resources, use the AWS CloudFront call ListDistributionsByWebACLId .
See also: AWS API Documentation
Request Syntax
response = client.list_resources_for_web_acl(
WebACLArn='string',
ResourceType='APPLICATION_LOAD_BALANCER'|'API_GATEWAY'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the Web ACL.
dict
Response Syntax
{
'ResourceArns': [
'string',
]
}
Response Structure
(dict) --
ResourceArns (list) --
The array of Amazon Resource Names (ARNs) of the associated resources.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Retrieves an array of RuleGroupSummary objects for the rule groups that you manage.
See also: AWS API Documentation
Request Syntax
response = client.list_rule_groups(
Scope='CLOUDFRONT'|'REGIONAL',
NextMarker='string',
Limit=123
)
[REQUIRED]
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
dict
Response Syntax
{
'NextMarker': 'string',
'RuleGroups': [
{
'Name': 'string',
'Id': 'string',
'Description': 'string',
'LockToken': 'string',
'ARN': 'string'
},
]
}
Response Structure
(dict) --
NextMarker (string) --
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.
RuleGroups (list) --
(dict) --
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
High-level information about a RuleGroup , returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RuleGroup , and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule .
Name (string) --
A friendly name of the data type instance. You cannot change the name after you create the instance.
Id (string) --
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.
Description (string) --
A friendly description of the rule group. You cannot change the description of a rule group after you create it.
LockToken (string) --
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.
ARN (string) --
The Amazon Resource Name (ARN) of the entity.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Retrieves the TagInfoForResource for the specified resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
NextMarker='string',
Limit=123,
ResourceARN='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
dict
Response Syntax
{
'NextMarker': 'string',
'TagInfoForResource': {
'ResourceARN': 'string',
'TagList': [
{
'Key': 'string',
'Value': 'string'
},
]
}
}
Response Structure
(dict) --
NextMarker (string) --
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.
TagInfoForResource (dict) --
The collection of tagging definitions for the resource.
ResourceARN (string) --
The Amazon Resource Name (ARN) of the resource.
TagList (list) --
The array of Tag objects defined for the resource.
(dict) --
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
A collection of key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each AWS resource.
Key (string) --
Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Value (string) --
Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Retrieves an array of WebACLSummary objects for the web ACLs that you manage.
See also: AWS API Documentation
Request Syntax
response = client.list_web_acls(
Scope='CLOUDFRONT'|'REGIONAL',
NextMarker='string',
Limit=123
)
[REQUIRED]
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
dict
Response Syntax
{
'NextMarker': 'string',
'WebACLs': [
{
'Name': 'string',
'Id': 'string',
'Description': 'string',
'LockToken': 'string',
'ARN': 'string'
},
]
}
Response Structure
(dict) --
NextMarker (string) --
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.
WebACLs (list) --
(dict) --
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
High-level information about a WebACL , returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a WebACL , and the ARN, that you provide to operations like AssociateWebACL .
Name (string) --
A friendly name of the Web ACL. You cannot change the name of a Web ACL after you create it.
Id (string) --
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.
Description (string) --
A friendly description of the Web ACL. You cannot change the description of a Web ACL after you create it.
LockToken (string) --
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.
ARN (string) --
The Amazon Resource Name (ARN) of the entity.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Enables the specified LoggingConfiguration , to start logging from a web ACL, according to the configuration provided.
You can access information about all traffic that AWS WAF inspects using the following steps:
Note
Do not create the data firehose using a Kinesis stream as your source.
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 Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide .
See also: AWS API Documentation
Request Syntax
response = client.put_logging_configuration(
LoggingConfiguration={
'ResourceArn': 'string',
'LogDestinationConfigs': [
'string',
],
'RedactedFields': [
{
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {}
,
'Method': {}
},
]
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs .
The Amazon Kinesis Data Firehose Amazon Resource Name (ARNs) that you want to associate with the web ACL.
The parts of the request that you want to keep out of the logs. For example, if you redact the cookie field, the cookie field in the firehose will be xxx .
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
The part of a web request that you want AWS WAF to inspect. Include the FieldToMatch types that you want to inspect, with additional specifications as needed, according to the type.
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
The name of the query header to inspect.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
The name of the query argument to inspect.
Inspect all query arguments.
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
{
'LoggingConfiguration': {
'ResourceArn': 'string',
'LogDestinationConfigs': [
'string',
],
'RedactedFields': [
{
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {},
'UriPath': {},
'QueryString': {},
'Body': {},
'Method': {}
},
]
}
}
Response Structure
The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs .
The Amazon Kinesis Data Firehose Amazon Resource Name (ARNs) that you want to associate with the web ACL.
The parts of the request that you want to keep out of the logs. For example, if you redact the cookie field, the cookie field in the firehose will be xxx .
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
The part of a web request that you want AWS WAF to inspect. Include the FieldToMatch types that you want to inspect, with additional specifications as needed, according to the type.
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
The name of the query header to inspect.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
The name of the query argument to inspect.
Inspect all query arguments.
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Associates tags with the specified 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.
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
ResourceARN='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
[REQUIRED]
An array of key:value pairs to associate with the resource.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
A collection of key:value pairs associated with an AWS resource. The key:value pair can be anything you define. Typically, the tag key represents a category (such as "environment") and the tag value represents a specific value within that category (such as "test," "development," or "production"). You can add up to 50 tags to each AWS resource.
Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
dict
Response Syntax
{}
Response Structure
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
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.
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
ResourceARN='string',
TagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the resource.
[REQUIRED]
An array of keys identifying the tags to disassociate from the resource.
dict
Response Syntax
{}
Response Structure
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Updates the specified IPSet .
See also: AWS API Documentation
Request Syntax
response = client.update_ip_set(
Name='string',
Scope='CLOUDFRONT'|'REGIONAL',
Id='string',
Description='string',
Addresses=[
'string',
],
LockToken='string'
)
[REQUIRED]
A friendly name of the IP set. You cannot change the name of an IPSet after you create it.
[REQUIRED]
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
[REQUIRED]
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.
[REQUIRED]
Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all address ranges for IP versions IPv4 and IPv6.
Examples:
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing .
[REQUIRED]
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.
dict
Response Syntax
{
'NextLockToken': 'string'
}
Response Structure
(dict) --
NextLockToken (string) --
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 .
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Updates the specified RegexPatternSet .
See also: AWS API Documentation
Request Syntax
response = client.update_regex_pattern_set(
Name='string',
Scope='CLOUDFRONT'|'REGIONAL',
Id='string',
Description='string',
RegularExpressionList=[
{
'RegexString': 'string'
},
],
LockToken='string'
)
[REQUIRED]
A friendly name of the set. You cannot change the name after you create the set.
[REQUIRED]
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
[REQUIRED]
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.
[REQUIRED]
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
A single regular expression. This is used in a RegexPatternSet .
The string representing the regular expression.
[REQUIRED]
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.
dict
Response Syntax
{
'NextLockToken': 'string'
}
Response Structure
(dict) --
NextLockToken (string) --
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 .
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Updates the specified RuleGroup .
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.
See also: AWS API Documentation
Request Syntax
response = client.update_rule_group(
Name='string',
Scope='CLOUDFRONT'|'REGIONAL',
Id='string',
Description='string',
Rules=[
{
'Name': 'string',
'Priority': 123,
'Statement': {
'ByteMatchStatement': {
'SearchString': b'bytes',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {}
,
'Method': {}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
],
'PositionalConstraint': 'EXACTLY'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CONTAINS_WORD'
},
'SqliMatchStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {}
,
'Method': {}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
]
},
'XssMatchStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {}
,
'Method': {}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
]
},
'SizeConstraintStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {}
,
'Method': {}
},
'ComparisonOperator': 'EQ'|'NE'|'LE'|'LT'|'GE'|'GT',
'Size': 123,
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
]
},
'GeoMatchStatement': {
'CountryCodes': [
'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CD'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KP'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'US'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW',
]
},
'RuleGroupReferenceStatement': {
'ARN': 'string',
'ExcludedRules': [
{
'Name': 'string'
},
]
},
'IPSetReferenceStatement': {
'ARN': 'string'
},
'RegexPatternSetReferenceStatement': {
'ARN': 'string',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {}
,
'Method': {}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
]
},
'RateBasedStatement': {
'Limit': 123,
'AggregateKeyType': 'IP',
'ScopeDownStatement': {'... recursive ...'}
},
'AndStatement': {
'Statements': [
{'... recursive ...'},
]
},
'OrStatement': {
'Statements': [
{'... recursive ...'},
]
},
'NotStatement': {
'Statement': {'... recursive ...'}
},
'ManagedRuleGroupStatement': {
'VendorName': 'string',
'Name': 'string',
'ExcludedRules': [
{
'Name': 'string'
},
]
}
},
'Action': {
'Block': {}
,
'Allow': {}
,
'Count': {}
},
'OverrideAction': {
'Count': {}
,
'None': {}
},
'VisibilityConfig': {
'SampledRequestsEnabled': True|False,
'CloudWatchMetricsEnabled': True|False,
'MetricName': 'string'
}
},
],
VisibilityConfig={
'SampledRequestsEnabled': True|False,
'CloudWatchMetricsEnabled': True|False,
'MetricName': 'string'
},
LockToken='string'
)
[REQUIRED]
A friendly name of the rule group. You cannot change the name of a rule group after you create it.
[REQUIRED]
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
[REQUIRED]
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.
The Rule statements used to identify the web requests that you want to allow, block, or count. 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.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
A single rule, which you can use in a WebACL or RuleGroup to identify web requests that you want to allow, block, or count. 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.
A friendly name of the rule. You can't change the name of a Rule after you create it.
If you define more than one Rule in a WebACL , AWS WAF evaluates each request against the Rules in order based on the value of Priority . AWS WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.
The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement .
A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement.
A string value that you want AWS WAF to search for. AWS WAF searches only in the part of web requests that you designate for inspection in FieldToMatch . The maximum length of the value is 50 bytes.
Valid values depend on the areas that you specify for inspection in FieldToMatch :
If SearchString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.
If you're using the AWS WAF API
Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.
For example, suppose the value of Type is HEADER and the value of Data is User-Agent . If you want to search the User-Agent header for the value BadBot , you base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90 , in the value of SearchString .
If you're using the AWS CLI or one of the AWS SDKs
The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
The name of the query header to inspect.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
The name of the query argument to inspect.
Inspect all query arguments.
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
The area within the portion of a web request that you want AWS WAF to search for SearchString . Valid values include the following:
CONTAINS
The specified part of the web request must include the value of SearchString , but the location doesn't matter.
CONTAINS_WORD
The specified part of the web request must include the value of SearchString , and SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, SearchString must be a word, which means that both of the following are true:
EXACTLY
The value of the specified part of the web request must exactly match the value of SearchString .
STARTS_WITH
The value of SearchString must appear at the beginning of the specified part of the web request.
ENDS_WITH
The value of SearchString must appear at the end of the specified part of the web request.
Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
The name of the query header to inspect.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
The name of the query argument to inspect.
Inspect all query arguments.
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings.
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
The name of the query header to inspect.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
The name of the query argument to inspect.
Inspect all query arguments.
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.
If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes.
If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
The name of the query header to inspect.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
The name of the query argument to inspect.
Inspect all query arguments.
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
The operator to use to compare the request part to the size setting.
The size, in byte, to compare to the request part, after any transformations.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
A rule statement used to identify web requests based on country of origin.
An array of two-character country codes, for example, [ "US", "CN" ] , from the alpha-2 country ISO codes of the ISO 3166 international standard.
A rule statement used to run the rules that are defined in a RuleGroup . To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.
You cannot nest a RuleGroupReferenceStatement , for example for use inside a NotStatement or OrStatement . It can only be referenced as a top-level statement within a rule.
The Amazon Resource Name (ARN) of the entity.
The names of rules that are in the referenced rule group, but that you want AWS WAF to exclude from processing for this rule statement.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Specifies a single rule to exclude from the rule group. Excluding a rule overrides its action setting for the rule group in the web ACL, setting it to COUNT . This effectively excludes the rule from acting on web requests.
The name of the rule to exclude.
A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet .
Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
The Amazon Resource Name (ARN) of the IPSet that this statement references.
A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet .
Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
The name of the query header to inspect.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
The name of the query argument to inspect.
Inspect all query arguments.
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.
When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.
You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:
In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.
You cannot nest a RateBasedStatement , for example for use inside a NotStatement or OrStatement . It can only be referenced as a top-level statement within a rule.
The limit on requests per 5-minute period for a single originating IP address. If the statement includes a ScopDownStatement , this limit is applied only to the requests that match the statement.
Setting that indicates how to aggregate the request counts. Currently, you must set this to IP . The request counts are aggregated on IP addresses.
An optional nested statement that narrows the scope of the rate-based statement to matching web requests. This can be any nestable statement, and you can nest statements at any level below this scope-down statement.
A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement .
The statements to combine with AND logic. You can use any statements that can be nested.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
The processing guidance for a Rule , used by AWS WAF to determine whether a web request matches the rule.
A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement .
The statements to combine with OR logic. You can use any statements that can be nested.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
The processing guidance for a Rule , used by AWS WAF to determine whether a web request matches the rule.
A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement .
The statement to negate. You can use any statement that can be nested.
A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups .
You can't nest a ManagedRuleGroupStatement , for example for use inside a NotStatement or OrStatement . It can only be referenced as a top-level statement within a rule.
The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Specifies a single rule to exclude from the rule group. Excluding a rule overrides its action setting for the rule group in the web ACL, setting it to COUNT . This effectively excludes the rule from acting on web requests.
The name of the rule to exclude.
The action that AWS WAF should take on a web request when it matches the rule's statement. Settings at the web ACL level can override the rule action setting.
Instructs AWS WAF to block the web request.
Instructs AWS WAF to allow the web request.
Instructs AWS WAF to count the web request and allow it.
The action to use to override the rule's Action setting. You can use no override action, in which case the rule action is in effect, or count action, in which case, if the rule matches a web request, it only counts the match.
Override the rule action setting to count.
Don't override the rule action setting.
Defines and enables Amazon CloudWatch metrics and web request sample collection.
A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.
A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics .
A friendly name of the CloudWatch metric. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with length from one to 128 characters. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action." You can't change a MetricName after you create a VisibilityConfig .
[REQUIRED]
Defines and enables Amazon CloudWatch metrics and web request sample collection.
A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.
A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics .
A friendly name of the CloudWatch metric. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with length from one to 128 characters. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action." You can't change a MetricName after you create a VisibilityConfig .
[REQUIRED]
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.
dict
Response Syntax
{
'NextLockToken': 'string'
}
Response Structure
(dict) --
NextLockToken (string) --
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 .
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Updates the specified WebACL .
A Web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. 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 resources can be Amazon CloudFront, an Amazon API Gateway API, or an Application Load Balancer.
See also: AWS API Documentation
Request Syntax
response = client.update_web_acl(
Name='string',
Scope='CLOUDFRONT'|'REGIONAL',
Id='string',
DefaultAction={
'Block': {}
,
'Allow': {}
},
Description='string',
Rules=[
{
'Name': 'string',
'Priority': 123,
'Statement': {
'ByteMatchStatement': {
'SearchString': b'bytes',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {}
,
'Method': {}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
],
'PositionalConstraint': 'EXACTLY'|'STARTS_WITH'|'ENDS_WITH'|'CONTAINS'|'CONTAINS_WORD'
},
'SqliMatchStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {}
,
'Method': {}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
]
},
'XssMatchStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {}
,
'Method': {}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
]
},
'SizeConstraintStatement': {
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {}
,
'Method': {}
},
'ComparisonOperator': 'EQ'|'NE'|'LE'|'LT'|'GE'|'GT',
'Size': 123,
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
]
},
'GeoMatchStatement': {
'CountryCodes': [
'AF'|'AX'|'AL'|'DZ'|'AS'|'AD'|'AO'|'AI'|'AQ'|'AG'|'AR'|'AM'|'AW'|'AU'|'AT'|'AZ'|'BS'|'BH'|'BD'|'BB'|'BY'|'BE'|'BZ'|'BJ'|'BM'|'BT'|'BO'|'BQ'|'BA'|'BW'|'BV'|'BR'|'IO'|'BN'|'BG'|'BF'|'BI'|'KH'|'CM'|'CA'|'CV'|'KY'|'CF'|'TD'|'CL'|'CN'|'CX'|'CC'|'CO'|'KM'|'CG'|'CD'|'CK'|'CR'|'CI'|'HR'|'CU'|'CW'|'CY'|'CZ'|'DK'|'DJ'|'DM'|'DO'|'EC'|'EG'|'SV'|'GQ'|'ER'|'EE'|'ET'|'FK'|'FO'|'FJ'|'FI'|'FR'|'GF'|'PF'|'TF'|'GA'|'GM'|'GE'|'DE'|'GH'|'GI'|'GR'|'GL'|'GD'|'GP'|'GU'|'GT'|'GG'|'GN'|'GW'|'GY'|'HT'|'HM'|'VA'|'HN'|'HK'|'HU'|'IS'|'IN'|'ID'|'IR'|'IQ'|'IE'|'IM'|'IL'|'IT'|'JM'|'JP'|'JE'|'JO'|'KZ'|'KE'|'KI'|'KP'|'KR'|'KW'|'KG'|'LA'|'LV'|'LB'|'LS'|'LR'|'LY'|'LI'|'LT'|'LU'|'MO'|'MK'|'MG'|'MW'|'MY'|'MV'|'ML'|'MT'|'MH'|'MQ'|'MR'|'MU'|'YT'|'MX'|'FM'|'MD'|'MC'|'MN'|'ME'|'MS'|'MA'|'MZ'|'MM'|'NA'|'NR'|'NP'|'NL'|'NC'|'NZ'|'NI'|'NE'|'NG'|'NU'|'NF'|'MP'|'NO'|'OM'|'PK'|'PW'|'PS'|'PA'|'PG'|'PY'|'PE'|'PH'|'PN'|'PL'|'PT'|'PR'|'QA'|'RE'|'RO'|'RU'|'RW'|'BL'|'SH'|'KN'|'LC'|'MF'|'PM'|'VC'|'WS'|'SM'|'ST'|'SA'|'SN'|'RS'|'SC'|'SL'|'SG'|'SX'|'SK'|'SI'|'SB'|'SO'|'ZA'|'GS'|'SS'|'ES'|'LK'|'SD'|'SR'|'SJ'|'SZ'|'SE'|'CH'|'SY'|'TW'|'TJ'|'TZ'|'TH'|'TL'|'TG'|'TK'|'TO'|'TT'|'TN'|'TR'|'TM'|'TC'|'TV'|'UG'|'UA'|'AE'|'GB'|'US'|'UM'|'UY'|'UZ'|'VU'|'VE'|'VN'|'VG'|'VI'|'WF'|'EH'|'YE'|'ZM'|'ZW',
]
},
'RuleGroupReferenceStatement': {
'ARN': 'string',
'ExcludedRules': [
{
'Name': 'string'
},
]
},
'IPSetReferenceStatement': {
'ARN': 'string'
},
'RegexPatternSetReferenceStatement': {
'ARN': 'string',
'FieldToMatch': {
'SingleHeader': {
'Name': 'string'
},
'SingleQueryArgument': {
'Name': 'string'
},
'AllQueryArguments': {}
,
'UriPath': {}
,
'QueryString': {}
,
'Body': {}
,
'Method': {}
},
'TextTransformations': [
{
'Priority': 123,
'Type': 'NONE'|'COMPRESS_WHITE_SPACE'|'HTML_ENTITY_DECODE'|'LOWERCASE'|'CMD_LINE'|'URL_DECODE'
},
]
},
'RateBasedStatement': {
'Limit': 123,
'AggregateKeyType': 'IP',
'ScopeDownStatement': {'... recursive ...'}
},
'AndStatement': {
'Statements': [
{'... recursive ...'},
]
},
'OrStatement': {
'Statements': [
{'... recursive ...'},
]
},
'NotStatement': {
'Statement': {'... recursive ...'}
},
'ManagedRuleGroupStatement': {
'VendorName': 'string',
'Name': 'string',
'ExcludedRules': [
{
'Name': 'string'
},
]
}
},
'Action': {
'Block': {}
,
'Allow': {}
,
'Count': {}
},
'OverrideAction': {
'Count': {}
,
'None': {}
},
'VisibilityConfig': {
'SampledRequestsEnabled': True|False,
'CloudWatchMetricsEnabled': True|False,
'MetricName': 'string'
}
},
],
VisibilityConfig={
'SampledRequestsEnabled': True|False,
'CloudWatchMetricsEnabled': True|False,
'MetricName': 'string'
},
LockToken='string'
)
[REQUIRED]
A friendly name of the Web ACL. You cannot change the name of a Web ACL after you create it.
[REQUIRED]
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
[REQUIRED]
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.
[REQUIRED]
The action to perform if none of the Rules contained in the WebACL match.
Specifies that AWS WAF should block requests by default.
Specifies that AWS WAF should allow requests by default.
The Rule statements used to identify the web requests that you want to allow, block, or count. 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.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
A single rule, which you can use in a WebACL or RuleGroup to identify web requests that you want to allow, block, or count. 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.
A friendly name of the rule. You can't change the name of a Rule after you create it.
If you define more than one Rule in a WebACL , AWS WAF evaluates each request against the Rules in order based on the value of Priority . AWS WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.
The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement .
A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement.
A string value that you want AWS WAF to search for. AWS WAF searches only in the part of web requests that you designate for inspection in FieldToMatch . The maximum length of the value is 50 bytes.
Valid values depend on the areas that you specify for inspection in FieldToMatch :
If SearchString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.
If you're using the AWS WAF API
Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.
For example, suppose the value of Type is HEADER and the value of Data is User-Agent . If you want to search the User-Agent header for the value BadBot , you base64-encode BadBot using MIME base64-encoding and include the resulting value, QmFkQm90 , in the value of SearchString .
If you're using the AWS CLI or one of the AWS SDKs
The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
The name of the query header to inspect.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
The name of the query argument to inspect.
Inspect all query arguments.
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
The area within the portion of a web request that you want AWS WAF to search for SearchString . Valid values include the following:
CONTAINS
The specified part of the web request must include the value of SearchString , but the location doesn't matter.
CONTAINS_WORD
The specified part of the web request must include the value of SearchString , and SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, SearchString must be a word, which means that both of the following are true:
EXACTLY
The value of the specified part of the web request must exactly match the value of SearchString .
STARTS_WITH
The value of SearchString must appear at the beginning of the specified part of the web request.
ENDS_WITH
The value of SearchString must appear at the end of the specified part of the web request.
Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
The name of the query header to inspect.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
The name of the query argument to inspect.
Inspect all query arguments.
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings.
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
The name of the query header to inspect.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
The name of the query argument to inspect.
Inspect all query arguments.
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.
If you configure AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes.
If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
The name of the query header to inspect.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
The name of the query argument to inspect.
Inspect all query arguments.
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
The operator to use to compare the request part to the size setting.
The size, in byte, to compare to the request part, after any transformations.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
A rule statement used to identify web requests based on country of origin.
An array of two-character country codes, for example, [ "US", "CN" ] , from the alpha-2 country ISO codes of the ISO 3166 international standard.
A rule statement used to run the rules that are defined in a RuleGroup . To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.
You cannot nest a RuleGroupReferenceStatement , for example for use inside a NotStatement or OrStatement . It can only be referenced as a top-level statement within a rule.
The Amazon Resource Name (ARN) of the entity.
The names of rules that are in the referenced rule group, but that you want AWS WAF to exclude from processing for this rule statement.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Specifies a single rule to exclude from the rule group. Excluding a rule overrides its action setting for the rule group in the web ACL, setting it to COUNT . This effectively excludes the rule from acting on web requests.
The name of the rule to exclude.
A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet .
Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
The Amazon Resource Name (ARN) of the IPSet that this statement references.
A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet .
Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.
The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch .
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer . This setting isn't case sensitive.
The name of the query header to inspect.
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion . The name can be up to 30 characters long and isn't case sensitive.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
The name of the query argument to inspect.
Inspect all query arguments.
Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg .
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Inspect the request body, which immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement , with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content identified by FieldToMatch , starting from the lowest priority setting, before inspecting the content for a match.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Sets the relative processing order for multiple transformations that are defined for a rule statement. AWS WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
You can specify the following transformation types:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.
When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.
You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:
In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.
You cannot nest a RateBasedStatement , for example for use inside a NotStatement or OrStatement . It can only be referenced as a top-level statement within a rule.
The limit on requests per 5-minute period for a single originating IP address. If the statement includes a ScopDownStatement , this limit is applied only to the requests that match the statement.
Setting that indicates how to aggregate the request counts. Currently, you must set this to IP . The request counts are aggregated on IP addresses.
An optional nested statement that narrows the scope of the rate-based statement to matching web requests. This can be any nestable statement, and you can nest statements at any level below this scope-down statement.
A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement .
The statements to combine with AND logic. You can use any statements that can be nested.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
The processing guidance for a Rule , used by AWS WAF to determine whether a web request matches the rule.
A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement .
The statements to combine with OR logic. You can use any statements that can be nested.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
The processing guidance for a Rule , used by AWS WAF to determine whether a web request matches the rule.
A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement .
The statement to negate. You can use any statement that can be nested.
A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups .
You can't nest a ManagedRuleGroupStatement , for example for use inside a NotStatement or OrStatement . It can only be referenced as a top-level statement within a rule.
The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests.
Note
This is the latest version of AWS WAF , named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide .
Specifies a single rule to exclude from the rule group. Excluding a rule overrides its action setting for the rule group in the web ACL, setting it to COUNT . This effectively excludes the rule from acting on web requests.
The name of the rule to exclude.
The action that AWS WAF should take on a web request when it matches the rule's statement. Settings at the web ACL level can override the rule action setting.
Instructs AWS WAF to block the web request.
Instructs AWS WAF to allow the web request.
Instructs AWS WAF to count the web request and allow it.
The action to use to override the rule's Action setting. You can use no override action, in which case the rule action is in effect, or count action, in which case, if the rule matches a web request, it only counts the match.
Override the rule action setting to count.
Don't override the rule action setting.
Defines and enables Amazon CloudWatch metrics and web request sample collection.
A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.
A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics .
A friendly name of the CloudWatch metric. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with length from one to 128 characters. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action." You can't change a MetricName after you create a VisibilityConfig .
[REQUIRED]
Defines and enables Amazon CloudWatch metrics and web request sample collection.
A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.
A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics .
A friendly name of the CloudWatch metric. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with length from one to 128 characters. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action." You can't change a MetricName after you create a VisibilityConfig .
[REQUIRED]
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.
dict
Response Syntax
{
'NextLockToken': 'string'
}
Response Structure
(dict) --
NextLockToken (string) --
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 .
The available paginators are: