@aws-sdk/client-network-firewall 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.
Files changed (2) hide show
  1. package/README.md +26 -46
  2. package/package.json +33 -33
package/README.md CHANGED
@@ -95,8 +95,9 @@ firewall subnet definitions. You can also add endpoints to Availability Zones th
95
95
  or for another VPC, by following the prior steps for the Amazon VPC setup, and defining the new VPC subnets as VPC endpoint associations. </p>
96
96
 
97
97
  ## Installing
98
- To install this package, simply type add or install @aws-sdk/client-network-firewall
99
- using your favorite package manager:
98
+
99
+ To install this package, use the CLI of your favorite package manager:
100
+
100
101
  - `npm install @aws-sdk/client-network-firewall`
101
102
  - `yarn add @aws-sdk/client-network-firewall`
102
103
  - `pnpm add @aws-sdk/client-network-firewall`
@@ -121,15 +122,15 @@ import { NetworkFirewallClient, ListProxiesCommand } from "@aws-sdk/client-netwo
121
122
 
122
123
  ### Usage
123
124
 
124
- To send a request, you:
125
+ To send a request:
125
126
 
126
- - Initiate client with configuration (e.g. credentials, region).
127
- - Initiate command with input parameters.
128
- - Call `send` operation on client with command object as input.
129
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
127
+ - Instantiate a client with configuration (e.g. credentials, region).
128
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
129
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
130
+ - Instantiate a command with input parameters.
131
+ - Call the `send` operation on the client, providing the command object as input.
130
132
 
131
133
  ```js
132
- // a client can be shared by different commands.
133
134
  const client = new NetworkFirewallClient({ region: "REGION" });
134
135
 
135
136
  const params = { /** input parameters */ };
@@ -138,7 +139,7 @@ const command = new ListProxiesCommand(params);
138
139
 
139
140
  #### Async/await
140
141
 
141
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
142
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
142
143
  operator to wait for the promise returned by send operation as follows:
143
144
 
144
145
  ```js
@@ -153,26 +154,9 @@ try {
153
154
  }
154
155
  ```
155
156
 
156
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
157
- as compared to using Promise chains or callbacks.
158
-
159
157
  #### Promises
160
158
 
161
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
162
- to execute send operation.
163
-
164
- ```js
165
- client.send(command).then(
166
- (data) => {
167
- // process data.
168
- },
169
- (error) => {
170
- // error handling.
171
- }
172
- );
173
- ```
174
-
175
- Promises can also be called using `.catch()` and `.finally()` as follows:
159
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
176
160
 
177
161
  ```js
178
162
  client
@@ -188,27 +172,21 @@ client
188
172
  });
189
173
  ```
190
174
 
191
- #### Callbacks
192
-
193
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
194
- but they are supported by the send operation.
175
+ #### Aggregated client
195
176
 
196
- ```js
197
- // callbacks.
198
- client.send(command, (err, data) => {
199
- // process err and data.
200
- });
201
- ```
177
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
202
178
 
203
- #### v2 compatible style
179
+ `NetworkFirewall` extends `NetworkFirewallClient` and additionally supports all operations, waiters, and paginators as methods.
180
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
204
181
 
205
- The client can also send requests using v2 compatible style.
206
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
207
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
182
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`NetworkFirewallClient`).
183
+ More details are in the blog post on
184
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
208
185
 
209
186
  ```ts
210
- import * as AWS from "@aws-sdk/client-network-firewall";
211
- const client = new AWS.NetworkFirewall({ region: "REGION" });
187
+ import { NetworkFirewall } from "@aws-sdk/client-network-firewall";
188
+
189
+ const client = new NetworkFirewall({ region: "REGION" });
212
190
 
213
191
  // async/await.
214
192
  try {
@@ -228,7 +206,7 @@ client
228
206
  // error handling.
229
207
  });
230
208
 
231
- // callbacks.
209
+ // callbacks (not recommended).
232
210
  client.listProxies(params, (err, data) => {
233
211
  // process err and data.
234
212
  });
@@ -256,12 +234,14 @@ try {
256
234
  }
257
235
  ```
258
236
 
237
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
238
+
259
239
  ## Getting Help
260
240
 
261
241
  Please use these community resources for getting help.
262
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
242
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
263
243
 
264
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
244
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
265
245
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
266
246
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
267
247
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-network-firewall",
3
3
  "description": "AWS SDK for JavaScript Network Firewall Client for Node.js, Browser and React Native",
4
- "version": "3.1008.0",
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-network-firewall",
@@ -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.19",
25
- "@aws-sdk/credential-provider-node": "^3.972.20",
26
- "@aws-sdk/middleware-host-header": "^3.972.7",
27
- "@aws-sdk/middleware-logger": "^3.972.7",
28
- "@aws-sdk/middleware-recursion-detection": "^3.972.7",
29
- "@aws-sdk/middleware-user-agent": "^3.972.20",
30
- "@aws-sdk/region-config-resolver": "^3.972.7",
31
- "@aws-sdk/types": "^3.973.5",
32
- "@aws-sdk/util-endpoints": "^3.996.4",
33
- "@aws-sdk/util-user-agent-browser": "^3.972.7",
34
- "@aws-sdk/util-user-agent-node": "^3.973.6",
35
- "@smithy/config-resolver": "^4.4.10",
36
- "@smithy/core": "^3.23.9",
37
- "@smithy/fetch-http-handler": "^5.3.13",
38
- "@smithy/hash-node": "^4.2.11",
39
- "@smithy/invalid-dependency": "^4.2.11",
40
- "@smithy/middleware-content-length": "^4.2.11",
41
- "@smithy/middleware-endpoint": "^4.4.23",
42
- "@smithy/middleware-retry": "^4.4.40",
43
- "@smithy/middleware-serde": "^4.2.12",
44
- "@smithy/middleware-stack": "^4.2.11",
45
- "@smithy/node-config-provider": "^4.3.11",
46
- "@smithy/node-http-handler": "^4.4.14",
47
- "@smithy/protocol-http": "^5.3.11",
48
- "@smithy/smithy-client": "^4.12.3",
49
- "@smithy/types": "^4.13.0",
50
- "@smithy/url-parser": "^4.2.11",
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.39",
55
- "@smithy/util-defaults-mode-node": "^4.2.42",
56
- "@smithy/util-endpoints": "^3.3.2",
57
- "@smithy/util-middleware": "^4.2.11",
58
- "@smithy/util-retry": "^4.2.11",
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
  },