@aws-sdk/client-ec2-instance-connect 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.
- package/README.md +26 -46
- package/package.json +33 -33
package/README.md
CHANGED
|
@@ -18,8 +18,9 @@ your Linux instance using EC2 Instance Connect</a>.</p>
|
|
|
18
18
|
Reference</a>.</p>
|
|
19
19
|
|
|
20
20
|
## Installing
|
|
21
|
-
|
|
22
|
-
|
|
21
|
+
|
|
22
|
+
To install this package, use the CLI of your favorite package manager:
|
|
23
|
+
|
|
23
24
|
- `npm install @aws-sdk/client-ec2-instance-connect`
|
|
24
25
|
- `yarn add @aws-sdk/client-ec2-instance-connect`
|
|
25
26
|
- `pnpm add @aws-sdk/client-ec2-instance-connect`
|
|
@@ -44,15 +45,15 @@ import { EC2InstanceConnectClient, SendSSHPublicKeyCommand } from "@aws-sdk/clie
|
|
|
44
45
|
|
|
45
46
|
### Usage
|
|
46
47
|
|
|
47
|
-
To send a request
|
|
48
|
+
To send a request:
|
|
48
49
|
|
|
49
|
-
-
|
|
50
|
-
-
|
|
51
|
-
-
|
|
52
|
-
-
|
|
50
|
+
- Instantiate a client with configuration (e.g. credentials, region).
|
|
51
|
+
- See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
|
|
52
|
+
- See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
|
|
53
|
+
- Instantiate a command with input parameters.
|
|
54
|
+
- Call the `send` operation on the client, providing the command object as input.
|
|
53
55
|
|
|
54
56
|
```js
|
|
55
|
-
// a client can be shared by different commands.
|
|
56
57
|
const client = new EC2InstanceConnectClient({ region: "REGION" });
|
|
57
58
|
|
|
58
59
|
const params = { /** input parameters */ };
|
|
@@ -61,7 +62,7 @@ const command = new SendSSHPublicKeyCommand(params);
|
|
|
61
62
|
|
|
62
63
|
#### Async/await
|
|
63
64
|
|
|
64
|
-
We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
|
|
65
|
+
We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
|
|
65
66
|
operator to wait for the promise returned by send operation as follows:
|
|
66
67
|
|
|
67
68
|
```js
|
|
@@ -76,26 +77,9 @@ try {
|
|
|
76
77
|
}
|
|
77
78
|
```
|
|
78
79
|
|
|
79
|
-
Async-await is clean, concise, intuitive, easy to debug and has better error handling
|
|
80
|
-
as compared to using Promise chains or callbacks.
|
|
81
|
-
|
|
82
80
|
#### Promises
|
|
83
81
|
|
|
84
|
-
You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
|
|
85
|
-
to execute send operation.
|
|
86
|
-
|
|
87
|
-
```js
|
|
88
|
-
client.send(command).then(
|
|
89
|
-
(data) => {
|
|
90
|
-
// process data.
|
|
91
|
-
},
|
|
92
|
-
(error) => {
|
|
93
|
-
// error handling.
|
|
94
|
-
}
|
|
95
|
-
);
|
|
96
|
-
```
|
|
97
|
-
|
|
98
|
-
Promises can also be called using `.catch()` and `.finally()` as follows:
|
|
82
|
+
You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
|
|
99
83
|
|
|
100
84
|
```js
|
|
101
85
|
client
|
|
@@ -111,27 +95,21 @@ client
|
|
|
111
95
|
});
|
|
112
96
|
```
|
|
113
97
|
|
|
114
|
-
####
|
|
115
|
-
|
|
116
|
-
We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
|
|
117
|
-
but they are supported by the send operation.
|
|
98
|
+
#### Aggregated client
|
|
118
99
|
|
|
119
|
-
|
|
120
|
-
// callbacks.
|
|
121
|
-
client.send(command, (err, data) => {
|
|
122
|
-
// process err and data.
|
|
123
|
-
});
|
|
124
|
-
```
|
|
100
|
+
The aggregated client class is exported from the same package, but without the "Client" suffix.
|
|
125
101
|
|
|
126
|
-
|
|
102
|
+
`EC2InstanceConnect` extends `EC2InstanceConnectClient` and additionally supports all operations, waiters, and paginators as methods.
|
|
103
|
+
This style may be familiar to you from the AWS SDK for JavaScript v2.
|
|
127
104
|
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
105
|
+
If you are bundling the AWS SDK, we recommend using only the bare-bones client (`EC2InstanceConnectClient`).
|
|
106
|
+
More details are in the blog post on
|
|
107
|
+
[modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
|
|
131
108
|
|
|
132
109
|
```ts
|
|
133
|
-
import
|
|
134
|
-
|
|
110
|
+
import { EC2InstanceConnect } from "@aws-sdk/client-ec2-instance-connect";
|
|
111
|
+
|
|
112
|
+
const client = new EC2InstanceConnect({ region: "REGION" });
|
|
135
113
|
|
|
136
114
|
// async/await.
|
|
137
115
|
try {
|
|
@@ -151,7 +129,7 @@ client
|
|
|
151
129
|
// error handling.
|
|
152
130
|
});
|
|
153
131
|
|
|
154
|
-
// callbacks.
|
|
132
|
+
// callbacks (not recommended).
|
|
155
133
|
client.sendSSHPublicKey(params, (err, data) => {
|
|
156
134
|
// process err and data.
|
|
157
135
|
});
|
|
@@ -179,12 +157,14 @@ try {
|
|
|
179
157
|
}
|
|
180
158
|
```
|
|
181
159
|
|
|
160
|
+
See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
|
|
161
|
+
|
|
182
162
|
## Getting Help
|
|
183
163
|
|
|
184
164
|
Please use these community resources for getting help.
|
|
185
|
-
We use
|
|
165
|
+
We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
|
|
186
166
|
|
|
187
|
-
- Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
|
|
167
|
+
- Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
|
|
188
168
|
or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
|
|
189
169
|
- Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
|
|
190
170
|
on AWS Developer Blog.
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-ec2-instance-connect",
|
|
3
3
|
"description": "AWS SDK for JavaScript Ec2 Instance Connect 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-ec2-instance-connect",
|
|
@@ -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
|
},
|