@aws-sdk/client-network-firewall 3.295.0 → 3.297.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 (41) hide show
  1. package/dist-types/NetworkFirewall.d.ts +32 -0
  2. package/dist-types/NetworkFirewallClient.d.ts +24 -4
  3. package/dist-types/commands/AssociateFirewallPolicyCommand.d.ts +16 -0
  4. package/dist-types/commands/AssociateSubnetsCommand.d.ts +16 -0
  5. package/dist-types/commands/CreateFirewallCommand.d.ts +16 -0
  6. package/dist-types/commands/CreateFirewallPolicyCommand.d.ts +16 -0
  7. package/dist-types/commands/CreateRuleGroupCommand.d.ts +16 -0
  8. package/dist-types/commands/DeleteFirewallCommand.d.ts +16 -0
  9. package/dist-types/commands/DeleteFirewallPolicyCommand.d.ts +16 -0
  10. package/dist-types/commands/DeleteResourcePolicyCommand.d.ts +16 -0
  11. package/dist-types/commands/DeleteRuleGroupCommand.d.ts +16 -0
  12. package/dist-types/commands/DescribeFirewallCommand.d.ts +16 -0
  13. package/dist-types/commands/DescribeFirewallPolicyCommand.d.ts +16 -0
  14. package/dist-types/commands/DescribeLoggingConfigurationCommand.d.ts +16 -0
  15. package/dist-types/commands/DescribeResourcePolicyCommand.d.ts +16 -0
  16. package/dist-types/commands/DescribeRuleGroupCommand.d.ts +16 -0
  17. package/dist-types/commands/DescribeRuleGroupMetadataCommand.d.ts +16 -0
  18. package/dist-types/commands/DisassociateSubnetsCommand.d.ts +16 -0
  19. package/dist-types/commands/ListFirewallPoliciesCommand.d.ts +16 -0
  20. package/dist-types/commands/ListFirewallsCommand.d.ts +16 -0
  21. package/dist-types/commands/ListRuleGroupsCommand.d.ts +16 -0
  22. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  23. package/dist-types/commands/PutResourcePolicyCommand.d.ts +16 -0
  24. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  25. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  26. package/dist-types/commands/UpdateFirewallDeleteProtectionCommand.d.ts +16 -0
  27. package/dist-types/commands/UpdateFirewallDescriptionCommand.d.ts +16 -0
  28. package/dist-types/commands/UpdateFirewallEncryptionConfigurationCommand.d.ts +16 -0
  29. package/dist-types/commands/UpdateFirewallPolicyChangeProtectionCommand.d.ts +16 -0
  30. package/dist-types/commands/UpdateFirewallPolicyCommand.d.ts +16 -0
  31. package/dist-types/commands/UpdateLoggingConfigurationCommand.d.ts +16 -0
  32. package/dist-types/commands/UpdateRuleGroupCommand.d.ts +16 -0
  33. package/dist-types/commands/UpdateSubnetChangeProtectionCommand.d.ts +16 -0
  34. package/dist-types/models/NetworkFirewallServiceException.d.ts +2 -0
  35. package/dist-types/models/models_0.d.ts +313 -5
  36. package/dist-types/pagination/Interfaces.d.ts +3 -0
  37. package/dist-types/pagination/ListFirewallPoliciesPaginator.d.ts +3 -0
  38. package/dist-types/pagination/ListFirewallsPaginator.d.ts +3 -0
  39. package/dist-types/pagination/ListRuleGroupsPaginator.d.ts +3 -0
  40. package/dist-types/pagination/ListTagsForResourcePaginator.d.ts +3 -0
  41. package/package.json +29 -29
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteFirewallPolicyRequest, DeleteFirewallPolicyResponse } from "../models/models_0";
5
5
  import { NetworkFirewallClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NetworkFirewallClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteFirewallPolicyCommand}.
8
10
  */
9
11
  export interface DeleteFirewallPolicyCommandInput extends DeleteFirewallPolicyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteFirewallPolicyCommand}.
13
17
  */
14
18
  export interface DeleteFirewallPolicyCommandOutput extends DeleteFirewallPolicyResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the specified <a>FirewallPolicy</a>. </p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteFirewallPolicyCommandOutput extends DeleteFirewallPolicyR
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteFirewallPolicyCommandInput - {@link DeleteFirewallPolicyCommandInput}
34
+ * @returns {@link DeleteFirewallPolicyCommandOutput}
28
35
  * @see {@link DeleteFirewallPolicyCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteFirewallPolicyCommandOutput} for command's `response` shape.
30
37
  * @see {@link NetworkFirewallClientResolvedConfig | config} for NetworkFirewallClient's `config` shape.
@@ -67,11 +74,20 @@ export interface DeleteFirewallPolicyCommandOutput extends DeleteFirewallPolicyR
67
74
  export declare class DeleteFirewallPolicyCommand extends $Command<DeleteFirewallPolicyCommandInput, DeleteFirewallPolicyCommandOutput, NetworkFirewallClientResolvedConfig> {
68
75
  readonly input: DeleteFirewallPolicyCommandInput;
69
76
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
77
+ /**
78
+ * @public
79
+ */
70
80
  constructor(input: DeleteFirewallPolicyCommandInput);
71
81
  /**
72
82
  * @internal
73
83
  */
74
84
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: NetworkFirewallClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteFirewallPolicyCommandInput, DeleteFirewallPolicyCommandOutput>;
85
+ /**
86
+ * @internal
87
+ */
75
88
  private serialize;
89
+ /**
90
+ * @internal
91
+ */
76
92
  private deserialize;
77
93
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteResourcePolicyRequest, DeleteResourcePolicyResponse } from "../models/models_0";
5
5
  import { NetworkFirewallClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NetworkFirewallClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteResourcePolicyCommand}.
8
10
  */
9
11
  export interface DeleteResourcePolicyCommandInput extends DeleteResourcePolicyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteResourcePolicyCommand}.
13
17
  */
14
18
  export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes a resource policy that you created in a <a>PutResourcePolicy</a> request. </p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyR
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteResourcePolicyCommandInput - {@link DeleteResourcePolicyCommandInput}
34
+ * @returns {@link DeleteResourcePolicyCommandOutput}
28
35
  * @see {@link DeleteResourcePolicyCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteResourcePolicyCommandOutput} for command's `response` shape.
30
37
  * @see {@link NetworkFirewallClientResolvedConfig | config} for NetworkFirewallClient's `config` shape.
@@ -63,11 +70,20 @@ export interface DeleteResourcePolicyCommandOutput extends DeleteResourcePolicyR
63
70
  export declare class DeleteResourcePolicyCommand extends $Command<DeleteResourcePolicyCommandInput, DeleteResourcePolicyCommandOutput, NetworkFirewallClientResolvedConfig> {
64
71
  readonly input: DeleteResourcePolicyCommandInput;
65
72
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
73
+ /**
74
+ * @public
75
+ */
66
76
  constructor(input: DeleteResourcePolicyCommandInput);
67
77
  /**
68
78
  * @internal
69
79
  */
70
80
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: NetworkFirewallClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteResourcePolicyCommandInput, DeleteResourcePolicyCommandOutput>;
81
+ /**
82
+ * @internal
83
+ */
71
84
  private serialize;
85
+ /**
86
+ * @internal
87
+ */
72
88
  private deserialize;
73
89
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DeleteRuleGroupRequest, DeleteRuleGroupResponse } from "../models/models_0";
5
5
  import { NetworkFirewallClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NetworkFirewallClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DeleteRuleGroupCommand}.
8
10
  */
9
11
  export interface DeleteRuleGroupCommandInput extends DeleteRuleGroupRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DeleteRuleGroupCommand}.
13
17
  */
14
18
  export interface DeleteRuleGroupCommandOutput extends DeleteRuleGroupResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Deletes the specified <a>RuleGroup</a>. </p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DeleteRuleGroupCommandOutput extends DeleteRuleGroupResponse, _
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DeleteRuleGroupCommandInput - {@link DeleteRuleGroupCommandInput}
34
+ * @returns {@link DeleteRuleGroupCommandOutput}
28
35
  * @see {@link DeleteRuleGroupCommandInput} for command's `input` shape.
29
36
  * @see {@link DeleteRuleGroupCommandOutput} for command's `response` shape.
30
37
  * @see {@link NetworkFirewallClientResolvedConfig | config} for NetworkFirewallClient's `config` shape.
@@ -67,11 +74,20 @@ export interface DeleteRuleGroupCommandOutput extends DeleteRuleGroupResponse, _
67
74
  export declare class DeleteRuleGroupCommand extends $Command<DeleteRuleGroupCommandInput, DeleteRuleGroupCommandOutput, NetworkFirewallClientResolvedConfig> {
68
75
  readonly input: DeleteRuleGroupCommandInput;
69
76
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
77
+ /**
78
+ * @public
79
+ */
70
80
  constructor(input: DeleteRuleGroupCommandInput);
71
81
  /**
72
82
  * @internal
73
83
  */
74
84
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: NetworkFirewallClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeleteRuleGroupCommandInput, DeleteRuleGroupCommandOutput>;
85
+ /**
86
+ * @internal
87
+ */
75
88
  private serialize;
89
+ /**
90
+ * @internal
91
+ */
76
92
  private deserialize;
77
93
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeFirewallRequest, DescribeFirewallResponse } from "../models/models_0";
5
5
  import { NetworkFirewallClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NetworkFirewallClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeFirewallCommand}.
8
10
  */
9
11
  export interface DescribeFirewallCommandInput extends DescribeFirewallRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeFirewallCommand}.
13
17
  */
14
18
  export interface DescribeFirewallCommandOutput extends DescribeFirewallResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the data objects for the specified firewall. </p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeFirewallCommandOutput extends DescribeFirewallResponse,
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeFirewallCommandInput - {@link DescribeFirewallCommandInput}
34
+ * @returns {@link DescribeFirewallCommandOutput}
28
35
  * @see {@link DescribeFirewallCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeFirewallCommandOutput} for command's `response` shape.
30
37
  * @see {@link NetworkFirewallClientResolvedConfig | config} for NetworkFirewallClient's `config` shape.
@@ -60,11 +67,20 @@ export interface DescribeFirewallCommandOutput extends DescribeFirewallResponse,
60
67
  export declare class DescribeFirewallCommand extends $Command<DescribeFirewallCommandInput, DescribeFirewallCommandOutput, NetworkFirewallClientResolvedConfig> {
61
68
  readonly input: DescribeFirewallCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: DescribeFirewallCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: NetworkFirewallClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeFirewallCommandInput, DescribeFirewallCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeFirewallPolicyRequest, DescribeFirewallPolicyResponse } from "../models/models_0";
5
5
  import { NetworkFirewallClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NetworkFirewallClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeFirewallPolicyCommand}.
8
10
  */
9
11
  export interface DescribeFirewallPolicyCommandInput extends DescribeFirewallPolicyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeFirewallPolicyCommand}.
13
17
  */
14
18
  export interface DescribeFirewallPolicyCommandOutput extends DescribeFirewallPolicyResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the data objects for the specified firewall policy. </p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeFirewallPolicyCommandOutput extends DescribeFirewallPol
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeFirewallPolicyCommandInput - {@link DescribeFirewallPolicyCommandInput}
34
+ * @returns {@link DescribeFirewallPolicyCommandOutput}
28
35
  * @see {@link DescribeFirewallPolicyCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeFirewallPolicyCommandOutput} for command's `response` shape.
30
37
  * @see {@link NetworkFirewallClientResolvedConfig | config} for NetworkFirewallClient's `config` shape.
@@ -60,11 +67,20 @@ export interface DescribeFirewallPolicyCommandOutput extends DescribeFirewallPol
60
67
  export declare class DescribeFirewallPolicyCommand extends $Command<DescribeFirewallPolicyCommandInput, DescribeFirewallPolicyCommandOutput, NetworkFirewallClientResolvedConfig> {
61
68
  readonly input: DescribeFirewallPolicyCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: DescribeFirewallPolicyCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: NetworkFirewallClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeFirewallPolicyCommandInput, DescribeFirewallPolicyCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeLoggingConfigurationRequest, DescribeLoggingConfigurationResponse } from "../models/models_0";
5
5
  import { NetworkFirewallClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NetworkFirewallClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeLoggingConfigurationCommand}.
8
10
  */
9
11
  export interface DescribeLoggingConfigurationCommandInput extends DescribeLoggingConfigurationRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeLoggingConfigurationCommand}.
13
17
  */
14
18
  export interface DescribeLoggingConfigurationCommandOutput extends DescribeLoggingConfigurationResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the logging configuration for the specified firewall. </p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeLoggingConfigurationCommandOutput extends DescribeLoggi
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeLoggingConfigurationCommandInput - {@link DescribeLoggingConfigurationCommandInput}
34
+ * @returns {@link DescribeLoggingConfigurationCommandOutput}
28
35
  * @see {@link DescribeLoggingConfigurationCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeLoggingConfigurationCommandOutput} for command's `response` shape.
30
37
  * @see {@link NetworkFirewallClientResolvedConfig | config} for NetworkFirewallClient's `config` shape.
@@ -60,11 +67,20 @@ export interface DescribeLoggingConfigurationCommandOutput extends DescribeLoggi
60
67
  export declare class DescribeLoggingConfigurationCommand extends $Command<DescribeLoggingConfigurationCommandInput, DescribeLoggingConfigurationCommandOutput, NetworkFirewallClientResolvedConfig> {
61
68
  readonly input: DescribeLoggingConfigurationCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: DescribeLoggingConfigurationCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: NetworkFirewallClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeLoggingConfigurationCommandInput, DescribeLoggingConfigurationCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeResourcePolicyRequest, DescribeResourcePolicyResponse } from "../models/models_0";
5
5
  import { NetworkFirewallClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NetworkFirewallClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeResourcePolicyCommand}.
8
10
  */
9
11
  export interface DescribeResourcePolicyCommandInput extends DescribeResourcePolicyRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeResourcePolicyCommand}.
13
17
  */
14
18
  export interface DescribeResourcePolicyCommandOutput extends DescribeResourcePolicyResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves a resource policy that you created in a <a>PutResourcePolicy</a> request. </p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeResourcePolicyCommandOutput extends DescribeResourcePol
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeResourcePolicyCommandInput - {@link DescribeResourcePolicyCommandInput}
34
+ * @returns {@link DescribeResourcePolicyCommandOutput}
28
35
  * @see {@link DescribeResourcePolicyCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeResourcePolicyCommandOutput} for command's `response` shape.
30
37
  * @see {@link NetworkFirewallClientResolvedConfig | config} for NetworkFirewallClient's `config` shape.
@@ -60,11 +67,20 @@ export interface DescribeResourcePolicyCommandOutput extends DescribeResourcePol
60
67
  export declare class DescribeResourcePolicyCommand extends $Command<DescribeResourcePolicyCommandInput, DescribeResourcePolicyCommandOutput, NetworkFirewallClientResolvedConfig> {
61
68
  readonly input: DescribeResourcePolicyCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: DescribeResourcePolicyCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: NetworkFirewallClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeResourcePolicyCommandInput, DescribeResourcePolicyCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeRuleGroupRequest, DescribeRuleGroupResponse } from "../models/models_0";
5
5
  import { NetworkFirewallClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NetworkFirewallClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeRuleGroupCommand}.
8
10
  */
9
11
  export interface DescribeRuleGroupCommandInput extends DescribeRuleGroupRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeRuleGroupCommand}.
13
17
  */
14
18
  export interface DescribeRuleGroupCommandOutput extends DescribeRuleGroupResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Returns the data objects for the specified rule group. </p>
18
23
  * @example
19
24
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface DescribeRuleGroupCommandOutput extends DescribeRuleGroupRespons
25
30
  * const response = await client.send(command);
26
31
  * ```
27
32
  *
33
+ * @param DescribeRuleGroupCommandInput - {@link DescribeRuleGroupCommandInput}
34
+ * @returns {@link DescribeRuleGroupCommandOutput}
28
35
  * @see {@link DescribeRuleGroupCommandInput} for command's `input` shape.
29
36
  * @see {@link DescribeRuleGroupCommandOutput} for command's `response` shape.
30
37
  * @see {@link NetworkFirewallClientResolvedConfig | config} for NetworkFirewallClient's `config` shape.
@@ -60,11 +67,20 @@ export interface DescribeRuleGroupCommandOutput extends DescribeRuleGroupRespons
60
67
  export declare class DescribeRuleGroupCommand extends $Command<DescribeRuleGroupCommandInput, DescribeRuleGroupCommandOutput, NetworkFirewallClientResolvedConfig> {
61
68
  readonly input: DescribeRuleGroupCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: DescribeRuleGroupCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: NetworkFirewallClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeRuleGroupCommandInput, DescribeRuleGroupCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DescribeRuleGroupMetadataRequest, DescribeRuleGroupMetadataResponse } from "../models/models_0";
5
5
  import { NetworkFirewallClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NetworkFirewallClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DescribeRuleGroupMetadataCommand}.
8
10
  */
9
11
  export interface DescribeRuleGroupMetadataCommandInput extends DescribeRuleGroupMetadataRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DescribeRuleGroupMetadataCommand}.
13
17
  */
14
18
  export interface DescribeRuleGroupMetadataCommandOutput extends DescribeRuleGroupMetadataResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>High-level information about a rule group, returned by operations like create and describe.
18
23
  * You can use the information provided in the metadata to retrieve and manage a rule group.
19
24
  * You can retrieve all objects for a rule group by calling <a>DescribeRuleGroup</a>.
@@ -28,6 +33,8 @@ export interface DescribeRuleGroupMetadataCommandOutput extends DescribeRuleGrou
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DescribeRuleGroupMetadataCommandInput - {@link DescribeRuleGroupMetadataCommandInput}
37
+ * @returns {@link DescribeRuleGroupMetadataCommandOutput}
31
38
  * @see {@link DescribeRuleGroupMetadataCommandInput} for command's `input` shape.
32
39
  * @see {@link DescribeRuleGroupMetadataCommandOutput} for command's `response` shape.
33
40
  * @see {@link NetworkFirewallClientResolvedConfig | config} for NetworkFirewallClient's `config` shape.
@@ -63,11 +70,20 @@ export interface DescribeRuleGroupMetadataCommandOutput extends DescribeRuleGrou
63
70
  export declare class DescribeRuleGroupMetadataCommand extends $Command<DescribeRuleGroupMetadataCommandInput, DescribeRuleGroupMetadataCommandOutput, NetworkFirewallClientResolvedConfig> {
64
71
  readonly input: DescribeRuleGroupMetadataCommandInput;
65
72
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
73
+ /**
74
+ * @public
75
+ */
66
76
  constructor(input: DescribeRuleGroupMetadataCommandInput);
67
77
  /**
68
78
  * @internal
69
79
  */
70
80
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: NetworkFirewallClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeRuleGroupMetadataCommandInput, DescribeRuleGroupMetadataCommandOutput>;
81
+ /**
82
+ * @internal
83
+ */
71
84
  private serialize;
85
+ /**
86
+ * @internal
87
+ */
72
88
  private deserialize;
73
89
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { DisassociateSubnetsRequest, DisassociateSubnetsResponse } from "../models/models_0";
5
5
  import { NetworkFirewallClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NetworkFirewallClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link DisassociateSubnetsCommand}.
8
10
  */
9
11
  export interface DisassociateSubnetsCommandInput extends DisassociateSubnetsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link DisassociateSubnetsCommand}.
13
17
  */
14
18
  export interface DisassociateSubnetsCommandOutput extends DisassociateSubnetsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Removes the specified subnet associations from the firewall. This removes the
18
23
  * firewall endpoints from the subnets and removes any network filtering protections that the endpoints
19
24
  * were providing.
@@ -28,6 +33,8 @@ export interface DisassociateSubnetsCommandOutput extends DisassociateSubnetsRes
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param DisassociateSubnetsCommandInput - {@link DisassociateSubnetsCommandInput}
37
+ * @returns {@link DisassociateSubnetsCommandOutput}
31
38
  * @see {@link DisassociateSubnetsCommandInput} for command's `input` shape.
32
39
  * @see {@link DisassociateSubnetsCommandOutput} for command's `response` shape.
33
40
  * @see {@link NetworkFirewallClientResolvedConfig | config} for NetworkFirewallClient's `config` shape.
@@ -70,11 +77,20 @@ export interface DisassociateSubnetsCommandOutput extends DisassociateSubnetsRes
70
77
  export declare class DisassociateSubnetsCommand extends $Command<DisassociateSubnetsCommandInput, DisassociateSubnetsCommandOutput, NetworkFirewallClientResolvedConfig> {
71
78
  readonly input: DisassociateSubnetsCommandInput;
72
79
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
80
+ /**
81
+ * @public
82
+ */
73
83
  constructor(input: DisassociateSubnetsCommandInput);
74
84
  /**
75
85
  * @internal
76
86
  */
77
87
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: NetworkFirewallClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DisassociateSubnetsCommandInput, DisassociateSubnetsCommandOutput>;
88
+ /**
89
+ * @internal
90
+ */
78
91
  private serialize;
92
+ /**
93
+ * @internal
94
+ */
79
95
  private deserialize;
80
96
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListFirewallPoliciesRequest, ListFirewallPoliciesResponse } from "../models/models_0";
5
5
  import { NetworkFirewallClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NetworkFirewallClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListFirewallPoliciesCommand}.
8
10
  */
9
11
  export interface ListFirewallPoliciesCommandInput extends ListFirewallPoliciesRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListFirewallPoliciesCommand}.
13
17
  */
14
18
  export interface ListFirewallPoliciesCommandOutput extends ListFirewallPoliciesResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the metadata for the firewall policies that you have defined. Depending on
18
23
  * your setting for max results and the number of firewall policies, a single call might not
19
24
  * return the full list. </p>
@@ -27,6 +32,8 @@ export interface ListFirewallPoliciesCommandOutput extends ListFirewallPoliciesR
27
32
  * const response = await client.send(command);
28
33
  * ```
29
34
  *
35
+ * @param ListFirewallPoliciesCommandInput - {@link ListFirewallPoliciesCommandInput}
36
+ * @returns {@link ListFirewallPoliciesCommandOutput}
30
37
  * @see {@link ListFirewallPoliciesCommandInput} for command's `input` shape.
31
38
  * @see {@link ListFirewallPoliciesCommandOutput} for command's `response` shape.
32
39
  * @see {@link NetworkFirewallClientResolvedConfig | config} for NetworkFirewallClient's `config` shape.
@@ -59,11 +66,20 @@ export interface ListFirewallPoliciesCommandOutput extends ListFirewallPoliciesR
59
66
  export declare class ListFirewallPoliciesCommand extends $Command<ListFirewallPoliciesCommandInput, ListFirewallPoliciesCommandOutput, NetworkFirewallClientResolvedConfig> {
60
67
  readonly input: ListFirewallPoliciesCommandInput;
61
68
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
69
+ /**
70
+ * @public
71
+ */
62
72
  constructor(input: ListFirewallPoliciesCommandInput);
63
73
  /**
64
74
  * @internal
65
75
  */
66
76
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: NetworkFirewallClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListFirewallPoliciesCommandInput, ListFirewallPoliciesCommandOutput>;
77
+ /**
78
+ * @internal
79
+ */
67
80
  private serialize;
81
+ /**
82
+ * @internal
83
+ */
68
84
  private deserialize;
69
85
  }
@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
4
4
  import { ListFirewallsRequest, ListFirewallsResponse } from "../models/models_0";
5
5
  import { NetworkFirewallClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NetworkFirewallClient";
6
6
  /**
7
+ * @public
8
+ *
7
9
  * The input for {@link ListFirewallsCommand}.
8
10
  */
9
11
  export interface ListFirewallsCommandInput extends ListFirewallsRequest {
10
12
  }
11
13
  /**
14
+ * @public
15
+ *
12
16
  * The output of {@link ListFirewallsCommand}.
13
17
  */
14
18
  export interface ListFirewallsCommandOutput extends ListFirewallsResponse, __MetadataBearer {
15
19
  }
16
20
  /**
21
+ * @public
17
22
  * <p>Retrieves the metadata for the firewalls that you have defined. If you provide VPC
18
23
  * identifiers in your request, this returns only the firewalls for those VPCs.</p>
19
24
  * <p>Depending on your setting for max results and the number of firewalls, a single call
@@ -28,6 +33,8 @@ export interface ListFirewallsCommandOutput extends ListFirewallsResponse, __Met
28
33
  * const response = await client.send(command);
29
34
  * ```
30
35
  *
36
+ * @param ListFirewallsCommandInput - {@link ListFirewallsCommandInput}
37
+ * @returns {@link ListFirewallsCommandOutput}
31
38
  * @see {@link ListFirewallsCommandInput} for command's `input` shape.
32
39
  * @see {@link ListFirewallsCommandOutput} for command's `response` shape.
33
40
  * @see {@link NetworkFirewallClientResolvedConfig | config} for NetworkFirewallClient's `config` shape.
@@ -60,11 +67,20 @@ export interface ListFirewallsCommandOutput extends ListFirewallsResponse, __Met
60
67
  export declare class ListFirewallsCommand extends $Command<ListFirewallsCommandInput, ListFirewallsCommandOutput, NetworkFirewallClientResolvedConfig> {
61
68
  readonly input: ListFirewallsCommandInput;
62
69
  static getEndpointParameterInstructions(): EndpointParameterInstructions;
70
+ /**
71
+ * @public
72
+ */
63
73
  constructor(input: ListFirewallsCommandInput);
64
74
  /**
65
75
  * @internal
66
76
  */
67
77
  resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: NetworkFirewallClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListFirewallsCommandInput, ListFirewallsCommandOutput>;
78
+ /**
79
+ * @internal
80
+ */
68
81
  private serialize;
82
+ /**
83
+ * @internal
84
+ */
69
85
  private deserialize;
70
86
  }