@aws-sdk/client-fsx 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
@@ -10,8 +10,9 @@ AWS SDK for JavaScript FSx Client for Node.js, Browser and React Native.
10
10
  application administrators to launch and use shared file storage.</p>
11
11
 
12
12
  ## Installing
13
- To install this package, simply type add or install @aws-sdk/client-fsx
14
- using your favorite package manager:
13
+
14
+ To install this package, use the CLI of your favorite package manager:
15
+
15
16
  - `npm install @aws-sdk/client-fsx`
16
17
  - `yarn add @aws-sdk/client-fsx`
17
18
  - `pnpm add @aws-sdk/client-fsx`
@@ -36,15 +37,15 @@ import { FSxClient, ListTagsForResourceCommand } from "@aws-sdk/client-fsx";
36
37
 
37
38
  ### Usage
38
39
 
39
- To send a request, you:
40
+ To send a request:
40
41
 
41
- - Initiate client with configuration (e.g. credentials, region).
42
- - Initiate command with input parameters.
43
- - Call `send` operation on client with command object as input.
44
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
42
+ - Instantiate a client with configuration (e.g. credentials, region).
43
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
44
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
45
+ - Instantiate a command with input parameters.
46
+ - Call the `send` operation on the client, providing the command object as input.
45
47
 
46
48
  ```js
47
- // a client can be shared by different commands.
48
49
  const client = new FSxClient({ region: "REGION" });
49
50
 
50
51
  const params = { /** input parameters */ };
@@ -53,7 +54,7 @@ const command = new ListTagsForResourceCommand(params);
53
54
 
54
55
  #### Async/await
55
56
 
56
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
57
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
57
58
  operator to wait for the promise returned by send operation as follows:
58
59
 
59
60
  ```js
@@ -68,26 +69,9 @@ try {
68
69
  }
69
70
  ```
70
71
 
71
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
72
- as compared to using Promise chains or callbacks.
73
-
74
72
  #### Promises
75
73
 
76
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
77
- to execute send operation.
78
-
79
- ```js
80
- client.send(command).then(
81
- (data) => {
82
- // process data.
83
- },
84
- (error) => {
85
- // error handling.
86
- }
87
- );
88
- ```
89
-
90
- Promises can also be called using `.catch()` and `.finally()` as follows:
74
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
91
75
 
92
76
  ```js
93
77
  client
@@ -103,27 +87,21 @@ client
103
87
  });
104
88
  ```
105
89
 
106
- #### Callbacks
107
-
108
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
109
- but they are supported by the send operation.
90
+ #### Aggregated client
110
91
 
111
- ```js
112
- // callbacks.
113
- client.send(command, (err, data) => {
114
- // process err and data.
115
- });
116
- ```
92
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
117
93
 
118
- #### v2 compatible style
94
+ `FSx` extends `FSxClient` and additionally supports all operations, waiters, and paginators as methods.
95
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
119
96
 
120
- The client can also send requests using v2 compatible style.
121
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
122
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
97
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`FSxClient`).
98
+ More details are in the blog post on
99
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
123
100
 
124
101
  ```ts
125
- import * as AWS from "@aws-sdk/client-fsx";
126
- const client = new AWS.FSx({ region: "REGION" });
102
+ import { FSx } from "@aws-sdk/client-fsx";
103
+
104
+ const client = new FSx({ region: "REGION" });
127
105
 
128
106
  // async/await.
129
107
  try {
@@ -143,7 +121,7 @@ client
143
121
  // error handling.
144
122
  });
145
123
 
146
- // callbacks.
124
+ // callbacks (not recommended).
147
125
  client.listTagsForResource(params, (err, data) => {
148
126
  // process err and data.
149
127
  });
@@ -171,12 +149,14 @@ try {
171
149
  }
172
150
  ```
173
151
 
152
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
153
+
174
154
  ## Getting Help
175
155
 
176
156
  Please use these community resources for getting help.
177
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
157
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
178
158
 
179
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
159
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
180
160
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
181
161
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
182
162
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-fsx",
3
3
  "description": "AWS SDK for JavaScript Fsx 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-fsx",
@@ -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
  },