@aws-sdk/client-networkflowmonitor 3.1008.0 → 3.1010.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 +26 -46
- package/package.json +33 -33
package/README.md
CHANGED
|
@@ -9,8 +9,9 @@ AWS SDK for JavaScript NetworkFlowMonitor Client for Node.js, Browser and React
|
|
|
9
9
|
<p>Network Flow Monitor is a feature of Amazon CloudWatch Network Monitoring that provides visibility into the performance of network flows for your Amazon Web Services workloads, between instances in subnets, as well as to and from Amazon Web Services. Lightweight agents that you install on the instances capture performance metrics for your network flows, such as packet loss and latency, and send them to the Network Flow Monitor backend. Then, you can view and analyze metrics from the top contributors for each metric type, to help troubleshoot issues.</p> <p>In addition, when you create a monitor, Network Flow Monitor provides a network health indicator (NHI) that informs you whether there were Amazon Web Services network issues for one or more of the network flows tracked by a monitor, during a time period that you choose. By using this value, you can independently determine if the Amazon Web Services network is impacting your workload during a specific time frame, to help you focus troubleshooting efforts.</p> <p>To learn more about Network Flow Monitor, see the <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch-NetworkFlowMonitor.html">Network Flow Monitor User Guide</a> in the Amazon CloudWatch User Guide.</p>
|
|
10
10
|
|
|
11
11
|
## Installing
|
|
12
|
-
|
|
13
|
-
|
|
12
|
+
|
|
13
|
+
To install this package, use the CLI of your favorite package manager:
|
|
14
|
+
|
|
14
15
|
- `npm install @aws-sdk/client-networkflowmonitor`
|
|
15
16
|
- `yarn add @aws-sdk/client-networkflowmonitor`
|
|
16
17
|
- `pnpm add @aws-sdk/client-networkflowmonitor`
|
|
@@ -35,15 +36,15 @@ import { NetworkFlowMonitorClient, ListScopesCommand } from "@aws-sdk/client-net
|
|
|
35
36
|
|
|
36
37
|
### Usage
|
|
37
38
|
|
|
38
|
-
To send a request
|
|
39
|
+
To send a request:
|
|
39
40
|
|
|
40
|
-
-
|
|
41
|
-
-
|
|
42
|
-
-
|
|
43
|
-
-
|
|
41
|
+
- Instantiate a client with configuration (e.g. credentials, region).
|
|
42
|
+
- See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
|
|
43
|
+
- See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
|
|
44
|
+
- Instantiate a command with input parameters.
|
|
45
|
+
- Call the `send` operation on the client, providing the command object as input.
|
|
44
46
|
|
|
45
47
|
```js
|
|
46
|
-
// a client can be shared by different commands.
|
|
47
48
|
const client = new NetworkFlowMonitorClient({ region: "REGION" });
|
|
48
49
|
|
|
49
50
|
const params = { /** input parameters */ };
|
|
@@ -52,7 +53,7 @@ const command = new ListScopesCommand(params);
|
|
|
52
53
|
|
|
53
54
|
#### Async/await
|
|
54
55
|
|
|
55
|
-
We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
|
|
56
|
+
We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
|
|
56
57
|
operator to wait for the promise returned by send operation as follows:
|
|
57
58
|
|
|
58
59
|
```js
|
|
@@ -67,26 +68,9 @@ try {
|
|
|
67
68
|
}
|
|
68
69
|
```
|
|
69
70
|
|
|
70
|
-
Async-await is clean, concise, intuitive, easy to debug and has better error handling
|
|
71
|
-
as compared to using Promise chains or callbacks.
|
|
72
|
-
|
|
73
71
|
#### Promises
|
|
74
72
|
|
|
75
|
-
You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
|
|
76
|
-
to execute send operation.
|
|
77
|
-
|
|
78
|
-
```js
|
|
79
|
-
client.send(command).then(
|
|
80
|
-
(data) => {
|
|
81
|
-
// process data.
|
|
82
|
-
},
|
|
83
|
-
(error) => {
|
|
84
|
-
// error handling.
|
|
85
|
-
}
|
|
86
|
-
);
|
|
87
|
-
```
|
|
88
|
-
|
|
89
|
-
Promises can also be called using `.catch()` and `.finally()` as follows:
|
|
73
|
+
You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
|
|
90
74
|
|
|
91
75
|
```js
|
|
92
76
|
client
|
|
@@ -102,27 +86,21 @@ client
|
|
|
102
86
|
});
|
|
103
87
|
```
|
|
104
88
|
|
|
105
|
-
####
|
|
106
|
-
|
|
107
|
-
We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
|
|
108
|
-
but they are supported by the send operation.
|
|
89
|
+
#### Aggregated client
|
|
109
90
|
|
|
110
|
-
|
|
111
|
-
// callbacks.
|
|
112
|
-
client.send(command, (err, data) => {
|
|
113
|
-
// process err and data.
|
|
114
|
-
});
|
|
115
|
-
```
|
|
91
|
+
The aggregated client class is exported from the same package, but without the "Client" suffix.
|
|
116
92
|
|
|
117
|
-
|
|
93
|
+
`NetworkFlowMonitor` extends `NetworkFlowMonitorClient` and additionally supports all operations, waiters, and paginators as methods.
|
|
94
|
+
This style may be familiar to you from the AWS SDK for JavaScript v2.
|
|
118
95
|
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
96
|
+
If you are bundling the AWS SDK, we recommend using only the bare-bones client (`NetworkFlowMonitorClient`).
|
|
97
|
+
More details are in the blog post on
|
|
98
|
+
[modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
|
|
122
99
|
|
|
123
100
|
```ts
|
|
124
|
-
import
|
|
125
|
-
|
|
101
|
+
import { NetworkFlowMonitor } from "@aws-sdk/client-networkflowmonitor";
|
|
102
|
+
|
|
103
|
+
const client = new NetworkFlowMonitor({ region: "REGION" });
|
|
126
104
|
|
|
127
105
|
// async/await.
|
|
128
106
|
try {
|
|
@@ -142,7 +120,7 @@ client
|
|
|
142
120
|
// error handling.
|
|
143
121
|
});
|
|
144
122
|
|
|
145
|
-
// callbacks.
|
|
123
|
+
// callbacks (not recommended).
|
|
146
124
|
client.listScopes(params, (err, data) => {
|
|
147
125
|
// process err and data.
|
|
148
126
|
});
|
|
@@ -170,12 +148,14 @@ try {
|
|
|
170
148
|
}
|
|
171
149
|
```
|
|
172
150
|
|
|
151
|
+
See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
|
|
152
|
+
|
|
173
153
|
## Getting Help
|
|
174
154
|
|
|
175
155
|
Please use these community resources for getting help.
|
|
176
|
-
We use
|
|
156
|
+
We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
|
|
177
157
|
|
|
178
|
-
- Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
|
|
158
|
+
- Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
|
|
179
159
|
or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
|
|
180
160
|
- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
|
|
181
161
|
on AWS Developer Blog.
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-networkflowmonitor",
|
|
3
3
|
"description": "AWS SDK for JavaScript Networkflowmonitor Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.1010.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:types' 'yarn:build:es' && yarn build:cjs",
|
|
7
7
|
"build:cjs": "node ../../scripts/compilation/inline client-networkflowmonitor",
|
|
@@ -21,41 +21,41 @@
|
|
|
21
21
|
"dependencies": {
|
|
22
22
|
"@aws-crypto/sha256-browser": "5.2.0",
|
|
23
23
|
"@aws-crypto/sha256-js": "5.2.0",
|
|
24
|
-
"@aws-sdk/core": "^3.973.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "^3.972.
|
|
26
|
-
"@aws-sdk/middleware-host-header": "^3.972.
|
|
27
|
-
"@aws-sdk/middleware-logger": "^3.972.
|
|
28
|
-
"@aws-sdk/middleware-recursion-detection": "^3.972.
|
|
29
|
-
"@aws-sdk/middleware-user-agent": "^3.972.
|
|
30
|
-
"@aws-sdk/region-config-resolver": "^3.972.
|
|
31
|
-
"@aws-sdk/types": "^3.973.
|
|
32
|
-
"@aws-sdk/util-endpoints": "^3.996.
|
|
33
|
-
"@aws-sdk/util-user-agent-browser": "^3.972.
|
|
34
|
-
"@aws-sdk/util-user-agent-node": "^3.973.
|
|
35
|
-
"@smithy/config-resolver": "^4.4.
|
|
36
|
-
"@smithy/core": "^3.23.
|
|
37
|
-
"@smithy/fetch-http-handler": "^5.3.
|
|
38
|
-
"@smithy/hash-node": "^4.2.
|
|
39
|
-
"@smithy/invalid-dependency": "^4.2.
|
|
40
|
-
"@smithy/middleware-content-length": "^4.2.
|
|
41
|
-
"@smithy/middleware-endpoint": "^4.4.
|
|
42
|
-
"@smithy/middleware-retry": "^4.4.
|
|
43
|
-
"@smithy/middleware-serde": "^4.2.
|
|
44
|
-
"@smithy/middleware-stack": "^4.2.
|
|
45
|
-
"@smithy/node-config-provider": "^4.3.
|
|
46
|
-
"@smithy/node-http-handler": "^4.4.
|
|
47
|
-
"@smithy/protocol-http": "^5.3.
|
|
48
|
-
"@smithy/smithy-client": "^4.12.
|
|
49
|
-
"@smithy/types": "^4.13.
|
|
50
|
-
"@smithy/url-parser": "^4.2.
|
|
24
|
+
"@aws-sdk/core": "^3.973.20",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "^3.972.21",
|
|
26
|
+
"@aws-sdk/middleware-host-header": "^3.972.8",
|
|
27
|
+
"@aws-sdk/middleware-logger": "^3.972.8",
|
|
28
|
+
"@aws-sdk/middleware-recursion-detection": "^3.972.8",
|
|
29
|
+
"@aws-sdk/middleware-user-agent": "^3.972.21",
|
|
30
|
+
"@aws-sdk/region-config-resolver": "^3.972.8",
|
|
31
|
+
"@aws-sdk/types": "^3.973.6",
|
|
32
|
+
"@aws-sdk/util-endpoints": "^3.996.5",
|
|
33
|
+
"@aws-sdk/util-user-agent-browser": "^3.972.8",
|
|
34
|
+
"@aws-sdk/util-user-agent-node": "^3.973.7",
|
|
35
|
+
"@smithy/config-resolver": "^4.4.11",
|
|
36
|
+
"@smithy/core": "^3.23.11",
|
|
37
|
+
"@smithy/fetch-http-handler": "^5.3.15",
|
|
38
|
+
"@smithy/hash-node": "^4.2.12",
|
|
39
|
+
"@smithy/invalid-dependency": "^4.2.12",
|
|
40
|
+
"@smithy/middleware-content-length": "^4.2.12",
|
|
41
|
+
"@smithy/middleware-endpoint": "^4.4.25",
|
|
42
|
+
"@smithy/middleware-retry": "^4.4.42",
|
|
43
|
+
"@smithy/middleware-serde": "^4.2.14",
|
|
44
|
+
"@smithy/middleware-stack": "^4.2.12",
|
|
45
|
+
"@smithy/node-config-provider": "^4.3.12",
|
|
46
|
+
"@smithy/node-http-handler": "^4.4.16",
|
|
47
|
+
"@smithy/protocol-http": "^5.3.12",
|
|
48
|
+
"@smithy/smithy-client": "^4.12.5",
|
|
49
|
+
"@smithy/types": "^4.13.1",
|
|
50
|
+
"@smithy/url-parser": "^4.2.12",
|
|
51
51
|
"@smithy/util-base64": "^4.3.2",
|
|
52
52
|
"@smithy/util-body-length-browser": "^4.2.2",
|
|
53
53
|
"@smithy/util-body-length-node": "^4.2.3",
|
|
54
|
-
"@smithy/util-defaults-mode-browser": "^4.3.
|
|
55
|
-
"@smithy/util-defaults-mode-node": "^4.2.
|
|
56
|
-
"@smithy/util-endpoints": "^3.3.
|
|
57
|
-
"@smithy/util-middleware": "^4.2.
|
|
58
|
-
"@smithy/util-retry": "^4.2.
|
|
54
|
+
"@smithy/util-defaults-mode-browser": "^4.3.41",
|
|
55
|
+
"@smithy/util-defaults-mode-node": "^4.2.44",
|
|
56
|
+
"@smithy/util-endpoints": "^3.3.3",
|
|
57
|
+
"@smithy/util-middleware": "^4.2.12",
|
|
58
|
+
"@smithy/util-retry": "^4.2.12",
|
|
59
59
|
"@smithy/util-utf8": "^4.2.2",
|
|
60
60
|
"tslib": "^2.6.2"
|
|
61
61
|
},
|