@aws-sdk/client-wafv2 3.28.0 → 3.32.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +35 -0
- package/WAFV2.ts +8 -8
- package/commands/GetManagedRuleSetCommand.ts +1 -1
- package/commands/GetRateBasedStatementManagedKeysCommand.ts +3 -3
- package/commands/ListAvailableManagedRuleGroupsCommand.ts +1 -1
- package/commands/ListManagedRuleSetsCommand.ts +1 -1
- package/commands/PutManagedRuleSetVersionsCommand.ts +1 -1
- package/commands/UpdateManagedRuleSetVersionExpiryDateCommand.ts +1 -1
- package/dist/cjs/commands/GetManagedRuleSetCommand.js +1 -1
- package/dist/cjs/commands/GetRateBasedStatementManagedKeysCommand.js +3 -3
- package/dist/cjs/commands/ListAvailableManagedRuleGroupsCommand.js +1 -1
- package/dist/cjs/commands/ListManagedRuleSetsCommand.js +1 -1
- package/dist/cjs/commands/PutManagedRuleSetVersionsCommand.js +1 -1
- package/dist/cjs/commands/UpdateManagedRuleSetVersionExpiryDateCommand.js +1 -1
- package/dist/cjs/models/models_0.js +3 -0
- package/dist/cjs/models/models_0.js.map +1 -1
- package/dist/cjs/package.json +31 -31
- package/dist/cjs/protocols/Aws_json1_1.js +27 -23
- package/dist/cjs/protocols/Aws_json1_1.js.map +1 -1
- package/dist/es/commands/GetManagedRuleSetCommand.js +1 -1
- package/dist/es/commands/GetRateBasedStatementManagedKeysCommand.js +3 -3
- package/dist/es/commands/ListAvailableManagedRuleGroupsCommand.js +1 -1
- package/dist/es/commands/ListManagedRuleSetsCommand.js +1 -1
- package/dist/es/commands/PutManagedRuleSetVersionsCommand.js +1 -1
- package/dist/es/commands/UpdateManagedRuleSetVersionExpiryDateCommand.js +1 -1
- package/dist/es/endpoints.js +1 -2
- package/dist/es/endpoints.js.map +1 -1
- package/dist/es/models/models_0.js +3 -0
- package/dist/es/models/models_0.js.map +1 -1
- package/dist/es/package.json +31 -31
- package/dist/es/protocols/Aws_json1_1.js +28 -25
- package/dist/es/protocols/Aws_json1_1.js.map +1 -1
- package/dist/types/WAFV2.d.ts +8 -8
- package/dist/types/commands/GetManagedRuleSetCommand.d.ts +1 -1
- package/dist/types/commands/GetRateBasedStatementManagedKeysCommand.d.ts +3 -3
- package/dist/types/commands/ListAvailableManagedRuleGroupsCommand.d.ts +1 -1
- package/dist/types/commands/ListManagedRuleSetsCommand.d.ts +1 -1
- package/dist/types/commands/PutManagedRuleSetVersionsCommand.d.ts +1 -1
- package/dist/types/commands/UpdateManagedRuleSetVersionExpiryDateCommand.d.ts +1 -1
- package/dist/types/models/models_0.d.ts +67 -35
- package/dist/types/ts3.4/WAFV2.d.ts +8 -8
- package/dist/types/ts3.4/commands/GetManagedRuleSetCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/GetRateBasedStatementManagedKeysCommand.d.ts +3 -3
- package/dist/types/ts3.4/commands/ListAvailableManagedRuleGroupsCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/ListManagedRuleSetsCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/PutManagedRuleSetVersionsCommand.d.ts +1 -1
- package/dist/types/ts3.4/commands/UpdateManagedRuleSetVersionExpiryDateCommand.d.ts +1 -1
- package/dist/types/ts3.4/models/models_0.d.ts +67 -35
- package/models/models_0.ts +68 -35
- package/package.json +31 -31
- package/protocols/Aws_json1_1.ts +32 -24
package/dist/types/WAFV2.d.ts
CHANGED
|
@@ -242,7 +242,7 @@ export declare class WAFV2 extends WAFV2Client {
|
|
|
242
242
|
/**
|
|
243
243
|
* <p>Retrieves the specified managed rule set. </p>
|
|
244
244
|
* <note>
|
|
245
|
-
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers. </p>
|
|
245
|
+
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers. </p>
|
|
246
246
|
* <p>Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are <code>ListManagedRuleSets</code>, <code>GetManagedRuleSet</code>, <code>PutManagedRuleSetVersions</code>, and <code>UpdateManagedRuleSetVersionExpiryDate</code>.</p>
|
|
247
247
|
* </note>
|
|
248
248
|
*/
|
|
@@ -257,9 +257,9 @@ export declare class WAFV2 extends WAFV2Client {
|
|
|
257
257
|
getPermissionPolicy(args: GetPermissionPolicyCommandInput, cb: (err: any, data?: GetPermissionPolicyCommandOutput) => void): void;
|
|
258
258
|
getPermissionPolicy(args: GetPermissionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPermissionPolicyCommandOutput) => void): void;
|
|
259
259
|
/**
|
|
260
|
-
* <p>Retrieves the keys that are currently blocked by a rate-based rule. The maximum number
|
|
261
|
-
*
|
|
262
|
-
*
|
|
260
|
+
* <p>Retrieves the keys that are currently blocked by a rate-based rule instance. The maximum number of managed keys that can be blocked for a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked.</p>
|
|
261
|
+
* <p>For a rate-based rule that you've defined inside a rule group, provide the name of the rule group reference statement in your request, in addition to the rate-based rule name and the web ACL name. </p>
|
|
262
|
+
* <p>WAF monitors web requests and manages keys independently for each unique combination of web ACL, optional rule group, and rate-based rule. For example, if you define a rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF monitors web requests and manages keys for that web ACL, rule group reference statement, and rate-based rule instance. If you use the same rule group in a second web ACL, WAF monitors web requests and manages keys for this second usage completely independent of your first. </p>
|
|
263
263
|
*/
|
|
264
264
|
getRateBasedStatementManagedKeys(args: GetRateBasedStatementManagedKeysCommandInput, options?: __HttpHandlerOptions): Promise<GetRateBasedStatementManagedKeysCommandOutput>;
|
|
265
265
|
getRateBasedStatementManagedKeys(args: GetRateBasedStatementManagedKeysCommandInput, cb: (err: any, data?: GetRateBasedStatementManagedKeysCommandOutput) => void): void;
|
|
@@ -305,7 +305,7 @@ export declare class WAFV2 extends WAFV2Client {
|
|
|
305
305
|
getWebACLForResource(args: GetWebACLForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWebACLForResourceCommandOutput) => void): void;
|
|
306
306
|
/**
|
|
307
307
|
* <p>Retrieves an array of managed rule groups that are available for you to use. This list
|
|
308
|
-
* includes all Amazon Web Services Managed Rules rule groups and all of the Marketplace managed rule groups that you're
|
|
308
|
+
* includes all Amazon Web Services Managed Rules rule groups and all of the Amazon Web Services Marketplace managed rule groups that you're
|
|
309
309
|
* subscribed to.</p>
|
|
310
310
|
*/
|
|
311
311
|
listAvailableManagedRuleGroups(args: ListAvailableManagedRuleGroupsCommandInput, options?: __HttpHandlerOptions): Promise<ListAvailableManagedRuleGroupsCommandOutput>;
|
|
@@ -333,7 +333,7 @@ export declare class WAFV2 extends WAFV2Client {
|
|
|
333
333
|
/**
|
|
334
334
|
* <p>Retrieves the managed rule sets that you own. </p>
|
|
335
335
|
* <note>
|
|
336
|
-
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers. </p>
|
|
336
|
+
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers. </p>
|
|
337
337
|
* <p>Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are <code>ListManagedRuleSets</code>, <code>GetManagedRuleSet</code>, <code>PutManagedRuleSetVersions</code>, and <code>UpdateManagedRuleSetVersionExpiryDate</code>.</p>
|
|
338
338
|
* </note>
|
|
339
339
|
*/
|
|
@@ -422,7 +422,7 @@ export declare class WAFV2 extends WAFV2Client {
|
|
|
422
422
|
* <p>Defines the versions of your managed rule set that you are offering to the customers.
|
|
423
423
|
* Customers see your offerings as managed rule groups with versioning.</p>
|
|
424
424
|
* <note>
|
|
425
|
-
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers. </p>
|
|
425
|
+
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers. </p>
|
|
426
426
|
* <p>Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are <code>ListManagedRuleSets</code>, <code>GetManagedRuleSet</code>, <code>PutManagedRuleSetVersions</code>, and <code>UpdateManagedRuleSetVersionExpiryDate</code>.</p>
|
|
427
427
|
* </note>
|
|
428
428
|
* <p>Customers retrieve their managed rule group list by calling <a>ListAvailableManagedRuleGroups</a>. The name that you provide here for your
|
|
@@ -493,7 +493,7 @@ export declare class WAFV2 extends WAFV2Client {
|
|
|
493
493
|
* expiration of a managed rule group version. After you initiate expiration for a version,
|
|
494
494
|
* WAF excludes it from the reponse to <a>ListAvailableManagedRuleGroupVersions</a> for the managed rule group. </p>
|
|
495
495
|
* <note>
|
|
496
|
-
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers. </p>
|
|
496
|
+
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers. </p>
|
|
497
497
|
* <p>Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are <code>ListManagedRuleSets</code>, <code>GetManagedRuleSet</code>, <code>PutManagedRuleSetVersions</code>, and <code>UpdateManagedRuleSetVersionExpiryDate</code>.</p>
|
|
498
498
|
* </note>
|
|
499
499
|
*/
|
|
@@ -9,7 +9,7 @@ export interface GetManagedRuleSetCommandOutput extends GetManagedRuleSetRespons
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Retrieves the specified managed rule set. </p>
|
|
11
11
|
* <note>
|
|
12
|
-
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers. </p>
|
|
12
|
+
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers. </p>
|
|
13
13
|
* <p>Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are <code>ListManagedRuleSets</code>, <code>GetManagedRuleSet</code>, <code>PutManagedRuleSetVersions</code>, and <code>UpdateManagedRuleSetVersionExpiryDate</code>.</p>
|
|
14
14
|
* </note>
|
|
15
15
|
* @example
|
|
@@ -7,9 +7,9 @@ export interface GetRateBasedStatementManagedKeysCommandInput extends GetRateBas
|
|
|
7
7
|
export interface GetRateBasedStatementManagedKeysCommandOutput extends GetRateBasedStatementManagedKeysResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Retrieves the keys that are currently blocked by a rate-based rule. The maximum number
|
|
11
|
-
*
|
|
12
|
-
*
|
|
10
|
+
* <p>Retrieves the keys that are currently blocked by a rate-based rule instance. The maximum number of managed keys that can be blocked for a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked.</p>
|
|
11
|
+
* <p>For a rate-based rule that you've defined inside a rule group, provide the name of the rule group reference statement in your request, in addition to the rate-based rule name and the web ACL name. </p>
|
|
12
|
+
* <p>WAF monitors web requests and manages keys independently for each unique combination of web ACL, optional rule group, and rate-based rule. For example, if you define a rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF monitors web requests and manages keys for that web ACL, rule group reference statement, and rate-based rule instance. If you use the same rule group in a second web ACL, WAF monitors web requests and manages keys for this second usage completely independent of your first. </p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -8,7 +8,7 @@ export interface ListAvailableManagedRuleGroupsCommandOutput extends ListAvailab
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Retrieves an array of managed rule groups that are available for you to use. This list
|
|
11
|
-
* includes all Amazon Web Services Managed Rules rule groups and all of the Marketplace managed rule groups that you're
|
|
11
|
+
* includes all Amazon Web Services Managed Rules rule groups and all of the Amazon Web Services Marketplace managed rule groups that you're
|
|
12
12
|
* subscribed to.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,7 +9,7 @@ export interface ListManagedRuleSetsCommandOutput extends ListManagedRuleSetsRes
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Retrieves the managed rule sets that you own. </p>
|
|
11
11
|
* <note>
|
|
12
|
-
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers. </p>
|
|
12
|
+
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers. </p>
|
|
13
13
|
* <p>Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are <code>ListManagedRuleSets</code>, <code>GetManagedRuleSet</code>, <code>PutManagedRuleSetVersions</code>, and <code>UpdateManagedRuleSetVersionExpiryDate</code>.</p>
|
|
14
14
|
* </note>
|
|
15
15
|
* @example
|
|
@@ -10,7 +10,7 @@ export interface PutManagedRuleSetVersionsCommandOutput extends PutManagedRuleSe
|
|
|
10
10
|
* <p>Defines the versions of your managed rule set that you are offering to the customers.
|
|
11
11
|
* Customers see your offerings as managed rule groups with versioning.</p>
|
|
12
12
|
* <note>
|
|
13
|
-
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers. </p>
|
|
13
|
+
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers. </p>
|
|
14
14
|
* <p>Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are <code>ListManagedRuleSets</code>, <code>GetManagedRuleSet</code>, <code>PutManagedRuleSetVersions</code>, and <code>UpdateManagedRuleSetVersionExpiryDate</code>.</p>
|
|
15
15
|
* </note>
|
|
16
16
|
* <p>Customers retrieve their managed rule group list by calling <a>ListAvailableManagedRuleGroups</a>. The name that you provide here for your
|
|
@@ -11,7 +11,7 @@ export interface UpdateManagedRuleSetVersionExpiryDateCommandOutput extends Upda
|
|
|
11
11
|
* expiration of a managed rule group version. After you initiate expiration for a version,
|
|
12
12
|
* WAF excludes it from the reponse to <a>ListAvailableManagedRuleGroupVersions</a> for the managed rule group. </p>
|
|
13
13
|
* <note>
|
|
14
|
-
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers. </p>
|
|
14
|
+
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers. </p>
|
|
15
15
|
* <p>Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are <code>ListManagedRuleSets</code>, <code>GetManagedRuleSet</code>, <code>PutManagedRuleSetVersions</code>, and <code>UpdateManagedRuleSetVersionExpiryDate</code>.</p>
|
|
16
16
|
* </note>
|
|
17
17
|
* @example
|
|
@@ -28,6 +28,8 @@ export declare namespace ActionCondition {
|
|
|
28
28
|
*
|
|
29
29
|
* </p>
|
|
30
30
|
* <p>This is used only to indicate the web request component for WAF to inspect, in the <a>FieldToMatch</a> specification. </p>
|
|
31
|
+
* <p>JSON specification: <code>"All": {}</code>
|
|
32
|
+
* </p>
|
|
31
33
|
*/
|
|
32
34
|
export interface All {
|
|
33
35
|
}
|
|
@@ -101,7 +103,9 @@ export declare namespace AllowAction {
|
|
|
101
103
|
}
|
|
102
104
|
/**
|
|
103
105
|
* <p>All query arguments of a web request. </p>
|
|
104
|
-
*
|
|
106
|
+
* <p>This is used only to indicate the web request component for WAF to inspect, in the <a>FieldToMatch</a> specification. </p>
|
|
107
|
+
* <p>JSON specification: <code>"AllQueryArguments": {}</code>
|
|
108
|
+
* </p>
|
|
105
109
|
*/
|
|
106
110
|
export interface AllQueryArguments {
|
|
107
111
|
}
|
|
@@ -114,6 +118,8 @@ export declare namespace AllQueryArguments {
|
|
|
114
118
|
/**
|
|
115
119
|
* <p>The body of a web request. This immediately follows the request headers.</p>
|
|
116
120
|
* <p>This is used only to indicate the web request component for WAF to inspect, in the <a>FieldToMatch</a> specification. </p>
|
|
121
|
+
* <p>JSON specification: <code>"Body": {}</code>
|
|
122
|
+
* </p>
|
|
117
123
|
*/
|
|
118
124
|
export interface Body {
|
|
119
125
|
}
|
|
@@ -177,6 +183,8 @@ export declare enum JsonMatchScope {
|
|
|
177
183
|
* that result from the matches that you
|
|
178
184
|
* indicate.
|
|
179
185
|
* </p>
|
|
186
|
+
* <p>Example JSON: <code>"JsonBody": { "MatchPattern": { "All": {} }, "MatchScope": "ALL" }</code>
|
|
187
|
+
* </p>
|
|
180
188
|
*/
|
|
181
189
|
export interface JsonBody {
|
|
182
190
|
/**
|
|
@@ -240,9 +248,10 @@ export declare namespace JsonBody {
|
|
|
240
248
|
const filterSensitiveLog: (obj: JsonBody) => any;
|
|
241
249
|
}
|
|
242
250
|
/**
|
|
243
|
-
* <p>The HTTP method of a web request. The method indicates the type of operation that the
|
|
244
|
-
*
|
|
245
|
-
* <p>
|
|
251
|
+
* <p>The HTTP method of a web request. The method indicates the type of operation that the request is asking the origin to perform. </p>
|
|
252
|
+
* <p>This is used only to indicate the web request component for WAF to inspect, in the <a>FieldToMatch</a> specification. </p>
|
|
253
|
+
* <p>JSON specification: <code>"Method": {}</code>
|
|
254
|
+
* </p>
|
|
246
255
|
*/
|
|
247
256
|
export interface Method {
|
|
248
257
|
}
|
|
@@ -253,9 +262,10 @@ export declare namespace Method {
|
|
|
253
262
|
const filterSensitiveLog: (obj: Method) => any;
|
|
254
263
|
}
|
|
255
264
|
/**
|
|
256
|
-
* <p>The query string of a web request. This is the part of a URL that appears after a
|
|
257
|
-
*
|
|
258
|
-
* <p>
|
|
265
|
+
* <p>The query string of a web request. This is the part of a URL that appears after a <code>?</code> character, if any.</p>
|
|
266
|
+
* <p>This is used only to indicate the web request component for WAF to inspect, in the <a>FieldToMatch</a> specification. </p>
|
|
267
|
+
* <p>JSON specification: <code>"QueryString": {}</code>
|
|
268
|
+
* </p>
|
|
259
269
|
*/
|
|
260
270
|
export interface QueryString {
|
|
261
271
|
}
|
|
@@ -270,6 +280,8 @@ export declare namespace QueryString {
|
|
|
270
280
|
* <code>User-Agent</code> or <code>Referer</code>. This setting isn't case
|
|
271
281
|
* sensitive.</p>
|
|
272
282
|
* <p>This is used only to indicate the web request component for WAF to inspect, in the <a>FieldToMatch</a> specification. </p>
|
|
283
|
+
* <p>Example JSON: <code>"SingleHeader": { "Name": "haystack" }</code>
|
|
284
|
+
* </p>
|
|
273
285
|
*/
|
|
274
286
|
export interface SingleHeader {
|
|
275
287
|
/**
|
|
@@ -287,6 +299,8 @@ export declare namespace SingleHeader {
|
|
|
287
299
|
* <p>One query argument in a web request, identified by name, for example
|
|
288
300
|
* <i>UserName</i> or <i>SalesRegion</i>. The name can be up to
|
|
289
301
|
* 30 characters long and isn't case sensitive. </p>
|
|
302
|
+
* <p>Example JSON: <code>"SingleQueryArgument": { "Name": "myArgument" }</code>
|
|
303
|
+
* </p>
|
|
290
304
|
*/
|
|
291
305
|
export interface SingleQueryArgument {
|
|
292
306
|
/**
|
|
@@ -303,6 +317,8 @@ export declare namespace SingleQueryArgument {
|
|
|
303
317
|
/**
|
|
304
318
|
* <p>The path component of the URI of a web request. This is the part of a web request that identifies a resource. For example, <code>/images/daily-ad.jpg</code>.</p>
|
|
305
319
|
* <p>This is used only to indicate the web request component for WAF to inspect, in the <a>FieldToMatch</a> specification. </p>
|
|
320
|
+
* <p>JSON specification: <code>"UriPath": {}</code>
|
|
321
|
+
* </p>
|
|
306
322
|
*/
|
|
307
323
|
export interface UriPath {
|
|
308
324
|
}
|
|
@@ -313,11 +329,15 @@ export declare namespace UriPath {
|
|
|
313
329
|
const filterSensitiveLog: (obj: UriPath) => any;
|
|
314
330
|
}
|
|
315
331
|
/**
|
|
316
|
-
* <p>The part of a web request that you want WAF to inspect. Include the single
|
|
317
|
-
*
|
|
318
|
-
*
|
|
319
|
-
* <code>FieldToMatch
|
|
320
|
-
*
|
|
332
|
+
* <p>The part of a web request that you want WAF to inspect. Include the single <code>FieldToMatch</code> type that you want to inspect, with additional specifications as needed, according to the type. You specify a single request component in <code>FieldToMatch</code> for each rule statement that requires it. To inspect more than one component of a web request, create a separate rule statement for each component.</p>
|
|
333
|
+
* <p>JSON specification for a <code>QueryString</code> field to match: </p>
|
|
334
|
+
* <p>
|
|
335
|
+
* <code> "FieldToMatch": { "QueryString": {} }</code>
|
|
336
|
+
* </p>
|
|
337
|
+
* <p>Example JSON for a <code>Method</code> field to match specification:</p>
|
|
338
|
+
* <p>
|
|
339
|
+
* <code> "FieldToMatch": { "Method": { "Name": "DELETE" } }</code>
|
|
340
|
+
* </p>
|
|
321
341
|
*/
|
|
322
342
|
export interface FieldToMatch {
|
|
323
343
|
/**
|
|
@@ -1211,7 +1231,8 @@ export declare namespace RegexPatternSetReferenceStatement {
|
|
|
1211
1231
|
}
|
|
1212
1232
|
/**
|
|
1213
1233
|
* <p>A rule statement used to run the rules that are defined in a <a>RuleGroup</a>. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.</p>
|
|
1214
|
-
* <p>You cannot nest a <code>RuleGroupReferenceStatement</code>, for example for use inside a <code>NotStatement</code> or <code>OrStatement</code>.
|
|
1234
|
+
* <p>You cannot nest a <code>RuleGroupReferenceStatement</code>, for example for use inside a <code>NotStatement</code> or <code>OrStatement</code>. You
|
|
1235
|
+
* can only use a rule group reference statement at the top level inside a web ACL. </p>
|
|
1215
1236
|
*/
|
|
1216
1237
|
export interface RuleGroupReferenceStatement {
|
|
1217
1238
|
/**
|
|
@@ -1390,14 +1411,17 @@ export declare namespace WAFInvalidOperationException {
|
|
|
1390
1411
|
}
|
|
1391
1412
|
export declare enum ParameterExceptionField {
|
|
1392
1413
|
AND_STATEMENT = "AND_STATEMENT",
|
|
1414
|
+
ASSOCIABLE_RESOURCE = "ASSOCIABLE_RESOURCE",
|
|
1393
1415
|
BODY_PARSING_FALLBACK_BEHAVIOR = "BODY_PARSING_FALLBACK_BEHAVIOR",
|
|
1394
1416
|
BYTE_MATCH_STATEMENT = "BYTE_MATCH_STATEMENT",
|
|
1417
|
+
CHANGE_PROPAGATION_STATUS = "CHANGE_PROPAGATION_STATUS",
|
|
1395
1418
|
CUSTOM_REQUEST_HANDLING = "CUSTOM_REQUEST_HANDLING",
|
|
1396
1419
|
CUSTOM_RESPONSE = "CUSTOM_RESPONSE",
|
|
1397
1420
|
CUSTOM_RESPONSE_BODY = "CUSTOM_RESPONSE_BODY",
|
|
1398
1421
|
DEFAULT_ACTION = "DEFAULT_ACTION",
|
|
1399
1422
|
ENTITY_LIMIT = "ENTITY_LIMIT",
|
|
1400
1423
|
EXCLUDED_RULE = "EXCLUDED_RULE",
|
|
1424
|
+
EXPIRE_TIMESTAMP = "EXPIRE_TIMESTAMP",
|
|
1401
1425
|
FALLBACK_BEHAVIOR = "FALLBACK_BEHAVIOR",
|
|
1402
1426
|
FIELD_TO_MATCH = "FIELD_TO_MATCH",
|
|
1403
1427
|
FILTER_CONDITION = "FILTER_CONDITION",
|
|
@@ -1617,6 +1641,8 @@ export declare namespace RuleAction {
|
|
|
1617
1641
|
* <p>Specifies that WAF should do nothing. This is generally used to try out a rule
|
|
1618
1642
|
* without performing any actions. You set the <code>OverrideAction</code> on the <a>Rule</a>. </p>
|
|
1619
1643
|
* <p>This is used in the context of other settings, for example to specify values for <a>RuleAction</a> and web ACL <a>DefaultAction</a>. </p>
|
|
1644
|
+
* <p>JSON specification: <code>"None": {}</code>
|
|
1645
|
+
* </p>
|
|
1620
1646
|
*/
|
|
1621
1647
|
export interface NoneAction {
|
|
1622
1648
|
}
|
|
@@ -2862,12 +2888,10 @@ export interface LoggingConfiguration {
|
|
|
2862
2888
|
*/
|
|
2863
2889
|
LogDestinationConfigs: string[] | undefined;
|
|
2864
2890
|
/**
|
|
2865
|
-
* <p>The parts of the request that you want to keep out of the logs. For
|
|
2866
|
-
*
|
|
2867
|
-
* <code>xxx</code>. </p>
|
|
2891
|
+
* <p>The parts of the request that you want to keep out of the logs. For
|
|
2892
|
+
* example, if you redact the <code>SingleHeader</code> field, the <code>HEADER</code> field in the firehose will be <code>xxx</code>. </p>
|
|
2868
2893
|
* <note>
|
|
2869
|
-
*
|
|
2870
|
-
* <code>QUERY_STRING</code>, <code>HEADER</code>, or <code>METHOD</code>.</p>
|
|
2894
|
+
* <p>You can specify only the following fields for redaction: <code>UriPath</code>, <code>QueryString</code>, <code>SingleHeader</code>, <code>Method</code>, and <code>JsonBody</code>.</p>
|
|
2871
2895
|
* </note>
|
|
2872
2896
|
*/
|
|
2873
2897
|
RedactedFields?: FieldToMatch[];
|
|
@@ -2935,7 +2959,7 @@ export declare namespace GetManagedRuleSetRequest {
|
|
|
2935
2959
|
/**
|
|
2936
2960
|
* <p>Information for a single version of a managed rule set. </p>
|
|
2937
2961
|
* <note>
|
|
2938
|
-
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers. </p>
|
|
2962
|
+
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers. </p>
|
|
2939
2963
|
* <p>Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are <code>ListManagedRuleSets</code>, <code>GetManagedRuleSet</code>, <code>PutManagedRuleSetVersions</code>, and <code>UpdateManagedRuleSetVersionExpiryDate</code>.</p>
|
|
2940
2964
|
* </note>
|
|
2941
2965
|
*/
|
|
@@ -2985,10 +3009,10 @@ export declare namespace ManagedRuleSetVersion {
|
|
|
2985
3009
|
const filterSensitiveLog: (obj: ManagedRuleSetVersion) => any;
|
|
2986
3010
|
}
|
|
2987
3011
|
/**
|
|
2988
|
-
* <p>A set of rules that is managed by Amazon Web Services and Marketplace sellers to provide versioned managed
|
|
3012
|
+
* <p>A set of rules that is managed by Amazon Web Services and Amazon Web Services Marketplace sellers to provide versioned managed
|
|
2989
3013
|
* rule groups for customers of WAF.</p>
|
|
2990
3014
|
* <note>
|
|
2991
|
-
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers. </p>
|
|
3015
|
+
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers. </p>
|
|
2992
3016
|
* <p>Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are <code>ListManagedRuleSets</code>, <code>GetManagedRuleSet</code>, <code>PutManagedRuleSetVersions</code>, and <code>UpdateManagedRuleSetVersionExpiryDate</code>.</p>
|
|
2993
3017
|
* </note>
|
|
2994
3018
|
*/
|
|
@@ -3109,7 +3133,12 @@ export interface GetRateBasedStatementManagedKeysRequest {
|
|
|
3109
3133
|
*/
|
|
3110
3134
|
WebACLId: string | undefined;
|
|
3111
3135
|
/**
|
|
3112
|
-
* <p>The name of the
|
|
3136
|
+
* <p>The name of the rule group reference statement in your web ACL. This is required only when you have the rate-based rule nested
|
|
3137
|
+
* inside a rule group. </p>
|
|
3138
|
+
*/
|
|
3139
|
+
RuleGroupRuleName?: string;
|
|
3140
|
+
/**
|
|
3141
|
+
* <p>The name of the rate-based rule to get the keys for. If you have the rule defined inside a rule group that you're using in your web ACL, also provide the name of the rule group reference statement in the request parameter <code>RuleGroupRuleName</code>.</p>
|
|
3113
3142
|
*/
|
|
3114
3143
|
RuleName: string | undefined;
|
|
3115
3144
|
}
|
|
@@ -3120,7 +3149,7 @@ export declare namespace GetRateBasedStatementManagedKeysRequest {
|
|
|
3120
3149
|
const filterSensitiveLog: (obj: GetRateBasedStatementManagedKeysRequest) => any;
|
|
3121
3150
|
}
|
|
3122
3151
|
/**
|
|
3123
|
-
* <p>The set of IP addresses that are currently blocked for a
|
|
3152
|
+
* <p>The set of IP addresses that are currently blocked for a <a>RateBasedStatement</a>.</p>
|
|
3124
3153
|
*/
|
|
3125
3154
|
export interface RateBasedStatementManagedKeysIPSet {
|
|
3126
3155
|
/**
|
|
@@ -3594,7 +3623,7 @@ export declare namespace ListAvailableManagedRuleGroupsRequest {
|
|
|
3594
3623
|
const filterSensitiveLog: (obj: ListAvailableManagedRuleGroupsRequest) => any;
|
|
3595
3624
|
}
|
|
3596
3625
|
/**
|
|
3597
|
-
* <p>High-level information about a managed rule group, returned by <a>ListAvailableManagedRuleGroups</a>. This provides information like the name and vendor name, that you provide when you add a <a>ManagedRuleGroupStatement</a> to a web ACL. Managed rule groups include Amazon Web Services Managed Rules rule groups, which are free of charge to WAF customers, and Marketplace managed rule groups, which you can subscribe to through Marketplace. </p>
|
|
3626
|
+
* <p>High-level information about a managed rule group, returned by <a>ListAvailableManagedRuleGroups</a>. This provides information like the name and vendor name, that you provide when you add a <a>ManagedRuleGroupStatement</a> to a web ACL. Managed rule groups include Amazon Web Services Managed Rules rule groups, which are free of charge to WAF customers, and Amazon Web Services Marketplace managed rule groups, which you can subscribe to through Amazon Web Services Marketplace. </p>
|
|
3598
3627
|
*/
|
|
3599
3628
|
export interface ManagedRuleGroupSummary {
|
|
3600
3629
|
/**
|
|
@@ -3606,7 +3635,7 @@ export interface ManagedRuleGroupSummary {
|
|
|
3606
3635
|
*/
|
|
3607
3636
|
Name?: string;
|
|
3608
3637
|
/**
|
|
3609
|
-
* <p>The description of the managed rule group, provided by Amazon Web Services Managed Rules or the Marketplace seller who manages it.</p>
|
|
3638
|
+
* <p>The description of the managed rule group, provided by Amazon Web Services Managed Rules or the Amazon Web Services Marketplace seller who manages it.</p>
|
|
3610
3639
|
*/
|
|
3611
3640
|
Description?: string;
|
|
3612
3641
|
}
|
|
@@ -3852,7 +3881,7 @@ export declare namespace ListManagedRuleSetsRequest {
|
|
|
3852
3881
|
/**
|
|
3853
3882
|
* <p>High-level information for a managed rule set. </p>
|
|
3854
3883
|
* <note>
|
|
3855
|
-
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers. </p>
|
|
3884
|
+
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers. </p>
|
|
3856
3885
|
* <p>Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are <code>ListManagedRuleSets</code>, <code>GetManagedRuleSet</code>, <code>PutManagedRuleSetVersions</code>, and <code>UpdateManagedRuleSetVersionExpiryDate</code>.</p>
|
|
3857
3886
|
* </note>
|
|
3858
3887
|
*/
|
|
@@ -4227,7 +4256,7 @@ export declare namespace WAFServiceLinkedRoleErrorException {
|
|
|
4227
4256
|
* <p>A version of the named managed rule group, that the rule group's vendor publishes for
|
|
4228
4257
|
* use by customers. </p>
|
|
4229
4258
|
* <note>
|
|
4230
|
-
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers. </p>
|
|
4259
|
+
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers. </p>
|
|
4231
4260
|
* <p>Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are <code>ListManagedRuleSets</code>, <code>GetManagedRuleSet</code>, <code>PutManagedRuleSetVersions</code>, and <code>UpdateManagedRuleSetVersionExpiryDate</code>.</p>
|
|
4232
4261
|
* </note>
|
|
4233
4262
|
*/
|
|
@@ -4651,8 +4680,7 @@ export declare namespace UpdateWebACLResponse {
|
|
|
4651
4680
|
const filterSensitiveLog: (obj: UpdateWebACLResponse) => any;
|
|
4652
4681
|
}
|
|
4653
4682
|
/**
|
|
4654
|
-
* <p>The processing guidance for a <a>Rule</a>, used by WAF to determine
|
|
4655
|
-
* whether a web request matches the rule. </p>
|
|
4683
|
+
* <p>The processing guidance for a <a>Rule</a>, used by WAF to determine whether a web request matches the rule. </p>
|
|
4656
4684
|
*/
|
|
4657
4685
|
export interface Statement {
|
|
4658
4686
|
/**
|
|
@@ -4683,7 +4711,8 @@ export interface Statement {
|
|
|
4683
4711
|
GeoMatchStatement?: GeoMatchStatement;
|
|
4684
4712
|
/**
|
|
4685
4713
|
* <p>A rule statement used to run the rules that are defined in a <a>RuleGroup</a>. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.</p>
|
|
4686
|
-
* <p>You cannot nest a <code>RuleGroupReferenceStatement</code>, for example for use inside a <code>NotStatement</code> or <code>OrStatement</code>.
|
|
4714
|
+
* <p>You cannot nest a <code>RuleGroupReferenceStatement</code>, for example for use inside a <code>NotStatement</code> or <code>OrStatement</code>. You
|
|
4715
|
+
* can only use a rule group reference statement at the top level inside a web ACL. </p>
|
|
4687
4716
|
*/
|
|
4688
4717
|
RuleGroupReferenceStatement?: RuleGroupReferenceStatement;
|
|
4689
4718
|
/**
|
|
@@ -4697,7 +4726,8 @@ export interface Statement {
|
|
|
4697
4726
|
*/
|
|
4698
4727
|
RegexPatternSetReferenceStatement?: RegexPatternSetReferenceStatement;
|
|
4699
4728
|
/**
|
|
4700
|
-
* <p>A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests
|
|
4729
|
+
* <p>A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests. </p>
|
|
4730
|
+
* <p>WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF. </p>
|
|
4701
4731
|
* <p>When the rule action triggers, WAF blocks additional requests from the IP address until the request rate falls below the limit.</p>
|
|
4702
4732
|
* <p>You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:</p>
|
|
4703
4733
|
* <ul>
|
|
@@ -4709,7 +4739,7 @@ export interface Statement {
|
|
|
4709
4739
|
* </li>
|
|
4710
4740
|
* </ul>
|
|
4711
4741
|
* <p>In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.</p>
|
|
4712
|
-
* <p>You cannot nest a <code>RateBasedStatement</code
|
|
4742
|
+
* <p>You cannot nest a <code>RateBasedStatement</code> inside another statement, for example inside a <code>NotStatement</code> or <code>OrStatement</code>. You can define a <code>RateBasedStatement</code> inside a web ACL and inside a rule group. </p>
|
|
4713
4743
|
*/
|
|
4714
4744
|
RateBasedStatement?: RateBasedStatement;
|
|
4715
4745
|
/**
|
|
@@ -4798,7 +4828,8 @@ export declare namespace NotStatement {
|
|
|
4798
4828
|
const filterSensitiveLog: (obj: NotStatement) => any;
|
|
4799
4829
|
}
|
|
4800
4830
|
/**
|
|
4801
|
-
* <p>A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests
|
|
4831
|
+
* <p>A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests. </p>
|
|
4832
|
+
* <p>WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF. </p>
|
|
4802
4833
|
* <p>When the rule action triggers, WAF blocks additional requests from the IP address until the request rate falls below the limit.</p>
|
|
4803
4834
|
* <p>You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:</p>
|
|
4804
4835
|
* <ul>
|
|
@@ -4810,7 +4841,7 @@ export declare namespace NotStatement {
|
|
|
4810
4841
|
* </li>
|
|
4811
4842
|
* </ul>
|
|
4812
4843
|
* <p>In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.</p>
|
|
4813
|
-
* <p>You cannot nest a <code>RateBasedStatement</code
|
|
4844
|
+
* <p>You cannot nest a <code>RateBasedStatement</code> inside another statement, for example inside a <code>NotStatement</code> or <code>OrStatement</code>. You can define a <code>RateBasedStatement</code> inside a web ACL and inside a rule group. </p>
|
|
4814
4845
|
*/
|
|
4815
4846
|
export interface RateBasedStatement {
|
|
4816
4847
|
/**
|
|
@@ -4995,7 +5026,8 @@ export interface FirewallManagerStatement {
|
|
|
4995
5026
|
ManagedRuleGroupStatement?: ManagedRuleGroupStatement;
|
|
4996
5027
|
/**
|
|
4997
5028
|
* <p>A rule statement used to run the rules that are defined in a <a>RuleGroup</a>. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.</p>
|
|
4998
|
-
* <p>You cannot nest a <code>RuleGroupReferenceStatement</code>, for example for use inside a <code>NotStatement</code> or <code>OrStatement</code>.
|
|
5029
|
+
* <p>You cannot nest a <code>RuleGroupReferenceStatement</code>, for example for use inside a <code>NotStatement</code> or <code>OrStatement</code>. You
|
|
5030
|
+
* can only use a rule group reference statement at the top level inside a web ACL. </p>
|
|
4999
5031
|
*/
|
|
5000
5032
|
RuleGroupReferenceStatement?: RuleGroupReferenceStatement;
|
|
5001
5033
|
}
|
|
@@ -242,7 +242,7 @@ export declare class WAFV2 extends WAFV2Client {
|
|
|
242
242
|
/**
|
|
243
243
|
* <p>Retrieves the specified managed rule set. </p>
|
|
244
244
|
* <note>
|
|
245
|
-
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers. </p>
|
|
245
|
+
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers. </p>
|
|
246
246
|
* <p>Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are <code>ListManagedRuleSets</code>, <code>GetManagedRuleSet</code>, <code>PutManagedRuleSetVersions</code>, and <code>UpdateManagedRuleSetVersionExpiryDate</code>.</p>
|
|
247
247
|
* </note>
|
|
248
248
|
*/
|
|
@@ -257,9 +257,9 @@ export declare class WAFV2 extends WAFV2Client {
|
|
|
257
257
|
getPermissionPolicy(args: GetPermissionPolicyCommandInput, cb: (err: any, data?: GetPermissionPolicyCommandOutput) => void): void;
|
|
258
258
|
getPermissionPolicy(args: GetPermissionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPermissionPolicyCommandOutput) => void): void;
|
|
259
259
|
/**
|
|
260
|
-
* <p>Retrieves the keys that are currently blocked by a rate-based rule. The maximum number
|
|
261
|
-
*
|
|
262
|
-
*
|
|
260
|
+
* <p>Retrieves the keys that are currently blocked by a rate-based rule instance. The maximum number of managed keys that can be blocked for a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked.</p>
|
|
261
|
+
* <p>For a rate-based rule that you've defined inside a rule group, provide the name of the rule group reference statement in your request, in addition to the rate-based rule name and the web ACL name. </p>
|
|
262
|
+
* <p>WAF monitors web requests and manages keys independently for each unique combination of web ACL, optional rule group, and rate-based rule. For example, if you define a rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF monitors web requests and manages keys for that web ACL, rule group reference statement, and rate-based rule instance. If you use the same rule group in a second web ACL, WAF monitors web requests and manages keys for this second usage completely independent of your first. </p>
|
|
263
263
|
*/
|
|
264
264
|
getRateBasedStatementManagedKeys(args: GetRateBasedStatementManagedKeysCommandInput, options?: __HttpHandlerOptions): Promise<GetRateBasedStatementManagedKeysCommandOutput>;
|
|
265
265
|
getRateBasedStatementManagedKeys(args: GetRateBasedStatementManagedKeysCommandInput, cb: (err: any, data?: GetRateBasedStatementManagedKeysCommandOutput) => void): void;
|
|
@@ -305,7 +305,7 @@ export declare class WAFV2 extends WAFV2Client {
|
|
|
305
305
|
getWebACLForResource(args: GetWebACLForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWebACLForResourceCommandOutput) => void): void;
|
|
306
306
|
/**
|
|
307
307
|
* <p>Retrieves an array of managed rule groups that are available for you to use. This list
|
|
308
|
-
* includes all Amazon Web Services Managed Rules rule groups and all of the Marketplace managed rule groups that you're
|
|
308
|
+
* includes all Amazon Web Services Managed Rules rule groups and all of the Amazon Web Services Marketplace managed rule groups that you're
|
|
309
309
|
* subscribed to.</p>
|
|
310
310
|
*/
|
|
311
311
|
listAvailableManagedRuleGroups(args: ListAvailableManagedRuleGroupsCommandInput, options?: __HttpHandlerOptions): Promise<ListAvailableManagedRuleGroupsCommandOutput>;
|
|
@@ -333,7 +333,7 @@ export declare class WAFV2 extends WAFV2Client {
|
|
|
333
333
|
/**
|
|
334
334
|
* <p>Retrieves the managed rule sets that you own. </p>
|
|
335
335
|
* <note>
|
|
336
|
-
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers. </p>
|
|
336
|
+
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers. </p>
|
|
337
337
|
* <p>Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are <code>ListManagedRuleSets</code>, <code>GetManagedRuleSet</code>, <code>PutManagedRuleSetVersions</code>, and <code>UpdateManagedRuleSetVersionExpiryDate</code>.</p>
|
|
338
338
|
* </note>
|
|
339
339
|
*/
|
|
@@ -422,7 +422,7 @@ export declare class WAFV2 extends WAFV2Client {
|
|
|
422
422
|
* <p>Defines the versions of your managed rule set that you are offering to the customers.
|
|
423
423
|
* Customers see your offerings as managed rule groups with versioning.</p>
|
|
424
424
|
* <note>
|
|
425
|
-
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers. </p>
|
|
425
|
+
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers. </p>
|
|
426
426
|
* <p>Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are <code>ListManagedRuleSets</code>, <code>GetManagedRuleSet</code>, <code>PutManagedRuleSetVersions</code>, and <code>UpdateManagedRuleSetVersionExpiryDate</code>.</p>
|
|
427
427
|
* </note>
|
|
428
428
|
* <p>Customers retrieve their managed rule group list by calling <a>ListAvailableManagedRuleGroups</a>. The name that you provide here for your
|
|
@@ -493,7 +493,7 @@ export declare class WAFV2 extends WAFV2Client {
|
|
|
493
493
|
* expiration of a managed rule group version. After you initiate expiration for a version,
|
|
494
494
|
* WAF excludes it from the reponse to <a>ListAvailableManagedRuleGroupVersions</a> for the managed rule group. </p>
|
|
495
495
|
* <note>
|
|
496
|
-
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers. </p>
|
|
496
|
+
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers. </p>
|
|
497
497
|
* <p>Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are <code>ListManagedRuleSets</code>, <code>GetManagedRuleSet</code>, <code>PutManagedRuleSetVersions</code>, and <code>UpdateManagedRuleSetVersionExpiryDate</code>.</p>
|
|
498
498
|
* </note>
|
|
499
499
|
*/
|
|
@@ -9,7 +9,7 @@ export interface GetManagedRuleSetCommandOutput extends GetManagedRuleSetRespons
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Retrieves the specified managed rule set. </p>
|
|
11
11
|
* <note>
|
|
12
|
-
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers. </p>
|
|
12
|
+
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers. </p>
|
|
13
13
|
* <p>Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are <code>ListManagedRuleSets</code>, <code>GetManagedRuleSet</code>, <code>PutManagedRuleSetVersions</code>, and <code>UpdateManagedRuleSetVersionExpiryDate</code>.</p>
|
|
14
14
|
* </note>
|
|
15
15
|
* @example
|
|
@@ -7,9 +7,9 @@ export interface GetRateBasedStatementManagedKeysCommandInput extends GetRateBas
|
|
|
7
7
|
export interface GetRateBasedStatementManagedKeysCommandOutput extends GetRateBasedStatementManagedKeysResponse, __MetadataBearer {
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
|
-
* <p>Retrieves the keys that are currently blocked by a rate-based rule. The maximum number
|
|
11
|
-
*
|
|
12
|
-
*
|
|
10
|
+
* <p>Retrieves the keys that are currently blocked by a rate-based rule instance. The maximum number of managed keys that can be blocked for a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked.</p>
|
|
11
|
+
* <p>For a rate-based rule that you've defined inside a rule group, provide the name of the rule group reference statement in your request, in addition to the rate-based rule name and the web ACL name. </p>
|
|
12
|
+
* <p>WAF monitors web requests and manages keys independently for each unique combination of web ACL, optional rule group, and rate-based rule. For example, if you define a rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF monitors web requests and manages keys for that web ACL, rule group reference statement, and rate-based rule instance. If you use the same rule group in a second web ACL, WAF monitors web requests and manages keys for this second usage completely independent of your first. </p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
15
15
|
* ```javascript
|
|
@@ -8,7 +8,7 @@ export interface ListAvailableManagedRuleGroupsCommandOutput extends ListAvailab
|
|
|
8
8
|
}
|
|
9
9
|
/**
|
|
10
10
|
* <p>Retrieves an array of managed rule groups that are available for you to use. This list
|
|
11
|
-
* includes all Amazon Web Services Managed Rules rule groups and all of the Marketplace managed rule groups that you're
|
|
11
|
+
* includes all Amazon Web Services Managed Rules rule groups and all of the Amazon Web Services Marketplace managed rule groups that you're
|
|
12
12
|
* subscribed to.</p>
|
|
13
13
|
* @example
|
|
14
14
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -9,7 +9,7 @@ export interface ListManagedRuleSetsCommandOutput extends ListManagedRuleSetsRes
|
|
|
9
9
|
/**
|
|
10
10
|
* <p>Retrieves the managed rule sets that you own. </p>
|
|
11
11
|
* <note>
|
|
12
|
-
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers. </p>
|
|
12
|
+
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers. </p>
|
|
13
13
|
* <p>Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are <code>ListManagedRuleSets</code>, <code>GetManagedRuleSet</code>, <code>PutManagedRuleSetVersions</code>, and <code>UpdateManagedRuleSetVersionExpiryDate</code>.</p>
|
|
14
14
|
* </note>
|
|
15
15
|
* @example
|
|
@@ -10,7 +10,7 @@ export interface PutManagedRuleSetVersionsCommandOutput extends PutManagedRuleSe
|
|
|
10
10
|
* <p>Defines the versions of your managed rule set that you are offering to the customers.
|
|
11
11
|
* Customers see your offerings as managed rule groups with versioning.</p>
|
|
12
12
|
* <note>
|
|
13
|
-
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers. </p>
|
|
13
|
+
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers. </p>
|
|
14
14
|
* <p>Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are <code>ListManagedRuleSets</code>, <code>GetManagedRuleSet</code>, <code>PutManagedRuleSetVersions</code>, and <code>UpdateManagedRuleSetVersionExpiryDate</code>.</p>
|
|
15
15
|
* </note>
|
|
16
16
|
* <p>Customers retrieve their managed rule group list by calling <a>ListAvailableManagedRuleGroups</a>. The name that you provide here for your
|
|
@@ -11,7 +11,7 @@ export interface UpdateManagedRuleSetVersionExpiryDateCommandOutput extends Upda
|
|
|
11
11
|
* expiration of a managed rule group version. After you initiate expiration for a version,
|
|
12
12
|
* WAF excludes it from the reponse to <a>ListAvailableManagedRuleGroupVersions</a> for the managed rule group. </p>
|
|
13
13
|
* <note>
|
|
14
|
-
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Marketplace sellers. </p>
|
|
14
|
+
* <p>This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers. </p>
|
|
15
15
|
* <p>Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are <code>ListManagedRuleSets</code>, <code>GetManagedRuleSet</code>, <code>PutManagedRuleSetVersions</code>, and <code>UpdateManagedRuleSetVersionExpiryDate</code>.</p>
|
|
16
16
|
* </note>
|
|
17
17
|
* @example
|