@aws-sdk/client-codeconnections 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.
- package/README.md +26 -46
- package/package.json +33 -33
package/README.md
CHANGED
|
@@ -87,8 +87,9 @@ CodeConnections.</p>
|
|
|
87
87
|
Tools User Guide</a>.</p>
|
|
88
88
|
|
|
89
89
|
## Installing
|
|
90
|
-
|
|
91
|
-
|
|
90
|
+
|
|
91
|
+
To install this package, use the CLI of your favorite package manager:
|
|
92
|
+
|
|
92
93
|
- `npm install @aws-sdk/client-codeconnections`
|
|
93
94
|
- `yarn add @aws-sdk/client-codeconnections`
|
|
94
95
|
- `pnpm add @aws-sdk/client-codeconnections`
|
|
@@ -113,15 +114,15 @@ import { CodeConnectionsClient, ListHostsCommand } from "@aws-sdk/client-codecon
|
|
|
113
114
|
|
|
114
115
|
### Usage
|
|
115
116
|
|
|
116
|
-
To send a request
|
|
117
|
+
To send a request:
|
|
117
118
|
|
|
118
|
-
-
|
|
119
|
-
-
|
|
120
|
-
-
|
|
121
|
-
-
|
|
119
|
+
- Instantiate a client with configuration (e.g. credentials, region).
|
|
120
|
+
- See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
|
|
121
|
+
- See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
|
|
122
|
+
- Instantiate a command with input parameters.
|
|
123
|
+
- Call the `send` operation on the client, providing the command object as input.
|
|
122
124
|
|
|
123
125
|
```js
|
|
124
|
-
// a client can be shared by different commands.
|
|
125
126
|
const client = new CodeConnectionsClient({ region: "REGION" });
|
|
126
127
|
|
|
127
128
|
const params = { /** input parameters */ };
|
|
@@ -130,7 +131,7 @@ const command = new ListHostsCommand(params);
|
|
|
130
131
|
|
|
131
132
|
#### Async/await
|
|
132
133
|
|
|
133
|
-
We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
|
|
134
|
+
We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
|
|
134
135
|
operator to wait for the promise returned by send operation as follows:
|
|
135
136
|
|
|
136
137
|
```js
|
|
@@ -145,26 +146,9 @@ try {
|
|
|
145
146
|
}
|
|
146
147
|
```
|
|
147
148
|
|
|
148
|
-
Async-await is clean, concise, intuitive, easy to debug and has better error handling
|
|
149
|
-
as compared to using Promise chains or callbacks.
|
|
150
|
-
|
|
151
149
|
#### Promises
|
|
152
150
|
|
|
153
|
-
You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
|
|
154
|
-
to execute send operation.
|
|
155
|
-
|
|
156
|
-
```js
|
|
157
|
-
client.send(command).then(
|
|
158
|
-
(data) => {
|
|
159
|
-
// process data.
|
|
160
|
-
},
|
|
161
|
-
(error) => {
|
|
162
|
-
// error handling.
|
|
163
|
-
}
|
|
164
|
-
);
|
|
165
|
-
```
|
|
166
|
-
|
|
167
|
-
Promises can also be called using `.catch()` and `.finally()` as follows:
|
|
151
|
+
You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
|
|
168
152
|
|
|
169
153
|
```js
|
|
170
154
|
client
|
|
@@ -180,27 +164,21 @@ client
|
|
|
180
164
|
});
|
|
181
165
|
```
|
|
182
166
|
|
|
183
|
-
####
|
|
184
|
-
|
|
185
|
-
We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
|
|
186
|
-
but they are supported by the send operation.
|
|
167
|
+
#### Aggregated client
|
|
187
168
|
|
|
188
|
-
|
|
189
|
-
// callbacks.
|
|
190
|
-
client.send(command, (err, data) => {
|
|
191
|
-
// process err and data.
|
|
192
|
-
});
|
|
193
|
-
```
|
|
169
|
+
The aggregated client class is exported from the same package, but without the "Client" suffix.
|
|
194
170
|
|
|
195
|
-
|
|
171
|
+
`CodeConnections` extends `CodeConnectionsClient` and additionally supports all operations, waiters, and paginators as methods.
|
|
172
|
+
This style may be familiar to you from the AWS SDK for JavaScript v2.
|
|
196
173
|
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
174
|
+
If you are bundling the AWS SDK, we recommend using only the bare-bones client (`CodeConnectionsClient`).
|
|
175
|
+
More details are in the blog post on
|
|
176
|
+
[modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
|
|
200
177
|
|
|
201
178
|
```ts
|
|
202
|
-
import
|
|
203
|
-
|
|
179
|
+
import { CodeConnections } from "@aws-sdk/client-codeconnections";
|
|
180
|
+
|
|
181
|
+
const client = new CodeConnections({ region: "REGION" });
|
|
204
182
|
|
|
205
183
|
// async/await.
|
|
206
184
|
try {
|
|
@@ -220,7 +198,7 @@ client
|
|
|
220
198
|
// error handling.
|
|
221
199
|
});
|
|
222
200
|
|
|
223
|
-
// callbacks.
|
|
201
|
+
// callbacks (not recommended).
|
|
224
202
|
client.listHosts(params, (err, data) => {
|
|
225
203
|
// process err and data.
|
|
226
204
|
});
|
|
@@ -248,12 +226,14 @@ try {
|
|
|
248
226
|
}
|
|
249
227
|
```
|
|
250
228
|
|
|
229
|
+
See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
|
|
230
|
+
|
|
251
231
|
## Getting Help
|
|
252
232
|
|
|
253
233
|
Please use these community resources for getting help.
|
|
254
|
-
We use
|
|
234
|
+
We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
|
|
255
235
|
|
|
256
|
-
- Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
|
|
236
|
+
- Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
|
|
257
237
|
or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
|
|
258
238
|
- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
|
|
259
239
|
on AWS Developer Blog.
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-codeconnections",
|
|
3
3
|
"description": "AWS SDK for JavaScript Codeconnections Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
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-codeconnections",
|
|
@@ -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.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "^3.972.
|
|
26
|
-
"@aws-sdk/middleware-host-header": "^3.972.
|
|
27
|
-
"@aws-sdk/middleware-logger": "^3.972.
|
|
28
|
-
"@aws-sdk/middleware-recursion-detection": "^3.972.
|
|
29
|
-
"@aws-sdk/middleware-user-agent": "^3.972.
|
|
30
|
-
"@aws-sdk/region-config-resolver": "^3.972.
|
|
31
|
-
"@aws-sdk/types": "^3.973.
|
|
32
|
-
"@aws-sdk/util-endpoints": "^3.996.
|
|
33
|
-
"@aws-sdk/util-user-agent-browser": "^3.972.
|
|
34
|
-
"@aws-sdk/util-user-agent-node": "^3.973.
|
|
35
|
-
"@smithy/config-resolver": "^4.4.
|
|
36
|
-
"@smithy/core": "^3.23.
|
|
37
|
-
"@smithy/fetch-http-handler": "^5.3.
|
|
38
|
-
"@smithy/hash-node": "^4.2.
|
|
39
|
-
"@smithy/invalid-dependency": "^4.2.
|
|
40
|
-
"@smithy/middleware-content-length": "^4.2.
|
|
41
|
-
"@smithy/middleware-endpoint": "^4.4.
|
|
42
|
-
"@smithy/middleware-retry": "^4.4.
|
|
43
|
-
"@smithy/middleware-serde": "^4.2.
|
|
44
|
-
"@smithy/middleware-stack": "^4.2.
|
|
45
|
-
"@smithy/node-config-provider": "^4.3.
|
|
46
|
-
"@smithy/node-http-handler": "^4.4.
|
|
47
|
-
"@smithy/protocol-http": "^5.3.
|
|
48
|
-
"@smithy/smithy-client": "^4.12.
|
|
49
|
-
"@smithy/types": "^4.13.
|
|
50
|
-
"@smithy/url-parser": "^4.2.
|
|
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.
|
|
55
|
-
"@smithy/util-defaults-mode-node": "^4.2.
|
|
56
|
-
"@smithy/util-endpoints": "^3.3.
|
|
57
|
-
"@smithy/util-middleware": "^4.2.
|
|
58
|
-
"@smithy/util-retry": "^4.2.
|
|
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
|
},
|