@aws-sdk/client-efs 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
@@ -16,8 +16,9 @@ the <a href="https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html">Amazon El
16
16
  User Guide</a>.</p>
17
17
 
18
18
  ## Installing
19
- To install this package, simply type add or install @aws-sdk/client-efs
20
- using your favorite package manager:
19
+
20
+ To install this package, use the CLI of your favorite package manager:
21
+
21
22
  - `npm install @aws-sdk/client-efs`
22
23
  - `yarn add @aws-sdk/client-efs`
23
24
  - `pnpm add @aws-sdk/client-efs`
@@ -42,15 +43,15 @@ import { EFSClient, ListTagsForResourceCommand } from "@aws-sdk/client-efs";
42
43
 
43
44
  ### Usage
44
45
 
45
- To send a request, you:
46
+ To send a request:
46
47
 
47
- - Initiate client with configuration (e.g. credentials, region).
48
- - Initiate command with input parameters.
49
- - Call `send` operation on client with command object as input.
50
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
48
+ - Instantiate a client with configuration (e.g. credentials, region).
49
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
50
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
51
+ - Instantiate a command with input parameters.
52
+ - Call the `send` operation on the client, providing the command object as input.
51
53
 
52
54
  ```js
53
- // a client can be shared by different commands.
54
55
  const client = new EFSClient({ region: "REGION" });
55
56
 
56
57
  const params = { /** input parameters */ };
@@ -59,7 +60,7 @@ const command = new ListTagsForResourceCommand(params);
59
60
 
60
61
  #### Async/await
61
62
 
62
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
63
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
63
64
  operator to wait for the promise returned by send operation as follows:
64
65
 
65
66
  ```js
@@ -74,26 +75,9 @@ try {
74
75
  }
75
76
  ```
76
77
 
77
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
78
- as compared to using Promise chains or callbacks.
79
-
80
78
  #### Promises
81
79
 
82
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
83
- to execute send operation.
84
-
85
- ```js
86
- client.send(command).then(
87
- (data) => {
88
- // process data.
89
- },
90
- (error) => {
91
- // error handling.
92
- }
93
- );
94
- ```
95
-
96
- Promises can also be called using `.catch()` and `.finally()` as follows:
80
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
97
81
 
98
82
  ```js
99
83
  client
@@ -109,27 +93,21 @@ client
109
93
  });
110
94
  ```
111
95
 
112
- #### Callbacks
113
-
114
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
115
- but they are supported by the send operation.
96
+ #### Aggregated client
116
97
 
117
- ```js
118
- // callbacks.
119
- client.send(command, (err, data) => {
120
- // process err and data.
121
- });
122
- ```
98
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
123
99
 
124
- #### v2 compatible style
100
+ `EFS` extends `EFSClient` and additionally supports all operations, waiters, and paginators as methods.
101
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
125
102
 
126
- The client can also send requests using v2 compatible style.
127
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
128
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
103
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`EFSClient`).
104
+ More details are in the blog post on
105
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
129
106
 
130
107
  ```ts
131
- import * as AWS from "@aws-sdk/client-efs";
132
- const client = new AWS.EFS({ region: "REGION" });
108
+ import { EFS } from "@aws-sdk/client-efs";
109
+
110
+ const client = new EFS({ region: "REGION" });
133
111
 
134
112
  // async/await.
135
113
  try {
@@ -149,7 +127,7 @@ client
149
127
  // error handling.
150
128
  });
151
129
 
152
- // callbacks.
130
+ // callbacks (not recommended).
153
131
  client.listTagsForResource(params, (err, data) => {
154
132
  // process err and data.
155
133
  });
@@ -177,12 +155,14 @@ try {
177
155
  }
178
156
  ```
179
157
 
158
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
159
+
180
160
  ## Getting Help
181
161
 
182
162
  Please use these community resources for getting help.
183
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
163
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
184
164
 
185
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
165
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
186
166
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
187
167
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
188
168
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-efs",
3
3
  "description": "AWS SDK for JavaScript Efs 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-efs",
@@ -23,41 +23,41 @@
23
23
  "dependencies": {
24
24
  "@aws-crypto/sha256-browser": "5.2.0",
25
25
  "@aws-crypto/sha256-js": "5.2.0",
26
- "@aws-sdk/core": "^3.973.19",
27
- "@aws-sdk/credential-provider-node": "^3.972.20",
28
- "@aws-sdk/middleware-host-header": "^3.972.7",
29
- "@aws-sdk/middleware-logger": "^3.972.7",
30
- "@aws-sdk/middleware-recursion-detection": "^3.972.7",
31
- "@aws-sdk/middleware-user-agent": "^3.972.20",
32
- "@aws-sdk/region-config-resolver": "^3.972.7",
33
- "@aws-sdk/types": "^3.973.5",
34
- "@aws-sdk/util-endpoints": "^3.996.4",
35
- "@aws-sdk/util-user-agent-browser": "^3.972.7",
36
- "@aws-sdk/util-user-agent-node": "^3.973.6",
37
- "@smithy/config-resolver": "^4.4.10",
38
- "@smithy/core": "^3.23.9",
39
- "@smithy/fetch-http-handler": "^5.3.13",
40
- "@smithy/hash-node": "^4.2.11",
41
- "@smithy/invalid-dependency": "^4.2.11",
42
- "@smithy/middleware-content-length": "^4.2.11",
43
- "@smithy/middleware-endpoint": "^4.4.23",
44
- "@smithy/middleware-retry": "^4.4.40",
45
- "@smithy/middleware-serde": "^4.2.12",
46
- "@smithy/middleware-stack": "^4.2.11",
47
- "@smithy/node-config-provider": "^4.3.11",
48
- "@smithy/node-http-handler": "^4.4.14",
49
- "@smithy/protocol-http": "^5.3.11",
50
- "@smithy/smithy-client": "^4.12.3",
51
- "@smithy/types": "^4.13.0",
52
- "@smithy/url-parser": "^4.2.11",
26
+ "@aws-sdk/core": "^3.973.20",
27
+ "@aws-sdk/credential-provider-node": "^3.972.21",
28
+ "@aws-sdk/middleware-host-header": "^3.972.8",
29
+ "@aws-sdk/middleware-logger": "^3.972.8",
30
+ "@aws-sdk/middleware-recursion-detection": "^3.972.8",
31
+ "@aws-sdk/middleware-user-agent": "^3.972.21",
32
+ "@aws-sdk/region-config-resolver": "^3.972.8",
33
+ "@aws-sdk/types": "^3.973.6",
34
+ "@aws-sdk/util-endpoints": "^3.996.5",
35
+ "@aws-sdk/util-user-agent-browser": "^3.972.8",
36
+ "@aws-sdk/util-user-agent-node": "^3.973.7",
37
+ "@smithy/config-resolver": "^4.4.11",
38
+ "@smithy/core": "^3.23.11",
39
+ "@smithy/fetch-http-handler": "^5.3.15",
40
+ "@smithy/hash-node": "^4.2.12",
41
+ "@smithy/invalid-dependency": "^4.2.12",
42
+ "@smithy/middleware-content-length": "^4.2.12",
43
+ "@smithy/middleware-endpoint": "^4.4.25",
44
+ "@smithy/middleware-retry": "^4.4.42",
45
+ "@smithy/middleware-serde": "^4.2.14",
46
+ "@smithy/middleware-stack": "^4.2.12",
47
+ "@smithy/node-config-provider": "^4.3.12",
48
+ "@smithy/node-http-handler": "^4.4.16",
49
+ "@smithy/protocol-http": "^5.3.12",
50
+ "@smithy/smithy-client": "^4.12.5",
51
+ "@smithy/types": "^4.13.1",
52
+ "@smithy/url-parser": "^4.2.12",
53
53
  "@smithy/util-base64": "^4.3.2",
54
54
  "@smithy/util-body-length-browser": "^4.2.2",
55
55
  "@smithy/util-body-length-node": "^4.2.3",
56
- "@smithy/util-defaults-mode-browser": "^4.3.39",
57
- "@smithy/util-defaults-mode-node": "^4.2.42",
58
- "@smithy/util-endpoints": "^3.3.2",
59
- "@smithy/util-middleware": "^4.2.11",
60
- "@smithy/util-retry": "^4.2.11",
56
+ "@smithy/util-defaults-mode-browser": "^4.3.41",
57
+ "@smithy/util-defaults-mode-node": "^4.2.44",
58
+ "@smithy/util-endpoints": "^3.3.3",
59
+ "@smithy/util-middleware": "^4.2.12",
60
+ "@smithy/util-retry": "^4.2.12",
61
61
  "@smithy/util-utf8": "^4.2.2",
62
62
  "tslib": "^2.6.2"
63
63
  },