UNPKG

247 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class WAF extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: WAF.Types.ClientConfiguration)
13 config: Config & WAF.Types.ClientConfiguration;
14 /**
15 * Creates a ByteMatchSet. You then use UpdateByteMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a ByteMatchSet that matches any requests with User-Agent headers that contain the string BadBot. You can then configure AWS WAF to reject those requests. To create and configure a ByteMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateByteMatchSet request. Submit a CreateByteMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
16 */
17 createByteMatchSet(params: WAF.Types.CreateByteMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.CreateByteMatchSetResponse) => void): Request<WAF.Types.CreateByteMatchSetResponse, AWSError>;
18 /**
19 * Creates a ByteMatchSet. You then use UpdateByteMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a ByteMatchSet that matches any requests with User-Agent headers that contain the string BadBot. You can then configure AWS WAF to reject those requests. To create and configure a ByteMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateByteMatchSet request. Submit a CreateByteMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
20 */
21 createByteMatchSet(callback?: (err: AWSError, data: WAF.Types.CreateByteMatchSetResponse) => void): Request<WAF.Types.CreateByteMatchSetResponse, AWSError>;
22 /**
23 * Creates an GeoMatchSet, which you use to specify which web requests you want to allow or block based on the country that the requests originate from. For example, if you're receiving a lot of requests from one or more countries and you want to block the requests, you can create an GeoMatchSet that contains those countries and then configure AWS WAF to block the requests. To create and configure a GeoMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateGeoMatchSet request. Submit a CreateGeoMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateGeoMatchSet request. Submit an UpdateGeoMatchSetSet request to specify the countries that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
24 */
25 createGeoMatchSet(params: WAF.Types.CreateGeoMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.CreateGeoMatchSetResponse) => void): Request<WAF.Types.CreateGeoMatchSetResponse, AWSError>;
26 /**
27 * Creates an GeoMatchSet, which you use to specify which web requests you want to allow or block based on the country that the requests originate from. For example, if you're receiving a lot of requests from one or more countries and you want to block the requests, you can create an GeoMatchSet that contains those countries and then configure AWS WAF to block the requests. To create and configure a GeoMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateGeoMatchSet request. Submit a CreateGeoMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateGeoMatchSet request. Submit an UpdateGeoMatchSetSet request to specify the countries that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
28 */
29 createGeoMatchSet(callback?: (err: AWSError, data: WAF.Types.CreateGeoMatchSetResponse) => void): Request<WAF.Types.CreateGeoMatchSetResponse, AWSError>;
30 /**
31 * Creates an IPSet, which you use to specify which web requests that you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an IPSet that contains those IP addresses and then configure AWS WAF to block the requests. To create and configure an IPSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateIPSet request. Submit a CreateIPSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
32 */
33 createIPSet(params: WAF.Types.CreateIPSetRequest, callback?: (err: AWSError, data: WAF.Types.CreateIPSetResponse) => void): Request<WAF.Types.CreateIPSetResponse, AWSError>;
34 /**
35 * Creates an IPSet, which you use to specify which web requests that you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an IPSet that contains those IP addresses and then configure AWS WAF to block the requests. To create and configure an IPSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateIPSet request. Submit a CreateIPSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
36 */
37 createIPSet(callback?: (err: AWSError, data: WAF.Types.CreateIPSetResponse) => void): Request<WAF.Types.CreateIPSetResponse, AWSError>;
38 /**
39 * Creates a RateBasedRule. The RateBasedRule contains a RateLimit, which specifies the maximum number of requests that AWS WAF allows from a specified IP address in a five-minute period. The RateBasedRule also contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to count or block if these requests exceed the RateLimit. If you add more than one predicate to a RateBasedRule, a request not only must exceed the RateLimit, but it also must match all the specifications to be counted or blocked. For example, suppose you add the following to a RateBasedRule: An IPSet that matches the IP address 192.0.2.44/32 A ByteMatchSet that matches BadBot in the User-Agent header Further, you specify a RateLimit of 15,000. You then add the RateBasedRule to a WebACL and specify that you want to block requests that meet the conditions in the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions must be received at a rate of more than 15,000 requests every five minutes. If both conditions are met and the rate is exceeded, AWS WAF blocks the requests. If the rate drops below 15,000 for a five-minute period, AWS WAF no longer blocks the requests. As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule: A ByteMatchSet with FieldToMatch of URI A PositionalConstraint of STARTS_WITH A TargetString of login Further, you specify a RateLimit of 15,000. By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site. To create and configure a RateBasedRule, perform the following steps: Create and update the predicates that you want to include in the rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request. Submit a CreateRateBasedRule request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. Submit an UpdateRateBasedRule request to specify the predicates that you want to include in the rule. Create and update a WebACL that contains the RateBasedRule. For more information, see CreateWebACL. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
40 */
41 createRateBasedRule(params: WAF.Types.CreateRateBasedRuleRequest, callback?: (err: AWSError, data: WAF.Types.CreateRateBasedRuleResponse) => void): Request<WAF.Types.CreateRateBasedRuleResponse, AWSError>;
42 /**
43 * Creates a RateBasedRule. The RateBasedRule contains a RateLimit, which specifies the maximum number of requests that AWS WAF allows from a specified IP address in a five-minute period. The RateBasedRule also contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to count or block if these requests exceed the RateLimit. If you add more than one predicate to a RateBasedRule, a request not only must exceed the RateLimit, but it also must match all the specifications to be counted or blocked. For example, suppose you add the following to a RateBasedRule: An IPSet that matches the IP address 192.0.2.44/32 A ByteMatchSet that matches BadBot in the User-Agent header Further, you specify a RateLimit of 15,000. You then add the RateBasedRule to a WebACL and specify that you want to block requests that meet the conditions in the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions must be received at a rate of more than 15,000 requests every five minutes. If both conditions are met and the rate is exceeded, AWS WAF blocks the requests. If the rate drops below 15,000 for a five-minute period, AWS WAF no longer blocks the requests. As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule: A ByteMatchSet with FieldToMatch of URI A PositionalConstraint of STARTS_WITH A TargetString of login Further, you specify a RateLimit of 15,000. By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site. To create and configure a RateBasedRule, perform the following steps: Create and update the predicates that you want to include in the rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request. Submit a CreateRateBasedRule request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. Submit an UpdateRateBasedRule request to specify the predicates that you want to include in the rule. Create and update a WebACL that contains the RateBasedRule. For more information, see CreateWebACL. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
44 */
45 createRateBasedRule(callback?: (err: AWSError, data: WAF.Types.CreateRateBasedRuleResponse) => void): Request<WAF.Types.CreateRateBasedRuleResponse, AWSError>;
46 /**
47 * Creates a RegexMatchSet. You then use UpdateRegexMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a RegexMatchSet that contains a RegexMatchTuple that looks for any requests with User-Agent headers that match a RegexPatternSet with pattern B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and configure a RegexMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexMatchSet request. Submit a CreateRegexMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet request. Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value, using a RegexPatternSet, that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
48 */
49 createRegexMatchSet(params: WAF.Types.CreateRegexMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.CreateRegexMatchSetResponse) => void): Request<WAF.Types.CreateRegexMatchSetResponse, AWSError>;
50 /**
51 * Creates a RegexMatchSet. You then use UpdateRegexMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a RegexMatchSet that contains a RegexMatchTuple that looks for any requests with User-Agent headers that match a RegexPatternSet with pattern B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and configure a RegexMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexMatchSet request. Submit a CreateRegexMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet request. Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value, using a RegexPatternSet, that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
52 */
53 createRegexMatchSet(callback?: (err: AWSError, data: WAF.Types.CreateRegexMatchSetResponse) => void): Request<WAF.Types.CreateRegexMatchSetResponse, AWSError>;
54 /**
55 * Creates a RegexPatternSet. You then use UpdateRegexPatternSet to specify the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and configure a RegexPatternSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexPatternSet request. Submit a CreateRegexPatternSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request. Submit an UpdateRegexPatternSet request to specify the string that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
56 */
57 createRegexPatternSet(params: WAF.Types.CreateRegexPatternSetRequest, callback?: (err: AWSError, data: WAF.Types.CreateRegexPatternSetResponse) => void): Request<WAF.Types.CreateRegexPatternSetResponse, AWSError>;
58 /**
59 * Creates a RegexPatternSet. You then use UpdateRegexPatternSet to specify the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and configure a RegexPatternSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexPatternSet request. Submit a CreateRegexPatternSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request. Submit an UpdateRegexPatternSet request to specify the string that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
60 */
61 createRegexPatternSet(callback?: (err: AWSError, data: WAF.Types.CreateRegexPatternSetResponse) => void): Request<WAF.Types.CreateRegexPatternSetResponse, AWSError>;
62 /**
63 * Creates a Rule, which contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed or blocked. For example, suppose that you add the following to a Rule: An IPSet that matches the IP address 192.0.2.44/32 A ByteMatchSet that matches BadBot in the User-Agent header You then add the Rule to a WebACL and specify that you want to blocks requests that satisfy the Rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. To create and configure a Rule, perform the following steps: Create and update the predicates that you want to include in the Rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request. Submit a CreateRule request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. Submit an UpdateRule request to specify the predicates that you want to include in the Rule. Create and update a WebACL that contains the Rule. For more information, see CreateWebACL. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
64 */
65 createRule(params: WAF.Types.CreateRuleRequest, callback?: (err: AWSError, data: WAF.Types.CreateRuleResponse) => void): Request<WAF.Types.CreateRuleResponse, AWSError>;
66 /**
67 * Creates a Rule, which contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed or blocked. For example, suppose that you add the following to a Rule: An IPSet that matches the IP address 192.0.2.44/32 A ByteMatchSet that matches BadBot in the User-Agent header You then add the Rule to a WebACL and specify that you want to blocks requests that satisfy the Rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. To create and configure a Rule, perform the following steps: Create and update the predicates that you want to include in the Rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request. Submit a CreateRule request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. Submit an UpdateRule request to specify the predicates that you want to include in the Rule. Create and update a WebACL that contains the Rule. For more information, see CreateWebACL. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
68 */
69 createRule(callback?: (err: AWSError, data: WAF.Types.CreateRuleResponse) => void): Request<WAF.Types.CreateRuleResponse, AWSError>;
70 /**
71 * Creates a RuleGroup. A rule group is a collection of predefined rules that you add to a web ACL. You use UpdateRuleGroup to add rules to the rule group. Rule groups are subject to the following limits: Three rule groups per account. You can request an increase to this limit by contacting customer support. One rule group per web ACL. Ten rules per rule group. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
72 */
73 createRuleGroup(params: WAF.Types.CreateRuleGroupRequest, callback?: (err: AWSError, data: WAF.Types.CreateRuleGroupResponse) => void): Request<WAF.Types.CreateRuleGroupResponse, AWSError>;
74 /**
75 * Creates a RuleGroup. A rule group is a collection of predefined rules that you add to a web ACL. You use UpdateRuleGroup to add rules to the rule group. Rule groups are subject to the following limits: Three rule groups per account. You can request an increase to this limit by contacting customer support. One rule group per web ACL. Ten rules per rule group. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
76 */
77 createRuleGroup(callback?: (err: AWSError, data: WAF.Types.CreateRuleGroupResponse) => void): Request<WAF.Types.CreateRuleGroupResponse, AWSError>;
78 /**
79 * Creates a SizeConstraintSet. You then use UpdateSizeConstraintSet to identify the part of a web request that you want AWS WAF to check for length, such as the length of the User-Agent header or the length of the query string. For example, you can create a SizeConstraintSet that matches any requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those requests. To create and configure a SizeConstraintSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSizeConstraintSet request. Submit a CreateSizeConstraintSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
80 */
81 createSizeConstraintSet(params: WAF.Types.CreateSizeConstraintSetRequest, callback?: (err: AWSError, data: WAF.Types.CreateSizeConstraintSetResponse) => void): Request<WAF.Types.CreateSizeConstraintSetResponse, AWSError>;
82 /**
83 * Creates a SizeConstraintSet. You then use UpdateSizeConstraintSet to identify the part of a web request that you want AWS WAF to check for length, such as the length of the User-Agent header or the length of the query string. For example, you can create a SizeConstraintSet that matches any requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those requests. To create and configure a SizeConstraintSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSizeConstraintSet request. Submit a CreateSizeConstraintSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
84 */
85 createSizeConstraintSet(callback?: (err: AWSError, data: WAF.Types.CreateSizeConstraintSetResponse) => void): Request<WAF.Types.CreateSizeConstraintSetResponse, AWSError>;
86 /**
87 * Creates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings. To create and configure a SqlInjectionMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSqlInjectionMatchSet request. Submit a CreateSqlInjectionMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSqlInjectionMatchSet request. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests in which you want to allow, block, or count malicious SQL code. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
88 */
89 createSqlInjectionMatchSet(params: WAF.Types.CreateSqlInjectionMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.CreateSqlInjectionMatchSetResponse) => void): Request<WAF.Types.CreateSqlInjectionMatchSetResponse, AWSError>;
90 /**
91 * Creates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings. To create and configure a SqlInjectionMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSqlInjectionMatchSet request. Submit a CreateSqlInjectionMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSqlInjectionMatchSet request. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests in which you want to allow, block, or count malicious SQL code. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
92 */
93 createSqlInjectionMatchSet(callback?: (err: AWSError, data: WAF.Types.CreateSqlInjectionMatchSetResponse) => void): Request<WAF.Types.CreateSqlInjectionMatchSetResponse, AWSError>;
94 /**
95 * Creates a WebACL, which contains the Rules that identify the CloudFront web requests that you want to allow, block, or count. AWS WAF evaluates Rules in order based on the value of Priority for each Rule. You also specify a default action, either ALLOW or BLOCK. If a web request doesn't match any of the Rules in a WebACL, AWS WAF responds to the request with the default action. To create and configure a WebACL, perform the following steps: Create and update the ByteMatchSet objects and other predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateWebACL request. Submit a CreateWebACL request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request. Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution. For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide.
96 */
97 createWebACL(params: WAF.Types.CreateWebACLRequest, callback?: (err: AWSError, data: WAF.Types.CreateWebACLResponse) => void): Request<WAF.Types.CreateWebACLResponse, AWSError>;
98 /**
99 * Creates a WebACL, which contains the Rules that identify the CloudFront web requests that you want to allow, block, or count. AWS WAF evaluates Rules in order based on the value of Priority for each Rule. You also specify a default action, either ALLOW or BLOCK. If a web request doesn't match any of the Rules in a WebACL, AWS WAF responds to the request with the default action. To create and configure a WebACL, perform the following steps: Create and update the ByteMatchSet objects and other predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateWebACL request. Submit a CreateWebACL request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request. Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution. For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide.
100 */
101 createWebACL(callback?: (err: AWSError, data: WAF.Types.CreateWebACLResponse) => void): Request<WAF.Types.CreateWebACLResponse, AWSError>;
102 /**
103 * Creates an XssMatchSet, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings. To create and configure an XssMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateXssMatchSet request. Submit a CreateXssMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateXssMatchSet request. Submit an UpdateXssMatchSet request to specify the parts of web requests in which you want to allow, block, or count cross-site scripting attacks. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
104 */
105 createXssMatchSet(params: WAF.Types.CreateXssMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.CreateXssMatchSetResponse) => void): Request<WAF.Types.CreateXssMatchSetResponse, AWSError>;
106 /**
107 * Creates an XssMatchSet, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings. To create and configure an XssMatchSet, perform the following steps: Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateXssMatchSet request. Submit a CreateXssMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateXssMatchSet request. Submit an UpdateXssMatchSet request to specify the parts of web requests in which you want to allow, block, or count cross-site scripting attacks. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
108 */
109 createXssMatchSet(callback?: (err: AWSError, data: WAF.Types.CreateXssMatchSetResponse) => void): Request<WAF.Types.CreateXssMatchSetResponse, AWSError>;
110 /**
111 * Permanently deletes a ByteMatchSet. You can't delete a ByteMatchSet if it's still used in any Rules or if it still includes any ByteMatchTuple objects (any filters). If you just want to remove a ByteMatchSet from a Rule, use UpdateRule. To permanently delete a ByteMatchSet, perform the following steps: Update the ByteMatchSet to remove filters, if any. For more information, see UpdateByteMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteByteMatchSet request. Submit a DeleteByteMatchSet request.
112 */
113 deleteByteMatchSet(params: WAF.Types.DeleteByteMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.DeleteByteMatchSetResponse) => void): Request<WAF.Types.DeleteByteMatchSetResponse, AWSError>;
114 /**
115 * Permanently deletes a ByteMatchSet. You can't delete a ByteMatchSet if it's still used in any Rules or if it still includes any ByteMatchTuple objects (any filters). If you just want to remove a ByteMatchSet from a Rule, use UpdateRule. To permanently delete a ByteMatchSet, perform the following steps: Update the ByteMatchSet to remove filters, if any. For more information, see UpdateByteMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteByteMatchSet request. Submit a DeleteByteMatchSet request.
116 */
117 deleteByteMatchSet(callback?: (err: AWSError, data: WAF.Types.DeleteByteMatchSetResponse) => void): Request<WAF.Types.DeleteByteMatchSetResponse, AWSError>;
118 /**
119 * Permanently deletes a GeoMatchSet. You can't delete a GeoMatchSet if it's still used in any Rules or if it still includes any countries. If you just want to remove a GeoMatchSet from a Rule, use UpdateRule. To permanently delete a GeoMatchSet from AWS WAF, perform the following steps: Update the GeoMatchSet to remove any countries. For more information, see UpdateGeoMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteGeoMatchSet request. Submit a DeleteGeoMatchSet request.
120 */
121 deleteGeoMatchSet(params: WAF.Types.DeleteGeoMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.DeleteGeoMatchSetResponse) => void): Request<WAF.Types.DeleteGeoMatchSetResponse, AWSError>;
122 /**
123 * Permanently deletes a GeoMatchSet. You can't delete a GeoMatchSet if it's still used in any Rules or if it still includes any countries. If you just want to remove a GeoMatchSet from a Rule, use UpdateRule. To permanently delete a GeoMatchSet from AWS WAF, perform the following steps: Update the GeoMatchSet to remove any countries. For more information, see UpdateGeoMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteGeoMatchSet request. Submit a DeleteGeoMatchSet request.
124 */
125 deleteGeoMatchSet(callback?: (err: AWSError, data: WAF.Types.DeleteGeoMatchSetResponse) => void): Request<WAF.Types.DeleteGeoMatchSetResponse, AWSError>;
126 /**
127 * Permanently deletes an IPSet. You can't delete an IPSet if it's still used in any Rules or if it still includes any IP addresses. If you just want to remove an IPSet from a Rule, use UpdateRule. To permanently delete an IPSet from AWS WAF, perform the following steps: Update the IPSet to remove IP address ranges, if any. For more information, see UpdateIPSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteIPSet request. Submit a DeleteIPSet request.
128 */
129 deleteIPSet(params: WAF.Types.DeleteIPSetRequest, callback?: (err: AWSError, data: WAF.Types.DeleteIPSetResponse) => void): Request<WAF.Types.DeleteIPSetResponse, AWSError>;
130 /**
131 * Permanently deletes an IPSet. You can't delete an IPSet if it's still used in any Rules or if it still includes any IP addresses. If you just want to remove an IPSet from a Rule, use UpdateRule. To permanently delete an IPSet from AWS WAF, perform the following steps: Update the IPSet to remove IP address ranges, if any. For more information, see UpdateIPSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteIPSet request. Submit a DeleteIPSet request.
132 */
133 deleteIPSet(callback?: (err: AWSError, data: WAF.Types.DeleteIPSetResponse) => void): Request<WAF.Types.DeleteIPSetResponse, AWSError>;
134 /**
135 * Permanently deletes the LoggingConfiguration from the specified web ACL.
136 */
137 deleteLoggingConfiguration(params: WAF.Types.DeleteLoggingConfigurationRequest, callback?: (err: AWSError, data: WAF.Types.DeleteLoggingConfigurationResponse) => void): Request<WAF.Types.DeleteLoggingConfigurationResponse, AWSError>;
138 /**
139 * Permanently deletes the LoggingConfiguration from the specified web ACL.
140 */
141 deleteLoggingConfiguration(callback?: (err: AWSError, data: WAF.Types.DeleteLoggingConfigurationResponse) => void): Request<WAF.Types.DeleteLoggingConfigurationResponse, AWSError>;
142 /**
143 * Permanently deletes an IAM policy from the specified RuleGroup. The user making the request must be the owner of the RuleGroup.
144 */
145 deletePermissionPolicy(params: WAF.Types.DeletePermissionPolicyRequest, callback?: (err: AWSError, data: WAF.Types.DeletePermissionPolicyResponse) => void): Request<WAF.Types.DeletePermissionPolicyResponse, AWSError>;
146 /**
147 * Permanently deletes an IAM policy from the specified RuleGroup. The user making the request must be the owner of the RuleGroup.
148 */
149 deletePermissionPolicy(callback?: (err: AWSError, data: WAF.Types.DeletePermissionPolicyResponse) => void): Request<WAF.Types.DeletePermissionPolicyResponse, AWSError>;
150 /**
151 * Permanently deletes a RateBasedRule. You can't delete a rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects. If you just want to remove a rule from a WebACL, use UpdateWebACL. To permanently delete a RateBasedRule from AWS WAF, perform the following steps: Update the RateBasedRule to remove predicates, if any. For more information, see UpdateRateBasedRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRateBasedRule request. Submit a DeleteRateBasedRule request.
152 */
153 deleteRateBasedRule(params: WAF.Types.DeleteRateBasedRuleRequest, callback?: (err: AWSError, data: WAF.Types.DeleteRateBasedRuleResponse) => void): Request<WAF.Types.DeleteRateBasedRuleResponse, AWSError>;
154 /**
155 * Permanently deletes a RateBasedRule. You can't delete a rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects. If you just want to remove a rule from a WebACL, use UpdateWebACL. To permanently delete a RateBasedRule from AWS WAF, perform the following steps: Update the RateBasedRule to remove predicates, if any. For more information, see UpdateRateBasedRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRateBasedRule request. Submit a DeleteRateBasedRule request.
156 */
157 deleteRateBasedRule(callback?: (err: AWSError, data: WAF.Types.DeleteRateBasedRuleResponse) => void): Request<WAF.Types.DeleteRateBasedRuleResponse, AWSError>;
158 /**
159 * Permanently deletes a RegexMatchSet. You can't delete a RegexMatchSet if it's still used in any Rules or if it still includes any RegexMatchTuples objects (any filters). If you just want to remove a RegexMatchSet from a Rule, use UpdateRule. To permanently delete a RegexMatchSet, perform the following steps: Update the RegexMatchSet to remove filters, if any. For more information, see UpdateRegexMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRegexMatchSet request. Submit a DeleteRegexMatchSet request.
160 */
161 deleteRegexMatchSet(params: WAF.Types.DeleteRegexMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.DeleteRegexMatchSetResponse) => void): Request<WAF.Types.DeleteRegexMatchSetResponse, AWSError>;
162 /**
163 * Permanently deletes a RegexMatchSet. You can't delete a RegexMatchSet if it's still used in any Rules or if it still includes any RegexMatchTuples objects (any filters). If you just want to remove a RegexMatchSet from a Rule, use UpdateRule. To permanently delete a RegexMatchSet, perform the following steps: Update the RegexMatchSet to remove filters, if any. For more information, see UpdateRegexMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRegexMatchSet request. Submit a DeleteRegexMatchSet request.
164 */
165 deleteRegexMatchSet(callback?: (err: AWSError, data: WAF.Types.DeleteRegexMatchSetResponse) => void): Request<WAF.Types.DeleteRegexMatchSetResponse, AWSError>;
166 /**
167 * Permanently deletes a RegexPatternSet. You can't delete a RegexPatternSet if it's still used in any RegexMatchSet or if the RegexPatternSet is not empty.
168 */
169 deleteRegexPatternSet(params: WAF.Types.DeleteRegexPatternSetRequest, callback?: (err: AWSError, data: WAF.Types.DeleteRegexPatternSetResponse) => void): Request<WAF.Types.DeleteRegexPatternSetResponse, AWSError>;
170 /**
171 * Permanently deletes a RegexPatternSet. You can't delete a RegexPatternSet if it's still used in any RegexMatchSet or if the RegexPatternSet is not empty.
172 */
173 deleteRegexPatternSet(callback?: (err: AWSError, data: WAF.Types.DeleteRegexPatternSetResponse) => void): Request<WAF.Types.DeleteRegexPatternSetResponse, AWSError>;
174 /**
175 * Permanently deletes a Rule. You can't delete a Rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects. If you just want to remove a Rule from a WebACL, use UpdateWebACL. To permanently delete a Rule from AWS WAF, perform the following steps: Update the Rule to remove predicates, if any. For more information, see UpdateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRule request. Submit a DeleteRule request.
176 */
177 deleteRule(params: WAF.Types.DeleteRuleRequest, callback?: (err: AWSError, data: WAF.Types.DeleteRuleResponse) => void): Request<WAF.Types.DeleteRuleResponse, AWSError>;
178 /**
179 * Permanently deletes a Rule. You can't delete a Rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects. If you just want to remove a Rule from a WebACL, use UpdateWebACL. To permanently delete a Rule from AWS WAF, perform the following steps: Update the Rule to remove predicates, if any. For more information, see UpdateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRule request. Submit a DeleteRule request.
180 */
181 deleteRule(callback?: (err: AWSError, data: WAF.Types.DeleteRuleResponse) => void): Request<WAF.Types.DeleteRuleResponse, AWSError>;
182 /**
183 * Permanently deletes a RuleGroup. You can't delete a RuleGroup if it's still used in any WebACL objects or if it still includes any rules. If you just want to remove a RuleGroup from a WebACL, use UpdateWebACL. To permanently delete a RuleGroup from AWS WAF, perform the following steps: Update the RuleGroup to remove rules, if any. For more information, see UpdateRuleGroup. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRuleGroup request. Submit a DeleteRuleGroup request.
184 */
185 deleteRuleGroup(params: WAF.Types.DeleteRuleGroupRequest, callback?: (err: AWSError, data: WAF.Types.DeleteRuleGroupResponse) => void): Request<WAF.Types.DeleteRuleGroupResponse, AWSError>;
186 /**
187 * Permanently deletes a RuleGroup. You can't delete a RuleGroup if it's still used in any WebACL objects or if it still includes any rules. If you just want to remove a RuleGroup from a WebACL, use UpdateWebACL. To permanently delete a RuleGroup from AWS WAF, perform the following steps: Update the RuleGroup to remove rules, if any. For more information, see UpdateRuleGroup. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRuleGroup request. Submit a DeleteRuleGroup request.
188 */
189 deleteRuleGroup(callback?: (err: AWSError, data: WAF.Types.DeleteRuleGroupResponse) => void): Request<WAF.Types.DeleteRuleGroupResponse, AWSError>;
190 /**
191 * Permanently deletes a SizeConstraintSet. You can't delete a SizeConstraintSet if it's still used in any Rules or if it still includes any SizeConstraint objects (any filters). If you just want to remove a SizeConstraintSet from a Rule, use UpdateRule. To permanently delete a SizeConstraintSet, perform the following steps: Update the SizeConstraintSet to remove filters, if any. For more information, see UpdateSizeConstraintSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSizeConstraintSet request. Submit a DeleteSizeConstraintSet request.
192 */
193 deleteSizeConstraintSet(params: WAF.Types.DeleteSizeConstraintSetRequest, callback?: (err: AWSError, data: WAF.Types.DeleteSizeConstraintSetResponse) => void): Request<WAF.Types.DeleteSizeConstraintSetResponse, AWSError>;
194 /**
195 * Permanently deletes a SizeConstraintSet. You can't delete a SizeConstraintSet if it's still used in any Rules or if it still includes any SizeConstraint objects (any filters). If you just want to remove a SizeConstraintSet from a Rule, use UpdateRule. To permanently delete a SizeConstraintSet, perform the following steps: Update the SizeConstraintSet to remove filters, if any. For more information, see UpdateSizeConstraintSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSizeConstraintSet request. Submit a DeleteSizeConstraintSet request.
196 */
197 deleteSizeConstraintSet(callback?: (err: AWSError, data: WAF.Types.DeleteSizeConstraintSetResponse) => void): Request<WAF.Types.DeleteSizeConstraintSetResponse, AWSError>;
198 /**
199 * Permanently deletes a SqlInjectionMatchSet. You can't delete a SqlInjectionMatchSet if it's still used in any Rules or if it still contains any SqlInjectionMatchTuple objects. If you just want to remove a SqlInjectionMatchSet from a Rule, use UpdateRule. To permanently delete a SqlInjectionMatchSet from AWS WAF, perform the following steps: Update the SqlInjectionMatchSet to remove filters, if any. For more information, see UpdateSqlInjectionMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSqlInjectionMatchSet request. Submit a DeleteSqlInjectionMatchSet request.
200 */
201 deleteSqlInjectionMatchSet(params: WAF.Types.DeleteSqlInjectionMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.DeleteSqlInjectionMatchSetResponse) => void): Request<WAF.Types.DeleteSqlInjectionMatchSetResponse, AWSError>;
202 /**
203 * Permanently deletes a SqlInjectionMatchSet. You can't delete a SqlInjectionMatchSet if it's still used in any Rules or if it still contains any SqlInjectionMatchTuple objects. If you just want to remove a SqlInjectionMatchSet from a Rule, use UpdateRule. To permanently delete a SqlInjectionMatchSet from AWS WAF, perform the following steps: Update the SqlInjectionMatchSet to remove filters, if any. For more information, see UpdateSqlInjectionMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSqlInjectionMatchSet request. Submit a DeleteSqlInjectionMatchSet request.
204 */
205 deleteSqlInjectionMatchSet(callback?: (err: AWSError, data: WAF.Types.DeleteSqlInjectionMatchSetResponse) => void): Request<WAF.Types.DeleteSqlInjectionMatchSetResponse, AWSError>;
206 /**
207 * Permanently deletes a WebACL. You can't delete a WebACL if it still contains any Rules. To delete a WebACL, perform the following steps: Update the WebACL to remove Rules, if any. For more information, see UpdateWebACL. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteWebACL request. Submit a DeleteWebACL request.
208 */
209 deleteWebACL(params: WAF.Types.DeleteWebACLRequest, callback?: (err: AWSError, data: WAF.Types.DeleteWebACLResponse) => void): Request<WAF.Types.DeleteWebACLResponse, AWSError>;
210 /**
211 * Permanently deletes a WebACL. You can't delete a WebACL if it still contains any Rules. To delete a WebACL, perform the following steps: Update the WebACL to remove Rules, if any. For more information, see UpdateWebACL. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteWebACL request. Submit a DeleteWebACL request.
212 */
213 deleteWebACL(callback?: (err: AWSError, data: WAF.Types.DeleteWebACLResponse) => void): Request<WAF.Types.DeleteWebACLResponse, AWSError>;
214 /**
215 * Permanently deletes an XssMatchSet. You can't delete an XssMatchSet if it's still used in any Rules or if it still contains any XssMatchTuple objects. If you just want to remove an XssMatchSet from a Rule, use UpdateRule. To permanently delete an XssMatchSet from AWS WAF, perform the following steps: Update the XssMatchSet to remove filters, if any. For more information, see UpdateXssMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteXssMatchSet request. Submit a DeleteXssMatchSet request.
216 */
217 deleteXssMatchSet(params: WAF.Types.DeleteXssMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.DeleteXssMatchSetResponse) => void): Request<WAF.Types.DeleteXssMatchSetResponse, AWSError>;
218 /**
219 * Permanently deletes an XssMatchSet. You can't delete an XssMatchSet if it's still used in any Rules or if it still contains any XssMatchTuple objects. If you just want to remove an XssMatchSet from a Rule, use UpdateRule. To permanently delete an XssMatchSet from AWS WAF, perform the following steps: Update the XssMatchSet to remove filters, if any. For more information, see UpdateXssMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteXssMatchSet request. Submit a DeleteXssMatchSet request.
220 */
221 deleteXssMatchSet(callback?: (err: AWSError, data: WAF.Types.DeleteXssMatchSetResponse) => void): Request<WAF.Types.DeleteXssMatchSetResponse, AWSError>;
222 /**
223 * Returns the ByteMatchSet specified by ByteMatchSetId.
224 */
225 getByteMatchSet(params: WAF.Types.GetByteMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.GetByteMatchSetResponse) => void): Request<WAF.Types.GetByteMatchSetResponse, AWSError>;
226 /**
227 * Returns the ByteMatchSet specified by ByteMatchSetId.
228 */
229 getByteMatchSet(callback?: (err: AWSError, data: WAF.Types.GetByteMatchSetResponse) => void): Request<WAF.Types.GetByteMatchSetResponse, AWSError>;
230 /**
231 * When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF. Each create, update, or delete request must use a unique change token. If your application submits a GetChangeToken request and then submits a second GetChangeToken request before submitting a create, update, or delete request, the second GetChangeToken request returns the same value as the first GetChangeToken request. When you use a change token in a create, update, or delete request, the status of the change token changes to PENDING, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use GetChangeTokenStatus to determine the status of your change token.
232 */
233 getChangeToken(params: WAF.Types.GetChangeTokenRequest, callback?: (err: AWSError, data: WAF.Types.GetChangeTokenResponse) => void): Request<WAF.Types.GetChangeTokenResponse, AWSError>;
234 /**
235 * When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF. Each create, update, or delete request must use a unique change token. If your application submits a GetChangeToken request and then submits a second GetChangeToken request before submitting a create, update, or delete request, the second GetChangeToken request returns the same value as the first GetChangeToken request. When you use a change token in a create, update, or delete request, the status of the change token changes to PENDING, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use GetChangeTokenStatus to determine the status of your change token.
236 */
237 getChangeToken(callback?: (err: AWSError, data: WAF.Types.GetChangeTokenResponse) => void): Request<WAF.Types.GetChangeTokenResponse, AWSError>;
238 /**
239 * Returns the status of a ChangeToken that you got by calling GetChangeToken. ChangeTokenStatus is one of the following values: PROVISIONED: You requested the change token by calling GetChangeToken, but you haven't used it yet in a call to create, update, or delete an AWS WAF object. PENDING: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers. INSYNC: Propagation is complete.
240 */
241 getChangeTokenStatus(params: WAF.Types.GetChangeTokenStatusRequest, callback?: (err: AWSError, data: WAF.Types.GetChangeTokenStatusResponse) => void): Request<WAF.Types.GetChangeTokenStatusResponse, AWSError>;
242 /**
243 * Returns the status of a ChangeToken that you got by calling GetChangeToken. ChangeTokenStatus is one of the following values: PROVISIONED: You requested the change token by calling GetChangeToken, but you haven't used it yet in a call to create, update, or delete an AWS WAF object. PENDING: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers. INSYNC: Propagation is complete.
244 */
245 getChangeTokenStatus(callback?: (err: AWSError, data: WAF.Types.GetChangeTokenStatusResponse) => void): Request<WAF.Types.GetChangeTokenStatusResponse, AWSError>;
246 /**
247 * Returns the GeoMatchSet that is specified by GeoMatchSetId.
248 */
249 getGeoMatchSet(params: WAF.Types.GetGeoMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.GetGeoMatchSetResponse) => void): Request<WAF.Types.GetGeoMatchSetResponse, AWSError>;
250 /**
251 * Returns the GeoMatchSet that is specified by GeoMatchSetId.
252 */
253 getGeoMatchSet(callback?: (err: AWSError, data: WAF.Types.GetGeoMatchSetResponse) => void): Request<WAF.Types.GetGeoMatchSetResponse, AWSError>;
254 /**
255 * Returns the IPSet that is specified by IPSetId.
256 */
257 getIPSet(params: WAF.Types.GetIPSetRequest, callback?: (err: AWSError, data: WAF.Types.GetIPSetResponse) => void): Request<WAF.Types.GetIPSetResponse, AWSError>;
258 /**
259 * Returns the IPSet that is specified by IPSetId.
260 */
261 getIPSet(callback?: (err: AWSError, data: WAF.Types.GetIPSetResponse) => void): Request<WAF.Types.GetIPSetResponse, AWSError>;
262 /**
263 * Returns the LoggingConfiguration for the specified web ACL.
264 */
265 getLoggingConfiguration(params: WAF.Types.GetLoggingConfigurationRequest, callback?: (err: AWSError, data: WAF.Types.GetLoggingConfigurationResponse) => void): Request<WAF.Types.GetLoggingConfigurationResponse, AWSError>;
266 /**
267 * Returns the LoggingConfiguration for the specified web ACL.
268 */
269 getLoggingConfiguration(callback?: (err: AWSError, data: WAF.Types.GetLoggingConfigurationResponse) => void): Request<WAF.Types.GetLoggingConfigurationResponse, AWSError>;
270 /**
271 * Returns the IAM policy attached to the RuleGroup.
272 */
273 getPermissionPolicy(params: WAF.Types.GetPermissionPolicyRequest, callback?: (err: AWSError, data: WAF.Types.GetPermissionPolicyResponse) => void): Request<WAF.Types.GetPermissionPolicyResponse, AWSError>;
274 /**
275 * Returns the IAM policy attached to the RuleGroup.
276 */
277 getPermissionPolicy(callback?: (err: AWSError, data: WAF.Types.GetPermissionPolicyResponse) => void): Request<WAF.Types.GetPermissionPolicyResponse, AWSError>;
278 /**
279 * Returns the RateBasedRule that is specified by the RuleId that you included in the GetRateBasedRule request.
280 */
281 getRateBasedRule(params: WAF.Types.GetRateBasedRuleRequest, callback?: (err: AWSError, data: WAF.Types.GetRateBasedRuleResponse) => void): Request<WAF.Types.GetRateBasedRuleResponse, AWSError>;
282 /**
283 * Returns the RateBasedRule that is specified by the RuleId that you included in the GetRateBasedRule request.
284 */
285 getRateBasedRule(callback?: (err: AWSError, data: WAF.Types.GetRateBasedRuleResponse) => void): Request<WAF.Types.GetRateBasedRuleResponse, AWSError>;
286 /**
287 * Returns an array of IP addresses currently being blocked by the RateBasedRule that is specified by the RuleId. The maximum number of managed keys that will be blocked is 10,000. If more than 10,000 addresses exceed the rate limit, the 10,000 addresses with the highest rates will be blocked.
288 */
289 getRateBasedRuleManagedKeys(params: WAF.Types.GetRateBasedRuleManagedKeysRequest, callback?: (err: AWSError, data: WAF.Types.GetRateBasedRuleManagedKeysResponse) => void): Request<WAF.Types.GetRateBasedRuleManagedKeysResponse, AWSError>;
290 /**
291 * Returns an array of IP addresses currently being blocked by the RateBasedRule that is specified by the RuleId. The maximum number of managed keys that will be blocked is 10,000. If more than 10,000 addresses exceed the rate limit, the 10,000 addresses with the highest rates will be blocked.
292 */
293 getRateBasedRuleManagedKeys(callback?: (err: AWSError, data: WAF.Types.GetRateBasedRuleManagedKeysResponse) => void): Request<WAF.Types.GetRateBasedRuleManagedKeysResponse, AWSError>;
294 /**
295 * Returns the RegexMatchSet specified by RegexMatchSetId.
296 */
297 getRegexMatchSet(params: WAF.Types.GetRegexMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.GetRegexMatchSetResponse) => void): Request<WAF.Types.GetRegexMatchSetResponse, AWSError>;
298 /**
299 * Returns the RegexMatchSet specified by RegexMatchSetId.
300 */
301 getRegexMatchSet(callback?: (err: AWSError, data: WAF.Types.GetRegexMatchSetResponse) => void): Request<WAF.Types.GetRegexMatchSetResponse, AWSError>;
302 /**
303 * Returns the RegexPatternSet specified by RegexPatternSetId.
304 */
305 getRegexPatternSet(params: WAF.Types.GetRegexPatternSetRequest, callback?: (err: AWSError, data: WAF.Types.GetRegexPatternSetResponse) => void): Request<WAF.Types.GetRegexPatternSetResponse, AWSError>;
306 /**
307 * Returns the RegexPatternSet specified by RegexPatternSetId.
308 */
309 getRegexPatternSet(callback?: (err: AWSError, data: WAF.Types.GetRegexPatternSetResponse) => void): Request<WAF.Types.GetRegexPatternSetResponse, AWSError>;
310 /**
311 * Returns the Rule that is specified by the RuleId that you included in the GetRule request.
312 */
313 getRule(params: WAF.Types.GetRuleRequest, callback?: (err: AWSError, data: WAF.Types.GetRuleResponse) => void): Request<WAF.Types.GetRuleResponse, AWSError>;
314 /**
315 * Returns the Rule that is specified by the RuleId that you included in the GetRule request.
316 */
317 getRule(callback?: (err: AWSError, data: WAF.Types.GetRuleResponse) => void): Request<WAF.Types.GetRuleResponse, AWSError>;
318 /**
319 * Returns the RuleGroup that is specified by the RuleGroupId that you included in the GetRuleGroup request. To view the rules in a rule group, use ListActivatedRulesInRuleGroup.
320 */
321 getRuleGroup(params: WAF.Types.GetRuleGroupRequest, callback?: (err: AWSError, data: WAF.Types.GetRuleGroupResponse) => void): Request<WAF.Types.GetRuleGroupResponse, AWSError>;
322 /**
323 * Returns the RuleGroup that is specified by the RuleGroupId that you included in the GetRuleGroup request. To view the rules in a rule group, use ListActivatedRulesInRuleGroup.
324 */
325 getRuleGroup(callback?: (err: AWSError, data: WAF.Types.GetRuleGroupResponse) => void): Request<WAF.Types.GetRuleGroupResponse, AWSError>;
326 /**
327 * 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.
328 */
329 getSampledRequests(params: WAF.Types.GetSampledRequestsRequest, callback?: (err: AWSError, data: WAF.Types.GetSampledRequestsResponse) => void): Request<WAF.Types.GetSampledRequestsResponse, AWSError>;
330 /**
331 * 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.
332 */
333 getSampledRequests(callback?: (err: AWSError, data: WAF.Types.GetSampledRequestsResponse) => void): Request<WAF.Types.GetSampledRequestsResponse, AWSError>;
334 /**
335 * Returns the SizeConstraintSet specified by SizeConstraintSetId.
336 */
337 getSizeConstraintSet(params: WAF.Types.GetSizeConstraintSetRequest, callback?: (err: AWSError, data: WAF.Types.GetSizeConstraintSetResponse) => void): Request<WAF.Types.GetSizeConstraintSetResponse, AWSError>;
338 /**
339 * Returns the SizeConstraintSet specified by SizeConstraintSetId.
340 */
341 getSizeConstraintSet(callback?: (err: AWSError, data: WAF.Types.GetSizeConstraintSetResponse) => void): Request<WAF.Types.GetSizeConstraintSetResponse, AWSError>;
342 /**
343 * Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId.
344 */
345 getSqlInjectionMatchSet(params: WAF.Types.GetSqlInjectionMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.GetSqlInjectionMatchSetResponse) => void): Request<WAF.Types.GetSqlInjectionMatchSetResponse, AWSError>;
346 /**
347 * Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId.
348 */
349 getSqlInjectionMatchSet(callback?: (err: AWSError, data: WAF.Types.GetSqlInjectionMatchSetResponse) => void): Request<WAF.Types.GetSqlInjectionMatchSetResponse, AWSError>;
350 /**
351 * Returns the WebACL that is specified by WebACLId.
352 */
353 getWebACL(params: WAF.Types.GetWebACLRequest, callback?: (err: AWSError, data: WAF.Types.GetWebACLResponse) => void): Request<WAF.Types.GetWebACLResponse, AWSError>;
354 /**
355 * Returns the WebACL that is specified by WebACLId.
356 */
357 getWebACL(callback?: (err: AWSError, data: WAF.Types.GetWebACLResponse) => void): Request<WAF.Types.GetWebACLResponse, AWSError>;
358 /**
359 * Returns the XssMatchSet that is specified by XssMatchSetId.
360 */
361 getXssMatchSet(params: WAF.Types.GetXssMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.GetXssMatchSetResponse) => void): Request<WAF.Types.GetXssMatchSetResponse, AWSError>;
362 /**
363 * Returns the XssMatchSet that is specified by XssMatchSetId.
364 */
365 getXssMatchSet(callback?: (err: AWSError, data: WAF.Types.GetXssMatchSetResponse) => void): Request<WAF.Types.GetXssMatchSetResponse, AWSError>;
366 /**
367 * Returns an array of ActivatedRule objects.
368 */
369 listActivatedRulesInRuleGroup(params: WAF.Types.ListActivatedRulesInRuleGroupRequest, callback?: (err: AWSError, data: WAF.Types.ListActivatedRulesInRuleGroupResponse) => void): Request<WAF.Types.ListActivatedRulesInRuleGroupResponse, AWSError>;
370 /**
371 * Returns an array of ActivatedRule objects.
372 */
373 listActivatedRulesInRuleGroup(callback?: (err: AWSError, data: WAF.Types.ListActivatedRulesInRuleGroupResponse) => void): Request<WAF.Types.ListActivatedRulesInRuleGroupResponse, AWSError>;
374 /**
375 * Returns an array of ByteMatchSetSummary objects.
376 */
377 listByteMatchSets(params: WAF.Types.ListByteMatchSetsRequest, callback?: (err: AWSError, data: WAF.Types.ListByteMatchSetsResponse) => void): Request<WAF.Types.ListByteMatchSetsResponse, AWSError>;
378 /**
379 * Returns an array of ByteMatchSetSummary objects.
380 */
381 listByteMatchSets(callback?: (err: AWSError, data: WAF.Types.ListByteMatchSetsResponse) => void): Request<WAF.Types.ListByteMatchSetsResponse, AWSError>;
382 /**
383 * Returns an array of GeoMatchSetSummary objects in the response.
384 */
385 listGeoMatchSets(params: WAF.Types.ListGeoMatchSetsRequest, callback?: (err: AWSError, data: WAF.Types.ListGeoMatchSetsResponse) => void): Request<WAF.Types.ListGeoMatchSetsResponse, AWSError>;
386 /**
387 * Returns an array of GeoMatchSetSummary objects in the response.
388 */
389 listGeoMatchSets(callback?: (err: AWSError, data: WAF.Types.ListGeoMatchSetsResponse) => void): Request<WAF.Types.ListGeoMatchSetsResponse, AWSError>;
390 /**
391 * Returns an array of IPSetSummary objects in the response.
392 */
393 listIPSets(params: WAF.Types.ListIPSetsRequest, callback?: (err: AWSError, data: WAF.Types.ListIPSetsResponse) => void): Request<WAF.Types.ListIPSetsResponse, AWSError>;
394 /**
395 * Returns an array of IPSetSummary objects in the response.
396 */
397 listIPSets(callback?: (err: AWSError, data: WAF.Types.ListIPSetsResponse) => void): Request<WAF.Types.ListIPSetsResponse, AWSError>;
398 /**
399 * Returns an array of LoggingConfiguration objects.
400 */
401 listLoggingConfigurations(params: WAF.Types.ListLoggingConfigurationsRequest, callback?: (err: AWSError, data: WAF.Types.ListLoggingConfigurationsResponse) => void): Request<WAF.Types.ListLoggingConfigurationsResponse, AWSError>;
402 /**
403 * Returns an array of LoggingConfiguration objects.
404 */
405 listLoggingConfigurations(callback?: (err: AWSError, data: WAF.Types.ListLoggingConfigurationsResponse) => void): Request<WAF.Types.ListLoggingConfigurationsResponse, AWSError>;
406 /**
407 * Returns an array of RuleSummary objects.
408 */
409 listRateBasedRules(params: WAF.Types.ListRateBasedRulesRequest, callback?: (err: AWSError, data: WAF.Types.ListRateBasedRulesResponse) => void): Request<WAF.Types.ListRateBasedRulesResponse, AWSError>;
410 /**
411 * Returns an array of RuleSummary objects.
412 */
413 listRateBasedRules(callback?: (err: AWSError, data: WAF.Types.ListRateBasedRulesResponse) => void): Request<WAF.Types.ListRateBasedRulesResponse, AWSError>;
414 /**
415 * Returns an array of RegexMatchSetSummary objects.
416 */
417 listRegexMatchSets(params: WAF.Types.ListRegexMatchSetsRequest, callback?: (err: AWSError, data: WAF.Types.ListRegexMatchSetsResponse) => void): Request<WAF.Types.ListRegexMatchSetsResponse, AWSError>;
418 /**
419 * Returns an array of RegexMatchSetSummary objects.
420 */
421 listRegexMatchSets(callback?: (err: AWSError, data: WAF.Types.ListRegexMatchSetsResponse) => void): Request<WAF.Types.ListRegexMatchSetsResponse, AWSError>;
422 /**
423 * Returns an array of RegexPatternSetSummary objects.
424 */
425 listRegexPatternSets(params: WAF.Types.ListRegexPatternSetsRequest, callback?: (err: AWSError, data: WAF.Types.ListRegexPatternSetsResponse) => void): Request<WAF.Types.ListRegexPatternSetsResponse, AWSError>;
426 /**
427 * Returns an array of RegexPatternSetSummary objects.
428 */
429 listRegexPatternSets(callback?: (err: AWSError, data: WAF.Types.ListRegexPatternSetsResponse) => void): Request<WAF.Types.ListRegexPatternSetsResponse, AWSError>;
430 /**
431 * Returns an array of RuleGroup objects.
432 */
433 listRuleGroups(params: WAF.Types.ListRuleGroupsRequest, callback?: (err: AWSError, data: WAF.Types.ListRuleGroupsResponse) => void): Request<WAF.Types.ListRuleGroupsResponse, AWSError>;
434 /**
435 * Returns an array of RuleGroup objects.
436 */
437 listRuleGroups(callback?: (err: AWSError, data: WAF.Types.ListRuleGroupsResponse) => void): Request<WAF.Types.ListRuleGroupsResponse, AWSError>;
438 /**
439 * Returns an array of RuleSummary objects.
440 */
441 listRules(params: WAF.Types.ListRulesRequest, callback?: (err: AWSError, data: WAF.Types.ListRulesResponse) => void): Request<WAF.Types.ListRulesResponse, AWSError>;
442 /**
443 * Returns an array of RuleSummary objects.
444 */
445 listRules(callback?: (err: AWSError, data: WAF.Types.ListRulesResponse) => void): Request<WAF.Types.ListRulesResponse, AWSError>;
446 /**
447 * Returns an array of SizeConstraintSetSummary objects.
448 */
449 listSizeConstraintSets(params: WAF.Types.ListSizeConstraintSetsRequest, callback?: (err: AWSError, data: WAF.Types.ListSizeConstraintSetsResponse) => void): Request<WAF.Types.ListSizeConstraintSetsResponse, AWSError>;
450 /**
451 * Returns an array of SizeConstraintSetSummary objects.
452 */
453 listSizeConstraintSets(callback?: (err: AWSError, data: WAF.Types.ListSizeConstraintSetsResponse) => void): Request<WAF.Types.ListSizeConstraintSetsResponse, AWSError>;
454 /**
455 * Returns an array of SqlInjectionMatchSet objects.
456 */
457 listSqlInjectionMatchSets(params: WAF.Types.ListSqlInjectionMatchSetsRequest, callback?: (err: AWSError, data: WAF.Types.ListSqlInjectionMatchSetsResponse) => void): Request<WAF.Types.ListSqlInjectionMatchSetsResponse, AWSError>;
458 /**
459 * Returns an array of SqlInjectionMatchSet objects.
460 */
461 listSqlInjectionMatchSets(callback?: (err: AWSError, data: WAF.Types.ListSqlInjectionMatchSetsResponse) => void): Request<WAF.Types.ListSqlInjectionMatchSetsResponse, AWSError>;
462 /**
463 * Returns an array of RuleGroup objects that you are subscribed to.
464 */
465 listSubscribedRuleGroups(params: WAF.Types.ListSubscribedRuleGroupsRequest, callback?: (err: AWSError, data: WAF.Types.ListSubscribedRuleGroupsResponse) => void): Request<WAF.Types.ListSubscribedRuleGroupsResponse, AWSError>;
466 /**
467 * Returns an array of RuleGroup objects that you are subscribed to.
468 */
469 listSubscribedRuleGroups(callback?: (err: AWSError, data: WAF.Types.ListSubscribedRuleGroupsResponse) => void): Request<WAF.Types.ListSubscribedRuleGroupsResponse, AWSError>;
470 /**
471 *
472 */
473 listTagsForResource(params: WAF.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: WAF.Types.ListTagsForResourceResponse) => void): Request<WAF.Types.ListTagsForResourceResponse, AWSError>;
474 /**
475 *
476 */
477 listTagsForResource(callback?: (err: AWSError, data: WAF.Types.ListTagsForResourceResponse) => void): Request<WAF.Types.ListTagsForResourceResponse, AWSError>;
478 /**
479 * Returns an array of WebACLSummary objects in the response.
480 */
481 listWebACLs(params: WAF.Types.ListWebACLsRequest, callback?: (err: AWSError, data: WAF.Types.ListWebACLsResponse) => void): Request<WAF.Types.ListWebACLsResponse, AWSError>;
482 /**
483 * Returns an array of WebACLSummary objects in the response.
484 */
485 listWebACLs(callback?: (err: AWSError, data: WAF.Types.ListWebACLsResponse) => void): Request<WAF.Types.ListWebACLsResponse, AWSError>;
486 /**
487 * Returns an array of XssMatchSet objects.
488 */
489 listXssMatchSets(params: WAF.Types.ListXssMatchSetsRequest, callback?: (err: AWSError, data: WAF.Types.ListXssMatchSetsResponse) => void): Request<WAF.Types.ListXssMatchSetsResponse, AWSError>;
490 /**
491 * Returns an array of XssMatchSet objects.
492 */
493 listXssMatchSets(callback?: (err: AWSError, data: WAF.Types.ListXssMatchSetsResponse) => void): Request<WAF.Types.ListXssMatchSetsResponse, AWSError>;
494 /**
495 * Associates a LoggingConfiguration with a specified web ACL. You can access information about all traffic that AWS WAF inspects using the following steps: Create an Amazon Kinesis Data Firehose. Create the data firehose with a PUT source and in the region that you are operating. However, if you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia). Do not create the data firehose using a Kinesis stream as your source. Associate that firehose to your web ACL using a PutLoggingConfiguration request. When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide.
496 */
497 putLoggingConfiguration(params: WAF.Types.PutLoggingConfigurationRequest, callback?: (err: AWSError, data: WAF.Types.PutLoggingConfigurationResponse) => void): Request<WAF.Types.PutLoggingConfigurationResponse, AWSError>;
498 /**
499 * Associates a LoggingConfiguration with a specified web ACL. You can access information about all traffic that AWS WAF inspects using the following steps: Create an Amazon Kinesis Data Firehose. Create the data firehose with a PUT source and in the region that you are operating. However, if you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia). Do not create the data firehose using a Kinesis stream as your source. Associate that firehose to your web ACL using a PutLoggingConfiguration request. When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide.
500 */
501 putLoggingConfiguration(callback?: (err: AWSError, data: WAF.Types.PutLoggingConfigurationResponse) => void): Request<WAF.Types.PutLoggingConfigurationResponse, AWSError>;
502 /**
503 * Attaches a IAM policy to the specified resource. The only supported use for this action is to share a RuleGroup across accounts. The PutPermissionPolicy is subject to the following restrictions: You can attach only one policy with each PutPermissionPolicy request. The policy must include an Effect, Action and Principal. Effect must specify Allow. The Action in the policy must be waf:UpdateWebACL, waf-regional:UpdateWebACL, waf:GetRuleGroup and waf-regional:GetRuleGroup . Any extra or wildcard actions in the policy will be rejected. The policy cannot include a Resource parameter. The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region. The user making the request must be the owner of the RuleGroup. Your policy must be composed using IAM Policy version 2012-10-17. For more information, see IAM Policies. An example of a valid policy parameter is shown in the Examples section below.
504 */
505 putPermissionPolicy(params: WAF.Types.PutPermissionPolicyRequest, callback?: (err: AWSError, data: WAF.Types.PutPermissionPolicyResponse) => void): Request<WAF.Types.PutPermissionPolicyResponse, AWSError>;
506 /**
507 * Attaches a IAM policy to the specified resource. The only supported use for this action is to share a RuleGroup across accounts. The PutPermissionPolicy is subject to the following restrictions: You can attach only one policy with each PutPermissionPolicy request. The policy must include an Effect, Action and Principal. Effect must specify Allow. The Action in the policy must be waf:UpdateWebACL, waf-regional:UpdateWebACL, waf:GetRuleGroup and waf-regional:GetRuleGroup . Any extra or wildcard actions in the policy will be rejected. The policy cannot include a Resource parameter. The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region. The user making the request must be the owner of the RuleGroup. Your policy must be composed using IAM Policy version 2012-10-17. For more information, see IAM Policies. An example of a valid policy parameter is shown in the Examples section below.
508 */
509 putPermissionPolicy(callback?: (err: AWSError, data: WAF.Types.PutPermissionPolicyResponse) => void): Request<WAF.Types.PutPermissionPolicyResponse, AWSError>;
510 /**
511 *
512 */
513 tagResource(params: WAF.Types.TagResourceRequest, callback?: (err: AWSError, data: WAF.Types.TagResourceResponse) => void): Request<WAF.Types.TagResourceResponse, AWSError>;
514 /**
515 *
516 */
517 tagResource(callback?: (err: AWSError, data: WAF.Types.TagResourceResponse) => void): Request<WAF.Types.TagResourceResponse, AWSError>;
518 /**
519 *
520 */
521 untagResource(params: WAF.Types.UntagResourceRequest, callback?: (err: AWSError, data: WAF.Types.UntagResourceResponse) => void): Request<WAF.Types.UntagResourceResponse, AWSError>;
522 /**
523 *
524 */
525 untagResource(callback?: (err: AWSError, data: WAF.Types.UntagResourceResponse) => void): Request<WAF.Types.UntagResourceResponse, AWSError>;
526 /**
527 * Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values: Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate object, you delete the existing object and add a new one. The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header. The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data type. Where to look, such as at the beginning or the end of a query string. Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string. For example, you can add a ByteMatchSetUpdate object that matches web requests in which User-Agent headers contain the string BadBot. You can then configure AWS WAF to block those requests. To create and configure a ByteMatchSet, perform the following steps: Create a ByteMatchSet. For more information, see CreateByteMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
528 */
529 updateByteMatchSet(params: WAF.Types.UpdateByteMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.UpdateByteMatchSetResponse) => void): Request<WAF.Types.UpdateByteMatchSetResponse, AWSError>;
530 /**
531 * Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values: Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate object, you delete the existing object and add a new one. The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header. The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data type. Where to look, such as at the beginning or the end of a query string. Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string. For example, you can add a ByteMatchSetUpdate object that matches web requests in which User-Agent headers contain the string BadBot. You can then configure AWS WAF to block those requests. To create and configure a ByteMatchSet, perform the following steps: Create a ByteMatchSet. For more information, see CreateByteMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
532 */
533 updateByteMatchSet(callback?: (err: AWSError, data: WAF.Types.UpdateByteMatchSetResponse) => void): Request<WAF.Types.UpdateByteMatchSetResponse, AWSError>;
534 /**
535 * Inserts or deletes GeoMatchConstraint objects in an GeoMatchSet. For each GeoMatchConstraint object, you specify the following values: Whether to insert or delete the object from the array. If you want to change an GeoMatchConstraint object, you delete the existing object and add a new one. The Type. The only valid value for Type is Country. The Value, which is a two character code for the country to add to the GeoMatchConstraint object. Valid codes are listed in GeoMatchConstraint$Value. To create and configure an GeoMatchSet, perform the following steps: Submit a CreateGeoMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateGeoMatchSet request. Submit an UpdateGeoMatchSet request to specify the country that you want AWS WAF to watch for. When you update an GeoMatchSet, you specify the country that you want to add and/or the country that you want to delete. If you want to change a country, you delete the existing country and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
536 */
537 updateGeoMatchSet(params: WAF.Types.UpdateGeoMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.UpdateGeoMatchSetResponse) => void): Request<WAF.Types.UpdateGeoMatchSetResponse, AWSError>;
538 /**
539 * Inserts or deletes GeoMatchConstraint objects in an GeoMatchSet. For each GeoMatchConstraint object, you specify the following values: Whether to insert or delete the object from the array. If you want to change an GeoMatchConstraint object, you delete the existing object and add a new one. The Type. The only valid value for Type is Country. The Value, which is a two character code for the country to add to the GeoMatchConstraint object. Valid codes are listed in GeoMatchConstraint$Value. To create and configure an GeoMatchSet, perform the following steps: Submit a CreateGeoMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateGeoMatchSet request. Submit an UpdateGeoMatchSet request to specify the country that you want AWS WAF to watch for. When you update an GeoMatchSet, you specify the country that you want to add and/or the country that you want to delete. If you want to change a country, you delete the existing country and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
540 */
541 updateGeoMatchSet(callback?: (err: AWSError, data: WAF.Types.UpdateGeoMatchSetResponse) => void): Request<WAF.Types.UpdateGeoMatchSetResponse, AWSError>;
542 /**
543 * Inserts or deletes IPSetDescriptor objects in an IPSet. For each IPSetDescriptor object, you specify the following values: Whether to insert or delete the object from the array. If you want to change an IPSetDescriptor object, you delete the existing object and add a new one. The IP address version, IPv4 or IPv6. The IP address in CIDR notation, for example, 192.0.2.0/24 (for the range of IP addresses from 192.0.2.0 to 192.0.2.255) or 192.0.2.44/32 (for the individual IP address 192.0.2.44). AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. IPv6 addresses can be represented using any of the following formats: 1111:0000:0000:0000:0000:0000:0000:0111/128 1111:0:0:0:0:0:0:0111/128 1111::0111/128 1111::111/128 You use an IPSet to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an IPSet that specifies those IP addresses, and then configure AWS WAF to block the requests. To create and configure an IPSet, perform the following steps: Submit a CreateIPSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for. When you update an IPSet, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one. You can insert a maximum of 1000 addresses in a single request. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
544 */
545 updateIPSet(params: WAF.Types.UpdateIPSetRequest, callback?: (err: AWSError, data: WAF.Types.UpdateIPSetResponse) => void): Request<WAF.Types.UpdateIPSetResponse, AWSError>;
546 /**
547 * Inserts or deletes IPSetDescriptor objects in an IPSet. For each IPSetDescriptor object, you specify the following values: Whether to insert or delete the object from the array. If you want to change an IPSetDescriptor object, you delete the existing object and add a new one. The IP address version, IPv4 or IPv6. The IP address in CIDR notation, for example, 192.0.2.0/24 (for the range of IP addresses from 192.0.2.0 to 192.0.2.255) or 192.0.2.44/32 (for the individual IP address 192.0.2.44). AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. IPv6 addresses can be represented using any of the following formats: 1111:0000:0000:0000:0000:0000:0000:0111/128 1111:0:0:0:0:0:0:0111/128 1111::0111/128 1111::111/128 You use an IPSet to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an IPSet that specifies those IP addresses, and then configure AWS WAF to block the requests. To create and configure an IPSet, perform the following steps: Submit a CreateIPSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for. When you update an IPSet, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one. You can insert a maximum of 1000 addresses in a single request. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
548 */
549 updateIPSet(callback?: (err: AWSError, data: WAF.Types.UpdateIPSetResponse) => void): Request<WAF.Types.UpdateIPSetResponse, AWSError>;
550 /**
551 * Inserts or deletes Predicate objects in a rule and updates the RateLimit in the rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to block or count. The RateLimit specifies the number of requests every five minutes that triggers the rule. If you add more than one predicate to a RateBasedRule, a request must match all the predicates and exceed the RateLimit to be counted or blocked. For example, suppose you add the following to a RateBasedRule: An IPSet that matches the IP address 192.0.2.44/32 A ByteMatchSet that matches BadBot in the User-Agent header Further, you specify a RateLimit of 15,000. You then add the RateBasedRule to a WebACL and specify that you want to block requests that satisfy the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions much be received at a rate of more than 15,000 every five minutes. If the rate drops below this limit, AWS WAF no longer blocks the requests. As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule: A ByteMatchSet with FieldToMatch of URI A PositionalConstraint of STARTS_WITH A TargetString of login Further, you specify a RateLimit of 15,000. By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site.
552 */
553 updateRateBasedRule(params: WAF.Types.UpdateRateBasedRuleRequest, callback?: (err: AWSError, data: WAF.Types.UpdateRateBasedRuleResponse) => void): Request<WAF.Types.UpdateRateBasedRuleResponse, AWSError>;
554 /**
555 * Inserts or deletes Predicate objects in a rule and updates the RateLimit in the rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to block or count. The RateLimit specifies the number of requests every five minutes that triggers the rule. If you add more than one predicate to a RateBasedRule, a request must match all the predicates and exceed the RateLimit to be counted or blocked. For example, suppose you add the following to a RateBasedRule: An IPSet that matches the IP address 192.0.2.44/32 A ByteMatchSet that matches BadBot in the User-Agent header Further, you specify a RateLimit of 15,000. You then add the RateBasedRule to a WebACL and specify that you want to block requests that satisfy the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions much be received at a rate of more than 15,000 every five minutes. If the rate drops below this limit, AWS WAF no longer blocks the requests. As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule: A ByteMatchSet with FieldToMatch of URI A PositionalConstraint of STARTS_WITH A TargetString of login Further, you specify a RateLimit of 15,000. By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site.
556 */
557 updateRateBasedRule(callback?: (err: AWSError, data: WAF.Types.UpdateRateBasedRuleResponse) => void): Request<WAF.Types.UpdateRateBasedRuleResponse, AWSError>;
558 /**
559 * Inserts or deletes RegexMatchTuple objects (filters) in a RegexMatchSet. For each RegexMatchSetUpdate object, you specify the following values: Whether to insert or delete the object from the array. If you want to change a RegexMatchSetUpdate object, you delete the existing object and add a new one. The part of a web request that you want AWS WAF to inspectupdate, such as a query string or the value of the User-Agent header. The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet. Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string. For example, you can create a RegexPatternSet that matches any requests with User-Agent headers that contain the string B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and configure a RegexMatchSet, perform the following steps: Create a RegexMatchSet. For more information, see CreateRegexMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet request. Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the identifier of the RegexPatternSet that contain the regular expression patters you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
560 */
561 updateRegexMatchSet(params: WAF.Types.UpdateRegexMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.UpdateRegexMatchSetResponse) => void): Request<WAF.Types.UpdateRegexMatchSetResponse, AWSError>;
562 /**
563 * Inserts or deletes RegexMatchTuple objects (filters) in a RegexMatchSet. For each RegexMatchSetUpdate object, you specify the following values: Whether to insert or delete the object from the array. If you want to change a RegexMatchSetUpdate object, you delete the existing object and add a new one. The part of a web request that you want AWS WAF to inspectupdate, such as a query string or the value of the User-Agent header. The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet. Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string. For example, you can create a RegexPatternSet that matches any requests with User-Agent headers that contain the string B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests. To create and configure a RegexMatchSet, perform the following steps: Create a RegexMatchSet. For more information, see CreateRegexMatchSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet request. Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the identifier of the RegexPatternSet that contain the regular expression patters you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
564 */
565 updateRegexMatchSet(callback?: (err: AWSError, data: WAF.Types.UpdateRegexMatchSetResponse) => void): Request<WAF.Types.UpdateRegexMatchSetResponse, AWSError>;
566 /**
567 * Inserts or deletes RegexPatternString objects in a RegexPatternSet. For each RegexPatternString object, you specify the following values: Whether to insert or delete the RegexPatternString. The regular expression pattern that you want to insert or delete. For more information, see RegexPatternSet. For example, you can create a RegexPatternString such as B[a@]dB[o0]t. AWS WAF will match this RegexPatternString to: BadBot BadB0t B@dBot B@dB0t To create and configure a RegexPatternSet, perform the following steps: Create a RegexPatternSet. For more information, see CreateRegexPatternSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request. Submit an UpdateRegexPatternSet request to specify the regular expression pattern that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
568 */
569 updateRegexPatternSet(params: WAF.Types.UpdateRegexPatternSetRequest, callback?: (err: AWSError, data: WAF.Types.UpdateRegexPatternSetResponse) => void): Request<WAF.Types.UpdateRegexPatternSetResponse, AWSError>;
570 /**
571 * Inserts or deletes RegexPatternString objects in a RegexPatternSet. For each RegexPatternString object, you specify the following values: Whether to insert or delete the RegexPatternString. The regular expression pattern that you want to insert or delete. For more information, see RegexPatternSet. For example, you can create a RegexPatternString such as B[a@]dB[o0]t. AWS WAF will match this RegexPatternString to: BadBot BadB0t B@dBot B@dB0t To create and configure a RegexPatternSet, perform the following steps: Create a RegexPatternSet. For more information, see CreateRegexPatternSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request. Submit an UpdateRegexPatternSet request to specify the regular expression pattern that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
572 */
573 updateRegexPatternSet(callback?: (err: AWSError, data: WAF.Types.UpdateRegexPatternSetResponse) => void): Request<WAF.Types.UpdateRegexPatternSetResponse, AWSError>;
574 /**
575 * Inserts or deletes Predicate objects in a Rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose that you add the following to a Rule: A ByteMatchSet that matches the value BadBot in the User-Agent header An IPSet that matches the IP address 192.0.2.44 You then add the Rule to a WebACL and specify that you want to block requests that satisfy the Rule. For a request to be blocked, the User-Agent header in the request must contain the value BadBot and the request must originate from the IP address 192.0.2.44. To create and configure a Rule, perform the following steps: Create and update the predicates that you want to include in the Rule. Create the Rule. See CreateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. Submit an UpdateRule request to add predicates to the Rule. Create and update a WebACL that contains the Rule. See CreateWebACL. If you want to replace one ByteMatchSet or IPSet with another, you delete the existing one and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
576 */
577 updateRule(params: WAF.Types.UpdateRuleRequest, callback?: (err: AWSError, data: WAF.Types.UpdateRuleResponse) => void): Request<WAF.Types.UpdateRuleResponse, AWSError>;
578 /**
579 * Inserts or deletes Predicate objects in a Rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose that you add the following to a Rule: A ByteMatchSet that matches the value BadBot in the User-Agent header An IPSet that matches the IP address 192.0.2.44 You then add the Rule to a WebACL and specify that you want to block requests that satisfy the Rule. For a request to be blocked, the User-Agent header in the request must contain the value BadBot and the request must originate from the IP address 192.0.2.44. To create and configure a Rule, perform the following steps: Create and update the predicates that you want to include in the Rule. Create the Rule. See CreateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request. Submit an UpdateRule request to add predicates to the Rule. Create and update a WebACL that contains the Rule. See CreateWebACL. If you want to replace one ByteMatchSet or IPSet with another, you delete the existing one and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
580 */
581 updateRule(callback?: (err: AWSError, data: WAF.Types.UpdateRuleResponse) => void): Request<WAF.Types.UpdateRuleResponse, AWSError>;
582 /**
583 * Inserts or deletes ActivatedRule objects in a RuleGroup. You can only insert REGULAR rules into a rule group. You can have a maximum of ten rules per rule group. To create and configure a RuleGroup, perform the following steps: Create and update the Rules that you want to include in the RuleGroup. See CreateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRuleGroup request. Submit an UpdateRuleGroup request to add Rules to the RuleGroup. Create and update a WebACL that contains the RuleGroup. See CreateWebACL. If you want to replace one Rule with another, you delete the existing one and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
584 */
585 updateRuleGroup(params: WAF.Types.UpdateRuleGroupRequest, callback?: (err: AWSError, data: WAF.Types.UpdateRuleGroupResponse) => void): Request<WAF.Types.UpdateRuleGroupResponse, AWSError>;
586 /**
587 * Inserts or deletes ActivatedRule objects in a RuleGroup. You can only insert REGULAR rules into a rule group. You can have a maximum of ten rules per rule group. To create and configure a RuleGroup, perform the following steps: Create and update the Rules that you want to include in the RuleGroup. See CreateRule. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRuleGroup request. Submit an UpdateRuleGroup request to add Rules to the RuleGroup. Create and update a WebACL that contains the RuleGroup. See CreateWebACL. If you want to replace one Rule with another, you delete the existing one and add the new one. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
588 */
589 updateRuleGroup(callback?: (err: AWSError, data: WAF.Types.UpdateRuleGroupResponse) => void): Request<WAF.Types.UpdateRuleGroupResponse, AWSError>;
590 /**
591 * Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each SizeConstraint object, you specify the following values: Whether to insert or delete the object from the array. If you want to change a SizeConstraintSetUpdate object, you delete the existing object and add a new one. The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the User-Agent header. Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. Note that transformations of the request body are not supported because the AWS resource forwards only the first 8192 bytes of your request to AWS WAF. You can only specify a single type of TextTransformation. A ComparisonOperator used for evaluating the selected part of the request against the specified Size, such as equals, greater than, less than, and so on. The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation. For example, you can add a SizeConstraintSetUpdate object that matches web requests in which the length of the User-Agent header is greater than 100 bytes. You can then configure AWS WAF to block those requests. To create and configure a SizeConstraintSet, perform the following steps: Create a SizeConstraintSet. For more information, see CreateSizeConstraintSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
592 */
593 updateSizeConstraintSet(params: WAF.Types.UpdateSizeConstraintSetRequest, callback?: (err: AWSError, data: WAF.Types.UpdateSizeConstraintSetResponse) => void): Request<WAF.Types.UpdateSizeConstraintSetResponse, AWSError>;
594 /**
595 * Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each SizeConstraint object, you specify the following values: Whether to insert or delete the object from the array. If you want to change a SizeConstraintSetUpdate object, you delete the existing object and add a new one. The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the User-Agent header. Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. Note that transformations of the request body are not supported because the AWS resource forwards only the first 8192 bytes of your request to AWS WAF. You can only specify a single type of TextTransformation. A ComparisonOperator used for evaluating the selected part of the request against the specified Size, such as equals, greater than, less than, and so on. The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation. For example, you can add a SizeConstraintSetUpdate object that matches web requests in which the length of the User-Agent header is greater than 100 bytes. You can then configure AWS WAF to block those requests. To create and configure a SizeConstraintSet, perform the following steps: Create a SizeConstraintSet. For more information, see CreateSizeConstraintSet. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
596 */
597 updateSizeConstraintSet(callback?: (err: AWSError, data: WAF.Types.UpdateSizeConstraintSetResponse) => void): Request<WAF.Types.UpdateSizeConstraintSetResponse, AWSError>;
598 /**
599 * Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the following values: Action: Whether to insert the object into or delete the object from the array. To change a SqlInjectionMatchTuple, you delete the existing object and add a new one. FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter. TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code. You can only specify a single type of TextTransformation. You use SqlInjectionMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a SqlInjectionMatchSet with the applicable settings, and then configure AWS WAF to block the requests. To create and configure a SqlInjectionMatchSet, perform the following steps: Submit a CreateSqlInjectionMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
600 */
601 updateSqlInjectionMatchSet(params: WAF.Types.UpdateSqlInjectionMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.UpdateSqlInjectionMatchSetResponse) => void): Request<WAF.Types.UpdateSqlInjectionMatchSetResponse, AWSError>;
602 /**
603 * Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the following values: Action: Whether to insert the object into or delete the object from the array. To change a SqlInjectionMatchTuple, you delete the existing object and add a new one. FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter. TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code. You can only specify a single type of TextTransformation. You use SqlInjectionMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a SqlInjectionMatchSet with the applicable settings, and then configure AWS WAF to block the requests. To create and configure a SqlInjectionMatchSet, perform the following steps: Submit a CreateSqlInjectionMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
604 */
605 updateSqlInjectionMatchSet(callback?: (err: AWSError, data: WAF.Types.UpdateSqlInjectionMatchSetResponse) => void): Request<WAF.Types.UpdateSqlInjectionMatchSetResponse, AWSError>;
606 /**
607 * Inserts or deletes ActivatedRule objects in a WebACL. Each Rule identifies web requests that you want to allow, block, or count. When you update a WebACL, you specify the following values: A default action for the WebACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the Rules in a WebACL. The Rules that you want to add or delete. If you want to replace one Rule with another, you delete the existing Rule and add the new one. For each Rule, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in the Rule. The order in which you want AWS WAF to evaluate the Rules in a WebACL. If you add more than one Rule to a WebACL, AWS WAF evaluates each request against the Rules in order based on the value of Priority. (The Rule that has the lowest value for Priority is evaluated first.) When a web request matches all the predicates (such as ByteMatchSets and IPSets) in a Rule, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remaining Rules in the WebACL, if any. To create and configure a WebACL, perform the following steps: Create and update the predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule. Create a WebACL. See CreateWebACL. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request. Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution. The ActivatedRule can be a rule group. If you specify a rule group as your ActivatedRule, you can exclude specific rules from that rule group. If you already have a rule group associated with a web ACL and want to submit an UpdateWebACL request to exclude certain rules from that rule group, you must first remove the rule group from the web ACL, the re-insert it again, specifying the excluded rules. For details, see ActivatedRule$ExcludedRules. Be aware that if you try to add a RATE_BASED rule to a web ACL without setting the rule type when first creating the rule, the UpdateWebACL request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
608 */
609 updateWebACL(params: WAF.Types.UpdateWebACLRequest, callback?: (err: AWSError, data: WAF.Types.UpdateWebACLResponse) => void): Request<WAF.Types.UpdateWebACLResponse, AWSError>;
610 /**
611 * Inserts or deletes ActivatedRule objects in a WebACL. Each Rule identifies web requests that you want to allow, block, or count. When you update a WebACL, you specify the following values: A default action for the WebACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the Rules in a WebACL. The Rules that you want to add or delete. If you want to replace one Rule with another, you delete the existing Rule and add the new one. For each Rule, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in the Rule. The order in which you want AWS WAF to evaluate the Rules in a WebACL. If you add more than one Rule to a WebACL, AWS WAF evaluates each request against the Rules in order based on the value of Priority. (The Rule that has the lowest value for Priority is evaluated first.) When a web request matches all the predicates (such as ByteMatchSets and IPSets) in a Rule, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remaining Rules in the WebACL, if any. To create and configure a WebACL, perform the following steps: Create and update the predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule. Create a WebACL. See CreateWebACL. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request. Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution. The ActivatedRule can be a rule group. If you specify a rule group as your ActivatedRule, you can exclude specific rules from that rule group. If you already have a rule group associated with a web ACL and want to submit an UpdateWebACL request to exclude certain rules from that rule group, you must first remove the rule group from the web ACL, the re-insert it again, specifying the excluded rules. For details, see ActivatedRule$ExcludedRules. Be aware that if you try to add a RATE_BASED rule to a web ACL without setting the rule type when first creating the rule, the UpdateWebACL request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
612 */
613 updateWebACL(callback?: (err: AWSError, data: WAF.Types.UpdateWebACLResponse) => void): Request<WAF.Types.UpdateWebACLResponse, AWSError>;
614 /**
615 * Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each XssMatchTuple object, you specify the following values: Action: Whether to insert the object into or delete the object from the array. To change an XssMatchTuple, you delete the existing object and add a new one. FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter. TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks. You can only specify a single type of TextTransformation. You use XssMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create an XssMatchSet with the applicable settings, and then configure AWS WAF to block the requests. To create and configure an XssMatchSet, perform the following steps: Submit a CreateXssMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateXssMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
616 */
617 updateXssMatchSet(params: WAF.Types.UpdateXssMatchSetRequest, callback?: (err: AWSError, data: WAF.Types.UpdateXssMatchSetResponse) => void): Request<WAF.Types.UpdateXssMatchSetResponse, AWSError>;
618 /**
619 * Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each XssMatchTuple object, you specify the following values: Action: Whether to insert the object into or delete the object from the array. To change an XssMatchTuple, you delete the existing object and add a new one. FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter. TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks. You can only specify a single type of TextTransformation. You use XssMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create an XssMatchSet with the applicable settings, and then configure AWS WAF to block the requests. To create and configure an XssMatchSet, perform the following steps: Submit a CreateXssMatchSet request. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request. Submit an UpdateXssMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.
620 */
621 updateXssMatchSet(callback?: (err: AWSError, data: WAF.Types.UpdateXssMatchSetResponse) => void): Request<WAF.Types.UpdateXssMatchSetResponse, AWSError>;
622}
623declare namespace WAF {
624 export type Action = string;
625 export interface ActivatedRule {
626 /**
627 * Specifies the order in which the Rules in a WebACL are evaluated. Rules with a lower value for Priority are evaluated before Rules with a higher value. The value must be a unique integer. If you add multiple Rules to a WebACL, the values don't need to be consecutive.
628 */
629 Priority: RulePriority;
630 /**
631 * The RuleId for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule). RuleId is returned by CreateRule and by ListRules.
632 */
633 RuleId: ResourceId;
634 /**
635 * Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. Valid values for Action include the following: ALLOW: CloudFront responds with the requested object. BLOCK: CloudFront responds with an HTTP 403 (Forbidden) status code. COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL. ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.
636 */
637 Action?: WafAction;
638 /**
639 * Use the OverrideAction to test your RuleGroup. Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to None, the RuleGroup will block a request if any individual rule in the RuleGroup matches the request and is configured to block that request. However if you first want to test the RuleGroup, set the OverrideAction to Count. The RuleGroup will then override any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests will be counted. You can view a record of counted requests using GetSampledRequests. ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.
640 */
641 OverrideAction?: WafOverrideAction;
642 /**
643 * The rule type, either REGULAR, as defined by Rule, RATE_BASED, as defined by RateBasedRule, or GROUP, as defined by RuleGroup. The default is REGULAR. Although this field is optional, be aware that if you try to add a RATE_BASED rule to a web ACL without setting the type, the UpdateWebACL request will fail because the request tries to add a REGULAR rule with the specified ID, which does not exist.
644 */
645 Type?: WafRuleType;
646 /**
647 * An array of rules to exclude from a rule group. This is applicable only when the ActivatedRule refers to a RuleGroup. Sometimes it is necessary to troubleshoot rule groups that are blocking traffic unexpectedly (false positives). One troubleshooting technique is to identify the specific rule within the rule group that is blocking the legitimate traffic and then disable (exclude) that particular rule. You can exclude rules from both your own rule groups and AWS Marketplace rule groups that have been associated with a web ACL. Specifying ExcludedRules does not remove those rules from the rule group. Rather, it changes the action for the rules to COUNT. Therefore, requests that match an ExcludedRule are counted but not blocked. The RuleGroup owner will receive COUNT metrics for each ExcludedRule. If you want to exclude rules from a rule group that is already associated with a web ACL, perform the following steps: Use the AWS WAF logs to identify the IDs of the rules that you want to exclude. For more information about the logs, see Logging Web ACL Traffic Information. Submit an UpdateWebACL request that has two actions: The first action deletes the existing rule group from the web ACL. That is, in the UpdateWebACL request, the first Updates:Action should be DELETE and Updates:ActivatedRule:RuleId should be the rule group that contains the rules that you want to exclude. The second action inserts the same rule group back in, but specifying the rules to exclude. That is, the second Updates:Action should be INSERT, Updates:ActivatedRule:RuleId should be the rule group that you just removed, and ExcludedRules should contain the rules that you want to exclude.
648 */
649 ExcludedRules?: ExcludedRules;
650 }
651 export type ActivatedRules = ActivatedRule[];
652 export interface ByteMatchSet {
653 /**
654 * The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see DeleteByteMatchSet). ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
655 */
656 ByteMatchSetId: ResourceId;
657 /**
658 * A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.
659 */
660 Name?: ResourceName;
661 /**
662 * Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.
663 */
664 ByteMatchTuples: ByteMatchTuples;
665 }
666 export type ByteMatchSetSummaries = ByteMatchSetSummary[];
667 export interface ByteMatchSetSummary {
668 /**
669 * The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet, update a ByteMatchSet, remove a ByteMatchSet from a Rule, and delete a ByteMatchSet from AWS WAF. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
670 */
671 ByteMatchSetId: ResourceId;
672 /**
673 * A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.
674 */
675 Name: ResourceName;
676 }
677 export interface ByteMatchSetUpdate {
678 /**
679 * Specifies whether to insert or delete a ByteMatchTuple.
680 */
681 Action: ChangeAction;
682 /**
683 * Information about the part of a web request that you want AWS WAF to inspect and the value that you want AWS WAF to search for. If you specify DELETE for the value of Action, the ByteMatchTuple values must exactly match the values in the ByteMatchTuple that you want to delete from the ByteMatchSet.
684 */
685 ByteMatchTuple: ByteMatchTuple;
686 }
687 export type ByteMatchSetUpdates = ByteMatchSetUpdate[];
688 export type ByteMatchTargetString = Buffer|Uint8Array|Blob|string;
689 export interface ByteMatchTuple {
690 /**
691 * The part of a web request that you want AWS WAF to search, such as a specified header or a query string. For more information, see FieldToMatch.
692 */
693 FieldToMatch: FieldToMatch;
694 /**
695 * The value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part of web requests that you specified in FieldToMatch. The maximum length of the value is 50 bytes. Valid values depend on the values that you specified for FieldToMatch: HEADER: The value that you want AWS WAF to search for in the request header that you specified in FieldToMatch, for example, the value of the User-Agent or Referer header. METHOD: The HTTP method, which indicates the type of operation specified in the request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. QUERY_STRING: The value that you want AWS WAF to search for in the query string, which is the part of a URL that appears after a ? character. URI: The value that you want AWS WAF to search for in the part of a URL that identifies a resource, for example, /images/daily-ad.jpg. BODY: 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. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet. SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters. ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but instead of inspecting a single parameter, AWS WAF inspects all parameters within the query string for the value or regex pattern that you specify in TargetString. If TargetString 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 TargetString. 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.
696 */
697 TargetString: ByteMatchTargetString;
698 /**
699 * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on TargetString before inspecting a request for a match. You can only specify a single type of TextTransformation. 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: Delete the following characters: \ " ' ^ Delete spaces before the following characters: / ( Replace the following characters with a space: , ; Replace multiple spaces with one space Convert uppercase letters (A-Z) to lowercase (a-z) COMPRESS_WHITE_SPACE Use this option to replace the following characters with a space character (decimal 32): \f, formfeed, decimal 12 \t, tab, decimal 9 \n, newline, decimal 10 \r, carriage return, decimal 13 \v, vertical tab, decimal 11 non-breaking space, decimal 160 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: Replaces (ampersand)quot; with " Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 Replaces (ampersand)lt; with a "less than" symbol Replaces (ampersand)gt; with &gt; Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters 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 to perform any text transformations.
700 */
701 TextTransformation: TextTransformation;
702 /**
703 * Within the portion of a web request that you want to search (for example, in the query string, if any), specify where you want AWS WAF to search. Valid values include the following: CONTAINS The specified part of the web request must include the value of TargetString, but the location doesn't matter. CONTAINS_WORD The specified part of the web request must include the value of TargetString, and TargetString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition, TargetString must be a word, which means one of the following: TargetString exactly matches the value of the specified part of the web request, such as the value of a header. TargetString is at the beginning of the specified part of the web request and is followed by a character other than an alphanumeric character or underscore (_), for example, BadBot;. TargetString is at the end of the specified part of the web request and is preceded by a character other than an alphanumeric character or underscore (_), for example, ;BadBot. TargetString is in the middle of the specified part of the web request and is preceded and followed by characters other than alphanumeric characters or underscore (_), for example, -BadBot;. EXACTLY The value of the specified part of the web request must exactly match the value of TargetString. STARTS_WITH The value of TargetString must appear at the beginning of the specified part of the web request. ENDS_WITH The value of TargetString must appear at the end of the specified part of the web request.
704 */
705 PositionalConstraint: PositionalConstraint;
706 }
707 export type ByteMatchTuples = ByteMatchTuple[];
708 export type ChangeAction = "INSERT"|"DELETE"|string;
709 export type ChangeToken = string;
710 export type ChangeTokenStatus = "PROVISIONED"|"PENDING"|"INSYNC"|string;
711 export type ComparisonOperator = "EQ"|"NE"|"LE"|"LT"|"GE"|"GT"|string;
712 export type Country = string;
713 export interface CreateByteMatchSetRequest {
714 /**
715 * A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.
716 */
717 Name: ResourceName;
718 /**
719 * The value returned by the most recent call to GetChangeToken.
720 */
721 ChangeToken: ChangeToken;
722 }
723 export interface CreateByteMatchSetResponse {
724 /**
725 * A ByteMatchSet that contains no ByteMatchTuple objects.
726 */
727 ByteMatchSet?: ByteMatchSet;
728 /**
729 * The ChangeToken that you used to submit the CreateByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
730 */
731 ChangeToken?: ChangeToken;
732 }
733 export interface CreateGeoMatchSetRequest {
734 /**
735 * A friendly name or description of the GeoMatchSet. You can't change Name after you create the GeoMatchSet.
736 */
737 Name: ResourceName;
738 /**
739 * The value returned by the most recent call to GetChangeToken.
740 */
741 ChangeToken: ChangeToken;
742 }
743 export interface CreateGeoMatchSetResponse {
744 /**
745 * The GeoMatchSet returned in the CreateGeoMatchSet response. The GeoMatchSet contains no GeoMatchConstraints.
746 */
747 GeoMatchSet?: GeoMatchSet;
748 /**
749 * The ChangeToken that you used to submit the CreateGeoMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
750 */
751 ChangeToken?: ChangeToken;
752 }
753 export interface CreateIPSetRequest {
754 /**
755 * A friendly name or description of the IPSet. You can't change Name after you create the IPSet.
756 */
757 Name: ResourceName;
758 /**
759 * The value returned by the most recent call to GetChangeToken.
760 */
761 ChangeToken: ChangeToken;
762 }
763 export interface CreateIPSetResponse {
764 /**
765 * The IPSet returned in the CreateIPSet response.
766 */
767 IPSet?: IPSet;
768 /**
769 * The ChangeToken that you used to submit the CreateIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
770 */
771 ChangeToken?: ChangeToken;
772 }
773 export interface CreateRateBasedRuleRequest {
774 /**
775 * A friendly name or description of the RateBasedRule. You can't change the name of a RateBasedRule after you create it.
776 */
777 Name: ResourceName;
778 /**
779 * A friendly name or description for the metrics for this RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RateBasedRule.
780 */
781 MetricName: MetricName;
782 /**
783 * The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests that arrive from the same IP address are subject to the RateLimit that is specified in the RateBasedRule.
784 */
785 RateKey: RateKey;
786 /**
787 * The maximum number of requests, which have an identical value in the field that is specified by RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.
788 */
789 RateLimit: RateLimit;
790 /**
791 * The ChangeToken that you used to submit the CreateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
792 */
793 ChangeToken: ChangeToken;
794 Tags?: TagList;
795 }
796 export interface CreateRateBasedRuleResponse {
797 /**
798 * The RateBasedRule that is returned in the CreateRateBasedRule response.
799 */
800 Rule?: RateBasedRule;
801 /**
802 * The ChangeToken that you used to submit the CreateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
803 */
804 ChangeToken?: ChangeToken;
805 }
806 export interface CreateRegexMatchSetRequest {
807 /**
808 * A friendly name or description of the RegexMatchSet. You can't change Name after you create a RegexMatchSet.
809 */
810 Name: ResourceName;
811 /**
812 * The value returned by the most recent call to GetChangeToken.
813 */
814 ChangeToken: ChangeToken;
815 }
816 export interface CreateRegexMatchSetResponse {
817 /**
818 * A RegexMatchSet that contains no RegexMatchTuple objects.
819 */
820 RegexMatchSet?: RegexMatchSet;
821 /**
822 * The ChangeToken that you used to submit the CreateRegexMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
823 */
824 ChangeToken?: ChangeToken;
825 }
826 export interface CreateRegexPatternSetRequest {
827 /**
828 * A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet.
829 */
830 Name: ResourceName;
831 /**
832 * The value returned by the most recent call to GetChangeToken.
833 */
834 ChangeToken: ChangeToken;
835 }
836 export interface CreateRegexPatternSetResponse {
837 /**
838 * A RegexPatternSet that contains no objects.
839 */
840 RegexPatternSet?: RegexPatternSet;
841 /**
842 * The ChangeToken that you used to submit the CreateRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
843 */
844 ChangeToken?: ChangeToken;
845 }
846 export interface CreateRuleGroupRequest {
847 /**
848 * A friendly name or description of the RuleGroup. You can't change Name after you create a RuleGroup.
849 */
850 Name: ResourceName;
851 /**
852 * A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RuleGroup.
853 */
854 MetricName: MetricName;
855 /**
856 * The value returned by the most recent call to GetChangeToken.
857 */
858 ChangeToken: ChangeToken;
859 Tags?: TagList;
860 }
861 export interface CreateRuleGroupResponse {
862 /**
863 * An empty RuleGroup.
864 */
865 RuleGroup?: RuleGroup;
866 /**
867 * The ChangeToken that you used to submit the CreateRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
868 */
869 ChangeToken?: ChangeToken;
870 }
871 export interface CreateRuleRequest {
872 /**
873 * A friendly name or description of the Rule. You can't change the name of a Rule after you create it.
874 */
875 Name: ResourceName;
876 /**
877 * A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the Rule.
878 */
879 MetricName: MetricName;
880 /**
881 * The value returned by the most recent call to GetChangeToken.
882 */
883 ChangeToken: ChangeToken;
884 Tags?: TagList;
885 }
886 export interface CreateRuleResponse {
887 /**
888 * The Rule returned in the CreateRule response.
889 */
890 Rule?: Rule;
891 /**
892 * The ChangeToken that you used to submit the CreateRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
893 */
894 ChangeToken?: ChangeToken;
895 }
896 export interface CreateSizeConstraintSetRequest {
897 /**
898 * A friendly name or description of the SizeConstraintSet. You can't change Name after you create a SizeConstraintSet.
899 */
900 Name: ResourceName;
901 /**
902 * The value returned by the most recent call to GetChangeToken.
903 */
904 ChangeToken: ChangeToken;
905 }
906 export interface CreateSizeConstraintSetResponse {
907 /**
908 * A SizeConstraintSet that contains no SizeConstraint objects.
909 */
910 SizeConstraintSet?: SizeConstraintSet;
911 /**
912 * The ChangeToken that you used to submit the CreateSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
913 */
914 ChangeToken?: ChangeToken;
915 }
916 export interface CreateSqlInjectionMatchSetRequest {
917 /**
918 * A friendly name or description for the SqlInjectionMatchSet that you're creating. You can't change Name after you create the SqlInjectionMatchSet.
919 */
920 Name: ResourceName;
921 /**
922 * The value returned by the most recent call to GetChangeToken.
923 */
924 ChangeToken: ChangeToken;
925 }
926 export interface CreateSqlInjectionMatchSetResponse {
927 /**
928 * A SqlInjectionMatchSet.
929 */
930 SqlInjectionMatchSet?: SqlInjectionMatchSet;
931 /**
932 * The ChangeToken that you used to submit the CreateSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
933 */
934 ChangeToken?: ChangeToken;
935 }
936 export interface CreateWebACLRequest {
937 /**
938 * A friendly name or description of the WebACL. You can't change Name after you create the WebACL.
939 */
940 Name: ResourceName;
941 /**
942 * A friendly name or description for the metrics for this WebACL.The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the WebACL.
943 */
944 MetricName: MetricName;
945 /**
946 * The action that you want AWS WAF to take when a request doesn't match the criteria specified in any of the Rule objects that are associated with the WebACL.
947 */
948 DefaultAction: WafAction;
949 /**
950 * The value returned by the most recent call to GetChangeToken.
951 */
952 ChangeToken: ChangeToken;
953 Tags?: TagList;
954 }
955 export interface CreateWebACLResponse {
956 /**
957 * The WebACL returned in the CreateWebACL response.
958 */
959 WebACL?: WebACL;
960 /**
961 * The ChangeToken that you used to submit the CreateWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
962 */
963 ChangeToken?: ChangeToken;
964 }
965 export interface CreateXssMatchSetRequest {
966 /**
967 * A friendly name or description for the XssMatchSet that you're creating. You can't change Name after you create the XssMatchSet.
968 */
969 Name: ResourceName;
970 /**
971 * The value returned by the most recent call to GetChangeToken.
972 */
973 ChangeToken: ChangeToken;
974 }
975 export interface CreateXssMatchSetResponse {
976 /**
977 * An XssMatchSet.
978 */
979 XssMatchSet?: XssMatchSet;
980 /**
981 * The ChangeToken that you used to submit the CreateXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
982 */
983 ChangeToken?: ChangeToken;
984 }
985 export interface DeleteByteMatchSetRequest {
986 /**
987 * The ByteMatchSetId of the ByteMatchSet that you want to delete. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
988 */
989 ByteMatchSetId: ResourceId;
990 /**
991 * The value returned by the most recent call to GetChangeToken.
992 */
993 ChangeToken: ChangeToken;
994 }
995 export interface DeleteByteMatchSetResponse {
996 /**
997 * The ChangeToken that you used to submit the DeleteByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
998 */
999 ChangeToken?: ChangeToken;
1000 }
1001 export interface DeleteGeoMatchSetRequest {
1002 /**
1003 * The GeoMatchSetID of the GeoMatchSet that you want to delete. GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.
1004 */
1005 GeoMatchSetId: ResourceId;
1006 /**
1007 * The value returned by the most recent call to GetChangeToken.
1008 */
1009 ChangeToken: ChangeToken;
1010 }
1011 export interface DeleteGeoMatchSetResponse {
1012 /**
1013 * The ChangeToken that you used to submit the DeleteGeoMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
1014 */
1015 ChangeToken?: ChangeToken;
1016 }
1017 export interface DeleteIPSetRequest {
1018 /**
1019 * The IPSetId of the IPSet that you want to delete. IPSetId is returned by CreateIPSet and by ListIPSets.
1020 */
1021 IPSetId: ResourceId;
1022 /**
1023 * The value returned by the most recent call to GetChangeToken.
1024 */
1025 ChangeToken: ChangeToken;
1026 }
1027 export interface DeleteIPSetResponse {
1028 /**
1029 * The ChangeToken that you used to submit the DeleteIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
1030 */
1031 ChangeToken?: ChangeToken;
1032 }
1033 export interface DeleteLoggingConfigurationRequest {
1034 /**
1035 * The Amazon Resource Name (ARN) of the web ACL from which you want to delete the LoggingConfiguration.
1036 */
1037 ResourceArn: ResourceArn;
1038 }
1039 export interface DeleteLoggingConfigurationResponse {
1040 }
1041 export interface DeletePermissionPolicyRequest {
1042 /**
1043 * The Amazon Resource Name (ARN) of the RuleGroup from which you want to delete the policy. The user making the request must be the owner of the RuleGroup.
1044 */
1045 ResourceArn: ResourceArn;
1046 }
1047 export interface DeletePermissionPolicyResponse {
1048 }
1049 export interface DeleteRateBasedRuleRequest {
1050 /**
1051 * The RuleId of the RateBasedRule that you want to delete. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.
1052 */
1053 RuleId: ResourceId;
1054 /**
1055 * The value returned by the most recent call to GetChangeToken.
1056 */
1057 ChangeToken: ChangeToken;
1058 }
1059 export interface DeleteRateBasedRuleResponse {
1060 /**
1061 * The ChangeToken that you used to submit the DeleteRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
1062 */
1063 ChangeToken?: ChangeToken;
1064 }
1065 export interface DeleteRegexMatchSetRequest {
1066 /**
1067 * The RegexMatchSetId of the RegexMatchSet that you want to delete. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.
1068 */
1069 RegexMatchSetId: ResourceId;
1070 /**
1071 * The value returned by the most recent call to GetChangeToken.
1072 */
1073 ChangeToken: ChangeToken;
1074 }
1075 export interface DeleteRegexMatchSetResponse {
1076 /**
1077 * The ChangeToken that you used to submit the DeleteRegexMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
1078 */
1079 ChangeToken?: ChangeToken;
1080 }
1081 export interface DeleteRegexPatternSetRequest {
1082 /**
1083 * The RegexPatternSetId of the RegexPatternSet that you want to delete. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
1084 */
1085 RegexPatternSetId: ResourceId;
1086 /**
1087 * The value returned by the most recent call to GetChangeToken.
1088 */
1089 ChangeToken: ChangeToken;
1090 }
1091 export interface DeleteRegexPatternSetResponse {
1092 /**
1093 * The ChangeToken that you used to submit the DeleteRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
1094 */
1095 ChangeToken?: ChangeToken;
1096 }
1097 export interface DeleteRuleGroupRequest {
1098 /**
1099 * The RuleGroupId of the RuleGroup that you want to delete. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.
1100 */
1101 RuleGroupId: ResourceId;
1102 /**
1103 * The value returned by the most recent call to GetChangeToken.
1104 */
1105 ChangeToken: ChangeToken;
1106 }
1107 export interface DeleteRuleGroupResponse {
1108 /**
1109 * The ChangeToken that you used to submit the DeleteRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
1110 */
1111 ChangeToken?: ChangeToken;
1112 }
1113 export interface DeleteRuleRequest {
1114 /**
1115 * The RuleId of the Rule that you want to delete. RuleId is returned by CreateRule and by ListRules.
1116 */
1117 RuleId: ResourceId;
1118 /**
1119 * The value returned by the most recent call to GetChangeToken.
1120 */
1121 ChangeToken: ChangeToken;
1122 }
1123 export interface DeleteRuleResponse {
1124 /**
1125 * The ChangeToken that you used to submit the DeleteRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
1126 */
1127 ChangeToken?: ChangeToken;
1128 }
1129 export interface DeleteSizeConstraintSetRequest {
1130 /**
1131 * The SizeConstraintSetId of the SizeConstraintSet that you want to delete. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.
1132 */
1133 SizeConstraintSetId: ResourceId;
1134 /**
1135 * The value returned by the most recent call to GetChangeToken.
1136 */
1137 ChangeToken: ChangeToken;
1138 }
1139 export interface DeleteSizeConstraintSetResponse {
1140 /**
1141 * The ChangeToken that you used to submit the DeleteSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
1142 */
1143 ChangeToken?: ChangeToken;
1144 }
1145 export interface DeleteSqlInjectionMatchSetRequest {
1146 /**
1147 * The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to delete. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.
1148 */
1149 SqlInjectionMatchSetId: ResourceId;
1150 /**
1151 * The value returned by the most recent call to GetChangeToken.
1152 */
1153 ChangeToken: ChangeToken;
1154 }
1155 export interface DeleteSqlInjectionMatchSetResponse {
1156 /**
1157 * The ChangeToken that you used to submit the DeleteSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
1158 */
1159 ChangeToken?: ChangeToken;
1160 }
1161 export interface DeleteWebACLRequest {
1162 /**
1163 * The WebACLId of the WebACL that you want to delete. WebACLId is returned by CreateWebACL and by ListWebACLs.
1164 */
1165 WebACLId: ResourceId;
1166 /**
1167 * The value returned by the most recent call to GetChangeToken.
1168 */
1169 ChangeToken: ChangeToken;
1170 }
1171 export interface DeleteWebACLResponse {
1172 /**
1173 * The ChangeToken that you used to submit the DeleteWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
1174 */
1175 ChangeToken?: ChangeToken;
1176 }
1177 export interface DeleteXssMatchSetRequest {
1178 /**
1179 * The XssMatchSetId of the XssMatchSet that you want to delete. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
1180 */
1181 XssMatchSetId: ResourceId;
1182 /**
1183 * The value returned by the most recent call to GetChangeToken.
1184 */
1185 ChangeToken: ChangeToken;
1186 }
1187 export interface DeleteXssMatchSetResponse {
1188 /**
1189 * The ChangeToken that you used to submit the DeleteXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
1190 */
1191 ChangeToken?: ChangeToken;
1192 }
1193 export interface ExcludedRule {
1194 /**
1195 * The unique identifier for the rule to exclude from the rule group.
1196 */
1197 RuleId: ResourceId;
1198 }
1199 export type ExcludedRules = ExcludedRule[];
1200 export interface FieldToMatch {
1201 /**
1202 * The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following: HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data. METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT. QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any. URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg. BODY: 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. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet. SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters. ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString.
1203 */
1204 Type: MatchFieldType;
1205 /**
1206 * When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive. When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive. If the value of Type is any other value, omit Data.
1207 */
1208 Data?: MatchFieldData;
1209 }
1210 export interface GeoMatchConstraint {
1211 /**
1212 * The type of geographical area you want AWS WAF to search for. Currently Country is the only valid value.
1213 */
1214 Type: GeoMatchConstraintType;
1215 /**
1216 * The country that you want AWS WAF to search for.
1217 */
1218 Value: GeoMatchConstraintValue;
1219 }
1220 export type GeoMatchConstraintType = "Country"|string;
1221 export type GeoMatchConstraintValue = "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"|string;
1222 export type GeoMatchConstraints = GeoMatchConstraint[];
1223 export interface GeoMatchSet {
1224 /**
1225 * The GeoMatchSetId for an GeoMatchSet. You use GeoMatchSetId to get information about a GeoMatchSet (see GeoMatchSet), update a GeoMatchSet (see UpdateGeoMatchSet), insert a GeoMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a GeoMatchSet from AWS WAF (see DeleteGeoMatchSet). GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.
1226 */
1227 GeoMatchSetId: ResourceId;
1228 /**
1229 * A friendly name or description of the GeoMatchSet. You can't change the name of an GeoMatchSet after you create it.
1230 */
1231 Name?: ResourceName;
1232 /**
1233 * An array of GeoMatchConstraint objects, which contain the country that you want AWS WAF to search for.
1234 */
1235 GeoMatchConstraints: GeoMatchConstraints;
1236 }
1237 export type GeoMatchSetSummaries = GeoMatchSetSummary[];
1238 export interface GeoMatchSetSummary {
1239 /**
1240 * The GeoMatchSetId for an GeoMatchSet. You can use GeoMatchSetId in a GetGeoMatchSet request to get detailed information about an GeoMatchSet.
1241 */
1242 GeoMatchSetId: ResourceId;
1243 /**
1244 * A friendly name or description of the GeoMatchSet. You can't change the name of an GeoMatchSet after you create it.
1245 */
1246 Name: ResourceName;
1247 }
1248 export interface GeoMatchSetUpdate {
1249 /**
1250 * Specifies whether to insert or delete a country with UpdateGeoMatchSet.
1251 */
1252 Action: ChangeAction;
1253 /**
1254 * The country from which web requests originate that you want AWS WAF to search for.
1255 */
1256 GeoMatchConstraint: GeoMatchConstraint;
1257 }
1258 export type GeoMatchSetUpdates = GeoMatchSetUpdate[];
1259 export interface GetByteMatchSetRequest {
1260 /**
1261 * The ByteMatchSetId of the ByteMatchSet that you want to get. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
1262 */
1263 ByteMatchSetId: ResourceId;
1264 }
1265 export interface GetByteMatchSetResponse {
1266 /**
1267 * Information about the ByteMatchSet that you specified in the GetByteMatchSet request. For more information, see the following topics: ByteMatchSet: Contains ByteMatchSetId, ByteMatchTuples, and Name ByteMatchTuples: Contains an array of ByteMatchTuple objects. Each ByteMatchTuple object contains FieldToMatch, PositionalConstraint, TargetString, and TextTransformation FieldToMatch: Contains Data and Type
1268 */
1269 ByteMatchSet?: ByteMatchSet;
1270 }
1271 export interface GetChangeTokenRequest {
1272 }
1273 export interface GetChangeTokenResponse {
1274 /**
1275 * The ChangeToken that you used in the request. Use this value in a GetChangeTokenStatus request to get the current status of the request.
1276 */
1277 ChangeToken?: ChangeToken;
1278 }
1279 export interface GetChangeTokenStatusRequest {
1280 /**
1281 * The change token for which you want to get the status. This change token was previously returned in the GetChangeToken response.
1282 */
1283 ChangeToken: ChangeToken;
1284 }
1285 export interface GetChangeTokenStatusResponse {
1286 /**
1287 * The status of the change token.
1288 */
1289 ChangeTokenStatus?: ChangeTokenStatus;
1290 }
1291 export interface GetGeoMatchSetRequest {
1292 /**
1293 * The GeoMatchSetId of the GeoMatchSet that you want to get. GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.
1294 */
1295 GeoMatchSetId: ResourceId;
1296 }
1297 export interface GetGeoMatchSetResponse {
1298 /**
1299 * Information about the GeoMatchSet that you specified in the GetGeoMatchSet request. This includes the Type, which for a GeoMatchContraint is always Country, as well as the Value, which is the identifier for a specific country.
1300 */
1301 GeoMatchSet?: GeoMatchSet;
1302 }
1303 export interface GetIPSetRequest {
1304 /**
1305 * The IPSetId of the IPSet that you want to get. IPSetId is returned by CreateIPSet and by ListIPSets.
1306 */
1307 IPSetId: ResourceId;
1308 }
1309 export interface GetIPSetResponse {
1310 /**
1311 * Information about the IPSet that you specified in the GetIPSet request. For more information, see the following topics: IPSet: Contains IPSetDescriptors, IPSetId, and Name IPSetDescriptors: Contains an array of IPSetDescriptor objects. Each IPSetDescriptor object contains Type and Value
1312 */
1313 IPSet?: IPSet;
1314 }
1315 export interface GetLoggingConfigurationRequest {
1316 /**
1317 * The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration.
1318 */
1319 ResourceArn: ResourceArn;
1320 }
1321 export interface GetLoggingConfigurationResponse {
1322 /**
1323 * The LoggingConfiguration for the specified web ACL.
1324 */
1325 LoggingConfiguration?: LoggingConfiguration;
1326 }
1327 export interface GetPermissionPolicyRequest {
1328 /**
1329 * The Amazon Resource Name (ARN) of the RuleGroup for which you want to get the policy.
1330 */
1331 ResourceArn: ResourceArn;
1332 }
1333 export interface GetPermissionPolicyResponse {
1334 /**
1335 * The IAM policy attached to the specified RuleGroup.
1336 */
1337 Policy?: PolicyString;
1338 }
1339 export interface GetRateBasedRuleManagedKeysRequest {
1340 /**
1341 * The RuleId of the RateBasedRule for which you want to get a list of ManagedKeys. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.
1342 */
1343 RuleId: ResourceId;
1344 /**
1345 * A null value and not currently used. Do not include this in your request.
1346 */
1347 NextMarker?: NextMarker;
1348 }
1349 export interface GetRateBasedRuleManagedKeysResponse {
1350 /**
1351 * An array of IP addresses that currently are blocked by the specified RateBasedRule.
1352 */
1353 ManagedKeys?: ManagedKeys;
1354 /**
1355 * A null value and not currently used.
1356 */
1357 NextMarker?: NextMarker;
1358 }
1359 export interface GetRateBasedRuleRequest {
1360 /**
1361 * The RuleId of the RateBasedRule that you want to get. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.
1362 */
1363 RuleId: ResourceId;
1364 }
1365 export interface GetRateBasedRuleResponse {
1366 /**
1367 * Information about the RateBasedRule that you specified in the GetRateBasedRule request.
1368 */
1369 Rule?: RateBasedRule;
1370 }
1371 export interface GetRegexMatchSetRequest {
1372 /**
1373 * The RegexMatchSetId of the RegexMatchSet that you want to get. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.
1374 */
1375 RegexMatchSetId: ResourceId;
1376 }
1377 export interface GetRegexMatchSetResponse {
1378 /**
1379 * Information about the RegexMatchSet that you specified in the GetRegexMatchSet request. For more information, see RegexMatchTuple.
1380 */
1381 RegexMatchSet?: RegexMatchSet;
1382 }
1383 export interface GetRegexPatternSetRequest {
1384 /**
1385 * The RegexPatternSetId of the RegexPatternSet that you want to get. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
1386 */
1387 RegexPatternSetId: ResourceId;
1388 }
1389 export interface GetRegexPatternSetResponse {
1390 /**
1391 * Information about the RegexPatternSet that you specified in the GetRegexPatternSet request, including the identifier of the pattern set and the regular expression patterns you want AWS WAF to search for.
1392 */
1393 RegexPatternSet?: RegexPatternSet;
1394 }
1395 export interface GetRuleGroupRequest {
1396 /**
1397 * The RuleGroupId of the RuleGroup that you want to get. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.
1398 */
1399 RuleGroupId: ResourceId;
1400 }
1401 export interface GetRuleGroupResponse {
1402 /**
1403 * Information about the RuleGroup that you specified in the GetRuleGroup request.
1404 */
1405 RuleGroup?: RuleGroup;
1406 }
1407 export interface GetRuleRequest {
1408 /**
1409 * The RuleId of the Rule that you want to get. RuleId is returned by CreateRule and by ListRules.
1410 */
1411 RuleId: ResourceId;
1412 }
1413 export interface GetRuleResponse {
1414 /**
1415 * Information about the Rule that you specified in the GetRule request. For more information, see the following topics: Rule: Contains MetricName, Name, an array of Predicate objects, and RuleId Predicate: Each Predicate object contains DataId, Negated, and Type
1416 */
1417 Rule?: Rule;
1418 }
1419 export type GetSampledRequestsMaxItems = number;
1420 export interface GetSampledRequestsRequest {
1421 /**
1422 * The WebACLId of the WebACL for which you want GetSampledRequests to return a sample of requests.
1423 */
1424 WebAclId: ResourceId;
1425 /**
1426 * RuleId is one of three values: The RuleId of the Rule or the RuleGroupId of the RuleGroup for which you want GetSampledRequests to return a sample of requests. Default_Action, which causes GetSampledRequests to return a sample of the requests that didn't match any of the rules in the specified WebACL.
1427 */
1428 RuleId: ResourceId;
1429 /**
1430 * 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.
1431 */
1432 TimeWindow: TimeWindow;
1433 /**
1434 * 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.
1435 */
1436 MaxItems: GetSampledRequestsMaxItems;
1437 }
1438 export interface GetSampledRequestsResponse {
1439 /**
1440 * A complex type that contains detailed information about each of the requests in the sample.
1441 */
1442 SampledRequests?: SampledHTTPRequests;
1443 /**
1444 * 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.
1445 */
1446 PopulationSize?: PopulationSize;
1447 /**
1448 * 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.
1449 */
1450 TimeWindow?: TimeWindow;
1451 }
1452 export interface GetSizeConstraintSetRequest {
1453 /**
1454 * The SizeConstraintSetId of the SizeConstraintSet that you want to get. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.
1455 */
1456 SizeConstraintSetId: ResourceId;
1457 }
1458 export interface GetSizeConstraintSetResponse {
1459 /**
1460 * Information about the SizeConstraintSet that you specified in the GetSizeConstraintSet request. For more information, see the following topics: SizeConstraintSet: Contains SizeConstraintSetId, SizeConstraints, and Name SizeConstraints: Contains an array of SizeConstraint objects. Each SizeConstraint object contains FieldToMatch, TextTransformation, ComparisonOperator, and Size FieldToMatch: Contains Data and Type
1461 */
1462 SizeConstraintSet?: SizeConstraintSet;
1463 }
1464 export interface GetSqlInjectionMatchSetRequest {
1465 /**
1466 * The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to get. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.
1467 */
1468 SqlInjectionMatchSetId: ResourceId;
1469 }
1470 export interface GetSqlInjectionMatchSetResponse {
1471 /**
1472 * Information about the SqlInjectionMatchSet that you specified in the GetSqlInjectionMatchSet request. For more information, see the following topics: SqlInjectionMatchSet: Contains Name, SqlInjectionMatchSetId, and an array of SqlInjectionMatchTuple objects SqlInjectionMatchTuple: Each SqlInjectionMatchTuple object contains FieldToMatch and TextTransformation FieldToMatch: Contains Data and Type
1473 */
1474 SqlInjectionMatchSet?: SqlInjectionMatchSet;
1475 }
1476 export interface GetWebACLRequest {
1477 /**
1478 * The WebACLId of the WebACL that you want to get. WebACLId is returned by CreateWebACL and by ListWebACLs.
1479 */
1480 WebACLId: ResourceId;
1481 }
1482 export interface GetWebACLResponse {
1483 /**
1484 * Information about the WebACL that you specified in the GetWebACL request. For more information, see the following topics: WebACL: Contains DefaultAction, MetricName, Name, an array of Rule objects, and WebACLId DefaultAction (Data type is WafAction): Contains Type Rules: Contains an array of ActivatedRule objects, which contain Action, Priority, and RuleId Action: Contains Type
1485 */
1486 WebACL?: WebACL;
1487 }
1488 export interface GetXssMatchSetRequest {
1489 /**
1490 * The XssMatchSetId of the XssMatchSet that you want to get. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
1491 */
1492 XssMatchSetId: ResourceId;
1493 }
1494 export interface GetXssMatchSetResponse {
1495 /**
1496 * Information about the XssMatchSet that you specified in the GetXssMatchSet request. For more information, see the following topics: XssMatchSet: Contains Name, XssMatchSetId, and an array of XssMatchTuple objects XssMatchTuple: Each XssMatchTuple object contains FieldToMatch and TextTransformation FieldToMatch: Contains Data and Type
1497 */
1498 XssMatchSet?: XssMatchSet;
1499 }
1500 export interface HTTPHeader {
1501 /**
1502 * The name of one of the headers in the sampled web request.
1503 */
1504 Name?: HeaderName;
1505 /**
1506 * The value of one of the headers in the sampled web request.
1507 */
1508 Value?: HeaderValue;
1509 }
1510 export type HTTPHeaders = HTTPHeader[];
1511 export type HTTPMethod = string;
1512 export interface HTTPRequest {
1513 /**
1514 * The IP address that the request originated from. If the WebACL is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs: c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the request x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request
1515 */
1516 ClientIP?: IPString;
1517 /**
1518 * 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.
1519 */
1520 Country?: Country;
1521 /**
1522 * The part of a web request that identifies the resource, for example, /images/daily-ad.jpg.
1523 */
1524 URI?: URIString;
1525 /**
1526 * The HTTP method specified in the sampled web request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.
1527 */
1528 Method?: HTTPMethod;
1529 /**
1530 * The HTTP version specified in the sampled web request, for example, HTTP/1.1.
1531 */
1532 HTTPVersion?: HTTPVersion;
1533 /**
1534 * A complex type that contains two values for each header in the sampled web request: the name of the header and the value of the header.
1535 */
1536 Headers?: HTTPHeaders;
1537 }
1538 export type HTTPVersion = string;
1539 export type HeaderName = string;
1540 export type HeaderValue = string;
1541 export interface IPSet {
1542 /**
1543 * The IPSetId for an IPSet. You use IPSetId to get information about an IPSet (see GetIPSet), update an IPSet (see UpdateIPSet), insert an IPSet into a Rule or delete one from a Rule (see UpdateRule), and delete an IPSet from AWS WAF (see DeleteIPSet). IPSetId is returned by CreateIPSet and by ListIPSets.
1544 */
1545 IPSetId: ResourceId;
1546 /**
1547 * A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it.
1548 */
1549 Name?: ResourceName;
1550 /**
1551 * The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL is associated with a CloudFront distribution and the viewer did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip field in the CloudFront access logs.
1552 */
1553 IPSetDescriptors: IPSetDescriptors;
1554 }
1555 export interface IPSetDescriptor {
1556 /**
1557 * Specify IPV4 or IPV6.
1558 */
1559 Type: IPSetDescriptorType;
1560 /**
1561 * Specify an IPv4 address by using CIDR notation. For example: To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32. To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. Specify an IPv6 address by using CIDR notation. For example: To configure AWS WAF to allow, block, or count requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128. To configure AWS WAF to allow, block, or count requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
1562 */
1563 Value: IPSetDescriptorValue;
1564 }
1565 export type IPSetDescriptorType = "IPV4"|"IPV6"|string;
1566 export type IPSetDescriptorValue = string;
1567 export type IPSetDescriptors = IPSetDescriptor[];
1568 export type IPSetSummaries = IPSetSummary[];
1569 export interface IPSetSummary {
1570 /**
1571 * The IPSetId for an IPSet. You can use IPSetId in a GetIPSet request to get detailed information about an IPSet.
1572 */
1573 IPSetId: ResourceId;
1574 /**
1575 * A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it.
1576 */
1577 Name: ResourceName;
1578 }
1579 export interface IPSetUpdate {
1580 /**
1581 * Specifies whether to insert or delete an IP address with UpdateIPSet.
1582 */
1583 Action: ChangeAction;
1584 /**
1585 * The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web requests originate from.
1586 */
1587 IPSetDescriptor: IPSetDescriptor;
1588 }
1589 export type IPSetUpdates = IPSetUpdate[];
1590 export type IPString = string;
1591 export interface ListActivatedRulesInRuleGroupRequest {
1592 /**
1593 * The RuleGroupId of the RuleGroup for which you want to get a list of ActivatedRule objects.
1594 */
1595 RuleGroupId?: ResourceId;
1596 /**
1597 * If you specify a value for Limit and you have more ActivatedRules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ActivatedRules. For the second and subsequent ListActivatedRulesInRuleGroup requests, specify the value of NextMarker from the previous response to get information about another batch of ActivatedRules.
1598 */
1599 NextMarker?: NextMarker;
1600 /**
1601 * Specifies the number of ActivatedRules that you want AWS WAF to return for this request. If you have more ActivatedRules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of ActivatedRules.
1602 */
1603 Limit?: PaginationLimit;
1604 }
1605 export interface ListActivatedRulesInRuleGroupResponse {
1606 /**
1607 * If you have more ActivatedRules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more ActivatedRules, submit another ListActivatedRulesInRuleGroup request, and specify the NextMarker value from the response in the NextMarker value in the next request.
1608 */
1609 NextMarker?: NextMarker;
1610 /**
1611 * An array of ActivatedRules objects.
1612 */
1613 ActivatedRules?: ActivatedRules;
1614 }
1615 export interface ListByteMatchSetsRequest {
1616 /**
1617 * If you specify a value for Limit and you have more ByteMatchSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ByteMatchSets. For the second and subsequent ListByteMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of ByteMatchSets.
1618 */
1619 NextMarker?: NextMarker;
1620 /**
1621 * Specifies the number of ByteMatchSet objects that you want AWS WAF to return for this request. If you have more ByteMatchSets objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of ByteMatchSet objects.
1622 */
1623 Limit?: PaginationLimit;
1624 }
1625 export interface ListByteMatchSetsResponse {
1626 /**
1627 * If you have more ByteMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more ByteMatchSet objects, submit another ListByteMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.
1628 */
1629 NextMarker?: NextMarker;
1630 /**
1631 * An array of ByteMatchSetSummary objects.
1632 */
1633 ByteMatchSets?: ByteMatchSetSummaries;
1634 }
1635 export interface ListGeoMatchSetsRequest {
1636 /**
1637 * If you specify a value for Limit and you have more GeoMatchSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of GeoMatchSet objects. For the second and subsequent ListGeoMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of GeoMatchSet objects.
1638 */
1639 NextMarker?: NextMarker;
1640 /**
1641 * Specifies the number of GeoMatchSet objects that you want AWS WAF to return for this request. If you have more GeoMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of GeoMatchSet objects.
1642 */
1643 Limit?: PaginationLimit;
1644 }
1645 export interface ListGeoMatchSetsResponse {
1646 /**
1647 * If you have more GeoMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more GeoMatchSet objects, submit another ListGeoMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.
1648 */
1649 NextMarker?: NextMarker;
1650 /**
1651 * An array of GeoMatchSetSummary objects.
1652 */
1653 GeoMatchSets?: GeoMatchSetSummaries;
1654 }
1655 export interface ListIPSetsRequest {
1656 /**
1657 * AWS WAF returns a NextMarker value in the response that allows you to list another group of IPSets. For the second and subsequent ListIPSets requests, specify the value of NextMarker from the previous response to get information about another batch of IPSets.
1658 */
1659 NextMarker?: NextMarker;
1660 /**
1661 * Specifies the number of IPSet objects that you want AWS WAF to return for this request. If you have more IPSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of IPSet objects.
1662 */
1663 Limit?: PaginationLimit;
1664 }
1665 export interface ListIPSetsResponse {
1666 /**
1667 * To list more IPSet objects, submit another ListIPSets request, and in the next request use the NextMarker response value as the NextMarker value.
1668 */
1669 NextMarker?: NextMarker;
1670 /**
1671 * An array of IPSetSummary objects.
1672 */
1673 IPSets?: IPSetSummaries;
1674 }
1675 export interface ListLoggingConfigurationsRequest {
1676 /**
1677 * If you specify a value for Limit and you have more LoggingConfigurations than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of LoggingConfigurations. For the second and subsequent ListLoggingConfigurations requests, specify the value of NextMarker from the previous response to get information about another batch of ListLoggingConfigurations.
1678 */
1679 NextMarker?: NextMarker;
1680 /**
1681 * Specifies the number of LoggingConfigurations that you want AWS WAF to return for this request. If you have more LoggingConfigurations than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of LoggingConfigurations.
1682 */
1683 Limit?: PaginationLimit;
1684 }
1685 export interface ListLoggingConfigurationsResponse {
1686 /**
1687 * An array of LoggingConfiguration objects.
1688 */
1689 LoggingConfigurations?: LoggingConfigurations;
1690 /**
1691 * If you have more LoggingConfigurations than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more LoggingConfigurations, submit another ListLoggingConfigurations request, and specify the NextMarker value from the response in the NextMarker value in the next request.
1692 */
1693 NextMarker?: NextMarker;
1694 }
1695 export interface ListRateBasedRulesRequest {
1696 /**
1697 * If you specify a value for Limit and you have more Rules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of Rules. For the second and subsequent ListRateBasedRules requests, specify the value of NextMarker from the previous response to get information about another batch of Rules.
1698 */
1699 NextMarker?: NextMarker;
1700 /**
1701 * Specifies the number of Rules that you want AWS WAF to return for this request. If you have more Rules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.
1702 */
1703 Limit?: PaginationLimit;
1704 }
1705 export interface ListRateBasedRulesResponse {
1706 /**
1707 * If you have more Rules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more Rules, submit another ListRateBasedRules request, and specify the NextMarker value from the response in the NextMarker value in the next request.
1708 */
1709 NextMarker?: NextMarker;
1710 /**
1711 * An array of RuleSummary objects.
1712 */
1713 Rules?: RuleSummaries;
1714 }
1715 export interface ListRegexMatchSetsRequest {
1716 /**
1717 * If you specify a value for Limit and you have more RegexMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ByteMatchSets. For the second and subsequent ListRegexMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of RegexMatchSet objects.
1718 */
1719 NextMarker?: NextMarker;
1720 /**
1721 * Specifies the number of RegexMatchSet objects that you want AWS WAF to return for this request. If you have more RegexMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RegexMatchSet objects.
1722 */
1723 Limit?: PaginationLimit;
1724 }
1725 export interface ListRegexMatchSetsResponse {
1726 /**
1727 * If you have more RegexMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RegexMatchSet objects, submit another ListRegexMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.
1728 */
1729 NextMarker?: NextMarker;
1730 /**
1731 * An array of RegexMatchSetSummary objects.
1732 */
1733 RegexMatchSets?: RegexMatchSetSummaries;
1734 }
1735 export interface ListRegexPatternSetsRequest {
1736 /**
1737 * If you specify a value for Limit and you have more RegexPatternSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of RegexPatternSet objects. For the second and subsequent ListRegexPatternSets requests, specify the value of NextMarker from the previous response to get information about another batch of RegexPatternSet objects.
1738 */
1739 NextMarker?: NextMarker;
1740 /**
1741 * Specifies the number of RegexPatternSet objects that you want AWS WAF to return for this request. If you have more RegexPatternSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RegexPatternSet objects.
1742 */
1743 Limit?: PaginationLimit;
1744 }
1745 export interface ListRegexPatternSetsResponse {
1746 /**
1747 * If you have more RegexPatternSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RegexPatternSet objects, submit another ListRegexPatternSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.
1748 */
1749 NextMarker?: NextMarker;
1750 /**
1751 * An array of RegexPatternSetSummary objects.
1752 */
1753 RegexPatternSets?: RegexPatternSetSummaries;
1754 }
1755 export interface ListRuleGroupsRequest {
1756 /**
1757 * If you specify a value for Limit and you have more RuleGroups than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of RuleGroups. For the second and subsequent ListRuleGroups requests, specify the value of NextMarker from the previous response to get information about another batch of RuleGroups.
1758 */
1759 NextMarker?: NextMarker;
1760 /**
1761 * Specifies the number of RuleGroups that you want AWS WAF to return for this request. If you have more RuleGroups than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RuleGroups.
1762 */
1763 Limit?: PaginationLimit;
1764 }
1765 export interface ListRuleGroupsResponse {
1766 /**
1767 * If you have more RuleGroups than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RuleGroups, submit another ListRuleGroups request, and specify the NextMarker value from the response in the NextMarker value in the next request.
1768 */
1769 NextMarker?: NextMarker;
1770 /**
1771 * An array of RuleGroup objects.
1772 */
1773 RuleGroups?: RuleGroupSummaries;
1774 }
1775 export interface ListRulesRequest {
1776 /**
1777 * If you specify a value for Limit and you have more Rules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of Rules. For the second and subsequent ListRules requests, specify the value of NextMarker from the previous response to get information about another batch of Rules.
1778 */
1779 NextMarker?: NextMarker;
1780 /**
1781 * Specifies the number of Rules that you want AWS WAF to return for this request. If you have more Rules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.
1782 */
1783 Limit?: PaginationLimit;
1784 }
1785 export interface ListRulesResponse {
1786 /**
1787 * If you have more Rules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more Rules, submit another ListRules request, and specify the NextMarker value from the response in the NextMarker value in the next request.
1788 */
1789 NextMarker?: NextMarker;
1790 /**
1791 * An array of RuleSummary objects.
1792 */
1793 Rules?: RuleSummaries;
1794 }
1795 export interface ListSizeConstraintSetsRequest {
1796 /**
1797 * If you specify a value for Limit and you have more SizeConstraintSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of SizeConstraintSets. For the second and subsequent ListSizeConstraintSets requests, specify the value of NextMarker from the previous response to get information about another batch of SizeConstraintSets.
1798 */
1799 NextMarker?: NextMarker;
1800 /**
1801 * Specifies the number of SizeConstraintSet objects that you want AWS WAF to return for this request. If you have more SizeConstraintSets objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of SizeConstraintSet objects.
1802 */
1803 Limit?: PaginationLimit;
1804 }
1805 export interface ListSizeConstraintSetsResponse {
1806 /**
1807 * If you have more SizeConstraintSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more SizeConstraintSet objects, submit another ListSizeConstraintSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.
1808 */
1809 NextMarker?: NextMarker;
1810 /**
1811 * An array of SizeConstraintSetSummary objects.
1812 */
1813 SizeConstraintSets?: SizeConstraintSetSummaries;
1814 }
1815 export interface ListSqlInjectionMatchSetsRequest {
1816 /**
1817 * If you specify a value for Limit and you have more SqlInjectionMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of SqlInjectionMatchSets. For the second and subsequent ListSqlInjectionMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of SqlInjectionMatchSets.
1818 */
1819 NextMarker?: NextMarker;
1820 /**
1821 * Specifies the number of SqlInjectionMatchSet objects that you want AWS WAF to return for this request. If you have more SqlInjectionMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.
1822 */
1823 Limit?: PaginationLimit;
1824 }
1825 export interface ListSqlInjectionMatchSetsResponse {
1826 /**
1827 * If you have more SqlInjectionMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more SqlInjectionMatchSet objects, submit another ListSqlInjectionMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.
1828 */
1829 NextMarker?: NextMarker;
1830 /**
1831 * An array of SqlInjectionMatchSetSummary objects.
1832 */
1833 SqlInjectionMatchSets?: SqlInjectionMatchSetSummaries;
1834 }
1835 export interface ListSubscribedRuleGroupsRequest {
1836 /**
1837 * If you specify a value for Limit and you have more ByteMatchSetssubscribed rule groups than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of subscribed rule groups. For the second and subsequent ListSubscribedRuleGroupsRequest requests, specify the value of NextMarker from the previous response to get information about another batch of subscribed rule groups.
1838 */
1839 NextMarker?: NextMarker;
1840 /**
1841 * Specifies the number of subscribed rule groups that you want AWS WAF to return for this request. If you have more objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of objects.
1842 */
1843 Limit?: PaginationLimit;
1844 }
1845 export interface ListSubscribedRuleGroupsResponse {
1846 /**
1847 * If you have more objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more objects, submit another ListSubscribedRuleGroups request, and specify the NextMarker value from the response in the NextMarker value in the next request.
1848 */
1849 NextMarker?: NextMarker;
1850 /**
1851 * An array of RuleGroup objects.
1852 */
1853 RuleGroups?: SubscribedRuleGroupSummaries;
1854 }
1855 export interface ListTagsForResourceRequest {
1856 NextMarker?: NextMarker;
1857 Limit?: PaginationLimit;
1858 ResourceARN: ResourceArn;
1859 }
1860 export interface ListTagsForResourceResponse {
1861 NextMarker?: NextMarker;
1862 TagInfoForResource?: TagInfoForResource;
1863 }
1864 export interface ListWebACLsRequest {
1865 /**
1866 * If you specify a value for Limit and you have more WebACL objects than the number that you specify for Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of WebACL objects. For the second and subsequent ListWebACLs requests, specify the value of NextMarker from the previous response to get information about another batch of WebACL objects.
1867 */
1868 NextMarker?: NextMarker;
1869 /**
1870 * Specifies the number of WebACL objects that you want AWS WAF to return for this request. If you have more WebACL objects than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of WebACL objects.
1871 */
1872 Limit?: PaginationLimit;
1873 }
1874 export interface ListWebACLsResponse {
1875 /**
1876 * If you have more WebACL objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more WebACL objects, submit another ListWebACLs request, and specify the NextMarker value from the response in the NextMarker value in the next request.
1877 */
1878 NextMarker?: NextMarker;
1879 /**
1880 * An array of WebACLSummary objects.
1881 */
1882 WebACLs?: WebACLSummaries;
1883 }
1884 export interface ListXssMatchSetsRequest {
1885 /**
1886 * If you specify a value for Limit and you have more XssMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of XssMatchSets. For the second and subsequent ListXssMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of XssMatchSets.
1887 */
1888 NextMarker?: NextMarker;
1889 /**
1890 * Specifies the number of XssMatchSet objects that you want AWS WAF to return for this request. If you have more XssMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.
1891 */
1892 Limit?: PaginationLimit;
1893 }
1894 export interface ListXssMatchSetsResponse {
1895 /**
1896 * If you have more XssMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more XssMatchSet objects, submit another ListXssMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.
1897 */
1898 NextMarker?: NextMarker;
1899 /**
1900 * An array of XssMatchSetSummary objects.
1901 */
1902 XssMatchSets?: XssMatchSetSummaries;
1903 }
1904 export type LogDestinationConfigs = ResourceArn[];
1905 export interface LoggingConfiguration {
1906 /**
1907 * The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs.
1908 */
1909 ResourceArn: ResourceArn;
1910 /**
1911 * An array of Amazon Kinesis Data Firehose ARNs.
1912 */
1913 LogDestinationConfigs: LogDestinationConfigs;
1914 /**
1915 * The parts of the request that you want redacted from the logs. For example, if you redact the cookie field, the cookie field in the firehose will be xxx.
1916 */
1917 RedactedFields?: RedactedFields;
1918 }
1919 export type LoggingConfigurations = LoggingConfiguration[];
1920 export type ManagedKey = string;
1921 export type ManagedKeys = ManagedKey[];
1922 export type MatchFieldData = string;
1923 export type MatchFieldType = "URI"|"QUERY_STRING"|"HEADER"|"METHOD"|"BODY"|"SINGLE_QUERY_ARG"|"ALL_QUERY_ARGS"|string;
1924 export type MetricName = string;
1925 export type Negated = boolean;
1926 export type NextMarker = string;
1927 export type PaginationLimit = number;
1928 export type PolicyString = string;
1929 export type PopulationSize = number;
1930 export type PositionalConstraint = "EXACTLY"|"STARTS_WITH"|"ENDS_WITH"|"CONTAINS"|"CONTAINS_WORD"|string;
1931 export interface Predicate {
1932 /**
1933 * Set Negated to False if you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address. Set Negated to True if you want AWS WAF to allow or block a request based on the negation of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44.
1934 */
1935 Negated: Negated;
1936 /**
1937 * The type of predicate in a Rule, such as ByteMatch or IPSet.
1938 */
1939 Type: PredicateType;
1940 /**
1941 * A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command.
1942 */
1943 DataId: ResourceId;
1944 }
1945 export type PredicateType = "IPMatch"|"ByteMatch"|"SqlInjectionMatch"|"GeoMatch"|"SizeConstraint"|"XssMatch"|"RegexMatch"|string;
1946 export type Predicates = Predicate[];
1947 export interface PutLoggingConfigurationRequest {
1948 /**
1949 * The Amazon Kinesis Data Firehose that contains the inspected traffic information, the redacted fields details, and the Amazon Resource Name (ARN) of the web ACL to monitor. When specifying Type in RedactedFields, you must use one of the following values: URI, QUERY_STRING, HEADER, or METHOD.
1950 */
1951 LoggingConfiguration: LoggingConfiguration;
1952 }
1953 export interface PutLoggingConfigurationResponse {
1954 /**
1955 * The LoggingConfiguration that you submitted in the request.
1956 */
1957 LoggingConfiguration?: LoggingConfiguration;
1958 }
1959 export interface PutPermissionPolicyRequest {
1960 /**
1961 * The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.
1962 */
1963 ResourceArn: ResourceArn;
1964 /**
1965 * The policy to attach to the specified RuleGroup.
1966 */
1967 Policy: PolicyString;
1968 }
1969 export interface PutPermissionPolicyResponse {
1970 }
1971 export interface RateBasedRule {
1972 /**
1973 * A unique identifier for a RateBasedRule. You use RuleId to get more information about a RateBasedRule (see GetRateBasedRule), update a RateBasedRule (see UpdateRateBasedRule), insert a RateBasedRule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RateBasedRule from AWS WAF (see DeleteRateBasedRule).
1974 */
1975 RuleId: ResourceId;
1976 /**
1977 * A friendly name or description for a RateBasedRule. You can't change the name of a RateBasedRule after you create it.
1978 */
1979 Name?: ResourceName;
1980 /**
1981 * A friendly name or description for the metrics for a RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RateBasedRule.
1982 */
1983 MetricName?: MetricName;
1984 /**
1985 * The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a RateBasedRule.
1986 */
1987 MatchPredicates: Predicates;
1988 /**
1989 * The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests arriving from the same IP address are subject to the RateLimit that is specified in the RateBasedRule.
1990 */
1991 RateKey: RateKey;
1992 /**
1993 * The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.
1994 */
1995 RateLimit: RateLimit;
1996 }
1997 export type RateKey = "IP"|string;
1998 export type RateLimit = number;
1999 export type RedactedFields = FieldToMatch[];
2000 export interface RegexMatchSet {
2001 /**
2002 * The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get information about a RegexMatchSet (see GetRegexMatchSet), update a RegexMatchSet (see UpdateRegexMatchSet), insert a RegexMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a RegexMatchSet from AWS WAF (see DeleteRegexMatchSet). RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.
2003 */
2004 RegexMatchSetId?: ResourceId;
2005 /**
2006 * A friendly name or description of the RegexMatchSet. You can't change Name after you create a RegexMatchSet.
2007 */
2008 Name?: ResourceName;
2009 /**
2010 * Contains an array of RegexMatchTuple objects. Each RegexMatchTuple object contains: The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header. The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet. Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.
2011 */
2012 RegexMatchTuples?: RegexMatchTuples;
2013 }
2014 export type RegexMatchSetSummaries = RegexMatchSetSummary[];
2015 export interface RegexMatchSetSummary {
2016 /**
2017 * The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get information about a RegexMatchSet, update a RegexMatchSet, remove a RegexMatchSet from a Rule, and delete a RegexMatchSet from AWS WAF. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.
2018 */
2019 RegexMatchSetId: ResourceId;
2020 /**
2021 * A friendly name or description of the RegexMatchSet. You can't change Name after you create a RegexMatchSet.
2022 */
2023 Name: ResourceName;
2024 }
2025 export interface RegexMatchSetUpdate {
2026 /**
2027 * Specifies whether to insert or delete a RegexMatchTuple.
2028 */
2029 Action: ChangeAction;
2030 /**
2031 * Information about the part of a web request that you want AWS WAF to inspect and the identifier of the regular expression (regex) pattern that you want AWS WAF to search for. If you specify DELETE for the value of Action, the RegexMatchTuple values must exactly match the values in the RegexMatchTuple that you want to delete from the RegexMatchSet.
2032 */
2033 RegexMatchTuple: RegexMatchTuple;
2034 }
2035 export type RegexMatchSetUpdates = RegexMatchSetUpdate[];
2036 export interface RegexMatchTuple {
2037 /**
2038 * Specifies where in a web request to look for the RegexPatternSet.
2039 */
2040 FieldToMatch: FieldToMatch;
2041 /**
2042 * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on RegexPatternSet before inspecting a request for a match. You can only specify a single type of TextTransformation. CMD_LINE When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations: Delete the following characters: \ " ' ^ Delete spaces before the following characters: / ( Replace the following characters with a space: , ; Replace multiple spaces with one space Convert uppercase letters (A-Z) to lowercase (a-z) COMPRESS_WHITE_SPACE Use this option to replace the following characters with a space character (decimal 32): \f, formfeed, decimal 12 \t, tab, decimal 9 \n, newline, decimal 10 \r, carriage return, decimal 13 \v, vertical tab, decimal 11 non-breaking space, decimal 160 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: Replaces (ampersand)quot; with " Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 Replaces (ampersand)lt; with a "less than" symbol Replaces (ampersand)gt; with &gt; Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters 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 to perform any text transformations.
2043 */
2044 TextTransformation: TextTransformation;
2045 /**
2046 * The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet (see GetRegexPatternSet), update a RegexPatternSet (see UpdateRegexPatternSet), insert a RegexPatternSet into a RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet). RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
2047 */
2048 RegexPatternSetId: ResourceId;
2049 }
2050 export type RegexMatchTuples = RegexMatchTuple[];
2051 export interface RegexPatternSet {
2052 /**
2053 * The identifier for the RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet, update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF. RegexMatchSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
2054 */
2055 RegexPatternSetId: ResourceId;
2056 /**
2057 * A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet.
2058 */
2059 Name?: ResourceName;
2060 /**
2061 * Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.
2062 */
2063 RegexPatternStrings: RegexPatternStrings;
2064 }
2065 export type RegexPatternSetSummaries = RegexPatternSetSummary[];
2066 export interface RegexPatternSetSummary {
2067 /**
2068 * The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet, update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
2069 */
2070 RegexPatternSetId: ResourceId;
2071 /**
2072 * A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet.
2073 */
2074 Name: ResourceName;
2075 }
2076 export interface RegexPatternSetUpdate {
2077 /**
2078 * Specifies whether to insert or delete a RegexPatternString.
2079 */
2080 Action: ChangeAction;
2081 /**
2082 * Specifies the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t.
2083 */
2084 RegexPatternString: RegexPatternString;
2085 }
2086 export type RegexPatternSetUpdates = RegexPatternSetUpdate[];
2087 export type RegexPatternString = string;
2088 export type RegexPatternStrings = RegexPatternString[];
2089 export type ResourceArn = string;
2090 export type ResourceId = string;
2091 export type ResourceName = string;
2092 export interface Rule {
2093 /**
2094 * A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule). RuleId is returned by CreateRule and by ListRules.
2095 */
2096 RuleId: ResourceId;
2097 /**
2098 * The friendly name or description for the Rule. You can't change the name of a Rule after you create it.
2099 */
2100 Name?: ResourceName;
2101 /**
2102 * A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the Rule.
2103 */
2104 MetricName?: MetricName;
2105 /**
2106 * The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.
2107 */
2108 Predicates: Predicates;
2109 }
2110 export interface RuleGroup {
2111 /**
2112 * A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup). RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.
2113 */
2114 RuleGroupId: ResourceId;
2115 /**
2116 * The friendly name or description for the RuleGroup. You can't change the name of a RuleGroup after you create it.
2117 */
2118 Name?: ResourceName;
2119 /**
2120 * A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RuleGroup.
2121 */
2122 MetricName?: MetricName;
2123 }
2124 export type RuleGroupSummaries = RuleGroupSummary[];
2125 export interface RuleGroupSummary {
2126 /**
2127 * A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup). RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.
2128 */
2129 RuleGroupId: ResourceId;
2130 /**
2131 * A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup after you create it.
2132 */
2133 Name: ResourceName;
2134 }
2135 export interface RuleGroupUpdate {
2136 /**
2137 * Specify INSERT to add an ActivatedRule to a RuleGroup. Use DELETE to remove an ActivatedRule from a RuleGroup.
2138 */
2139 Action: ChangeAction;
2140 /**
2141 * The ActivatedRule object specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT).
2142 */
2143 ActivatedRule: ActivatedRule;
2144 }
2145 export type RuleGroupUpdates = RuleGroupUpdate[];
2146 export type RulePriority = number;
2147 export type RuleSummaries = RuleSummary[];
2148 export interface RuleSummary {
2149 /**
2150 * A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule). RuleId is returned by CreateRule and by ListRules.
2151 */
2152 RuleId: ResourceId;
2153 /**
2154 * A friendly name or description of the Rule. You can't change the name of a Rule after you create it.
2155 */
2156 Name: ResourceName;
2157 }
2158 export interface RuleUpdate {
2159 /**
2160 * Specify INSERT to add a Predicate to a Rule. Use DELETE to remove a Predicate from a Rule.
2161 */
2162 Action: ChangeAction;
2163 /**
2164 * The ID of the Predicate (such as an IPSet) that you want to add to a Rule.
2165 */
2166 Predicate: Predicate;
2167 }
2168 export type RuleUpdates = RuleUpdate[];
2169 export type SampleWeight = number;
2170 export interface SampledHTTPRequest {
2171 /**
2172 * A complex type that contains detailed information about the request.
2173 */
2174 Request: HTTPRequest;
2175 /**
2176 * A value that indicates how one result in the response relates proportionally to other results in the response. A result that has a weight of 2 represents roughly twice as many CloudFront web requests as a result that has a weight of 1.
2177 */
2178 Weight: SampleWeight;
2179 /**
2180 * The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds).
2181 */
2182 Timestamp?: Timestamp;
2183 /**
2184 * The action for the Rule that the request matched: ALLOW, BLOCK, or COUNT.
2185 */
2186 Action?: Action;
2187 /**
2188 * This value is returned if the GetSampledRequests request specifies the ID of a RuleGroup rather than the ID of an individual rule. RuleWithinRuleGroup is the rule within the specified RuleGroup that matched the request listed in the response.
2189 */
2190 RuleWithinRuleGroup?: ResourceId;
2191 }
2192 export type SampledHTTPRequests = SampledHTTPRequest[];
2193 export type Size = number;
2194 export interface SizeConstraint {
2195 /**
2196 * Specifies where in a web request to look for the size constraint.
2197 */
2198 FieldToMatch: FieldToMatch;
2199 /**
2200 * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match. You can only specify a single type of TextTransformation. Note that if you choose BODY for the value of Type, you must choose NONE for TextTransformation because CloudFront forwards only the first 8192 bytes for inspection. NONE Specify NONE if you don't want to perform any text transformations. 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: Delete the following characters: \ " ' ^ Delete spaces before the following characters: / ( Replace the following characters with a space: , ; Replace multiple spaces with one space Convert uppercase letters (A-Z) to lowercase (a-z) COMPRESS_WHITE_SPACE Use this option to replace the following characters with a space character (decimal 32): \f, formfeed, decimal 12 \t, tab, decimal 9 \n, newline, decimal 10 \r, carriage return, decimal 13 \v, vertical tab, decimal 11 non-breaking space, decimal 160 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: Replaces (ampersand)quot; with " Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 Replaces (ampersand)lt; with a "less than" symbol Replaces (ampersand)gt; with &gt; Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters 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.
2201 */
2202 TextTransformation: TextTransformation;
2203 /**
2204 * The type of comparison you want AWS WAF to perform. AWS WAF uses this in combination with the provided Size and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match. EQ: Used to test if the Size is equal to the size of the FieldToMatch NE: Used to test if the Size is not equal to the size of the FieldToMatch LE: Used to test if the Size is less than or equal to the size of the FieldToMatch LT: Used to test if the Size is strictly less than the size of the FieldToMatch GE: Used to test if the Size is greater than or equal to the size of the FieldToMatch GT: Used to test if the Size is strictly greater than the size of the FieldToMatch
2205 */
2206 ComparisonOperator: ComparisonOperator;
2207 /**
2208 * The size in bytes that you want AWS WAF to compare against the size of the specified FieldToMatch. AWS WAF uses this in combination with ComparisonOperator and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match. Valid values for size are 0 - 21474836480 bytes (0 - 20 GB). If you specify URI for the value of Type, the / in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.
2209 */
2210 Size: Size;
2211 }
2212 export interface SizeConstraintSet {
2213 /**
2214 * A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get information about a SizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet). SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.
2215 */
2216 SizeConstraintSetId: ResourceId;
2217 /**
2218 * The name, if any, of the SizeConstraintSet.
2219 */
2220 Name?: ResourceName;
2221 /**
2222 * Specifies the parts of web requests that you want to inspect the size of.
2223 */
2224 SizeConstraints: SizeConstraints;
2225 }
2226 export type SizeConstraintSetSummaries = SizeConstraintSetSummary[];
2227 export interface SizeConstraintSetSummary {
2228 /**
2229 * A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get information about a SizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet). SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.
2230 */
2231 SizeConstraintSetId: ResourceId;
2232 /**
2233 * The name of the SizeConstraintSet, if any.
2234 */
2235 Name: ResourceName;
2236 }
2237 export interface SizeConstraintSetUpdate {
2238 /**
2239 * Specify INSERT to add a SizeConstraintSetUpdate to a SizeConstraintSet. Use DELETE to remove a SizeConstraintSetUpdate from a SizeConstraintSet.
2240 */
2241 Action: ChangeAction;
2242 /**
2243 * Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match.
2244 */
2245 SizeConstraint: SizeConstraint;
2246 }
2247 export type SizeConstraintSetUpdates = SizeConstraintSetUpdate[];
2248 export type SizeConstraints = SizeConstraint[];
2249 export interface SqlInjectionMatchSet {
2250 /**
2251 * A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet). SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.
2252 */
2253 SqlInjectionMatchSetId: ResourceId;
2254 /**
2255 * The name, if any, of the SqlInjectionMatchSet.
2256 */
2257 Name?: ResourceName;
2258 /**
2259 * Specifies the parts of web requests that you want to inspect for snippets of malicious SQL code.
2260 */
2261 SqlInjectionMatchTuples: SqlInjectionMatchTuples;
2262 }
2263 export type SqlInjectionMatchSetSummaries = SqlInjectionMatchSetSummary[];
2264 export interface SqlInjectionMatchSetSummary {
2265 /**
2266 * A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet). SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.
2267 */
2268 SqlInjectionMatchSetId: ResourceId;
2269 /**
2270 * The name of the SqlInjectionMatchSet, if any, specified by Id.
2271 */
2272 Name: ResourceName;
2273 }
2274 export interface SqlInjectionMatchSetUpdate {
2275 /**
2276 * Specify INSERT to add a SqlInjectionMatchSetUpdate to a SqlInjectionMatchSet. Use DELETE to remove a SqlInjectionMatchSetUpdate from a SqlInjectionMatchSet.
2277 */
2278 Action: ChangeAction;
2279 /**
2280 * Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.
2281 */
2282 SqlInjectionMatchTuple: SqlInjectionMatchTuple;
2283 }
2284 export type SqlInjectionMatchSetUpdates = SqlInjectionMatchSetUpdate[];
2285 export interface SqlInjectionMatchTuple {
2286 /**
2287 * Specifies where in a web request to look for snippets of malicious SQL code.
2288 */
2289 FieldToMatch: FieldToMatch;
2290 /**
2291 * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match. You can only specify a single type of TextTransformation. 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: Delete the following characters: \ " ' ^ Delete spaces before the following characters: / ( Replace the following characters with a space: , ; Replace multiple spaces with one space Convert uppercase letters (A-Z) to lowercase (a-z) COMPRESS_WHITE_SPACE Use this option to replace the following characters with a space character (decimal 32): \f, formfeed, decimal 12 \t, tab, decimal 9 \n, newline, decimal 10 \r, carriage return, decimal 13 \v, vertical tab, decimal 11 non-breaking space, decimal 160 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: Replaces (ampersand)quot; with " Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 Replaces (ampersand)lt; with a "less than" symbol Replaces (ampersand)gt; with &gt; Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters 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 to perform any text transformations.
2292 */
2293 TextTransformation: TextTransformation;
2294 }
2295 export type SqlInjectionMatchTuples = SqlInjectionMatchTuple[];
2296 export type SubscribedRuleGroupSummaries = SubscribedRuleGroupSummary[];
2297 export interface SubscribedRuleGroupSummary {
2298 /**
2299 * A unique identifier for a RuleGroup.
2300 */
2301 RuleGroupId: ResourceId;
2302 /**
2303 * A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup after you create it.
2304 */
2305 Name: ResourceName;
2306 /**
2307 * A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RuleGroup.
2308 */
2309 MetricName: MetricName;
2310 }
2311 export interface Tag {
2312 Key?: TagKey;
2313 Value?: TagValue;
2314 }
2315 export interface TagInfoForResource {
2316 ResourceARN?: ResourceArn;
2317 TagList?: TagList;
2318 }
2319 export type TagKey = string;
2320 export type TagKeyList = TagKey[];
2321 export type TagList = Tag[];
2322 export interface TagResourceRequest {
2323 ResourceARN: ResourceArn;
2324 Tags: TagList;
2325 }
2326 export interface TagResourceResponse {
2327 }
2328 export type TagValue = string;
2329 export type TextTransformation = "NONE"|"COMPRESS_WHITE_SPACE"|"HTML_ENTITY_DECODE"|"LOWERCASE"|"CMD_LINE"|"URL_DECODE"|string;
2330 export interface TimeWindow {
2331 /**
2332 * 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.
2333 */
2334 StartTime: Timestamp;
2335 /**
2336 * 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.
2337 */
2338 EndTime: Timestamp;
2339 }
2340 export type Timestamp = Date;
2341 export type URIString = string;
2342 export interface UntagResourceRequest {
2343 ResourceARN: ResourceArn;
2344 TagKeys: TagKeyList;
2345 }
2346 export interface UntagResourceResponse {
2347 }
2348 export interface UpdateByteMatchSetRequest {
2349 /**
2350 * The ByteMatchSetId of the ByteMatchSet that you want to update. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
2351 */
2352 ByteMatchSetId: ResourceId;
2353 /**
2354 * The value returned by the most recent call to GetChangeToken.
2355 */
2356 ChangeToken: ChangeToken;
2357 /**
2358 * An array of ByteMatchSetUpdate objects that you want to insert into or delete from a ByteMatchSet. For more information, see the applicable data types: ByteMatchSetUpdate: Contains Action and ByteMatchTuple ByteMatchTuple: Contains FieldToMatch, PositionalConstraint, TargetString, and TextTransformation FieldToMatch: Contains Data and Type
2359 */
2360 Updates: ByteMatchSetUpdates;
2361 }
2362 export interface UpdateByteMatchSetResponse {
2363 /**
2364 * The ChangeToken that you used to submit the UpdateByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
2365 */
2366 ChangeToken?: ChangeToken;
2367 }
2368 export interface UpdateGeoMatchSetRequest {
2369 /**
2370 * The GeoMatchSetId of the GeoMatchSet that you want to update. GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.
2371 */
2372 GeoMatchSetId: ResourceId;
2373 /**
2374 * The value returned by the most recent call to GetChangeToken.
2375 */
2376 ChangeToken: ChangeToken;
2377 /**
2378 * An array of GeoMatchSetUpdate objects that you want to insert into or delete from an GeoMatchSet. For more information, see the applicable data types: GeoMatchSetUpdate: Contains Action and GeoMatchConstraint GeoMatchConstraint: Contains Type and Value You can have only one Type and Value per GeoMatchConstraint. To add multiple countries, include multiple GeoMatchSetUpdate objects in your request.
2379 */
2380 Updates: GeoMatchSetUpdates;
2381 }
2382 export interface UpdateGeoMatchSetResponse {
2383 /**
2384 * The ChangeToken that you used to submit the UpdateGeoMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
2385 */
2386 ChangeToken?: ChangeToken;
2387 }
2388 export interface UpdateIPSetRequest {
2389 /**
2390 * The IPSetId of the IPSet that you want to update. IPSetId is returned by CreateIPSet and by ListIPSets.
2391 */
2392 IPSetId: ResourceId;
2393 /**
2394 * The value returned by the most recent call to GetChangeToken.
2395 */
2396 ChangeToken: ChangeToken;
2397 /**
2398 * An array of IPSetUpdate objects that you want to insert into or delete from an IPSet. For more information, see the applicable data types: IPSetUpdate: Contains Action and IPSetDescriptor IPSetDescriptor: Contains Type and Value You can insert a maximum of 1000 addresses in a single request.
2399 */
2400 Updates: IPSetUpdates;
2401 }
2402 export interface UpdateIPSetResponse {
2403 /**
2404 * The ChangeToken that you used to submit the UpdateIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
2405 */
2406 ChangeToken?: ChangeToken;
2407 }
2408 export interface UpdateRateBasedRuleRequest {
2409 /**
2410 * The RuleId of the RateBasedRule that you want to update. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.
2411 */
2412 RuleId: ResourceId;
2413 /**
2414 * The value returned by the most recent call to GetChangeToken.
2415 */
2416 ChangeToken: ChangeToken;
2417 /**
2418 * An array of RuleUpdate objects that you want to insert into or delete from a RateBasedRule.
2419 */
2420 Updates: RuleUpdates;
2421 /**
2422 * The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.
2423 */
2424 RateLimit: RateLimit;
2425 }
2426 export interface UpdateRateBasedRuleResponse {
2427 /**
2428 * The ChangeToken that you used to submit the UpdateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
2429 */
2430 ChangeToken?: ChangeToken;
2431 }
2432 export interface UpdateRegexMatchSetRequest {
2433 /**
2434 * The RegexMatchSetId of the RegexMatchSet that you want to update. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.
2435 */
2436 RegexMatchSetId: ResourceId;
2437 /**
2438 * An array of RegexMatchSetUpdate objects that you want to insert into or delete from a RegexMatchSet. For more information, see RegexMatchTuple.
2439 */
2440 Updates: RegexMatchSetUpdates;
2441 /**
2442 * The value returned by the most recent call to GetChangeToken.
2443 */
2444 ChangeToken: ChangeToken;
2445 }
2446 export interface UpdateRegexMatchSetResponse {
2447 /**
2448 * The ChangeToken that you used to submit the UpdateRegexMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
2449 */
2450 ChangeToken?: ChangeToken;
2451 }
2452 export interface UpdateRegexPatternSetRequest {
2453 /**
2454 * The RegexPatternSetId of the RegexPatternSet that you want to update. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
2455 */
2456 RegexPatternSetId: ResourceId;
2457 /**
2458 * An array of RegexPatternSetUpdate objects that you want to insert into or delete from a RegexPatternSet.
2459 */
2460 Updates: RegexPatternSetUpdates;
2461 /**
2462 * The value returned by the most recent call to GetChangeToken.
2463 */
2464 ChangeToken: ChangeToken;
2465 }
2466 export interface UpdateRegexPatternSetResponse {
2467 /**
2468 * The ChangeToken that you used to submit the UpdateRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
2469 */
2470 ChangeToken?: ChangeToken;
2471 }
2472 export interface UpdateRuleGroupRequest {
2473 /**
2474 * The RuleGroupId of the RuleGroup that you want to update. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.
2475 */
2476 RuleGroupId: ResourceId;
2477 /**
2478 * An array of RuleGroupUpdate objects that you want to insert into or delete from a RuleGroup. You can only insert REGULAR rules into a rule group. ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.
2479 */
2480 Updates: RuleGroupUpdates;
2481 /**
2482 * The value returned by the most recent call to GetChangeToken.
2483 */
2484 ChangeToken: ChangeToken;
2485 }
2486 export interface UpdateRuleGroupResponse {
2487 /**
2488 * The ChangeToken that you used to submit the UpdateRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
2489 */
2490 ChangeToken?: ChangeToken;
2491 }
2492 export interface UpdateRuleRequest {
2493 /**
2494 * The RuleId of the Rule that you want to update. RuleId is returned by CreateRule and by ListRules.
2495 */
2496 RuleId: ResourceId;
2497 /**
2498 * The value returned by the most recent call to GetChangeToken.
2499 */
2500 ChangeToken: ChangeToken;
2501 /**
2502 * An array of RuleUpdate objects that you want to insert into or delete from a Rule. For more information, see the applicable data types: RuleUpdate: Contains Action and Predicate Predicate: Contains DataId, Negated, and Type FieldToMatch: Contains Data and Type
2503 */
2504 Updates: RuleUpdates;
2505 }
2506 export interface UpdateRuleResponse {
2507 /**
2508 * The ChangeToken that you used to submit the UpdateRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
2509 */
2510 ChangeToken?: ChangeToken;
2511 }
2512 export interface UpdateSizeConstraintSetRequest {
2513 /**
2514 * The SizeConstraintSetId of the SizeConstraintSet that you want to update. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.
2515 */
2516 SizeConstraintSetId: ResourceId;
2517 /**
2518 * The value returned by the most recent call to GetChangeToken.
2519 */
2520 ChangeToken: ChangeToken;
2521 /**
2522 * An array of SizeConstraintSetUpdate objects that you want to insert into or delete from a SizeConstraintSet. For more information, see the applicable data types: SizeConstraintSetUpdate: Contains Action and SizeConstraint SizeConstraint: Contains FieldToMatch, TextTransformation, ComparisonOperator, and Size FieldToMatch: Contains Data and Type
2523 */
2524 Updates: SizeConstraintSetUpdates;
2525 }
2526 export interface UpdateSizeConstraintSetResponse {
2527 /**
2528 * The ChangeToken that you used to submit the UpdateSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
2529 */
2530 ChangeToken?: ChangeToken;
2531 }
2532 export interface UpdateSqlInjectionMatchSetRequest {
2533 /**
2534 * The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to update. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.
2535 */
2536 SqlInjectionMatchSetId: ResourceId;
2537 /**
2538 * The value returned by the most recent call to GetChangeToken.
2539 */
2540 ChangeToken: ChangeToken;
2541 /**
2542 * An array of SqlInjectionMatchSetUpdate objects that you want to insert into or delete from a SqlInjectionMatchSet. For more information, see the applicable data types: SqlInjectionMatchSetUpdate: Contains Action and SqlInjectionMatchTuple SqlInjectionMatchTuple: Contains FieldToMatch and TextTransformation FieldToMatch: Contains Data and Type
2543 */
2544 Updates: SqlInjectionMatchSetUpdates;
2545 }
2546 export interface UpdateSqlInjectionMatchSetResponse {
2547 /**
2548 * The ChangeToken that you used to submit the UpdateSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
2549 */
2550 ChangeToken?: ChangeToken;
2551 }
2552 export interface UpdateWebACLRequest {
2553 /**
2554 * The WebACLId of the WebACL that you want to update. WebACLId is returned by CreateWebACL and by ListWebACLs.
2555 */
2556 WebACLId: ResourceId;
2557 /**
2558 * The value returned by the most recent call to GetChangeToken.
2559 */
2560 ChangeToken: ChangeToken;
2561 /**
2562 * An array of updates to make to the WebACL. An array of WebACLUpdate objects that you want to insert into or delete from a WebACL. For more information, see the applicable data types: WebACLUpdate: Contains Action and ActivatedRule ActivatedRule: Contains Action, OverrideAction, Priority, RuleId, and Type. ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction. WafAction: Contains Type
2563 */
2564 Updates?: WebACLUpdates;
2565 /**
2566 * A default action for the web ACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the rules in a web ACL.
2567 */
2568 DefaultAction?: WafAction;
2569 }
2570 export interface UpdateWebACLResponse {
2571 /**
2572 * The ChangeToken that you used to submit the UpdateWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
2573 */
2574 ChangeToken?: ChangeToken;
2575 }
2576 export interface UpdateXssMatchSetRequest {
2577 /**
2578 * The XssMatchSetId of the XssMatchSet that you want to update. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
2579 */
2580 XssMatchSetId: ResourceId;
2581 /**
2582 * The value returned by the most recent call to GetChangeToken.
2583 */
2584 ChangeToken: ChangeToken;
2585 /**
2586 * An array of XssMatchSetUpdate objects that you want to insert into or delete from an XssMatchSet. For more information, see the applicable data types: XssMatchSetUpdate: Contains Action and XssMatchTuple XssMatchTuple: Contains FieldToMatch and TextTransformation FieldToMatch: Contains Data and Type
2587 */
2588 Updates: XssMatchSetUpdates;
2589 }
2590 export interface UpdateXssMatchSetResponse {
2591 /**
2592 * The ChangeToken that you used to submit the UpdateXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
2593 */
2594 ChangeToken?: ChangeToken;
2595 }
2596 export interface WafAction {
2597 /**
2598 * Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid settings include the following: ALLOW: AWS WAF allows requests BLOCK: AWS WAF blocks requests COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a WebACL.
2599 */
2600 Type: WafActionType;
2601 }
2602 export type WafActionType = "BLOCK"|"ALLOW"|"COUNT"|string;
2603 export interface WafOverrideAction {
2604 /**
2605 * COUNT overrides the action specified by the individual rule within a RuleGroup . If set to NONE, the rule's action will take place.
2606 */
2607 Type: WafOverrideActionType;
2608 }
2609 export type WafOverrideActionType = "NONE"|"COUNT"|string;
2610 export type WafRuleType = "REGULAR"|"RATE_BASED"|"GROUP"|string;
2611 export interface WebACL {
2612 /**
2613 * A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL). WebACLId is returned by CreateWebACL and by ListWebACLs.
2614 */
2615 WebACLId: ResourceId;
2616 /**
2617 * A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.
2618 */
2619 Name?: ResourceName;
2620 /**
2621 * A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change MetricName after you create the WebACL.
2622 */
2623 MetricName?: MetricName;
2624 /**
2625 * The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.
2626 */
2627 DefaultAction: WafAction;
2628 /**
2629 * An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.
2630 */
2631 Rules: ActivatedRules;
2632 /**
2633 * Tha Amazon Resource Name (ARN) of the web ACL.
2634 */
2635 WebACLArn?: ResourceArn;
2636 }
2637 export type WebACLSummaries = WebACLSummary[];
2638 export interface WebACLSummary {
2639 /**
2640 * A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL). WebACLId is returned by CreateWebACL and by ListWebACLs.
2641 */
2642 WebACLId: ResourceId;
2643 /**
2644 * A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.
2645 */
2646 Name: ResourceName;
2647 }
2648 export interface WebACLUpdate {
2649 /**
2650 * Specifies whether to insert a Rule into or delete a Rule from a WebACL.
2651 */
2652 Action: ChangeAction;
2653 /**
2654 * The ActivatedRule object in an UpdateWebACL request specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT).
2655 */
2656 ActivatedRule: ActivatedRule;
2657 }
2658 export type WebACLUpdates = WebACLUpdate[];
2659 export interface XssMatchSet {
2660 /**
2661 * A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about an XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see DeleteXssMatchSet). XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
2662 */
2663 XssMatchSetId: ResourceId;
2664 /**
2665 * The name, if any, of the XssMatchSet.
2666 */
2667 Name?: ResourceName;
2668 /**
2669 * Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.
2670 */
2671 XssMatchTuples: XssMatchTuples;
2672 }
2673 export type XssMatchSetSummaries = XssMatchSetSummary[];
2674 export interface XssMatchSetSummary {
2675 /**
2676 * A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about a XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see DeleteXssMatchSet). XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
2677 */
2678 XssMatchSetId: ResourceId;
2679 /**
2680 * The name of the XssMatchSet, if any, specified by Id.
2681 */
2682 Name: ResourceName;
2683 }
2684 export interface XssMatchSetUpdate {
2685 /**
2686 * Specify INSERT to add an XssMatchSetUpdate to an XssMatchSet. Use DELETE to remove an XssMatchSetUpdate from an XssMatchSet.
2687 */
2688 Action: ChangeAction;
2689 /**
2690 * Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header.
2691 */
2692 XssMatchTuple: XssMatchTuple;
2693 }
2694 export type XssMatchSetUpdates = XssMatchSetUpdate[];
2695 export interface XssMatchTuple {
2696 /**
2697 * Specifies where in a web request to look for cross-site scripting attacks.
2698 */
2699 FieldToMatch: FieldToMatch;
2700 /**
2701 * Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match. You can only specify a single type of TextTransformation. 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: Delete the following characters: \ " ' ^ Delete spaces before the following characters: / ( Replace the following characters with a space: , ; Replace multiple spaces with one space Convert uppercase letters (A-Z) to lowercase (a-z) COMPRESS_WHITE_SPACE Use this option to replace the following characters with a space character (decimal 32): \f, formfeed, decimal 12 \t, tab, decimal 9 \n, newline, decimal 10 \r, carriage return, decimal 13 \v, vertical tab, decimal 11 non-breaking space, decimal 160 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: Replaces (ampersand)quot; with " Replaces (ampersand)nbsp; with a non-breaking space, decimal 160 Replaces (ampersand)lt; with a "less than" symbol Replaces (ampersand)gt; with &gt; Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters 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 to perform any text transformations.
2702 */
2703 TextTransformation: TextTransformation;
2704 }
2705 export type XssMatchTuples = XssMatchTuple[];
2706 /**
2707 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
2708 */
2709 export type apiVersion = "2015-08-24"|"latest"|string;
2710 export interface ClientApiVersions {
2711 /**
2712 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
2713 */
2714 apiVersion?: apiVersion;
2715 }
2716 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
2717 /**
2718 * Contains interfaces for use with the WAF client.
2719 */
2720 export import Types = WAF;
2721}
2722export = WAF;