@aws-sdk/client-marketplace-metering 3.1007.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
@@ -147,8 +147,9 @@ Marketplace Seller Operations</a>.</p>
147
147
  </ul>
148
148
 
149
149
  ## Installing
150
- To install this package, simply type add or install @aws-sdk/client-marketplace-metering
151
- using your favorite package manager:
150
+
151
+ To install this package, use the CLI of your favorite package manager:
152
+
152
153
  - `npm install @aws-sdk/client-marketplace-metering`
153
154
  - `yarn add @aws-sdk/client-marketplace-metering`
154
155
  - `pnpm add @aws-sdk/client-marketplace-metering`
@@ -173,15 +174,15 @@ import { MarketplaceMeteringClient, BatchMeterUsageCommand } from "@aws-sdk/clie
173
174
 
174
175
  ### Usage
175
176
 
176
- To send a request, you:
177
+ To send a request:
177
178
 
178
- - Initiate client with configuration (e.g. credentials, region).
179
- - Initiate command with input parameters.
180
- - Call `send` operation on client with command object as input.
181
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
179
+ - Instantiate a client with configuration (e.g. credentials, region).
180
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
181
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
182
+ - Instantiate a command with input parameters.
183
+ - Call the `send` operation on the client, providing the command object as input.
182
184
 
183
185
  ```js
184
- // a client can be shared by different commands.
185
186
  const client = new MarketplaceMeteringClient({ region: "REGION" });
186
187
 
187
188
  const params = { /** input parameters */ };
@@ -190,7 +191,7 @@ const command = new BatchMeterUsageCommand(params);
190
191
 
191
192
  #### Async/await
192
193
 
193
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
194
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
194
195
  operator to wait for the promise returned by send operation as follows:
195
196
 
196
197
  ```js
@@ -205,26 +206,9 @@ try {
205
206
  }
206
207
  ```
207
208
 
208
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
209
- as compared to using Promise chains or callbacks.
210
-
211
209
  #### Promises
212
210
 
213
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
214
- to execute send operation.
215
-
216
- ```js
217
- client.send(command).then(
218
- (data) => {
219
- // process data.
220
- },
221
- (error) => {
222
- // error handling.
223
- }
224
- );
225
- ```
226
-
227
- Promises can also be called using `.catch()` and `.finally()` as follows:
211
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
228
212
 
229
213
  ```js
230
214
  client
@@ -240,27 +224,21 @@ client
240
224
  });
241
225
  ```
242
226
 
243
- #### Callbacks
244
-
245
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
246
- but they are supported by the send operation.
227
+ #### Aggregated client
247
228
 
248
- ```js
249
- // callbacks.
250
- client.send(command, (err, data) => {
251
- // process err and data.
252
- });
253
- ```
229
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
254
230
 
255
- #### v2 compatible style
231
+ `MarketplaceMetering` extends `MarketplaceMeteringClient` and additionally supports all operations, waiters, and paginators as methods.
232
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
256
233
 
257
- The client can also send requests using v2 compatible style.
258
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
259
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
234
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`MarketplaceMeteringClient`).
235
+ More details are in the blog post on
236
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
260
237
 
261
238
  ```ts
262
- import * as AWS from "@aws-sdk/client-marketplace-metering";
263
- const client = new AWS.MarketplaceMetering({ region: "REGION" });
239
+ import { MarketplaceMetering } from "@aws-sdk/client-marketplace-metering";
240
+
241
+ const client = new MarketplaceMetering({ region: "REGION" });
264
242
 
265
243
  // async/await.
266
244
  try {
@@ -280,7 +258,7 @@ client
280
258
  // error handling.
281
259
  });
282
260
 
283
- // callbacks.
261
+ // callbacks (not recommended).
284
262
  client.batchMeterUsage(params, (err, data) => {
285
263
  // process err and data.
286
264
  });
@@ -308,12 +286,14 @@ try {
308
286
  }
309
287
  ```
310
288
 
289
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
290
+
311
291
  ## Getting Help
312
292
 
313
293
  Please use these community resources for getting help.
314
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
294
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
315
295
 
316
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
296
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
317
297
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
318
298
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
319
299
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-marketplace-metering",
3
3
  "description": "AWS SDK for JavaScript Marketplace Metering Client for Node.js, Browser and React Native",
4
- "version": "3.1007.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-marketplace-metering",
@@ -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.19",
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.5",
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
  },