@aws-sdk/client-rekognition 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 +34 -34
package/README.md CHANGED
@@ -382,8 +382,9 @@ parameters, and common errors.</p>
382
382
  </ul>
383
383
 
384
384
  ## Installing
385
- To install this package, simply type add or install @aws-sdk/client-rekognition
386
- using your favorite package manager:
385
+
386
+ To install this package, use the CLI of your favorite package manager:
387
+
387
388
  - `npm install @aws-sdk/client-rekognition`
388
389
  - `yarn add @aws-sdk/client-rekognition`
389
390
  - `pnpm add @aws-sdk/client-rekognition`
@@ -408,15 +409,15 @@ import { RekognitionClient, ListCollectionsCommand } from "@aws-sdk/client-rekog
408
409
 
409
410
  ### Usage
410
411
 
411
- To send a request, you:
412
+ To send a request:
412
413
 
413
- - Initiate client with configuration (e.g. credentials, region).
414
- - Initiate command with input parameters.
415
- - Call `send` operation on client with command object as input.
416
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
414
+ - Instantiate a client with configuration (e.g. credentials, region).
415
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
416
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
417
+ - Instantiate a command with input parameters.
418
+ - Call the `send` operation on the client, providing the command object as input.
417
419
 
418
420
  ```js
419
- // a client can be shared by different commands.
420
421
  const client = new RekognitionClient({ region: "REGION" });
421
422
 
422
423
  const params = { /** input parameters */ };
@@ -425,7 +426,7 @@ const command = new ListCollectionsCommand(params);
425
426
 
426
427
  #### Async/await
427
428
 
428
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
429
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
429
430
  operator to wait for the promise returned by send operation as follows:
430
431
 
431
432
  ```js
@@ -440,26 +441,9 @@ try {
440
441
  }
441
442
  ```
442
443
 
443
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
444
- as compared to using Promise chains or callbacks.
445
-
446
444
  #### Promises
447
445
 
448
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
449
- to execute send operation.
450
-
451
- ```js
452
- client.send(command).then(
453
- (data) => {
454
- // process data.
455
- },
456
- (error) => {
457
- // error handling.
458
- }
459
- );
460
- ```
461
-
462
- Promises can also be called using `.catch()` and `.finally()` as follows:
446
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
463
447
 
464
448
  ```js
465
449
  client
@@ -475,27 +459,21 @@ client
475
459
  });
476
460
  ```
477
461
 
478
- #### Callbacks
479
-
480
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
481
- but they are supported by the send operation.
462
+ #### Aggregated client
482
463
 
483
- ```js
484
- // callbacks.
485
- client.send(command, (err, data) => {
486
- // process err and data.
487
- });
488
- ```
464
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
489
465
 
490
- #### v2 compatible style
466
+ `Rekognition` extends `RekognitionClient` and additionally supports all operations, waiters, and paginators as methods.
467
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
491
468
 
492
- The client can also send requests using v2 compatible style.
493
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
494
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
469
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`RekognitionClient`).
470
+ More details are in the blog post on
471
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
495
472
 
496
473
  ```ts
497
- import * as AWS from "@aws-sdk/client-rekognition";
498
- const client = new AWS.Rekognition({ region: "REGION" });
474
+ import { Rekognition } from "@aws-sdk/client-rekognition";
475
+
476
+ const client = new Rekognition({ region: "REGION" });
499
477
 
500
478
  // async/await.
501
479
  try {
@@ -515,7 +493,7 @@ client
515
493
  // error handling.
516
494
  });
517
495
 
518
- // callbacks.
496
+ // callbacks (not recommended).
519
497
  client.listCollections(params, (err, data) => {
520
498
  // process err and data.
521
499
  });
@@ -543,12 +521,14 @@ try {
543
521
  }
544
522
  ```
545
523
 
524
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
525
+
546
526
  ## Getting Help
547
527
 
548
528
  Please use these community resources for getting help.
549
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
529
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
550
530
 
551
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
531
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
552
532
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
553
533
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
554
534
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-rekognition",
3
3
  "description": "AWS SDK for JavaScript Rekognition 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-rekognition",
@@ -21,43 +21,43 @@
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
- "@smithy/util-waiter": "^4.2.12",
60
+ "@smithy/util-waiter": "^4.2.13",
61
61
  "tslib": "^2.6.2"
62
62
  },
63
63
  "devDependencies": {