@aws-sdk/client-cloud9 3.1008.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
@@ -81,8 +81,9 @@ environment member for an environment.</p>
81
81
  </ul>
82
82
 
83
83
  ## Installing
84
- To install this package, simply type add or install @aws-sdk/client-cloud9
85
- using your favorite package manager:
84
+
85
+ To install this package, use the CLI of your favorite package manager:
86
+
86
87
  - `npm install @aws-sdk/client-cloud9`
87
88
  - `yarn add @aws-sdk/client-cloud9`
88
89
  - `pnpm add @aws-sdk/client-cloud9`
@@ -107,15 +108,15 @@ import { Cloud9Client, ListEnvironmentsCommand } from "@aws-sdk/client-cloud9";
107
108
 
108
109
  ### Usage
109
110
 
110
- To send a request, you:
111
+ To send a request:
111
112
 
112
- - Initiate client with configuration (e.g. credentials, region).
113
- - Initiate command with input parameters.
114
- - Call `send` operation on client with command object as input.
115
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
113
+ - Instantiate a client with configuration (e.g. credentials, region).
114
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
115
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
116
+ - Instantiate a command with input parameters.
117
+ - Call the `send` operation on the client, providing the command object as input.
116
118
 
117
119
  ```js
118
- // a client can be shared by different commands.
119
120
  const client = new Cloud9Client({ region: "REGION" });
120
121
 
121
122
  const params = { /** input parameters */ };
@@ -124,7 +125,7 @@ const command = new ListEnvironmentsCommand(params);
124
125
 
125
126
  #### Async/await
126
127
 
127
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
128
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
128
129
  operator to wait for the promise returned by send operation as follows:
129
130
 
130
131
  ```js
@@ -139,26 +140,9 @@ try {
139
140
  }
140
141
  ```
141
142
 
142
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
143
- as compared to using Promise chains or callbacks.
144
-
145
143
  #### Promises
146
144
 
147
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
148
- to execute send operation.
149
-
150
- ```js
151
- client.send(command).then(
152
- (data) => {
153
- // process data.
154
- },
155
- (error) => {
156
- // error handling.
157
- }
158
- );
159
- ```
160
-
161
- Promises can also be called using `.catch()` and `.finally()` as follows:
145
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
162
146
 
163
147
  ```js
164
148
  client
@@ -174,27 +158,21 @@ client
174
158
  });
175
159
  ```
176
160
 
177
- #### Callbacks
178
-
179
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
180
- but they are supported by the send operation.
161
+ #### Aggregated client
181
162
 
182
- ```js
183
- // callbacks.
184
- client.send(command, (err, data) => {
185
- // process err and data.
186
- });
187
- ```
163
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
188
164
 
189
- #### v2 compatible style
165
+ `Cloud9` extends `Cloud9Client` and additionally supports all operations, waiters, and paginators as methods.
166
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
190
167
 
191
- The client can also send requests using v2 compatible style.
192
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
193
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
168
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`Cloud9Client`).
169
+ More details are in the blog post on
170
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
194
171
 
195
172
  ```ts
196
- import * as AWS from "@aws-sdk/client-cloud9";
197
- const client = new AWS.Cloud9({ region: "REGION" });
173
+ import { Cloud9 } from "@aws-sdk/client-cloud9";
174
+
175
+ const client = new Cloud9({ region: "REGION" });
198
176
 
199
177
  // async/await.
200
178
  try {
@@ -214,7 +192,7 @@ client
214
192
  // error handling.
215
193
  });
216
194
 
217
- // callbacks.
195
+ // callbacks (not recommended).
218
196
  client.listEnvironments(params, (err, data) => {
219
197
  // process err and data.
220
198
  });
@@ -242,12 +220,14 @@ try {
242
220
  }
243
221
  ```
244
222
 
223
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
224
+
245
225
  ## Getting Help
246
226
 
247
227
  Please use these community resources for getting help.
248
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
228
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
249
229
 
250
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
230
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
251
231
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
252
232
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
253
233
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-cloud9",
3
3
  "description": "AWS SDK for JavaScript Cloud9 Client for Node.js, Browser and React Native",
4
- "version": "3.1008.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-cloud9",
@@ -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.20",
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.6",
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
  },