@aws-sdk/client-wafv2 3.1008.0 → 3.1009.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
@@ -44,8 +44,9 @@ US East (N. Virginia): us-east-1.</p>
44
44
  programming language or platform that you're using. For more information, see <a href="http://aws.amazon.com/tools/#SDKs">Amazon Web Services SDKs</a>.</p>
45
45
 
46
46
  ## Installing
47
- To install this package, simply type add or install @aws-sdk/client-wafv2
48
- using your favorite package manager:
47
+
48
+ To install this package, use the CLI of your favorite package manager:
49
+
49
50
  - `npm install @aws-sdk/client-wafv2`
50
51
  - `yarn add @aws-sdk/client-wafv2`
51
52
  - `pnpm add @aws-sdk/client-wafv2`
@@ -70,15 +71,15 @@ import { WAFV2Client, ListAPIKeysCommand } from "@aws-sdk/client-wafv2";
70
71
 
71
72
  ### Usage
72
73
 
73
- To send a request, you:
74
+ To send a request:
74
75
 
75
- - Initiate client with configuration (e.g. credentials, region).
76
- - Initiate command with input parameters.
77
- - Call `send` operation on client with command object as input.
78
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
76
+ - Instantiate a client with configuration (e.g. credentials, region).
77
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
78
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
79
+ - Instantiate a command with input parameters.
80
+ - Call the `send` operation on the client, providing the command object as input.
79
81
 
80
82
  ```js
81
- // a client can be shared by different commands.
82
83
  const client = new WAFV2Client({ region: "REGION" });
83
84
 
84
85
  const params = { /** input parameters */ };
@@ -87,7 +88,7 @@ const command = new ListAPIKeysCommand(params);
87
88
 
88
89
  #### Async/await
89
90
 
90
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
91
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
91
92
  operator to wait for the promise returned by send operation as follows:
92
93
 
93
94
  ```js
@@ -102,26 +103,9 @@ try {
102
103
  }
103
104
  ```
104
105
 
105
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
106
- as compared to using Promise chains or callbacks.
107
-
108
106
  #### Promises
109
107
 
110
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
111
- to execute send operation.
112
-
113
- ```js
114
- client.send(command).then(
115
- (data) => {
116
- // process data.
117
- },
118
- (error) => {
119
- // error handling.
120
- }
121
- );
122
- ```
123
-
124
- Promises can also be called using `.catch()` and `.finally()` as follows:
108
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
125
109
 
126
110
  ```js
127
111
  client
@@ -137,27 +121,21 @@ client
137
121
  });
138
122
  ```
139
123
 
140
- #### Callbacks
141
-
142
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
143
- but they are supported by the send operation.
124
+ #### Aggregated client
144
125
 
145
- ```js
146
- // callbacks.
147
- client.send(command, (err, data) => {
148
- // process err and data.
149
- });
150
- ```
126
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
151
127
 
152
- #### v2 compatible style
128
+ `WAFV2` extends `WAFV2Client` and additionally supports all operations, waiters, and paginators as methods.
129
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
153
130
 
154
- The client can also send requests using v2 compatible style.
155
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
156
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
131
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`WAFV2Client`).
132
+ More details are in the blog post on
133
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
157
134
 
158
135
  ```ts
159
- import * as AWS from "@aws-sdk/client-wafv2";
160
- const client = new AWS.WAFV2({ region: "REGION" });
136
+ import { WAFV2 } from "@aws-sdk/client-wafv2";
137
+
138
+ const client = new WAFV2({ region: "REGION" });
161
139
 
162
140
  // async/await.
163
141
  try {
@@ -177,7 +155,7 @@ client
177
155
  // error handling.
178
156
  });
179
157
 
180
- // callbacks.
158
+ // callbacks (not recommended).
181
159
  client.listAPIKeys(params, (err, data) => {
182
160
  // process err and data.
183
161
  });
@@ -205,12 +183,14 @@ try {
205
183
  }
206
184
  ```
207
185
 
186
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
187
+
208
188
  ## Getting Help
209
189
 
210
190
  Please use these community resources for getting help.
211
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
191
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
212
192
 
213
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
193
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
214
194
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
215
195
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
216
196
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-wafv2",
3
3
  "description": "AWS SDK for JavaScript Wafv2 Client for Node.js, Browser and React Native",
4
- "version": "3.1008.0",
4
+ "version": "3.1009.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-wafv2",
@@ -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
  },