@aws-sdk/client-network-firewall 3.758.0 → 3.774.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +40 -0
- package/dist-cjs/index.js +284 -29
- package/dist-es/NetworkFirewall.js +10 -0
- package/dist-es/commands/DescribeFlowOperationCommand.js +22 -0
- package/dist-es/commands/ListFlowOperationResultsCommand.js +22 -0
- package/dist-es/commands/ListFlowOperationsCommand.js +22 -0
- package/dist-es/commands/StartFlowCaptureCommand.js +22 -0
- package/dist-es/commands/StartFlowFlushCommand.js +22 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/models/models_0.js +10 -0
- package/dist-es/pagination/ListFlowOperationResultsPaginator.js +4 -0
- package/dist-es/pagination/ListFlowOperationsPaginator.js +4 -0
- package/dist-es/pagination/index.js +2 -0
- package/dist-es/protocols/Aws_json1_0.js +141 -0
- package/dist-types/NetworkFirewall.d.ts +35 -0
- package/dist-types/NetworkFirewallClient.d.ts +7 -2
- package/dist-types/commands/DescribeFlowOperationCommand.d.ts +123 -0
- package/dist-types/commands/ListFlowOperationResultsCommand.d.ts +126 -0
- package/dist-types/commands/ListFlowOperationsCommand.d.ts +113 -0
- package/dist-types/commands/StartFlowCaptureCommand.d.ts +124 -0
- package/dist-types/commands/StartFlowFlushCommand.d.ts +123 -0
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/models/models_0.d.ts +497 -20
- package/dist-types/pagination/ListFlowOperationResultsPaginator.d.ts +7 -0
- package/dist-types/pagination/ListFlowOperationsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +2 -0
- package/dist-types/protocols/Aws_json1_0.d.ts +45 -0
- package/dist-types/ts3.4/NetworkFirewall.d.ts +85 -0
- package/dist-types/ts3.4/NetworkFirewallClient.d.ts +30 -0
- package/dist-types/ts3.4/commands/DescribeFlowOperationCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListFlowOperationResultsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/ListFlowOperationsCommand.d.ts +51 -0
- package/dist-types/ts3.4/commands/StartFlowCaptureCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/StartFlowFlushCommand.d.ts +50 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/models/models_0.d.ts +106 -0
- package/dist-types/ts3.4/pagination/ListFlowOperationResultsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/ListFlowOperationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +2 -0
- package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +60 -0
- package/package.json +7 -7
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ListFlowOperationResultsRequest, ListFlowOperationResultsResponse } from "../models/models_0";
|
|
4
|
+
import { NetworkFirewallClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NetworkFirewallClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListFlowOperationResultsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListFlowOperationResultsCommandInput extends ListFlowOperationResultsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListFlowOperationResultsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListFlowOperationResultsCommandOutput extends ListFlowOperationResultsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListFlowOperationResultsCommand_base: {
|
|
25
|
+
new (input: ListFlowOperationResultsCommandInput): import("@smithy/smithy-client").CommandImpl<ListFlowOperationResultsCommandInput, ListFlowOperationResultsCommandOutput, NetworkFirewallClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: ListFlowOperationResultsCommandInput): import("@smithy/smithy-client").CommandImpl<ListFlowOperationResultsCommandInput, ListFlowOperationResultsCommandOutput, NetworkFirewallClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Returns the results of a specific flow operation. </p>
|
|
31
|
+
* <p>Flow operations let you manage the flows tracked in the flow table, also known as the firewall table.</p>
|
|
32
|
+
* <p>A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules.
|
|
33
|
+
* For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort. </p>
|
|
34
|
+
* @example
|
|
35
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
36
|
+
* ```javascript
|
|
37
|
+
* import { NetworkFirewallClient, ListFlowOperationResultsCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import
|
|
38
|
+
* // const { NetworkFirewallClient, ListFlowOperationResultsCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import
|
|
39
|
+
* const client = new NetworkFirewallClient(config);
|
|
40
|
+
* const input = { // ListFlowOperationResultsRequest
|
|
41
|
+
* FirewallArn: "STRING_VALUE", // required
|
|
42
|
+
* FlowOperationId: "STRING_VALUE", // required
|
|
43
|
+
* NextToken: "STRING_VALUE",
|
|
44
|
+
* MaxResults: Number("int"),
|
|
45
|
+
* AvailabilityZone: "STRING_VALUE",
|
|
46
|
+
* };
|
|
47
|
+
* const command = new ListFlowOperationResultsCommand(input);
|
|
48
|
+
* const response = await client.send(command);
|
|
49
|
+
* // { // ListFlowOperationResultsResponse
|
|
50
|
+
* // FirewallArn: "STRING_VALUE",
|
|
51
|
+
* // AvailabilityZone: "STRING_VALUE",
|
|
52
|
+
* // FlowOperationId: "STRING_VALUE",
|
|
53
|
+
* // FlowOperationStatus: "COMPLETED" || "IN_PROGRESS" || "FAILED" || "COMPLETED_WITH_ERRORS",
|
|
54
|
+
* // StatusMessage: "STRING_VALUE",
|
|
55
|
+
* // FlowRequestTimestamp: new Date("TIMESTAMP"),
|
|
56
|
+
* // Flows: [ // Flows
|
|
57
|
+
* // { // Flow
|
|
58
|
+
* // SourceAddress: { // Address
|
|
59
|
+
* // AddressDefinition: "STRING_VALUE", // required
|
|
60
|
+
* // },
|
|
61
|
+
* // DestinationAddress: {
|
|
62
|
+
* // AddressDefinition: "STRING_VALUE", // required
|
|
63
|
+
* // },
|
|
64
|
+
* // SourcePort: "STRING_VALUE",
|
|
65
|
+
* // DestinationPort: "STRING_VALUE",
|
|
66
|
+
* // Protocol: "STRING_VALUE",
|
|
67
|
+
* // Age: Number("int"),
|
|
68
|
+
* // PacketCount: Number("int"),
|
|
69
|
+
* // ByteCount: Number("long"),
|
|
70
|
+
* // },
|
|
71
|
+
* // ],
|
|
72
|
+
* // NextToken: "STRING_VALUE",
|
|
73
|
+
* // };
|
|
74
|
+
*
|
|
75
|
+
* ```
|
|
76
|
+
*
|
|
77
|
+
* @param ListFlowOperationResultsCommandInput - {@link ListFlowOperationResultsCommandInput}
|
|
78
|
+
* @returns {@link ListFlowOperationResultsCommandOutput}
|
|
79
|
+
* @see {@link ListFlowOperationResultsCommandInput} for command's `input` shape.
|
|
80
|
+
* @see {@link ListFlowOperationResultsCommandOutput} for command's `response` shape.
|
|
81
|
+
* @see {@link NetworkFirewallClientResolvedConfig | config} for NetworkFirewallClient's `config` shape.
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link InternalServerError} (server fault)
|
|
84
|
+
* <p>Your request is valid, but Network Firewall couldn't perform the operation because of a
|
|
85
|
+
* system problem. Retry your request. </p>
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
88
|
+
* <p>The operation failed because of a problem with your request. Examples include: </p>
|
|
89
|
+
* <ul>
|
|
90
|
+
* <li>
|
|
91
|
+
* <p>You specified an unsupported parameter name or value.</p>
|
|
92
|
+
* </li>
|
|
93
|
+
* <li>
|
|
94
|
+
* <p>You tried to update a property with a value that isn't among the available
|
|
95
|
+
* types.</p>
|
|
96
|
+
* </li>
|
|
97
|
+
* <li>
|
|
98
|
+
* <p>Your request references an ARN that is malformed, or corresponds to a resource
|
|
99
|
+
* that isn't valid in the context of the request.</p>
|
|
100
|
+
* </li>
|
|
101
|
+
* </ul>
|
|
102
|
+
*
|
|
103
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
104
|
+
* <p>Unable to locate a resource using the parameters that you provided.</p>
|
|
105
|
+
*
|
|
106
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
107
|
+
* <p>Unable to process the request due to throttling limitations.</p>
|
|
108
|
+
*
|
|
109
|
+
* @throws {@link NetworkFirewallServiceException}
|
|
110
|
+
* <p>Base exception class for all service exceptions from NetworkFirewall service.</p>
|
|
111
|
+
*
|
|
112
|
+
* @public
|
|
113
|
+
*/
|
|
114
|
+
export declare class ListFlowOperationResultsCommand extends ListFlowOperationResultsCommand_base {
|
|
115
|
+
/** @internal type navigation helper, not in runtime. */
|
|
116
|
+
protected static __types: {
|
|
117
|
+
api: {
|
|
118
|
+
input: ListFlowOperationResultsRequest;
|
|
119
|
+
output: ListFlowOperationResultsResponse;
|
|
120
|
+
};
|
|
121
|
+
sdk: {
|
|
122
|
+
input: ListFlowOperationResultsCommandInput;
|
|
123
|
+
output: ListFlowOperationResultsCommandOutput;
|
|
124
|
+
};
|
|
125
|
+
};
|
|
126
|
+
}
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { ListFlowOperationsRequest, ListFlowOperationsResponse } from "../models/models_0";
|
|
4
|
+
import { NetworkFirewallClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NetworkFirewallClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link ListFlowOperationsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ListFlowOperationsCommandInput extends ListFlowOperationsRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ListFlowOperationsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ListFlowOperationsCommandOutput extends ListFlowOperationsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ListFlowOperationsCommand_base: {
|
|
25
|
+
new (input: ListFlowOperationsCommandInput): import("@smithy/smithy-client").CommandImpl<ListFlowOperationsCommandInput, ListFlowOperationsCommandOutput, NetworkFirewallClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: ListFlowOperationsCommandInput): import("@smithy/smithy-client").CommandImpl<ListFlowOperationsCommandInput, ListFlowOperationsCommandOutput, NetworkFirewallClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Returns a list of all flow operations ran in a specific firewall.
|
|
31
|
+
* You can optionally narrow the request scope by specifying the operation type or Availability Zone associated with a firewall's flow operations. </p>
|
|
32
|
+
* <p>Flow operations let you manage the flows tracked in the flow table, also known as the firewall table.</p>
|
|
33
|
+
* <p>A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules.
|
|
34
|
+
* For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort. </p>
|
|
35
|
+
* @example
|
|
36
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
37
|
+
* ```javascript
|
|
38
|
+
* import { NetworkFirewallClient, ListFlowOperationsCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import
|
|
39
|
+
* // const { NetworkFirewallClient, ListFlowOperationsCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import
|
|
40
|
+
* const client = new NetworkFirewallClient(config);
|
|
41
|
+
* const input = { // ListFlowOperationsRequest
|
|
42
|
+
* FirewallArn: "STRING_VALUE", // required
|
|
43
|
+
* AvailabilityZone: "STRING_VALUE",
|
|
44
|
+
* FlowOperationType: "FLOW_FLUSH" || "FLOW_CAPTURE",
|
|
45
|
+
* NextToken: "STRING_VALUE",
|
|
46
|
+
* MaxResults: Number("int"),
|
|
47
|
+
* };
|
|
48
|
+
* const command = new ListFlowOperationsCommand(input);
|
|
49
|
+
* const response = await client.send(command);
|
|
50
|
+
* // { // ListFlowOperationsResponse
|
|
51
|
+
* // FlowOperations: [ // FlowOperations
|
|
52
|
+
* // { // FlowOperationMetadata
|
|
53
|
+
* // FlowOperationId: "STRING_VALUE",
|
|
54
|
+
* // FlowOperationType: "FLOW_FLUSH" || "FLOW_CAPTURE",
|
|
55
|
+
* // FlowRequestTimestamp: new Date("TIMESTAMP"),
|
|
56
|
+
* // FlowOperationStatus: "COMPLETED" || "IN_PROGRESS" || "FAILED" || "COMPLETED_WITH_ERRORS",
|
|
57
|
+
* // },
|
|
58
|
+
* // ],
|
|
59
|
+
* // NextToken: "STRING_VALUE",
|
|
60
|
+
* // };
|
|
61
|
+
*
|
|
62
|
+
* ```
|
|
63
|
+
*
|
|
64
|
+
* @param ListFlowOperationsCommandInput - {@link ListFlowOperationsCommandInput}
|
|
65
|
+
* @returns {@link ListFlowOperationsCommandOutput}
|
|
66
|
+
* @see {@link ListFlowOperationsCommandInput} for command's `input` shape.
|
|
67
|
+
* @see {@link ListFlowOperationsCommandOutput} for command's `response` shape.
|
|
68
|
+
* @see {@link NetworkFirewallClientResolvedConfig | config} for NetworkFirewallClient's `config` shape.
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link InternalServerError} (server fault)
|
|
71
|
+
* <p>Your request is valid, but Network Firewall couldn't perform the operation because of a
|
|
72
|
+
* system problem. Retry your request. </p>
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
75
|
+
* <p>The operation failed because of a problem with your request. Examples include: </p>
|
|
76
|
+
* <ul>
|
|
77
|
+
* <li>
|
|
78
|
+
* <p>You specified an unsupported parameter name or value.</p>
|
|
79
|
+
* </li>
|
|
80
|
+
* <li>
|
|
81
|
+
* <p>You tried to update a property with a value that isn't among the available
|
|
82
|
+
* types.</p>
|
|
83
|
+
* </li>
|
|
84
|
+
* <li>
|
|
85
|
+
* <p>Your request references an ARN that is malformed, or corresponds to a resource
|
|
86
|
+
* that isn't valid in the context of the request.</p>
|
|
87
|
+
* </li>
|
|
88
|
+
* </ul>
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
91
|
+
* <p>Unable to locate a resource using the parameters that you provided.</p>
|
|
92
|
+
*
|
|
93
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
94
|
+
* <p>Unable to process the request due to throttling limitations.</p>
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link NetworkFirewallServiceException}
|
|
97
|
+
* <p>Base exception class for all service exceptions from NetworkFirewall service.</p>
|
|
98
|
+
*
|
|
99
|
+
* @public
|
|
100
|
+
*/
|
|
101
|
+
export declare class ListFlowOperationsCommand extends ListFlowOperationsCommand_base {
|
|
102
|
+
/** @internal type navigation helper, not in runtime. */
|
|
103
|
+
protected static __types: {
|
|
104
|
+
api: {
|
|
105
|
+
input: ListFlowOperationsRequest;
|
|
106
|
+
output: ListFlowOperationsResponse;
|
|
107
|
+
};
|
|
108
|
+
sdk: {
|
|
109
|
+
input: ListFlowOperationsCommandInput;
|
|
110
|
+
output: ListFlowOperationsCommandOutput;
|
|
111
|
+
};
|
|
112
|
+
};
|
|
113
|
+
}
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { StartFlowCaptureRequest, StartFlowCaptureResponse } from "../models/models_0";
|
|
4
|
+
import { NetworkFirewallClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NetworkFirewallClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link StartFlowCaptureCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface StartFlowCaptureCommandInput extends StartFlowCaptureRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link StartFlowCaptureCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface StartFlowCaptureCommandOutput extends StartFlowCaptureResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const StartFlowCaptureCommand_base: {
|
|
25
|
+
new (input: StartFlowCaptureCommandInput): import("@smithy/smithy-client").CommandImpl<StartFlowCaptureCommandInput, StartFlowCaptureCommandOutput, NetworkFirewallClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: StartFlowCaptureCommandInput): import("@smithy/smithy-client").CommandImpl<StartFlowCaptureCommandInput, StartFlowCaptureCommandOutput, NetworkFirewallClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Begins capturing the flows in a firewall, according to the filters you define.
|
|
31
|
+
* Captures are similar, but not identical to snapshots. Capture operations provide visibility into flows that are not closed and are tracked by a firewall's flow table.
|
|
32
|
+
* Unlike snapshots, captures are a time-boxed view. </p>
|
|
33
|
+
* <p>A flow is network traffic that is monitored by a firewall, either by stateful or stateless rules.
|
|
34
|
+
* For traffic to be considered part of a flow, it must share Destination, DestinationPort, Direction, Protocol, Source, and SourcePort. </p>
|
|
35
|
+
* <note>
|
|
36
|
+
* <p>To avoid encountering operation limits, you should avoid starting captures with broad filters, like wide IP ranges.
|
|
37
|
+
* Instead, we recommend you define more specific criteria with <code>FlowFilters</code>, like narrow IP ranges, ports, or protocols.</p>
|
|
38
|
+
* </note>
|
|
39
|
+
* @example
|
|
40
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
41
|
+
* ```javascript
|
|
42
|
+
* import { NetworkFirewallClient, StartFlowCaptureCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import
|
|
43
|
+
* // const { NetworkFirewallClient, StartFlowCaptureCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import
|
|
44
|
+
* const client = new NetworkFirewallClient(config);
|
|
45
|
+
* const input = { // StartFlowCaptureRequest
|
|
46
|
+
* FirewallArn: "STRING_VALUE", // required
|
|
47
|
+
* AvailabilityZone: "STRING_VALUE",
|
|
48
|
+
* MinimumFlowAgeInSeconds: Number("int"),
|
|
49
|
+
* FlowFilters: [ // FlowFilters // required
|
|
50
|
+
* { // FlowFilter
|
|
51
|
+
* SourceAddress: { // Address
|
|
52
|
+
* AddressDefinition: "STRING_VALUE", // required
|
|
53
|
+
* },
|
|
54
|
+
* DestinationAddress: {
|
|
55
|
+
* AddressDefinition: "STRING_VALUE", // required
|
|
56
|
+
* },
|
|
57
|
+
* SourcePort: "STRING_VALUE",
|
|
58
|
+
* DestinationPort: "STRING_VALUE",
|
|
59
|
+
* Protocols: [ // ProtocolStrings
|
|
60
|
+
* "STRING_VALUE",
|
|
61
|
+
* ],
|
|
62
|
+
* },
|
|
63
|
+
* ],
|
|
64
|
+
* };
|
|
65
|
+
* const command = new StartFlowCaptureCommand(input);
|
|
66
|
+
* const response = await client.send(command);
|
|
67
|
+
* // { // StartFlowCaptureResponse
|
|
68
|
+
* // FirewallArn: "STRING_VALUE",
|
|
69
|
+
* // FlowOperationId: "STRING_VALUE",
|
|
70
|
+
* // FlowOperationStatus: "COMPLETED" || "IN_PROGRESS" || "FAILED" || "COMPLETED_WITH_ERRORS",
|
|
71
|
+
* // };
|
|
72
|
+
*
|
|
73
|
+
* ```
|
|
74
|
+
*
|
|
75
|
+
* @param StartFlowCaptureCommandInput - {@link StartFlowCaptureCommandInput}
|
|
76
|
+
* @returns {@link StartFlowCaptureCommandOutput}
|
|
77
|
+
* @see {@link StartFlowCaptureCommandInput} for command's `input` shape.
|
|
78
|
+
* @see {@link StartFlowCaptureCommandOutput} for command's `response` shape.
|
|
79
|
+
* @see {@link NetworkFirewallClientResolvedConfig | config} for NetworkFirewallClient's `config` shape.
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link InternalServerError} (server fault)
|
|
82
|
+
* <p>Your request is valid, but Network Firewall couldn't perform the operation because of a
|
|
83
|
+
* system problem. Retry your request. </p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
86
|
+
* <p>The operation failed because of a problem with your request. Examples include: </p>
|
|
87
|
+
* <ul>
|
|
88
|
+
* <li>
|
|
89
|
+
* <p>You specified an unsupported parameter name or value.</p>
|
|
90
|
+
* </li>
|
|
91
|
+
* <li>
|
|
92
|
+
* <p>You tried to update a property with a value that isn't among the available
|
|
93
|
+
* types.</p>
|
|
94
|
+
* </li>
|
|
95
|
+
* <li>
|
|
96
|
+
* <p>Your request references an ARN that is malformed, or corresponds to a resource
|
|
97
|
+
* that isn't valid in the context of the request.</p>
|
|
98
|
+
* </li>
|
|
99
|
+
* </ul>
|
|
100
|
+
*
|
|
101
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
102
|
+
* <p>Unable to locate a resource using the parameters that you provided.</p>
|
|
103
|
+
*
|
|
104
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
105
|
+
* <p>Unable to process the request due to throttling limitations.</p>
|
|
106
|
+
*
|
|
107
|
+
* @throws {@link NetworkFirewallServiceException}
|
|
108
|
+
* <p>Base exception class for all service exceptions from NetworkFirewall service.</p>
|
|
109
|
+
*
|
|
110
|
+
* @public
|
|
111
|
+
*/
|
|
112
|
+
export declare class StartFlowCaptureCommand extends StartFlowCaptureCommand_base {
|
|
113
|
+
/** @internal type navigation helper, not in runtime. */
|
|
114
|
+
protected static __types: {
|
|
115
|
+
api: {
|
|
116
|
+
input: StartFlowCaptureRequest;
|
|
117
|
+
output: StartFlowCaptureResponse;
|
|
118
|
+
};
|
|
119
|
+
sdk: {
|
|
120
|
+
input: StartFlowCaptureCommandInput;
|
|
121
|
+
output: StartFlowCaptureCommandOutput;
|
|
122
|
+
};
|
|
123
|
+
};
|
|
124
|
+
}
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
2
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
3
|
+
import { StartFlowFlushRequest, StartFlowFlushResponse } from "../models/models_0";
|
|
4
|
+
import { NetworkFirewallClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../NetworkFirewallClient";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link StartFlowFlushCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface StartFlowFlushCommandInput extends StartFlowFlushRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link StartFlowFlushCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface StartFlowFlushCommandOutput extends StartFlowFlushResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const StartFlowFlushCommand_base: {
|
|
25
|
+
new (input: StartFlowFlushCommandInput): import("@smithy/smithy-client").CommandImpl<StartFlowFlushCommandInput, StartFlowFlushCommandOutput, NetworkFirewallClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: StartFlowFlushCommandInput): import("@smithy/smithy-client").CommandImpl<StartFlowFlushCommandInput, StartFlowFlushCommandOutput, NetworkFirewallClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* <p>Begins the flushing of traffic from the firewall, according to the filters you define.
|
|
31
|
+
* When the operation starts, impacted flows are temporarily marked as timed out before the Suricata engine prunes,
|
|
32
|
+
* or flushes, the flows from the firewall table.</p>
|
|
33
|
+
* <important>
|
|
34
|
+
* <p>While the flush completes, impacted flows are processed as midstream traffic. This may result in a
|
|
35
|
+
* temporary increase in midstream traffic metrics. We recommend that you double check your stream exception policy
|
|
36
|
+
* before you perform a flush operation.</p>
|
|
37
|
+
* </important>
|
|
38
|
+
* @example
|
|
39
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
40
|
+
* ```javascript
|
|
41
|
+
* import { NetworkFirewallClient, StartFlowFlushCommand } from "@aws-sdk/client-network-firewall"; // ES Modules import
|
|
42
|
+
* // const { NetworkFirewallClient, StartFlowFlushCommand } = require("@aws-sdk/client-network-firewall"); // CommonJS import
|
|
43
|
+
* const client = new NetworkFirewallClient(config);
|
|
44
|
+
* const input = { // StartFlowFlushRequest
|
|
45
|
+
* FirewallArn: "STRING_VALUE", // required
|
|
46
|
+
* AvailabilityZone: "STRING_VALUE",
|
|
47
|
+
* MinimumFlowAgeInSeconds: Number("int"),
|
|
48
|
+
* FlowFilters: [ // FlowFilters // required
|
|
49
|
+
* { // FlowFilter
|
|
50
|
+
* SourceAddress: { // Address
|
|
51
|
+
* AddressDefinition: "STRING_VALUE", // required
|
|
52
|
+
* },
|
|
53
|
+
* DestinationAddress: {
|
|
54
|
+
* AddressDefinition: "STRING_VALUE", // required
|
|
55
|
+
* },
|
|
56
|
+
* SourcePort: "STRING_VALUE",
|
|
57
|
+
* DestinationPort: "STRING_VALUE",
|
|
58
|
+
* Protocols: [ // ProtocolStrings
|
|
59
|
+
* "STRING_VALUE",
|
|
60
|
+
* ],
|
|
61
|
+
* },
|
|
62
|
+
* ],
|
|
63
|
+
* };
|
|
64
|
+
* const command = new StartFlowFlushCommand(input);
|
|
65
|
+
* const response = await client.send(command);
|
|
66
|
+
* // { // StartFlowFlushResponse
|
|
67
|
+
* // FirewallArn: "STRING_VALUE",
|
|
68
|
+
* // FlowOperationId: "STRING_VALUE",
|
|
69
|
+
* // FlowOperationStatus: "COMPLETED" || "IN_PROGRESS" || "FAILED" || "COMPLETED_WITH_ERRORS",
|
|
70
|
+
* // };
|
|
71
|
+
*
|
|
72
|
+
* ```
|
|
73
|
+
*
|
|
74
|
+
* @param StartFlowFlushCommandInput - {@link StartFlowFlushCommandInput}
|
|
75
|
+
* @returns {@link StartFlowFlushCommandOutput}
|
|
76
|
+
* @see {@link StartFlowFlushCommandInput} for command's `input` shape.
|
|
77
|
+
* @see {@link StartFlowFlushCommandOutput} for command's `response` shape.
|
|
78
|
+
* @see {@link NetworkFirewallClientResolvedConfig | config} for NetworkFirewallClient's `config` shape.
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link InternalServerError} (server fault)
|
|
81
|
+
* <p>Your request is valid, but Network Firewall couldn't perform the operation because of a
|
|
82
|
+
* system problem. Retry your request. </p>
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link InvalidRequestException} (client fault)
|
|
85
|
+
* <p>The operation failed because of a problem with your request. Examples include: </p>
|
|
86
|
+
* <ul>
|
|
87
|
+
* <li>
|
|
88
|
+
* <p>You specified an unsupported parameter name or value.</p>
|
|
89
|
+
* </li>
|
|
90
|
+
* <li>
|
|
91
|
+
* <p>You tried to update a property with a value that isn't among the available
|
|
92
|
+
* types.</p>
|
|
93
|
+
* </li>
|
|
94
|
+
* <li>
|
|
95
|
+
* <p>Your request references an ARN that is malformed, or corresponds to a resource
|
|
96
|
+
* that isn't valid in the context of the request.</p>
|
|
97
|
+
* </li>
|
|
98
|
+
* </ul>
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link ResourceNotFoundException} (client fault)
|
|
101
|
+
* <p>Unable to locate a resource using the parameters that you provided.</p>
|
|
102
|
+
*
|
|
103
|
+
* @throws {@link ThrottlingException} (client fault)
|
|
104
|
+
* <p>Unable to process the request due to throttling limitations.</p>
|
|
105
|
+
*
|
|
106
|
+
* @throws {@link NetworkFirewallServiceException}
|
|
107
|
+
* <p>Base exception class for all service exceptions from NetworkFirewall service.</p>
|
|
108
|
+
*
|
|
109
|
+
* @public
|
|
110
|
+
*/
|
|
111
|
+
export declare class StartFlowFlushCommand extends StartFlowFlushCommand_base {
|
|
112
|
+
/** @internal type navigation helper, not in runtime. */
|
|
113
|
+
protected static __types: {
|
|
114
|
+
api: {
|
|
115
|
+
input: StartFlowFlushRequest;
|
|
116
|
+
output: StartFlowFlushResponse;
|
|
117
|
+
};
|
|
118
|
+
sdk: {
|
|
119
|
+
input: StartFlowFlushCommandInput;
|
|
120
|
+
output: StartFlowFlushCommandOutput;
|
|
121
|
+
};
|
|
122
|
+
};
|
|
123
|
+
}
|
|
@@ -11,6 +11,7 @@ export * from "./DeleteRuleGroupCommand";
|
|
|
11
11
|
export * from "./DeleteTLSInspectionConfigurationCommand";
|
|
12
12
|
export * from "./DescribeFirewallCommand";
|
|
13
13
|
export * from "./DescribeFirewallPolicyCommand";
|
|
14
|
+
export * from "./DescribeFlowOperationCommand";
|
|
14
15
|
export * from "./DescribeLoggingConfigurationCommand";
|
|
15
16
|
export * from "./DescribeResourcePolicyCommand";
|
|
16
17
|
export * from "./DescribeRuleGroupCommand";
|
|
@@ -21,11 +22,15 @@ export * from "./GetAnalysisReportResultsCommand";
|
|
|
21
22
|
export * from "./ListAnalysisReportsCommand";
|
|
22
23
|
export * from "./ListFirewallPoliciesCommand";
|
|
23
24
|
export * from "./ListFirewallsCommand";
|
|
25
|
+
export * from "./ListFlowOperationResultsCommand";
|
|
26
|
+
export * from "./ListFlowOperationsCommand";
|
|
24
27
|
export * from "./ListRuleGroupsCommand";
|
|
25
28
|
export * from "./ListTLSInspectionConfigurationsCommand";
|
|
26
29
|
export * from "./ListTagsForResourceCommand";
|
|
27
30
|
export * from "./PutResourcePolicyCommand";
|
|
28
31
|
export * from "./StartAnalysisReportCommand";
|
|
32
|
+
export * from "./StartFlowCaptureCommand";
|
|
33
|
+
export * from "./StartFlowFlushCommand";
|
|
29
34
|
export * from "./TagResourceCommand";
|
|
30
35
|
export * from "./UntagResourceCommand";
|
|
31
36
|
export * from "./UpdateFirewallAnalysisSettingsCommand";
|