@aws-sdk/client-fms 3.52.0 → 3.54.1

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 (39) hide show
  1. package/CHANGELOG.md +28 -0
  2. package/README.md +6 -6
  3. package/dist-cjs/index.js +3 -0
  4. package/dist-cjs/models/FMSServiceException.js +11 -0
  5. package/dist-cjs/models/models_0.js +124 -3
  6. package/dist-cjs/protocols/Aws_json1_1.js +367 -888
  7. package/dist-es/index.js +1 -0
  8. package/dist-es/models/FMSServiceException.js +12 -0
  9. package/dist-es/models/models_0.js +106 -1
  10. package/dist-es/protocols/Aws_json1_1.js +667 -983
  11. package/dist-types/FMS.d.ts +59 -56
  12. package/dist-types/FMSClient.d.ts +8 -8
  13. package/dist-types/commands/AssociateAdminAccountCommand.d.ts +5 -4
  14. package/dist-types/commands/DeleteNotificationChannelCommand.d.ts +2 -2
  15. package/dist-types/commands/DisassociateAdminAccountCommand.d.ts +3 -3
  16. package/dist-types/commands/GetAdminAccountCommand.d.ts +2 -2
  17. package/dist-types/commands/GetComplianceDetailCommand.d.ts +13 -13
  18. package/dist-types/commands/GetNotificationChannelCommand.d.ts +2 -2
  19. package/dist-types/commands/GetProtectionStatusCommand.d.ts +2 -1
  20. package/dist-types/commands/GetViolationDetailsCommand.d.ts +2 -1
  21. package/dist-types/commands/ListComplianceStatusCommand.d.ts +2 -2
  22. package/dist-types/commands/ListMemberAccountsCommand.d.ts +2 -2
  23. package/dist-types/commands/ListTagsForResourceCommand.d.ts +1 -1
  24. package/dist-types/commands/PutNotificationChannelCommand.d.ts +6 -5
  25. package/dist-types/commands/PutPolicyCommand.d.ts +11 -12
  26. package/dist-types/index.d.ts +1 -0
  27. package/dist-types/models/FMSServiceException.d.ts +10 -0
  28. package/dist-types/models/models_0.d.ts +771 -334
  29. package/dist-types/runtimeConfig.browser.d.ts +1 -1
  30. package/dist-types/runtimeConfig.d.ts +1 -1
  31. package/dist-types/runtimeConfig.native.d.ts +1 -1
  32. package/dist-types/ts3.4/FMSClient.d.ts +2 -2
  33. package/dist-types/ts3.4/index.d.ts +1 -0
  34. package/dist-types/ts3.4/models/FMSServiceException.d.ts +6 -0
  35. package/dist-types/ts3.4/models/models_0.d.ts +126 -19
  36. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -1
  37. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -1
  38. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -1
  39. package/package.json +27 -27
@@ -28,19 +28,20 @@ import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./command
28
28
  import { FMSClient } from "./FMSClient";
29
29
  /**
30
30
  * <p>This is the <i>Firewall Manager API Reference</i>. This guide is for
31
- * developers who need detailed information about the Firewall Manager API actions, data
32
- * types, and errors. For detailed information about Firewall Manager features, see the
33
- * <a href="https://docs.aws.amazon.com/waf/latest/developerguide/fms-chapter.html">Firewall Manager Developer Guide</a>.</p>
34
- * <p>Some API actions require explicit resource permissions. For information, see the developer guide topic
35
- * <a href="https://docs.aws.amazon.com/waf/latest/developerguide/fms-api-permissions-ref.html">Firewall Manager required permissions for API actions</a>.
36
- * </p>
31
+ * developers who need detailed information about the Firewall Manager API actions, data types, and
32
+ * errors. For detailed information about Firewall Manager features, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/fms-chapter.html">Firewall Manager
33
+ * Developer Guide</a>.</p>
34
+ * <p>Some API actions require explicit resource permissions. For information, see the
35
+ * developer guide topic <a href="https://docs.aws.amazon.com/waf/latest/developerguide/fms-api-permissions-ref.html">Firewall Manager required permissions
36
+ * for API actions</a>. </p>
37
37
  */
38
38
  export declare class FMS extends FMSClient {
39
39
  /**
40
- * <p>Sets the Firewall Manager administrator account. The account must be
41
- * a member of the organization in Organizations whose resources you want to protect.
42
- * Firewall Manager sets the permissions that allow the account to administer your Firewall Manager policies.</p>
43
- * <p>The account that you associate with Firewall Manager is called the Firewall Manager administrator account. </p>
40
+ * <p>Sets the Firewall Manager administrator account. The account must be a member of the
41
+ * organization in Organizations whose resources you want to protect. Firewall Manager sets the
42
+ * permissions that allow the account to administer your Firewall Manager policies.</p>
43
+ * <p>The account that you associate with Firewall Manager is called the Firewall Manager administrator
44
+ * account. </p>
44
45
  */
45
46
  associateAdminAccount(args: AssociateAdminAccountCommandInput, options?: __HttpHandlerOptions): Promise<AssociateAdminAccountCommandOutput>;
46
47
  associateAdminAccount(args: AssociateAdminAccountCommandInput, cb: (err: any, data?: AssociateAdminAccountCommandOutput) => void): void;
@@ -52,8 +53,8 @@ export declare class FMS extends FMSClient {
52
53
  deleteAppsList(args: DeleteAppsListCommandInput, cb: (err: any, data?: DeleteAppsListCommandOutput) => void): void;
53
54
  deleteAppsList(args: DeleteAppsListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAppsListCommandOutput) => void): void;
54
55
  /**
55
- * <p>Deletes an Firewall Manager association with the IAM role and the Amazon Simple
56
- * Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.</p>
56
+ * <p>Deletes an Firewall Manager association with the IAM role and the Amazon Simple Notification
57
+ * Service (SNS) topic that is used to record Firewall Manager SNS logs.</p>
57
58
  */
58
59
  deleteNotificationChannel(args: DeleteNotificationChannelCommandInput, options?: __HttpHandlerOptions): Promise<DeleteNotificationChannelCommandOutput>;
59
60
  deleteNotificationChannel(args: DeleteNotificationChannelCommandInput, cb: (err: any, data?: DeleteNotificationChannelCommandOutput) => void): void;
@@ -71,16 +72,16 @@ export declare class FMS extends FMSClient {
71
72
  deleteProtocolsList(args: DeleteProtocolsListCommandInput, cb: (err: any, data?: DeleteProtocolsListCommandOutput) => void): void;
72
73
  deleteProtocolsList(args: DeleteProtocolsListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteProtocolsListCommandOutput) => void): void;
73
74
  /**
74
- * <p>Disassociates the account that has been set as the Firewall Manager administrator
75
- * account. To set a different account as the administrator account, you must submit an
76
- * <code>AssociateAdminAccount</code> request.</p>
75
+ * <p>Disassociates the account that has been set as the Firewall Manager administrator account. To
76
+ * set a different account as the administrator account, you must submit an
77
+ * <code>AssociateAdminAccount</code> request.</p>
77
78
  */
78
79
  disassociateAdminAccount(args: DisassociateAdminAccountCommandInput, options?: __HttpHandlerOptions): Promise<DisassociateAdminAccountCommandOutput>;
79
80
  disassociateAdminAccount(args: DisassociateAdminAccountCommandInput, cb: (err: any, data?: DisassociateAdminAccountCommandOutput) => void): void;
80
81
  disassociateAdminAccount(args: DisassociateAdminAccountCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DisassociateAdminAccountCommandOutput) => void): void;
81
82
  /**
82
- * <p>Returns the Organizations account that is associated with Firewall Manager
83
- * as the Firewall Manager administrator.</p>
83
+ * <p>Returns the Organizations account that is associated with Firewall Manager as the Firewall Manager
84
+ * administrator.</p>
84
85
  */
85
86
  getAdminAccount(args: GetAdminAccountCommandInput, options?: __HttpHandlerOptions): Promise<GetAdminAccountCommandOutput>;
86
87
  getAdminAccount(args: GetAdminAccountCommandInput, cb: (err: any, data?: GetAdminAccountCommandOutput) => void): void;
@@ -93,27 +94,27 @@ export declare class FMS extends FMSClient {
93
94
  getAppsList(args: GetAppsListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAppsListCommandOutput) => void): void;
94
95
  /**
95
96
  * <p>Returns detailed compliance information about the specified member account. Details
96
- * include resources that are in and out of compliance with the specified policy. </p>
97
+ * include resources that are in and out of compliance with the specified policy. </p>
97
98
  * <ul>
98
99
  * <li>
99
- * <p>Resources are
100
- * considered noncompliant for WAF and Shield Advanced policies if the specified policy has
101
- * not been applied to them.</p>
100
+ * <p>Resources are considered noncompliant for WAF and Shield Advanced policies
101
+ * if the specified policy has not been applied to them.</p>
102
102
  * </li>
103
103
  * <li>
104
- * <p>Resources are considered noncompliant for security group policies if
105
- * they are in scope of the policy, they violate one or more of the policy rules, and remediation
106
- * is disabled or not possible.</p>
104
+ * <p>Resources are considered noncompliant for security group policies if they are in
105
+ * scope of the policy, they violate one or more of the policy rules, and remediation is
106
+ * disabled or not possible.</p>
107
107
  * </li>
108
108
  * <li>
109
- * <p>Resources are considered noncompliant for Network Firewall policies
110
- * if a firewall is missing in the VPC, if the firewall endpoint isn't set up in an expected Availability Zone and subnet,
111
- * if a subnet created by the Firewall Manager doesn't have the expected route table,
112
- * and for modifications to a firewall policy that violate the Firewall Manager policy's rules.</p>
109
+ * <p>Resources are considered noncompliant for Network Firewall policies if a firewall is
110
+ * missing in the VPC, if the firewall endpoint isn't set up in an expected Availability
111
+ * Zone and subnet, if a subnet created by the Firewall Manager doesn't have the expected route
112
+ * table, and for modifications to a firewall policy that violate the Firewall Manager policy's
113
+ * rules.</p>
113
114
  * </li>
114
115
  * <li>
115
- * <p>Resources are considered noncompliant for DNS Firewall policies
116
- * if a DNS Firewall rule group is missing from the rule group associations for the VPC. </p>
116
+ * <p>Resources are considered noncompliant for DNS Firewall policies if a DNS Firewall
117
+ * rule group is missing from the rule group associations for the VPC. </p>
117
118
  * </li>
118
119
  * </ul>
119
120
  */
@@ -122,8 +123,8 @@ export declare class FMS extends FMSClient {
122
123
  getComplianceDetail(args: GetComplianceDetailCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetComplianceDetailCommandOutput) => void): void;
123
124
  /**
124
125
  * <p>Information
125
- * about the Amazon Simple Notification Service (SNS) topic that is used to
126
- * record Firewall Manager SNS logs.</p>
126
+ * about the Amazon Simple Notification Service (SNS) topic that is used to
127
+ * record Firewall Manager SNS logs.</p>
127
128
  */
128
129
  getNotificationChannel(args: GetNotificationChannelCommandInput, options?: __HttpHandlerOptions): Promise<GetNotificationChannelCommandOutput>;
129
130
  getNotificationChannel(args: GetNotificationChannelCommandInput, cb: (err: any, data?: GetNotificationChannelCommandOutput) => void): void;
@@ -136,7 +137,8 @@ export declare class FMS extends FMSClient {
136
137
  getPolicy(args: GetPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPolicyCommandOutput) => void): void;
137
138
  /**
138
139
  * <p>If you created a Shield Advanced policy, returns policy-level attack summary information
139
- * in the event of a potential DDoS attack. Other policy types are currently unsupported.</p>
140
+ * in the event of a potential DDoS attack. Other policy types are currently
141
+ * unsupported.</p>
140
142
  */
141
143
  getProtectionStatus(args: GetProtectionStatusCommandInput, options?: __HttpHandlerOptions): Promise<GetProtectionStatusCommandOutput>;
142
144
  getProtectionStatus(args: GetProtectionStatusCommandInput, cb: (err: any, data?: GetProtectionStatusCommandOutput) => void): void;
@@ -148,7 +150,8 @@ export declare class FMS extends FMSClient {
148
150
  getProtocolsList(args: GetProtocolsListCommandInput, cb: (err: any, data?: GetProtocolsListCommandOutput) => void): void;
149
151
  getProtocolsList(args: GetProtocolsListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetProtocolsListCommandOutput) => void): void;
150
152
  /**
151
- * <p>Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account.</p>
153
+ * <p>Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services
154
+ * account.</p>
152
155
  */
153
156
  getViolationDetails(args: GetViolationDetailsCommandInput, options?: __HttpHandlerOptions): Promise<GetViolationDetailsCommandOutput>;
154
157
  getViolationDetails(args: GetViolationDetailsCommandInput, cb: (err: any, data?: GetViolationDetailsCommandOutput) => void): void;
@@ -161,17 +164,17 @@ export declare class FMS extends FMSClient {
161
164
  listAppsLists(args: ListAppsListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAppsListsCommandOutput) => void): void;
162
165
  /**
163
166
  * <p>Returns an array of <code>PolicyComplianceStatus</code> objects. Use
164
- * <code>PolicyComplianceStatus</code> to get a summary of which member accounts are protected
165
- * by the specified policy. </p>
167
+ * <code>PolicyComplianceStatus</code> to get a summary of which member accounts are
168
+ * protected by the specified policy. </p>
166
169
  */
167
170
  listComplianceStatus(args: ListComplianceStatusCommandInput, options?: __HttpHandlerOptions): Promise<ListComplianceStatusCommandOutput>;
168
171
  listComplianceStatus(args: ListComplianceStatusCommandInput, cb: (err: any, data?: ListComplianceStatusCommandOutput) => void): void;
169
172
  listComplianceStatus(args: ListComplianceStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListComplianceStatusCommandOutput) => void): void;
170
173
  /**
171
174
  * <p>Returns a <code>MemberAccounts</code> object that lists the member accounts in the
172
- * administrator's Amazon Web Services organization.</p>
175
+ * administrator's Amazon Web Services organization.</p>
173
176
  * <p>The <code>ListMemberAccounts</code> must be submitted by the account that is set as the
174
- * Firewall Manager administrator.</p>
177
+ * Firewall Manager administrator.</p>
175
178
  */
176
179
  listMemberAccounts(args: ListMemberAccountsCommandInput, options?: __HttpHandlerOptions): Promise<ListMemberAccountsCommandOutput>;
177
180
  listMemberAccounts(args: ListMemberAccountsCommandInput, cb: (err: any, data?: ListMemberAccountsCommandOutput) => void): void;
@@ -189,7 +192,7 @@ export declare class FMS extends FMSClient {
189
192
  listProtocolsLists(args: ListProtocolsListsCommandInput, cb: (err: any, data?: ListProtocolsListsCommandOutput) => void): void;
190
193
  listProtocolsLists(args: ListProtocolsListsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListProtocolsListsCommandOutput) => void): void;
191
194
  /**
192
- * <p>Retrieves the list of tags for the specified Amazon Web Services resource. </p>
195
+ * <p>Retrieves the list of tags for the specified Amazon Web Services resource. </p>
193
196
  */
194
197
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
195
198
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
@@ -201,11 +204,12 @@ export declare class FMS extends FMSClient {
201
204
  putAppsList(args: PutAppsListCommandInput, cb: (err: any, data?: PutAppsListCommandOutput) => void): void;
202
205
  putAppsList(args: PutAppsListCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutAppsListCommandOutput) => void): void;
203
206
  /**
204
- * <p>Designates the IAM role and Amazon Simple Notification Service (SNS) topic that
205
- * Firewall Manager uses to record SNS logs.</p>
206
- * <p>To perform this action outside of the console, you must configure the SNS topic to allow the Firewall Manager
207
- * role <code>AWSServiceRoleForFMS</code> to publish SNS logs. For more information, see
208
- * <a href="https://docs.aws.amazon.com/waf/latest/developerguide/fms-api-permissions-ref.html">Firewall Manager required permissions for API actions</a> in the <i>Firewall Manager Developer Guide</i>.</p>
207
+ * <p>Designates the IAM role and Amazon Simple Notification Service (SNS) topic that Firewall Manager
208
+ * uses to record SNS logs.</p>
209
+ * <p>To perform this action outside of the console, you must configure the SNS topic to allow
210
+ * the Firewall Manager role <code>AWSServiceRoleForFMS</code> to publish SNS logs. For more information,
211
+ * see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/fms-api-permissions-ref.html">Firewall Manager required permissions
212
+ * for API actions</a> in the <i>Firewall Manager Developer Guide</i>.</p>
209
213
  */
210
214
  putNotificationChannel(args: PutNotificationChannelCommandInput, options?: __HttpHandlerOptions): Promise<PutNotificationChannelCommandOutput>;
211
215
  putNotificationChannel(args: PutNotificationChannelCommandInput, cb: (err: any, data?: PutNotificationChannelCommandOutput) => void): void;
@@ -216,34 +220,33 @@ export declare class FMS extends FMSClient {
216
220
  * <ul>
217
221
  * <li>
218
222
  * <p>An WAF policy (type WAFV2), which defines rule groups to run first in the
219
- * corresponding WAF web ACL and rule groups to run last in the web ACL.</p>
223
+ * corresponding WAF web ACL and rule groups to run last in the web ACL.</p>
220
224
  * </li>
221
225
  * <li>
222
226
  * <p>An WAF Classic policy (type WAF), which defines a rule group. </p>
223
227
  * </li>
224
228
  * <li>
225
229
  * <p>A Shield Advanced policy, which applies Shield Advanced protection to specified
226
- * accounts and resources.</p>
230
+ * accounts and resources.</p>
227
231
  * </li>
228
232
  * <li>
229
233
  * <p>A security group policy, which manages VPC security groups across your Amazon Web Services
230
- * organization. </p>
234
+ * organization. </p>
231
235
  * </li>
232
236
  * <li>
233
- * <p>An Network Firewall policy, which provides firewall rules to filter network traffic in specified
234
- * Amazon VPCs.</p>
237
+ * <p>An Network Firewall policy, which provides firewall rules to filter network traffic in
238
+ * specified Amazon VPCs.</p>
235
239
  * </li>
236
240
  * <li>
237
- * <p>A DNS Firewall policy, which provides Route 53 Resolver DNS Firewall rules to filter DNS queries for
238
- * specified VPCs.</p>
241
+ * <p>A DNS Firewall policy, which provides Route 53 Resolver DNS Firewall rules to filter DNS
242
+ * queries for specified VPCs.</p>
239
243
  * </li>
240
244
  * </ul>
241
- * <p>Each policy is specific to one of the types. If you want to enforce more than one
242
- * policy type across accounts, create multiple policies. You can create multiple
243
- * policies for each type.</p>
245
+ * <p>Each policy is specific to one of the types. If you want to enforce more than one policy
246
+ * type across accounts, create multiple policies. You can create multiple policies for each
247
+ * type.</p>
244
248
  * <p>You must be subscribed to Shield Advanced to create a Shield Advanced policy. For more
245
- * information about subscribing to Shield Advanced, see
246
- * <a href="https://docs.aws.amazon.com/waf/latest/DDOSAPIReference/API_CreateSubscription.html">CreateSubscription</a>.</p>
249
+ * information about subscribing to Shield Advanced, see <a href="https://docs.aws.amazon.com/waf/latest/DDOSAPIReference/API_CreateSubscription.html">CreateSubscription</a>.</p>
247
250
  */
248
251
  putPolicy(args: PutPolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutPolicyCommandOutput>;
249
252
  putPolicy(args: PutPolicyCommandInput, cb: (err: any, data?: PutPolicyCommandOutput) => void): void;
@@ -5,7 +5,7 @@ import { AwsAuthInputConfig, AwsAuthResolvedConfig } from "@aws-sdk/middleware-s
5
5
  import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middleware-user-agent";
6
6
  import { HttpHandler as __HttpHandler } from "@aws-sdk/protocol-http";
7
7
  import { Client as __Client, DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@aws-sdk/smithy-client";
8
- import { Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, RegionInfoProvider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
8
+ import { BodyLengthCalculator as __BodyLengthCalculator, Credentials as __Credentials, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, RegionInfoProvider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@aws-sdk/types";
9
9
  import { AssociateAdminAccountCommandInput, AssociateAdminAccountCommandOutput } from "./commands/AssociateAdminAccountCommand";
10
10
  import { DeleteAppsListCommandInput, DeleteAppsListCommandOutput } from "./commands/DeleteAppsListCommand";
11
11
  import { DeleteNotificationChannelCommandInput, DeleteNotificationChannelCommandOutput } from "./commands/DeleteNotificationChannelCommand";
@@ -54,7 +54,7 @@ export interface ClientDefaults extends Partial<__SmithyResolvedConfiguration<__
54
54
  * A function that can calculate the length of a request body.
55
55
  * @internal
56
56
  */
57
- bodyLengthChecker?: (body: any) => number | undefined;
57
+ bodyLengthChecker?: __BodyLengthCalculator;
58
58
  /**
59
59
  * A function that converts a stream into an array of bytes.
60
60
  * @internal
@@ -153,12 +153,12 @@ export interface FMSClientResolvedConfig extends FMSClientResolvedConfigType {
153
153
  }
154
154
  /**
155
155
  * <p>This is the <i>Firewall Manager API Reference</i>. This guide is for
156
- * developers who need detailed information about the Firewall Manager API actions, data
157
- * types, and errors. For detailed information about Firewall Manager features, see the
158
- * <a href="https://docs.aws.amazon.com/waf/latest/developerguide/fms-chapter.html">Firewall Manager Developer Guide</a>.</p>
159
- * <p>Some API actions require explicit resource permissions. For information, see the developer guide topic
160
- * <a href="https://docs.aws.amazon.com/waf/latest/developerguide/fms-api-permissions-ref.html">Firewall Manager required permissions for API actions</a>.
161
- * </p>
156
+ * developers who need detailed information about the Firewall Manager API actions, data types, and
157
+ * errors. For detailed information about Firewall Manager features, see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/fms-chapter.html">Firewall Manager
158
+ * Developer Guide</a>.</p>
159
+ * <p>Some API actions require explicit resource permissions. For information, see the
160
+ * developer guide topic <a href="https://docs.aws.amazon.com/waf/latest/developerguide/fms-api-permissions-ref.html">Firewall Manager required permissions
161
+ * for API actions</a>. </p>
162
162
  */
163
163
  export declare class FMSClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, FMSClientResolvedConfig> {
164
164
  /**
@@ -7,10 +7,11 @@ export interface AssociateAdminAccountCommandInput extends AssociateAdminAccount
7
7
  export interface AssociateAdminAccountCommandOutput extends __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Sets the Firewall Manager administrator account. The account must be
11
- * a member of the organization in Organizations whose resources you want to protect.
12
- * Firewall Manager sets the permissions that allow the account to administer your Firewall Manager policies.</p>
13
- * <p>The account that you associate with Firewall Manager is called the Firewall Manager administrator account. </p>
10
+ * <p>Sets the Firewall Manager administrator account. The account must be a member of the
11
+ * organization in Organizations whose resources you want to protect. Firewall Manager sets the
12
+ * permissions that allow the account to administer your Firewall Manager policies.</p>
13
+ * <p>The account that you associate with Firewall Manager is called the Firewall Manager administrator
14
+ * account. </p>
14
15
  * @example
15
16
  * Use a bare-bones client and the command you need to make an API call.
16
17
  * ```javascript
@@ -7,8 +7,8 @@ export interface DeleteNotificationChannelCommandInput extends DeleteNotificatio
7
7
  export interface DeleteNotificationChannelCommandOutput extends __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Deletes an Firewall Manager association with the IAM role and the Amazon Simple
11
- * Notification Service (SNS) topic that is used to record Firewall Manager SNS logs.</p>
10
+ * <p>Deletes an Firewall Manager association with the IAM role and the Amazon Simple Notification
11
+ * Service (SNS) topic that is used to record Firewall Manager SNS logs.</p>
12
12
  * @example
13
13
  * Use a bare-bones client and the command you need to make an API call.
14
14
  * ```javascript
@@ -7,9 +7,9 @@ export interface DisassociateAdminAccountCommandInput extends DisassociateAdminA
7
7
  export interface DisassociateAdminAccountCommandOutput extends __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Disassociates the account that has been set as the Firewall Manager administrator
11
- * account. To set a different account as the administrator account, you must submit an
12
- * <code>AssociateAdminAccount</code> request.</p>
10
+ * <p>Disassociates the account that has been set as the Firewall Manager administrator account. To
11
+ * set a different account as the administrator account, you must submit an
12
+ * <code>AssociateAdminAccount</code> request.</p>
13
13
  * @example
14
14
  * Use a bare-bones client and the command you need to make an API call.
15
15
  * ```javascript
@@ -7,8 +7,8 @@ export interface GetAdminAccountCommandInput extends GetAdminAccountRequest {
7
7
  export interface GetAdminAccountCommandOutput extends GetAdminAccountResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Returns the Organizations account that is associated with Firewall Manager
11
- * as the Firewall Manager administrator.</p>
10
+ * <p>Returns the Organizations account that is associated with Firewall Manager as the Firewall Manager
11
+ * administrator.</p>
12
12
  * @example
13
13
  * Use a bare-bones client and the command you need to make an API call.
14
14
  * ```javascript
@@ -8,27 +8,27 @@ export interface GetComplianceDetailCommandOutput extends GetComplianceDetailRes
8
8
  }
9
9
  /**
10
10
  * <p>Returns detailed compliance information about the specified member account. Details
11
- * include resources that are in and out of compliance with the specified policy. </p>
11
+ * include resources that are in and out of compliance with the specified policy. </p>
12
12
  * <ul>
13
13
  * <li>
14
- * <p>Resources are
15
- * considered noncompliant for WAF and Shield Advanced policies if the specified policy has
16
- * not been applied to them.</p>
14
+ * <p>Resources are considered noncompliant for WAF and Shield Advanced policies
15
+ * if the specified policy has not been applied to them.</p>
17
16
  * </li>
18
17
  * <li>
19
- * <p>Resources are considered noncompliant for security group policies if
20
- * they are in scope of the policy, they violate one or more of the policy rules, and remediation
21
- * is disabled or not possible.</p>
18
+ * <p>Resources are considered noncompliant for security group policies if they are in
19
+ * scope of the policy, they violate one or more of the policy rules, and remediation is
20
+ * disabled or not possible.</p>
22
21
  * </li>
23
22
  * <li>
24
- * <p>Resources are considered noncompliant for Network Firewall policies
25
- * if a firewall is missing in the VPC, if the firewall endpoint isn't set up in an expected Availability Zone and subnet,
26
- * if a subnet created by the Firewall Manager doesn't have the expected route table,
27
- * and for modifications to a firewall policy that violate the Firewall Manager policy's rules.</p>
23
+ * <p>Resources are considered noncompliant for Network Firewall policies if a firewall is
24
+ * missing in the VPC, if the firewall endpoint isn't set up in an expected Availability
25
+ * Zone and subnet, if a subnet created by the Firewall Manager doesn't have the expected route
26
+ * table, and for modifications to a firewall policy that violate the Firewall Manager policy's
27
+ * rules.</p>
28
28
  * </li>
29
29
  * <li>
30
- * <p>Resources are considered noncompliant for DNS Firewall policies
31
- * if a DNS Firewall rule group is missing from the rule group associations for the VPC. </p>
30
+ * <p>Resources are considered noncompliant for DNS Firewall policies if a DNS Firewall
31
+ * rule group is missing from the rule group associations for the VPC. </p>
32
32
  * </li>
33
33
  * </ul>
34
34
  * @example
@@ -8,8 +8,8 @@ export interface GetNotificationChannelCommandOutput extends GetNotificationChan
8
8
  }
9
9
  /**
10
10
  * <p>Information
11
- * about the Amazon Simple Notification Service (SNS) topic that is used to
12
- * record Firewall Manager SNS logs.</p>
11
+ * about the Amazon Simple Notification Service (SNS) topic that is used to
12
+ * record Firewall Manager SNS logs.</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,8 @@ export interface GetProtectionStatusCommandOutput extends GetProtectionStatusRes
8
8
  }
9
9
  /**
10
10
  * <p>If you created a Shield Advanced policy, returns policy-level attack summary information
11
- * in the event of a potential DDoS attack. Other policy types are currently unsupported.</p>
11
+ * in the event of a potential DDoS attack. Other policy types are currently
12
+ * unsupported.</p>
12
13
  * @example
13
14
  * Use a bare-bones client and the command you need to make an API call.
14
15
  * ```javascript
@@ -7,7 +7,8 @@ export interface GetViolationDetailsCommandInput extends GetViolationDetailsRequ
7
7
  export interface GetViolationDetailsCommandOutput extends GetViolationDetailsResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services account.</p>
10
+ * <p>Retrieves violations for a resource based on the specified Firewall Manager policy and Amazon Web Services
11
+ * account.</p>
11
12
  * @example
12
13
  * Use a bare-bones client and the command you need to make an API call.
13
14
  * ```javascript
@@ -8,8 +8,8 @@ export interface ListComplianceStatusCommandOutput extends ListComplianceStatusR
8
8
  }
9
9
  /**
10
10
  * <p>Returns an array of <code>PolicyComplianceStatus</code> objects. Use
11
- * <code>PolicyComplianceStatus</code> to get a summary of which member accounts are protected
12
- * by the specified policy. </p>
11
+ * <code>PolicyComplianceStatus</code> to get a summary of which member accounts are
12
+ * protected by the specified policy. </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,9 +8,9 @@ export interface ListMemberAccountsCommandOutput extends ListMemberAccountsRespo
8
8
  }
9
9
  /**
10
10
  * <p>Returns a <code>MemberAccounts</code> object that lists the member accounts in the
11
- * administrator's Amazon Web Services organization.</p>
11
+ * administrator's Amazon Web Services organization.</p>
12
12
  * <p>The <code>ListMemberAccounts</code> must be submitted by the account that is set as the
13
- * Firewall Manager administrator.</p>
13
+ * Firewall Manager administrator.</p>
14
14
  * @example
15
15
  * Use a bare-bones client and the command you need to make an API call.
16
16
  * ```javascript
@@ -7,7 +7,7 @@ export interface ListTagsForResourceCommandInput extends ListTagsForResourceRequ
7
7
  export interface ListTagsForResourceCommandOutput extends ListTagsForResourceResponse, __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Retrieves the list of tags for the specified Amazon Web Services resource. </p>
10
+ * <p>Retrieves the list of tags for the specified Amazon Web Services resource. </p>
11
11
  * @example
12
12
  * Use a bare-bones client and the command you need to make an API call.
13
13
  * ```javascript
@@ -7,11 +7,12 @@ export interface PutNotificationChannelCommandInput extends PutNotificationChann
7
7
  export interface PutNotificationChannelCommandOutput extends __MetadataBearer {
8
8
  }
9
9
  /**
10
- * <p>Designates the IAM role and Amazon Simple Notification Service (SNS) topic that
11
- * Firewall Manager uses to record SNS logs.</p>
12
- * <p>To perform this action outside of the console, you must configure the SNS topic to allow the Firewall Manager
13
- * role <code>AWSServiceRoleForFMS</code> to publish SNS logs. For more information, see
14
- * <a href="https://docs.aws.amazon.com/waf/latest/developerguide/fms-api-permissions-ref.html">Firewall Manager required permissions for API actions</a> in the <i>Firewall Manager Developer Guide</i>.</p>
10
+ * <p>Designates the IAM role and Amazon Simple Notification Service (SNS) topic that Firewall Manager
11
+ * uses to record SNS logs.</p>
12
+ * <p>To perform this action outside of the console, you must configure the SNS topic to allow
13
+ * the Firewall Manager role <code>AWSServiceRoleForFMS</code> to publish SNS logs. For more information,
14
+ * see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/fms-api-permissions-ref.html">Firewall Manager required permissions
15
+ * for API actions</a> in the <i>Firewall Manager Developer Guide</i>.</p>
15
16
  * @example
16
17
  * Use a bare-bones client and the command you need to make an API call.
17
18
  * ```javascript
@@ -12,34 +12,33 @@ export interface PutPolicyCommandOutput extends PutPolicyResponse, __MetadataBea
12
12
  * <ul>
13
13
  * <li>
14
14
  * <p>An WAF policy (type WAFV2), which defines rule groups to run first in the
15
- * corresponding WAF web ACL and rule groups to run last in the web ACL.</p>
15
+ * corresponding WAF web ACL and rule groups to run last in the web ACL.</p>
16
16
  * </li>
17
17
  * <li>
18
18
  * <p>An WAF Classic policy (type WAF), which defines a rule group. </p>
19
19
  * </li>
20
20
  * <li>
21
21
  * <p>A Shield Advanced policy, which applies Shield Advanced protection to specified
22
- * accounts and resources.</p>
22
+ * accounts and resources.</p>
23
23
  * </li>
24
24
  * <li>
25
25
  * <p>A security group policy, which manages VPC security groups across your Amazon Web Services
26
- * organization. </p>
26
+ * organization. </p>
27
27
  * </li>
28
28
  * <li>
29
- * <p>An Network Firewall policy, which provides firewall rules to filter network traffic in specified
30
- * Amazon VPCs.</p>
29
+ * <p>An Network Firewall policy, which provides firewall rules to filter network traffic in
30
+ * specified Amazon VPCs.</p>
31
31
  * </li>
32
32
  * <li>
33
- * <p>A DNS Firewall policy, which provides Route 53 Resolver DNS Firewall rules to filter DNS queries for
34
- * specified VPCs.</p>
33
+ * <p>A DNS Firewall policy, which provides Route 53 Resolver DNS Firewall rules to filter DNS
34
+ * queries for specified VPCs.</p>
35
35
  * </li>
36
36
  * </ul>
37
- * <p>Each policy is specific to one of the types. If you want to enforce more than one
38
- * policy type across accounts, create multiple policies. You can create multiple
39
- * policies for each type.</p>
37
+ * <p>Each policy is specific to one of the types. If you want to enforce more than one policy
38
+ * type across accounts, create multiple policies. You can create multiple policies for each
39
+ * type.</p>
40
40
  * <p>You must be subscribed to Shield Advanced to create a Shield Advanced policy. For more
41
- * information about subscribing to Shield Advanced, see
42
- * <a href="https://docs.aws.amazon.com/waf/latest/DDOSAPIReference/API_CreateSubscription.html">CreateSubscription</a>.</p>
41
+ * information about subscribing to Shield Advanced, see <a href="https://docs.aws.amazon.com/waf/latest/DDOSAPIReference/API_CreateSubscription.html">CreateSubscription</a>.</p>
43
42
  * @example
44
43
  * Use a bare-bones client and the command you need to make an API call.
45
44
  * ```javascript
@@ -3,3 +3,4 @@ export * from "./FMSClient";
3
3
  export * from "./commands";
4
4
  export * from "./models";
5
5
  export * from "./pagination";
6
+ export { FMSServiceException } from "./models/FMSServiceException";
@@ -0,0 +1,10 @@
1
+ import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
2
+ /**
3
+ * Base exception class for all service exceptions from FMS service.
4
+ */
5
+ export declare class FMSServiceException extends __ServiceException {
6
+ /**
7
+ * @internal
8
+ */
9
+ constructor(options: __ServiceExceptionOptions);
10
+ }