@aws-sdk/client-wafv2 3.315.0 → 3.317.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.
Files changed (30) hide show
  1. package/README.md +24 -0
  2. package/dist-cjs/WAFV2.js +58 -672
  3. package/dist-cjs/commands/CreateAPIKeyCommand.js +45 -0
  4. package/dist-cjs/commands/GetDecryptedAPIKeyCommand.js +45 -0
  5. package/dist-cjs/commands/ListAPIKeysCommand.js +45 -0
  6. package/dist-cjs/commands/index.js +3 -0
  7. package/dist-cjs/protocols/Aws_json1_1.js +179 -2
  8. package/dist-es/WAFV2.js +58 -672
  9. package/dist-es/commands/CreateAPIKeyCommand.js +41 -0
  10. package/dist-es/commands/GetDecryptedAPIKeyCommand.js +41 -0
  11. package/dist-es/commands/ListAPIKeysCommand.js +41 -0
  12. package/dist-es/commands/index.js +3 -0
  13. package/dist-es/protocols/Aws_json1_1.js +170 -0
  14. package/dist-types/WAFV2.d.ts +133 -432
  15. package/dist-types/WAFV2Client.d.ts +5 -2
  16. package/dist-types/commands/CreateAPIKeyCommand.d.ts +105 -0
  17. package/dist-types/commands/GetDecryptedAPIKeyCommand.d.ts +96 -0
  18. package/dist-types/commands/ListAPIKeysCommand.d.ts +97 -0
  19. package/dist-types/commands/index.d.ts +3 -0
  20. package/dist-types/models/models_0.d.ts +150 -11
  21. package/dist-types/protocols/Aws_json1_1.d.ts +27 -0
  22. package/dist-types/ts3.4/WAFV2.d.ts +53 -1
  23. package/dist-types/ts3.4/WAFV2Client.d.ts +18 -0
  24. package/dist-types/ts3.4/commands/CreateAPIKeyCommand.d.ts +34 -0
  25. package/dist-types/ts3.4/commands/GetDecryptedAPIKeyCommand.d.ts +38 -0
  26. package/dist-types/ts3.4/commands/ListAPIKeysCommand.d.ts +34 -0
  27. package/dist-types/ts3.4/commands/index.d.ts +3 -0
  28. package/dist-types/ts3.4/models/models_0.d.ts +31 -0
  29. package/dist-types/ts3.4/protocols/Aws_json1_1.d.ts +36 -0
  30. package/package.json +6 -6
@@ -1,6 +1,7 @@
1
1
  import { HttpHandlerOptions as __HttpHandlerOptions } from "@aws-sdk/types";
2
2
  import { AssociateWebACLCommandInput, AssociateWebACLCommandOutput } from "./commands/AssociateWebACLCommand";
3
3
  import { CheckCapacityCommandInput, CheckCapacityCommandOutput } from "./commands/CheckCapacityCommand";
4
+ import { CreateAPIKeyCommandInput, CreateAPIKeyCommandOutput } from "./commands/CreateAPIKeyCommand";
4
5
  import { CreateIPSetCommandInput, CreateIPSetCommandOutput } from "./commands/CreateIPSetCommand";
5
6
  import { CreateRegexPatternSetCommandInput, CreateRegexPatternSetCommandOutput } from "./commands/CreateRegexPatternSetCommand";
6
7
  import { CreateRuleGroupCommandInput, CreateRuleGroupCommandOutput } from "./commands/CreateRuleGroupCommand";
@@ -15,6 +16,7 @@ import { DeleteWebACLCommandInput, DeleteWebACLCommandOutput } from "./commands/
15
16
  import { DescribeManagedRuleGroupCommandInput, DescribeManagedRuleGroupCommandOutput } from "./commands/DescribeManagedRuleGroupCommand";
16
17
  import { DisassociateWebACLCommandInput, DisassociateWebACLCommandOutput } from "./commands/DisassociateWebACLCommand";
17
18
  import { GenerateMobileSdkReleaseUrlCommandInput, GenerateMobileSdkReleaseUrlCommandOutput } from "./commands/GenerateMobileSdkReleaseUrlCommand";
19
+ import { GetDecryptedAPIKeyCommandInput, GetDecryptedAPIKeyCommandOutput } from "./commands/GetDecryptedAPIKeyCommand";
18
20
  import { GetIPSetCommandInput, GetIPSetCommandOutput } from "./commands/GetIPSetCommand";
19
21
  import { GetLoggingConfigurationCommandInput, GetLoggingConfigurationCommandOutput } from "./commands/GetLoggingConfigurationCommand";
20
22
  import { GetManagedRuleSetCommandInput, GetManagedRuleSetCommandOutput } from "./commands/GetManagedRuleSetCommand";
@@ -26,6 +28,7 @@ import { GetRuleGroupCommandInput, GetRuleGroupCommandOutput } from "./commands/
26
28
  import { GetSampledRequestsCommandInput, GetSampledRequestsCommandOutput } from "./commands/GetSampledRequestsCommand";
27
29
  import { GetWebACLCommandInput, GetWebACLCommandOutput } from "./commands/GetWebACLCommand";
28
30
  import { GetWebACLForResourceCommandInput, GetWebACLForResourceCommandOutput } from "./commands/GetWebACLForResourceCommand";
31
+ import { ListAPIKeysCommandInput, ListAPIKeysCommandOutput } from "./commands/ListAPIKeysCommand";
29
32
  import { ListAvailableManagedRuleGroupsCommandInput, ListAvailableManagedRuleGroupsCommandOutput } from "./commands/ListAvailableManagedRuleGroupsCommand";
30
33
  import { ListAvailableManagedRuleGroupVersionsCommandInput, ListAvailableManagedRuleGroupVersionsCommandOutput } from "./commands/ListAvailableManagedRuleGroupVersionsCommand";
31
34
  import { ListIPSetsCommandInput, ListIPSetsCommandOutput } from "./commands/ListIPSetsCommand";
@@ -48,676 +51,374 @@ import { UpdateRegexPatternSetCommandInput, UpdateRegexPatternSetCommandOutput }
48
51
  import { UpdateRuleGroupCommandInput, UpdateRuleGroupCommandOutput } from "./commands/UpdateRuleGroupCommand";
49
52
  import { UpdateWebACLCommandInput, UpdateWebACLCommandOutput } from "./commands/UpdateWebACLCommand";
50
53
  import { WAFV2Client } from "./WAFV2Client";
51
- /**
52
- * @public
53
- * <fullname>WAF</fullname>
54
- * <note>
55
- * <p>This is the latest version of the <b>WAF</b> API,
56
- * released in November, 2019. The names of the entities that you use to access this API,
57
- * like endpoints and namespaces, all have the versioning information added, like "V2" or
58
- * "v2", to distinguish from the prior version. We recommend migrating your resources to
59
- * this version, because it has a number of significant improvements.</p>
60
- * <p>If you used WAF prior to this release, you can't use this WAFV2 API to access any
61
- * WAF resources that you created before. You can access your old rules, web ACLs, and
62
- * other WAF resources only through the WAF Classic APIs. The WAF Classic APIs
63
- * have retained the prior names, endpoints, and namespaces. </p>
64
- * <p>For information, including how to migrate your WAF resources to this version,
65
- * see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">WAF Developer Guide</a>. </p>
66
- * </note>
67
- * <p>WAF is a web application firewall that lets you monitor the HTTP and HTTPS
68
- * requests that are forwarded to an Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync
69
- * GraphQL API, Amazon Cognito user pool, or App Runner service. WAF also lets you control access to your content,
70
- * to protect the Amazon Web Services resource that WAF is monitoring. Based on conditions that
71
- * you specify, such as the IP addresses that requests originate from or the values of query
72
- * strings, the protected resource responds to requests with either the requested content, an HTTP 403 status code
73
- * (Forbidden), or with a custom response. </p>
74
- * <p>This API guide is for developers who need detailed information about WAF API actions,
75
- * data types, and errors. For detailed information about WAF features and guidance for configuring and using
76
- * WAF, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html">WAF Developer
77
- * Guide</a>.</p>
78
- * <p>You can make calls using the endpoints listed in <a href="https://docs.aws.amazon.com/general/latest/gr/waf.html">WAF endpoints and quotas</a>. </p>
79
- * <ul>
80
- * <li>
81
- * <p>For regional applications, you can use any of the endpoints in the list.
82
- * A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service. </p>
83
- * </li>
84
- * <li>
85
- * <p>For Amazon CloudFront applications, you must use the API endpoint listed for
86
- * US East (N. Virginia): us-east-1.</p>
87
- * </li>
88
- * </ul>
89
- * <p>Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the
90
- * programming language or platform that you're using. For more information, see <a href="http://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p>
91
- * <p>We currently provide two versions of the WAF API: this API and the prior versions,
92
- * the classic WAF APIs. This new API provides the same functionality as the older versions,
93
- * with the following major improvements:</p>
94
- * <ul>
95
- * <li>
96
- * <p>You use one API for both global and regional applications. Where you need to
97
- * distinguish the scope, you specify a <code>Scope</code> parameter and set it to
98
- * <code>CLOUDFRONT</code> or <code>REGIONAL</code>. </p>
99
- * </li>
100
- * <li>
101
- * <p>You can define a web ACL or rule group with a single call, and update it with a
102
- * single call. You define all rule specifications in JSON format, and pass them to your
103
- * rule group or web ACL calls.</p>
104
- * </li>
105
- * <li>
106
- * <p>The limits WAF places on the use of rules more closely reflects the cost of
107
- * running each type of rule. Rule groups include capacity settings, so you know the
108
- * maximum cost of a rule group when you use it.</p>
109
- * </li>
110
- * </ul>
111
- */
112
- export declare class WAFV2 extends WAFV2Client {
54
+ export interface WAFV2 {
113
55
  /**
114
- * @public
115
- * <p>Associates a web ACL with a regional application resource, to protect the resource.
116
- * A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service. </p>
117
- * <p>For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To
118
- * associate a web ACL, in the CloudFront call <code>UpdateDistribution</code>, set the web ACL ID
119
- * to the Amazon Resource Name (ARN) of the web ACL. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html">UpdateDistribution</a> in the <i>Amazon CloudFront Developer Guide</i>. </p>
120
- * <p>When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.</p>
56
+ * @see {@link AssociateWebACLCommand}
121
57
  */
122
58
  associateWebACL(args: AssociateWebACLCommandInput, options?: __HttpHandlerOptions): Promise<AssociateWebACLCommandOutput>;
123
59
  associateWebACL(args: AssociateWebACLCommandInput, cb: (err: any, data?: AssociateWebACLCommandOutput) => void): void;
124
60
  associateWebACL(args: AssociateWebACLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AssociateWebACLCommandOutput) => void): void;
125
61
  /**
126
- * @public
127
- * <p>Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules.
128
- * You can use this to check the capacity requirements for the rules you want to use in a
129
- * <a>RuleGroup</a> or <a>WebACL</a>.
130
- * </p>
131
- * <p>WAF uses WCUs to calculate and control the operating
132
- * resources that are used to run your rules, rule groups, and web ACLs. WAF
133
- * calculates capacity differently for each rule type, to reflect the relative cost of each rule.
134
- * Simple rules that cost little to run use fewer WCUs than more complex rules
135
- * that use more processing power.
136
- * Rule group capacity is fixed at creation, which helps users plan their
137
- * web ACL WCU usage when they use a rule group. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html">WAF web ACL capacity units (WCU)</a>
138
- * in the <i>WAF Developer Guide</i>. </p>
62
+ * @see {@link CheckCapacityCommand}
139
63
  */
140
64
  checkCapacity(args: CheckCapacityCommandInput, options?: __HttpHandlerOptions): Promise<CheckCapacityCommandOutput>;
141
65
  checkCapacity(args: CheckCapacityCommandInput, cb: (err: any, data?: CheckCapacityCommandOutput) => void): void;
142
66
  checkCapacity(args: CheckCapacityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CheckCapacityCommandOutput) => void): void;
143
67
  /**
144
- * @public
145
- * <p>Creates an <a>IPSet</a>, which you use to identify web requests that
146
- * originate from specific IP addresses or ranges of IP addresses. For example, if you're
147
- * receiving a lot of requests from a ranges of IP addresses, you can configure WAF to
148
- * block them using an IPSet that lists those IP addresses. </p>
68
+ * @see {@link CreateAPIKeyCommand}
69
+ */
70
+ createAPIKey(args: CreateAPIKeyCommandInput, options?: __HttpHandlerOptions): Promise<CreateAPIKeyCommandOutput>;
71
+ createAPIKey(args: CreateAPIKeyCommandInput, cb: (err: any, data?: CreateAPIKeyCommandOutput) => void): void;
72
+ createAPIKey(args: CreateAPIKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAPIKeyCommandOutput) => void): void;
73
+ /**
74
+ * @see {@link CreateIPSetCommand}
149
75
  */
150
76
  createIPSet(args: CreateIPSetCommandInput, options?: __HttpHandlerOptions): Promise<CreateIPSetCommandOutput>;
151
77
  createIPSet(args: CreateIPSetCommandInput, cb: (err: any, data?: CreateIPSetCommandOutput) => void): void;
152
78
  createIPSet(args: CreateIPSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateIPSetCommandOutput) => void): void;
153
79
  /**
154
- * @public
155
- * <p>Creates a <a>RegexPatternSet</a>, which you reference in a <a>RegexPatternSetReferenceStatement</a>, to have WAF inspect a web request
156
- * component for the specified patterns.</p>
80
+ * @see {@link CreateRegexPatternSetCommand}
157
81
  */
158
82
  createRegexPatternSet(args: CreateRegexPatternSetCommandInput, options?: __HttpHandlerOptions): Promise<CreateRegexPatternSetCommandOutput>;
159
83
  createRegexPatternSet(args: CreateRegexPatternSetCommandInput, cb: (err: any, data?: CreateRegexPatternSetCommandOutput) => void): void;
160
84
  createRegexPatternSet(args: CreateRegexPatternSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRegexPatternSetCommandOutput) => void): void;
161
85
  /**
162
- * @public
163
- * <p>Creates a <a>RuleGroup</a> per the specifications provided. </p>
164
- * <p> A rule group defines a collection of rules to inspect and control web requests that you can use in a <a>WebACL</a>. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements. </p>
86
+ * @see {@link CreateRuleGroupCommand}
165
87
  */
166
88
  createRuleGroup(args: CreateRuleGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreateRuleGroupCommandOutput>;
167
89
  createRuleGroup(args: CreateRuleGroupCommandInput, cb: (err: any, data?: CreateRuleGroupCommandOutput) => void): void;
168
90
  createRuleGroup(args: CreateRuleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRuleGroupCommandOutput) => void): void;
169
91
  /**
170
- * @public
171
- * <p>Creates a <a>WebACL</a> per the specifications provided.</p>
172
- * <p> A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types <a>Rule</a>, <a>RuleGroup</a>, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service. </p>
92
+ * @see {@link CreateWebACLCommand}
173
93
  */
174
94
  createWebACL(args: CreateWebACLCommandInput, options?: __HttpHandlerOptions): Promise<CreateWebACLCommandOutput>;
175
95
  createWebACL(args: CreateWebACLCommandInput, cb: (err: any, data?: CreateWebACLCommandOutput) => void): void;
176
96
  createWebACL(args: CreateWebACLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateWebACLCommandOutput) => void): void;
177
97
  /**
178
- * @public
179
- * <p>Deletes all rule groups that are managed by Firewall Manager for the specified web ACL. </p>
180
- * <p>You can only use this if <code>ManagedByFirewallManager</code> is false in the specified
181
- * <a>WebACL</a>. </p>
98
+ * @see {@link DeleteFirewallManagerRuleGroupsCommand}
182
99
  */
183
100
  deleteFirewallManagerRuleGroups(args: DeleteFirewallManagerRuleGroupsCommandInput, options?: __HttpHandlerOptions): Promise<DeleteFirewallManagerRuleGroupsCommandOutput>;
184
101
  deleteFirewallManagerRuleGroups(args: DeleteFirewallManagerRuleGroupsCommandInput, cb: (err: any, data?: DeleteFirewallManagerRuleGroupsCommandOutput) => void): void;
185
102
  deleteFirewallManagerRuleGroups(args: DeleteFirewallManagerRuleGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFirewallManagerRuleGroupsCommandOutput) => void): void;
186
103
  /**
187
- * @public
188
- * <p>Deletes the specified <a>IPSet</a>. </p>
104
+ * @see {@link DeleteIPSetCommand}
189
105
  */
190
106
  deleteIPSet(args: DeleteIPSetCommandInput, options?: __HttpHandlerOptions): Promise<DeleteIPSetCommandOutput>;
191
107
  deleteIPSet(args: DeleteIPSetCommandInput, cb: (err: any, data?: DeleteIPSetCommandOutput) => void): void;
192
108
  deleteIPSet(args: DeleteIPSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteIPSetCommandOutput) => void): void;
193
109
  /**
194
- * @public
195
- * <p>Deletes the <a>LoggingConfiguration</a> from the specified web ACL.</p>
110
+ * @see {@link DeleteLoggingConfigurationCommand}
196
111
  */
197
112
  deleteLoggingConfiguration(args: DeleteLoggingConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteLoggingConfigurationCommandOutput>;
198
113
  deleteLoggingConfiguration(args: DeleteLoggingConfigurationCommandInput, cb: (err: any, data?: DeleteLoggingConfigurationCommandOutput) => void): void;
199
114
  deleteLoggingConfiguration(args: DeleteLoggingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLoggingConfigurationCommandOutput) => void): void;
200
115
  /**
201
- * @public
202
- * <p>Permanently deletes an IAM policy from the specified rule group.</p>
203
- * <p>You must be the owner of the rule group to perform this operation.</p>
116
+ * @see {@link DeletePermissionPolicyCommand}
204
117
  */
205
118
  deletePermissionPolicy(args: DeletePermissionPolicyCommandInput, options?: __HttpHandlerOptions): Promise<DeletePermissionPolicyCommandOutput>;
206
119
  deletePermissionPolicy(args: DeletePermissionPolicyCommandInput, cb: (err: any, data?: DeletePermissionPolicyCommandOutput) => void): void;
207
120
  deletePermissionPolicy(args: DeletePermissionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePermissionPolicyCommandOutput) => void): void;
208
121
  /**
209
- * @public
210
- * <p>Deletes the specified <a>RegexPatternSet</a>.</p>
122
+ * @see {@link DeleteRegexPatternSetCommand}
211
123
  */
212
124
  deleteRegexPatternSet(args: DeleteRegexPatternSetCommandInput, options?: __HttpHandlerOptions): Promise<DeleteRegexPatternSetCommandOutput>;
213
125
  deleteRegexPatternSet(args: DeleteRegexPatternSetCommandInput, cb: (err: any, data?: DeleteRegexPatternSetCommandOutput) => void): void;
214
126
  deleteRegexPatternSet(args: DeleteRegexPatternSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRegexPatternSetCommandOutput) => void): void;
215
127
  /**
216
- * @public
217
- * <p>Deletes the specified <a>RuleGroup</a>.</p>
128
+ * @see {@link DeleteRuleGroupCommand}
218
129
  */
219
130
  deleteRuleGroup(args: DeleteRuleGroupCommandInput, options?: __HttpHandlerOptions): Promise<DeleteRuleGroupCommandOutput>;
220
131
  deleteRuleGroup(args: DeleteRuleGroupCommandInput, cb: (err: any, data?: DeleteRuleGroupCommandOutput) => void): void;
221
132
  deleteRuleGroup(args: DeleteRuleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRuleGroupCommandOutput) => void): void;
222
133
  /**
223
- * @public
224
- * <p>Deletes the specified <a>WebACL</a>. </p>
225
- * <p>You can only use this if <code>ManagedByFirewallManager</code> is false in the specified
226
- * <a>WebACL</a>. </p>
227
- * <note>
228
- * <p>Before deleting any web ACL, first disassociate it from all resources.</p>
229
- * <ul>
230
- * <li>
231
- * <p>To retrieve a list of the resources that are associated with a web ACL, use the
232
- * following calls:</p>
233
- * <ul>
234
- * <li>
235
- * <p>For regional resources, call <a>ListResourcesForWebACL</a>.</p>
236
- * </li>
237
- * <li>
238
- * <p>For Amazon CloudFront distributions, use the CloudFront call
239
- * <code>ListDistributionsByWebACLId</code>. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_ListDistributionsByWebACLId.html">ListDistributionsByWebACLId</a>
240
- * in the <i>Amazon CloudFront API Reference</i>. </p>
241
- * </li>
242
- * </ul>
243
- * </li>
244
- * <li>
245
- * <p>To disassociate a resource from a web ACL, use the following calls:</p>
246
- * <ul>
247
- * <li>
248
- * <p>For regional resources, call <a>DisassociateWebACL</a>.</p>
249
- * </li>
250
- * <li>
251
- * <p>For Amazon CloudFront distributions, provide an empty web ACL ID in the CloudFront call
252
- * <code>UpdateDistribution</code>. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html">UpdateDistribution</a>
253
- * in the <i>Amazon CloudFront API Reference</i>. </p>
254
- * </li>
255
- * </ul>
256
- * </li>
257
- * </ul>
258
- * </note>
134
+ * @see {@link DeleteWebACLCommand}
259
135
  */
260
136
  deleteWebACL(args: DeleteWebACLCommandInput, options?: __HttpHandlerOptions): Promise<DeleteWebACLCommandOutput>;
261
137
  deleteWebACL(args: DeleteWebACLCommandInput, cb: (err: any, data?: DeleteWebACLCommandOutput) => void): void;
262
138
  deleteWebACL(args: DeleteWebACLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteWebACLCommandOutput) => void): void;
263
139
  /**
264
- * @public
265
- * <p>Provides high-level information for a managed rule group, including descriptions of the
266
- * rules. </p>
140
+ * @see {@link DescribeManagedRuleGroupCommand}
267
141
  */
268
142
  describeManagedRuleGroup(args: DescribeManagedRuleGroupCommandInput, options?: __HttpHandlerOptions): Promise<DescribeManagedRuleGroupCommandOutput>;
269
143
  describeManagedRuleGroup(args: DescribeManagedRuleGroupCommandInput, cb: (err: any, data?: DescribeManagedRuleGroupCommandOutput) => void): void;
270
144
  describeManagedRuleGroup(args: DescribeManagedRuleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeManagedRuleGroupCommandOutput) => void): void;
271
145
  /**
272
- * @public
273
- * <p>Disassociates the specified regional application resource from any existing web ACL
274
- * association. A resource can have at most one web ACL association. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service. </p>
275
- * <p>For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To
276
- * disassociate a web ACL, provide an empty web ACL ID in the CloudFront call
277
- * <code>UpdateDistribution</code>. For information, see <a href="https://docs.aws.amazon.com/cloudfront/latest/APIReference/API_UpdateDistribution.html">UpdateDistribution</a> in the <i>Amazon CloudFront API Reference</i>. </p>
146
+ * @see {@link DisassociateWebACLCommand}
278
147
  */
279
148
  disassociateWebACL(args: DisassociateWebACLCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateWebACLCommandOutput>;
280
149
  disassociateWebACL(args: DisassociateWebACLCommandInput, cb: (err: any, data?: DisassociateWebACLCommandOutput) => void): void;
281
150
  disassociateWebACL(args: DisassociateWebACLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateWebACLCommandOutput) => void): void;
282
151
  /**
283
- * @public
284
- * <p>Generates a presigned download URL for the specified release of the mobile SDK.</p>
285
- * <p>The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see
286
- * <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html">WAF client application integration</a> in the <i>WAF Developer Guide</i>.</p>
152
+ * @see {@link GenerateMobileSdkReleaseUrlCommand}
287
153
  */
288
154
  generateMobileSdkReleaseUrl(args: GenerateMobileSdkReleaseUrlCommandInput, options?: __HttpHandlerOptions): Promise<GenerateMobileSdkReleaseUrlCommandOutput>;
289
155
  generateMobileSdkReleaseUrl(args: GenerateMobileSdkReleaseUrlCommandInput, cb: (err: any, data?: GenerateMobileSdkReleaseUrlCommandOutput) => void): void;
290
156
  generateMobileSdkReleaseUrl(args: GenerateMobileSdkReleaseUrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateMobileSdkReleaseUrlCommandOutput) => void): void;
291
157
  /**
292
- * @public
293
- * <p>Retrieves the specified <a>IPSet</a>.</p>
158
+ * @see {@link GetDecryptedAPIKeyCommand}
159
+ */
160
+ getDecryptedAPIKey(args: GetDecryptedAPIKeyCommandInput, options?: __HttpHandlerOptions): Promise<GetDecryptedAPIKeyCommandOutput>;
161
+ getDecryptedAPIKey(args: GetDecryptedAPIKeyCommandInput, cb: (err: any, data?: GetDecryptedAPIKeyCommandOutput) => void): void;
162
+ getDecryptedAPIKey(args: GetDecryptedAPIKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetDecryptedAPIKeyCommandOutput) => void): void;
163
+ /**
164
+ * @see {@link GetIPSetCommand}
294
165
  */
295
166
  getIPSet(args: GetIPSetCommandInput, options?: __HttpHandlerOptions): Promise<GetIPSetCommandOutput>;
296
167
  getIPSet(args: GetIPSetCommandInput, cb: (err: any, data?: GetIPSetCommandOutput) => void): void;
297
168
  getIPSet(args: GetIPSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetIPSetCommandOutput) => void): void;
298
169
  /**
299
- * @public
300
- * <p>Returns the <a>LoggingConfiguration</a> for the specified web ACL.</p>
170
+ * @see {@link GetLoggingConfigurationCommand}
301
171
  */
302
172
  getLoggingConfiguration(args: GetLoggingConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<GetLoggingConfigurationCommandOutput>;
303
173
  getLoggingConfiguration(args: GetLoggingConfigurationCommandInput, cb: (err: any, data?: GetLoggingConfigurationCommandOutput) => void): void;
304
174
  getLoggingConfiguration(args: GetLoggingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetLoggingConfigurationCommandOutput) => void): void;
305
175
  /**
306
- * @public
307
- * <p>Retrieves the specified managed rule set. </p>
308
- * <note>
309
- * <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>
310
- * <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>
311
- * </note>
176
+ * @see {@link GetManagedRuleSetCommand}
312
177
  */
313
178
  getManagedRuleSet(args: GetManagedRuleSetCommandInput, options?: __HttpHandlerOptions): Promise<GetManagedRuleSetCommandOutput>;
314
179
  getManagedRuleSet(args: GetManagedRuleSetCommandInput, cb: (err: any, data?: GetManagedRuleSetCommandOutput) => void): void;
315
180
  getManagedRuleSet(args: GetManagedRuleSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetManagedRuleSetCommandOutput) => void): void;
316
181
  /**
317
- * @public
318
- * <p>Retrieves information for the specified mobile SDK release, including release notes and
319
- * tags.</p>
320
- * <p>The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see
321
- * <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html">WAF client application integration</a> in the <i>WAF Developer Guide</i>.</p>
182
+ * @see {@link GetMobileSdkReleaseCommand}
322
183
  */
323
184
  getMobileSdkRelease(args: GetMobileSdkReleaseCommandInput, options?: __HttpHandlerOptions): Promise<GetMobileSdkReleaseCommandOutput>;
324
185
  getMobileSdkRelease(args: GetMobileSdkReleaseCommandInput, cb: (err: any, data?: GetMobileSdkReleaseCommandOutput) => void): void;
325
186
  getMobileSdkRelease(args: GetMobileSdkReleaseCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetMobileSdkReleaseCommandOutput) => void): void;
326
187
  /**
327
- * @public
328
- * <p>Returns the IAM policy that is attached to the specified rule group.</p>
329
- * <p>You must be the owner of the rule group to perform this operation.</p>
188
+ * @see {@link GetPermissionPolicyCommand}
330
189
  */
331
190
  getPermissionPolicy(args: GetPermissionPolicyCommandInput, options?: __HttpHandlerOptions): Promise<GetPermissionPolicyCommandOutput>;
332
191
  getPermissionPolicy(args: GetPermissionPolicyCommandInput, cb: (err: any, data?: GetPermissionPolicyCommandOutput) => void): void;
333
192
  getPermissionPolicy(args: GetPermissionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPermissionPolicyCommandOutput) => void): void;
334
193
  /**
335
- * @public
336
- * <p>Retrieves the keys that are currently blocked by a rate-based rule instance. The maximum
337
- * number of managed keys that can be blocked for a single rate-based rule instance is 10,000.
338
- * If more than 10,000 addresses exceed the rate limit, those with the highest rates are
339
- * blocked.</p>
340
- * <p>For a rate-based rule that you've defined inside a rule group, provide the name of the
341
- * rule group reference statement in your request, in addition to the rate-based rule name and
342
- * the web ACL name. </p>
343
- * <p>WAF monitors web requests and manages keys independently for each unique combination
344
- * of web ACL, optional rule group, and rate-based rule. For example, if you define a
345
- * rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF
346
- * monitors web requests and manages keys for that web ACL, rule group reference statement,
347
- * and rate-based rule instance. If you use the same rule group in a second web ACL, WAF
348
- * monitors web requests and manages keys for this second usage completely independent of your
349
- * first. </p>
194
+ * @see {@link GetRateBasedStatementManagedKeysCommand}
350
195
  */
351
196
  getRateBasedStatementManagedKeys(args: GetRateBasedStatementManagedKeysCommandInput, options?: __HttpHandlerOptions): Promise<GetRateBasedStatementManagedKeysCommandOutput>;
352
197
  getRateBasedStatementManagedKeys(args: GetRateBasedStatementManagedKeysCommandInput, cb: (err: any, data?: GetRateBasedStatementManagedKeysCommandOutput) => void): void;
353
198
  getRateBasedStatementManagedKeys(args: GetRateBasedStatementManagedKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRateBasedStatementManagedKeysCommandOutput) => void): void;
354
199
  /**
355
- * @public
356
- * <p>Retrieves the specified <a>RegexPatternSet</a>.</p>
200
+ * @see {@link GetRegexPatternSetCommand}
357
201
  */
358
202
  getRegexPatternSet(args: GetRegexPatternSetCommandInput, options?: __HttpHandlerOptions): Promise<GetRegexPatternSetCommandOutput>;
359
203
  getRegexPatternSet(args: GetRegexPatternSetCommandInput, cb: (err: any, data?: GetRegexPatternSetCommandOutput) => void): void;
360
204
  getRegexPatternSet(args: GetRegexPatternSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRegexPatternSetCommandOutput) => void): void;
361
205
  /**
362
- * @public
363
- * <p>Retrieves the specified <a>RuleGroup</a>.</p>
206
+ * @see {@link GetRuleGroupCommand}
364
207
  */
365
208
  getRuleGroup(args: GetRuleGroupCommandInput, options?: __HttpHandlerOptions): Promise<GetRuleGroupCommandOutput>;
366
209
  getRuleGroup(args: GetRuleGroupCommandInput, cb: (err: any, data?: GetRuleGroupCommandOutput) => void): void;
367
210
  getRuleGroup(args: GetRuleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRuleGroupCommandOutput) => void): void;
368
211
  /**
369
- * @public
370
- * <p>Gets detailed information about a specified number of requests--a sample--that WAF
371
- * randomly selects from among the first 5,000 requests that your Amazon Web Services resource received
372
- * during a time range that you choose. You can specify a sample size of up to 500 requests,
373
- * and you can specify any time range in the previous three hours.</p>
374
- * <p>
375
- * <code>GetSampledRequests</code> returns a time range, which is usually the time range that
376
- * you specified. However, if your resource (such as a CloudFront distribution) received 5,000
377
- * requests before the specified time range elapsed, <code>GetSampledRequests</code> returns
378
- * an updated time range. This new time range indicates the actual period during which WAF
379
- * selected the requests in the sample.</p>
212
+ * @see {@link GetSampledRequestsCommand}
380
213
  */
381
214
  getSampledRequests(args: GetSampledRequestsCommandInput, options?: __HttpHandlerOptions): Promise<GetSampledRequestsCommandOutput>;
382
215
  getSampledRequests(args: GetSampledRequestsCommandInput, cb: (err: any, data?: GetSampledRequestsCommandOutput) => void): void;
383
216
  getSampledRequests(args: GetSampledRequestsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetSampledRequestsCommandOutput) => void): void;
384
217
  /**
385
- * @public
386
- * <p>Retrieves the specified <a>WebACL</a>.</p>
218
+ * @see {@link GetWebACLCommand}
387
219
  */
388
220
  getWebACL(args: GetWebACLCommandInput, options?: __HttpHandlerOptions): Promise<GetWebACLCommandOutput>;
389
221
  getWebACL(args: GetWebACLCommandInput, cb: (err: any, data?: GetWebACLCommandOutput) => void): void;
390
222
  getWebACL(args: GetWebACLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWebACLCommandOutput) => void): void;
391
223
  /**
392
- * @public
393
- * <p>Retrieves the <a>WebACL</a> for the specified resource. </p>
224
+ * @see {@link GetWebACLForResourceCommand}
394
225
  */
395
226
  getWebACLForResource(args: GetWebACLForResourceCommandInput, options?: __HttpHandlerOptions): Promise<GetWebACLForResourceCommandOutput>;
396
227
  getWebACLForResource(args: GetWebACLForResourceCommandInput, cb: (err: any, data?: GetWebACLForResourceCommandOutput) => void): void;
397
228
  getWebACLForResource(args: GetWebACLForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetWebACLForResourceCommandOutput) => void): void;
398
229
  /**
399
- * @public
400
- * <p>Retrieves an array of managed rule groups that are available for you to use. This list
401
- * includes all Amazon Web Services Managed Rules rule groups and all of the Amazon Web Services Marketplace managed rule groups that you're
402
- * subscribed to.</p>
230
+ * @see {@link ListAPIKeysCommand}
231
+ */
232
+ listAPIKeys(args: ListAPIKeysCommandInput, options?: __HttpHandlerOptions): Promise<ListAPIKeysCommandOutput>;
233
+ listAPIKeys(args: ListAPIKeysCommandInput, cb: (err: any, data?: ListAPIKeysCommandOutput) => void): void;
234
+ listAPIKeys(args: ListAPIKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAPIKeysCommandOutput) => void): void;
235
+ /**
236
+ * @see {@link ListAvailableManagedRuleGroupsCommand}
403
237
  */
404
238
  listAvailableManagedRuleGroups(args: ListAvailableManagedRuleGroupsCommandInput, options?: __HttpHandlerOptions): Promise<ListAvailableManagedRuleGroupsCommandOutput>;
405
239
  listAvailableManagedRuleGroups(args: ListAvailableManagedRuleGroupsCommandInput, cb: (err: any, data?: ListAvailableManagedRuleGroupsCommandOutput) => void): void;
406
240
  listAvailableManagedRuleGroups(args: ListAvailableManagedRuleGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAvailableManagedRuleGroupsCommandOutput) => void): void;
407
241
  /**
408
- * @public
409
- * <p>Returns a list of the available versions for the specified managed rule group. </p>
242
+ * @see {@link ListAvailableManagedRuleGroupVersionsCommand}
410
243
  */
411
244
  listAvailableManagedRuleGroupVersions(args: ListAvailableManagedRuleGroupVersionsCommandInput, options?: __HttpHandlerOptions): Promise<ListAvailableManagedRuleGroupVersionsCommandOutput>;
412
245
  listAvailableManagedRuleGroupVersions(args: ListAvailableManagedRuleGroupVersionsCommandInput, cb: (err: any, data?: ListAvailableManagedRuleGroupVersionsCommandOutput) => void): void;
413
246
  listAvailableManagedRuleGroupVersions(args: ListAvailableManagedRuleGroupVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAvailableManagedRuleGroupVersionsCommandOutput) => void): void;
414
247
  /**
415
- * @public
416
- * <p>Retrieves an array of <a>IPSetSummary</a> objects for the IP sets that you
417
- * manage.</p>
248
+ * @see {@link ListIPSetsCommand}
418
249
  */
419
250
  listIPSets(args: ListIPSetsCommandInput, options?: __HttpHandlerOptions): Promise<ListIPSetsCommandOutput>;
420
251
  listIPSets(args: ListIPSetsCommandInput, cb: (err: any, data?: ListIPSetsCommandOutput) => void): void;
421
252
  listIPSets(args: ListIPSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListIPSetsCommandOutput) => void): void;
422
253
  /**
423
- * @public
424
- * <p>Retrieves an array of your <a>LoggingConfiguration</a> objects.</p>
254
+ * @see {@link ListLoggingConfigurationsCommand}
425
255
  */
426
256
  listLoggingConfigurations(args: ListLoggingConfigurationsCommandInput, options?: __HttpHandlerOptions): Promise<ListLoggingConfigurationsCommandOutput>;
427
257
  listLoggingConfigurations(args: ListLoggingConfigurationsCommandInput, cb: (err: any, data?: ListLoggingConfigurationsCommandOutput) => void): void;
428
258
  listLoggingConfigurations(args: ListLoggingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLoggingConfigurationsCommandOutput) => void): void;
429
259
  /**
430
- * @public
431
- * <p>Retrieves the managed rule sets that you own. </p>
432
- * <note>
433
- * <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>
434
- * <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>
435
- * </note>
260
+ * @see {@link ListManagedRuleSetsCommand}
436
261
  */
437
262
  listManagedRuleSets(args: ListManagedRuleSetsCommandInput, options?: __HttpHandlerOptions): Promise<ListManagedRuleSetsCommandOutput>;
438
263
  listManagedRuleSets(args: ListManagedRuleSetsCommandInput, cb: (err: any, data?: ListManagedRuleSetsCommandOutput) => void): void;
439
264
  listManagedRuleSets(args: ListManagedRuleSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListManagedRuleSetsCommandOutput) => void): void;
440
265
  /**
441
- * @public
442
- * <p>Retrieves a list of the available releases for the mobile SDK and the specified device
443
- * platform. </p>
444
- * <p>The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see
445
- * <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html">WAF client application integration</a> in the <i>WAF Developer Guide</i>.</p>
266
+ * @see {@link ListMobileSdkReleasesCommand}
446
267
  */
447
268
  listMobileSdkReleases(args: ListMobileSdkReleasesCommandInput, options?: __HttpHandlerOptions): Promise<ListMobileSdkReleasesCommandOutput>;
448
269
  listMobileSdkReleases(args: ListMobileSdkReleasesCommandInput, cb: (err: any, data?: ListMobileSdkReleasesCommandOutput) => void): void;
449
270
  listMobileSdkReleases(args: ListMobileSdkReleasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListMobileSdkReleasesCommandOutput) => void): void;
450
271
  /**
451
- * @public
452
- * <p>Retrieves an array of <a>RegexPatternSetSummary</a> objects for the regex
453
- * pattern sets that you manage.</p>
272
+ * @see {@link ListRegexPatternSetsCommand}
454
273
  */
455
274
  listRegexPatternSets(args: ListRegexPatternSetsCommandInput, options?: __HttpHandlerOptions): Promise<ListRegexPatternSetsCommandOutput>;
456
275
  listRegexPatternSets(args: ListRegexPatternSetsCommandInput, cb: (err: any, data?: ListRegexPatternSetsCommandOutput) => void): void;
457
276
  listRegexPatternSets(args: ListRegexPatternSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRegexPatternSetsCommandOutput) => void): void;
458
277
  /**
459
- * @public
460
- * <p>Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that
461
- * are associated with the specified web ACL. If you want the list of Amazon CloudFront resources, use
462
- * the CloudFront call <code>ListDistributionsByWebACLId</code>. </p>
278
+ * @see {@link ListResourcesForWebACLCommand}
463
279
  */
464
280
  listResourcesForWebACL(args: ListResourcesForWebACLCommandInput, options?: __HttpHandlerOptions): Promise<ListResourcesForWebACLCommandOutput>;
465
281
  listResourcesForWebACL(args: ListResourcesForWebACLCommandInput, cb: (err: any, data?: ListResourcesForWebACLCommandOutput) => void): void;
466
282
  listResourcesForWebACL(args: ListResourcesForWebACLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListResourcesForWebACLCommandOutput) => void): void;
467
283
  /**
468
- * @public
469
- * <p>Retrieves an array of <a>RuleGroupSummary</a> objects for the rule groups
470
- * that you manage. </p>
284
+ * @see {@link ListRuleGroupsCommand}
471
285
  */
472
286
  listRuleGroups(args: ListRuleGroupsCommandInput, options?: __HttpHandlerOptions): Promise<ListRuleGroupsCommandOutput>;
473
287
  listRuleGroups(args: ListRuleGroupsCommandInput, cb: (err: any, data?: ListRuleGroupsCommandOutput) => void): void;
474
288
  listRuleGroups(args: ListRuleGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRuleGroupsCommandOutput) => void): void;
475
289
  /**
476
- * @public
477
- * <p>Retrieves the <a>TagInfoForResource</a> for the specified resource. Tags are
478
- * key:value pairs that you can use to categorize and manage your resources, for purposes like
479
- * billing. For example, you might set the tag key to "customer" and the value to the customer
480
- * name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags
481
- * for a resource.</p>
482
- * <p>You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule
483
- * groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF
484
- * console. </p>
290
+ * @see {@link ListTagsForResourceCommand}
485
291
  */
486
292
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
487
293
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
488
294
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
489
295
  /**
490
- * @public
491
- * <p>Retrieves an array of <a>WebACLSummary</a> objects for the web ACLs that you
492
- * manage.</p>
296
+ * @see {@link ListWebACLsCommand}
493
297
  */
494
298
  listWebACLs(args: ListWebACLsCommandInput, options?: __HttpHandlerOptions): Promise<ListWebACLsCommandOutput>;
495
299
  listWebACLs(args: ListWebACLsCommandInput, cb: (err: any, data?: ListWebACLsCommandOutput) => void): void;
496
300
  listWebACLs(args: ListWebACLsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListWebACLsCommandOutput) => void): void;
497
301
  /**
498
- * @public
499
- * <p>Enables the specified <a>LoggingConfiguration</a>, to start logging from a
500
- * web ACL, according to the configuration provided. </p>
501
- * <note>
502
- * <p>This operation completely replaces any mutable specifications that you already have for a logging configuration with the ones that you provide to this call. </p>
503
- * <p>To modify an existing logging configuration, do the following: </p>
504
- * <ol>
505
- * <li>
506
- * <p>Retrieve it by calling <a>GetLoggingConfiguration</a>
507
- * </p>
508
- * </li>
509
- * <li>
510
- * <p>Update its settings as needed</p>
511
- * </li>
512
- * <li>
513
- * <p>Provide the complete logging configuration specification to this call</p>
514
- * </li>
515
- * </ol>
516
- * </note>
517
- * <note>
518
- * <p>You can define one logging destination per web ACL.</p>
519
- * </note>
520
- * <p>You can access information about the traffic that WAF inspects using the following
521
- * steps:</p>
522
- * <ol>
523
- * <li>
524
- * <p>Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose. </p>
525
- * <p>The name that you give the destination must start with <code>aws-waf-logs-</code>. Depending on the type of destination, you might need to configure additional settings or permissions. </p>
526
- * <p>For configuration requirements and pricing information for each destination type, see
527
- * <a href="https://docs.aws.amazon.com/waf/latest/developerguide/logging.html">Logging web ACL traffic</a>
528
- * in the <i>WAF Developer Guide</i>.</p>
529
- * </li>
530
- * <li>
531
- * <p>Associate your logging destination to your web ACL using a
532
- * <code>PutLoggingConfiguration</code> request.</p>
533
- * </li>
534
- * </ol>
535
- * <p>When you successfully enable logging using a <code>PutLoggingConfiguration</code>
536
- * request, WAF creates an additional role or policy that is required to write
537
- * logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group.
538
- * For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.</p>
539
- * <p>For additional information about web ACL logging, see
540
- * <a href="https://docs.aws.amazon.com/waf/latest/developerguide/logging.html">Logging web ACL traffic information</a>
541
- * in the <i>WAF Developer Guide</i>.</p>
302
+ * @see {@link PutLoggingConfigurationCommand}
542
303
  */
543
304
  putLoggingConfiguration(args: PutLoggingConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<PutLoggingConfigurationCommandOutput>;
544
305
  putLoggingConfiguration(args: PutLoggingConfigurationCommandInput, cb: (err: any, data?: PutLoggingConfigurationCommandOutput) => void): void;
545
306
  putLoggingConfiguration(args: PutLoggingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutLoggingConfigurationCommandOutput) => void): void;
546
307
  /**
547
- * @public
548
- * <p>Defines the versions of your managed rule set that you are offering to the customers.
549
- * Customers see your offerings as managed rule groups with versioning.</p>
550
- * <note>
551
- * <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>
552
- * <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>
553
- * </note>
554
- * <p>Customers retrieve their managed rule group list by calling <a>ListAvailableManagedRuleGroups</a>. The name that you provide here for your
555
- * managed rule set is the name the customer sees for the corresponding managed rule group.
556
- * Customers can retrieve the available versions for a managed rule group by calling <a>ListAvailableManagedRuleGroupVersions</a>. You provide a rule group
557
- * specification for each version. For each managed rule set, you must specify a version that
558
- * you recommend using. </p>
559
- * <p>To initiate the expiration of a managed rule group version, use <a>UpdateManagedRuleSetVersionExpiryDate</a>.</p>
308
+ * @see {@link PutManagedRuleSetVersionsCommand}
560
309
  */
561
310
  putManagedRuleSetVersions(args: PutManagedRuleSetVersionsCommandInput, options?: __HttpHandlerOptions): Promise<PutManagedRuleSetVersionsCommandOutput>;
562
311
  putManagedRuleSetVersions(args: PutManagedRuleSetVersionsCommandInput, cb: (err: any, data?: PutManagedRuleSetVersionsCommandOutput) => void): void;
563
312
  putManagedRuleSetVersions(args: PutManagedRuleSetVersionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutManagedRuleSetVersionsCommandOutput) => void): void;
564
313
  /**
565
- * @public
566
- * <p>Attaches an IAM policy to the specified resource. Use this to share a rule group across
567
- * accounts.</p>
568
- * <p>You must be the owner of the rule group to perform this operation.</p>
569
- * <p>This action is subject to the following restrictions:</p>
570
- * <ul>
571
- * <li>
572
- * <p>You can attach only one policy with each <code>PutPermissionPolicy</code>
573
- * request.</p>
574
- * </li>
575
- * <li>
576
- * <p>The ARN in the request must be a valid WAF <a>RuleGroup</a> ARN and the
577
- * rule group must exist in the same Region.</p>
578
- * </li>
579
- * <li>
580
- * <p>The user making the request must be the owner of the rule group.</p>
581
- * </li>
582
- * </ul>
314
+ * @see {@link PutPermissionPolicyCommand}
583
315
  */
584
316
  putPermissionPolicy(args: PutPermissionPolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutPermissionPolicyCommandOutput>;
585
317
  putPermissionPolicy(args: PutPermissionPolicyCommandInput, cb: (err: any, data?: PutPermissionPolicyCommandOutput) => void): void;
586
318
  putPermissionPolicy(args: PutPermissionPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutPermissionPolicyCommandOutput) => void): void;
587
319
  /**
588
- * @public
589
- * <p>Associates tags with the specified Amazon Web Services resource. Tags are key:value pairs that you can
590
- * use to categorize and manage your resources, for purposes like billing. For example, you
591
- * might set the tag key to "customer" and the value to the customer name or ID. You can
592
- * specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a
593
- * resource.</p>
594
- * <p>You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule
595
- * groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF
596
- * console. </p>
320
+ * @see {@link TagResourceCommand}
597
321
  */
598
322
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
599
323
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
600
324
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
601
325
  /**
602
- * @public
603
- * <p>Disassociates tags from an Amazon Web Services resource. Tags are key:value pairs that you can
604
- * associate with Amazon Web Services resources. For example, the tag key might be "customer" and the tag
605
- * value might be "companyA." You can specify one or more tags to add to each container. You
606
- * can add up to 50 tags to each Amazon Web Services resource.</p>
326
+ * @see {@link UntagResourceCommand}
607
327
  */
608
328
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
609
329
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
610
330
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
611
331
  /**
612
- * @public
613
- * <p>Updates the specified <a>IPSet</a>. </p>
614
- * <note>
615
- * <p>This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call. </p>
616
- * <p>To modify an IP set, do the following: </p>
617
- * <ol>
618
- * <li>
619
- * <p>Retrieve it by calling <a>GetIPSet</a>
620
- * </p>
621
- * </li>
622
- * <li>
623
- * <p>Update its settings as needed</p>
624
- * </li>
625
- * <li>
626
- * <p>Provide the complete IP set specification to this call</p>
627
- * </li>
628
- * </ol>
629
- * </note>
630
- * <p>When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.</p>
332
+ * @see {@link UpdateIPSetCommand}
631
333
  */
632
334
  updateIPSet(args: UpdateIPSetCommandInput, options?: __HttpHandlerOptions): Promise<UpdateIPSetCommandOutput>;
633
335
  updateIPSet(args: UpdateIPSetCommandInput, cb: (err: any, data?: UpdateIPSetCommandOutput) => void): void;
634
336
  updateIPSet(args: UpdateIPSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateIPSetCommandOutput) => void): void;
635
337
  /**
636
- * @public
637
- * <p>Updates the expiration information for your managed rule set. Use this to initiate the
638
- * expiration of a managed rule group version. After you initiate expiration for a version,
639
- * WAF excludes it from the response to <a>ListAvailableManagedRuleGroupVersions</a> for the managed rule group. </p>
640
- * <note>
641
- * <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>
642
- * <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>
643
- * </note>
338
+ * @see {@link UpdateManagedRuleSetVersionExpiryDateCommand}
644
339
  */
645
340
  updateManagedRuleSetVersionExpiryDate(args: UpdateManagedRuleSetVersionExpiryDateCommandInput, options?: __HttpHandlerOptions): Promise<UpdateManagedRuleSetVersionExpiryDateCommandOutput>;
646
341
  updateManagedRuleSetVersionExpiryDate(args: UpdateManagedRuleSetVersionExpiryDateCommandInput, cb: (err: any, data?: UpdateManagedRuleSetVersionExpiryDateCommandOutput) => void): void;
647
342
  updateManagedRuleSetVersionExpiryDate(args: UpdateManagedRuleSetVersionExpiryDateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateManagedRuleSetVersionExpiryDateCommandOutput) => void): void;
648
343
  /**
649
- * @public
650
- * <p>Updates the specified <a>RegexPatternSet</a>.</p>
651
- * <note>
652
- * <p>This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call. </p>
653
- * <p>To modify a regex pattern set, do the following: </p>
654
- * <ol>
655
- * <li>
656
- * <p>Retrieve it by calling <a>GetRegexPatternSet</a>
657
- * </p>
658
- * </li>
659
- * <li>
660
- * <p>Update its settings as needed</p>
661
- * </li>
662
- * <li>
663
- * <p>Provide the complete regex pattern set specification to this call</p>
664
- * </li>
665
- * </ol>
666
- * </note>
667
- * <p>When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.</p>
344
+ * @see {@link UpdateRegexPatternSetCommand}
668
345
  */
669
346
  updateRegexPatternSet(args: UpdateRegexPatternSetCommandInput, options?: __HttpHandlerOptions): Promise<UpdateRegexPatternSetCommandOutput>;
670
347
  updateRegexPatternSet(args: UpdateRegexPatternSetCommandInput, cb: (err: any, data?: UpdateRegexPatternSetCommandOutput) => void): void;
671
348
  updateRegexPatternSet(args: UpdateRegexPatternSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRegexPatternSetCommandOutput) => void): void;
672
349
  /**
673
- * @public
674
- * <p>Updates the specified <a>RuleGroup</a>.</p>
675
- * <note>
676
- * <p>This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call. </p>
677
- * <p>To modify a rule group, do the following: </p>
678
- * <ol>
679
- * <li>
680
- * <p>Retrieve it by calling <a>GetRuleGroup</a>
681
- * </p>
682
- * </li>
683
- * <li>
684
- * <p>Update its settings as needed</p>
685
- * </li>
686
- * <li>
687
- * <p>Provide the complete rule group specification to this call</p>
688
- * </li>
689
- * </ol>
690
- * </note>
691
- * <p>When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.</p>
692
- * <p> A rule group defines a collection of rules to inspect and control web requests that you can use in a <a>WebACL</a>. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements. </p>
350
+ * @see {@link UpdateRuleGroupCommand}
693
351
  */
694
352
  updateRuleGroup(args: UpdateRuleGroupCommandInput, options?: __HttpHandlerOptions): Promise<UpdateRuleGroupCommandOutput>;
695
353
  updateRuleGroup(args: UpdateRuleGroupCommandInput, cb: (err: any, data?: UpdateRuleGroupCommandOutput) => void): void;
696
354
  updateRuleGroup(args: UpdateRuleGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRuleGroupCommandOutput) => void): void;
697
355
  /**
698
- * @public
699
- * <p>Updates the specified <a>WebACL</a>. While updating a web ACL, WAF provides
700
- * continuous coverage to the resources that you have associated with the web ACL. </p>
701
- * <note>
702
- * <p>This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call. </p>
703
- * <p>To modify a web ACL, do the following: </p>
704
- * <ol>
705
- * <li>
706
- * <p>Retrieve it by calling <a>GetWebACL</a>
707
- * </p>
708
- * </li>
709
- * <li>
710
- * <p>Update its settings as needed</p>
711
- * </li>
712
- * <li>
713
- * <p>Provide the complete web ACL specification to this call</p>
714
- * </li>
715
- * </ol>
716
- * </note>
717
- * <p>When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.</p>
718
- * <p> A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types <a>Rule</a>, <a>RuleGroup</a>, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service. </p>
356
+ * @see {@link UpdateWebACLCommand}
719
357
  */
720
358
  updateWebACL(args: UpdateWebACLCommandInput, options?: __HttpHandlerOptions): Promise<UpdateWebACLCommandOutput>;
721
359
  updateWebACL(args: UpdateWebACLCommandInput, cb: (err: any, data?: UpdateWebACLCommandOutput) => void): void;
722
360
  updateWebACL(args: UpdateWebACLCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateWebACLCommandOutput) => void): void;
723
361
  }
362
+ /**
363
+ * @public
364
+ * <fullname>WAF</fullname>
365
+ * <note>
366
+ * <p>This is the latest version of the <b>WAF</b> API,
367
+ * released in November, 2019. The names of the entities that you use to access this API,
368
+ * like endpoints and namespaces, all have the versioning information added, like "V2" or
369
+ * "v2", to distinguish from the prior version. We recommend migrating your resources to
370
+ * this version, because it has a number of significant improvements.</p>
371
+ * <p>If you used WAF prior to this release, you can't use this WAFV2 API to access any
372
+ * WAF resources that you created before. You can access your old rules, web ACLs, and
373
+ * other WAF resources only through the WAF Classic APIs. The WAF Classic APIs
374
+ * have retained the prior names, endpoints, and namespaces. </p>
375
+ * <p>For information, including how to migrate your WAF resources to this version,
376
+ * see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">WAF Developer Guide</a>. </p>
377
+ * </note>
378
+ * <p>WAF is a web application firewall that lets you monitor the HTTP and HTTPS
379
+ * requests that are forwarded to an Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AppSync
380
+ * GraphQL API, Amazon Cognito user pool, or App Runner service. WAF also lets you control access to your content,
381
+ * to protect the Amazon Web Services resource that WAF is monitoring. Based on conditions that
382
+ * you specify, such as the IP addresses that requests originate from or the values of query
383
+ * strings, the protected resource responds to requests with either the requested content, an HTTP 403 status code
384
+ * (Forbidden), or with a custom response. </p>
385
+ * <p>This API guide is for developers who need detailed information about WAF API actions,
386
+ * data types, and errors. For detailed information about WAF features and guidance for configuring and using
387
+ * WAF, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/what-is-aws-waf.html">WAF Developer
388
+ * Guide</a>.</p>
389
+ * <p>You can make calls using the endpoints listed in <a href="https://docs.aws.amazon.com/general/latest/gr/waf.html">WAF endpoints and quotas</a>. </p>
390
+ * <ul>
391
+ * <li>
392
+ * <p>For regional applications, you can use any of the endpoints in the list.
393
+ * A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, or an App Runner service. </p>
394
+ * </li>
395
+ * <li>
396
+ * <p>For Amazon CloudFront applications, you must use the API endpoint listed for
397
+ * US East (N. Virginia): us-east-1.</p>
398
+ * </li>
399
+ * </ul>
400
+ * <p>Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to the
401
+ * programming language or platform that you're using. For more information, see <a href="http://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p>
402
+ * <p>We currently provide two versions of the WAF API: this API and the prior versions,
403
+ * the classic WAF APIs. This new API provides the same functionality as the older versions,
404
+ * with the following major improvements:</p>
405
+ * <ul>
406
+ * <li>
407
+ * <p>You use one API for both global and regional applications. Where you need to
408
+ * distinguish the scope, you specify a <code>Scope</code> parameter and set it to
409
+ * <code>CLOUDFRONT</code> or <code>REGIONAL</code>. </p>
410
+ * </li>
411
+ * <li>
412
+ * <p>You can define a web ACL or rule group with a single call, and update it with a
413
+ * single call. You define all rule specifications in JSON format, and pass them to your
414
+ * rule group or web ACL calls.</p>
415
+ * </li>
416
+ * <li>
417
+ * <p>The limits WAF places on the use of rules more closely reflects the cost of
418
+ * running each type of rule. Rule groups include capacity settings, so you know the
419
+ * maximum cost of a rule group when you use it.</p>
420
+ * </li>
421
+ * </ul>
422
+ */
423
+ export declare class WAFV2 extends WAFV2Client implements WAFV2 {
424
+ }