@aws-sdk/client-storage-gateway 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
@@ -72,8 +72,9 @@ Heads-up – Longer Storage Gateway volume and snapshot IDs coming in
72
72
  </important>
73
73
 
74
74
  ## Installing
75
- To install this package, simply type add or install @aws-sdk/client-storage-gateway
76
- using your favorite package manager:
75
+
76
+ To install this package, use the CLI of your favorite package manager:
77
+
77
78
  - `npm install @aws-sdk/client-storage-gateway`
78
79
  - `yarn add @aws-sdk/client-storage-gateway`
79
80
  - `pnpm add @aws-sdk/client-storage-gateway`
@@ -98,15 +99,15 @@ import { StorageGatewayClient, ListTapesCommand } from "@aws-sdk/client-storage-
98
99
 
99
100
  ### Usage
100
101
 
101
- To send a request, you:
102
+ To send a request:
102
103
 
103
- - Initiate client with configuration (e.g. credentials, region).
104
- - Initiate command with input parameters.
105
- - Call `send` operation on client with command object as input.
106
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
104
+ - Instantiate a client with configuration (e.g. credentials, region).
105
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
106
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
107
+ - Instantiate a command with input parameters.
108
+ - Call the `send` operation on the client, providing the command object as input.
107
109
 
108
110
  ```js
109
- // a client can be shared by different commands.
110
111
  const client = new StorageGatewayClient({ region: "REGION" });
111
112
 
112
113
  const params = { /** input parameters */ };
@@ -115,7 +116,7 @@ const command = new ListTapesCommand(params);
115
116
 
116
117
  #### Async/await
117
118
 
118
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
119
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
119
120
  operator to wait for the promise returned by send operation as follows:
120
121
 
121
122
  ```js
@@ -130,26 +131,9 @@ try {
130
131
  }
131
132
  ```
132
133
 
133
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
134
- as compared to using Promise chains or callbacks.
135
-
136
134
  #### Promises
137
135
 
138
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
139
- to execute send operation.
140
-
141
- ```js
142
- client.send(command).then(
143
- (data) => {
144
- // process data.
145
- },
146
- (error) => {
147
- // error handling.
148
- }
149
- );
150
- ```
151
-
152
- Promises can also be called using `.catch()` and `.finally()` as follows:
136
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
153
137
 
154
138
  ```js
155
139
  client
@@ -165,27 +149,21 @@ client
165
149
  });
166
150
  ```
167
151
 
168
- #### Callbacks
169
-
170
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
171
- but they are supported by the send operation.
152
+ #### Aggregated client
172
153
 
173
- ```js
174
- // callbacks.
175
- client.send(command, (err, data) => {
176
- // process err and data.
177
- });
178
- ```
154
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
179
155
 
180
- #### v2 compatible style
156
+ `StorageGateway` extends `StorageGatewayClient` and additionally supports all operations, waiters, and paginators as methods.
157
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
181
158
 
182
- The client can also send requests using v2 compatible style.
183
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
184
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
159
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`StorageGatewayClient`).
160
+ More details are in the blog post on
161
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
185
162
 
186
163
  ```ts
187
- import * as AWS from "@aws-sdk/client-storage-gateway";
188
- const client = new AWS.StorageGateway({ region: "REGION" });
164
+ import { StorageGateway } from "@aws-sdk/client-storage-gateway";
165
+
166
+ const client = new StorageGateway({ region: "REGION" });
189
167
 
190
168
  // async/await.
191
169
  try {
@@ -205,7 +183,7 @@ client
205
183
  // error handling.
206
184
  });
207
185
 
208
- // callbacks.
186
+ // callbacks (not recommended).
209
187
  client.listTapes(params, (err, data) => {
210
188
  // process err and data.
211
189
  });
@@ -233,12 +211,14 @@ try {
233
211
  }
234
212
  ```
235
213
 
214
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
215
+
236
216
  ## Getting Help
237
217
 
238
218
  Please use these community resources for getting help.
239
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
219
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
240
220
 
241
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
221
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
242
222
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
243
223
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
244
224
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-storage-gateway",
3
3
  "description": "AWS SDK for JavaScript Storage Gateway 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-storage-gateway",
@@ -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.19",
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.5",
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
  },