@aws-sdk/client-ssm-guiconnect 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
@@ -32,8 +32,9 @@ Amazon Web Services Systems Manager</a>
32
32
  </ul>
33
33
 
34
34
  ## Installing
35
- To install this package, simply type add or install @aws-sdk/client-ssm-guiconnect
36
- using your favorite package manager:
35
+
36
+ To install this package, use the CLI of your favorite package manager:
37
+
37
38
  - `npm install @aws-sdk/client-ssm-guiconnect`
38
39
  - `yarn add @aws-sdk/client-ssm-guiconnect`
39
40
  - `pnpm add @aws-sdk/client-ssm-guiconnect`
@@ -58,15 +59,15 @@ import { SSMGuiConnectClient, GetConnectionRecordingPreferencesCommand } from "@
58
59
 
59
60
  ### Usage
60
61
 
61
- To send a request, you:
62
+ To send a request:
62
63
 
63
- - Initiate client with configuration (e.g. credentials, region).
64
- - Initiate command with input parameters.
65
- - Call `send` operation on client with command object as input.
66
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
64
+ - Instantiate a client with configuration (e.g. credentials, region).
65
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
66
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
67
+ - Instantiate a command with input parameters.
68
+ - Call the `send` operation on the client, providing the command object as input.
67
69
 
68
70
  ```js
69
- // a client can be shared by different commands.
70
71
  const client = new SSMGuiConnectClient({ region: "REGION" });
71
72
 
72
73
  const params = { /** input parameters */ };
@@ -75,7 +76,7 @@ const command = new GetConnectionRecordingPreferencesCommand(params);
75
76
 
76
77
  #### Async/await
77
78
 
78
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
79
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
79
80
  operator to wait for the promise returned by send operation as follows:
80
81
 
81
82
  ```js
@@ -90,26 +91,9 @@ try {
90
91
  }
91
92
  ```
92
93
 
93
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
94
- as compared to using Promise chains or callbacks.
95
-
96
94
  #### Promises
97
95
 
98
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
99
- to execute send operation.
100
-
101
- ```js
102
- client.send(command).then(
103
- (data) => {
104
- // process data.
105
- },
106
- (error) => {
107
- // error handling.
108
- }
109
- );
110
- ```
111
-
112
- Promises can also be called using `.catch()` and `.finally()` as follows:
96
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
113
97
 
114
98
  ```js
115
99
  client
@@ -125,27 +109,21 @@ client
125
109
  });
126
110
  ```
127
111
 
128
- #### Callbacks
129
-
130
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
131
- but they are supported by the send operation.
112
+ #### Aggregated client
132
113
 
133
- ```js
134
- // callbacks.
135
- client.send(command, (err, data) => {
136
- // process err and data.
137
- });
138
- ```
114
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
139
115
 
140
- #### v2 compatible style
116
+ `SSMGuiConnect` extends `SSMGuiConnectClient` and additionally supports all operations, waiters, and paginators as methods.
117
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
141
118
 
142
- The client can also send requests using v2 compatible style.
143
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
144
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
119
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`SSMGuiConnectClient`).
120
+ More details are in the blog post on
121
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
145
122
 
146
123
  ```ts
147
- import * as AWS from "@aws-sdk/client-ssm-guiconnect";
148
- const client = new AWS.SSMGuiConnect({ region: "REGION" });
124
+ import { SSMGuiConnect } from "@aws-sdk/client-ssm-guiconnect";
125
+
126
+ const client = new SSMGuiConnect({ region: "REGION" });
149
127
 
150
128
  // async/await.
151
129
  try {
@@ -165,7 +143,7 @@ client
165
143
  // error handling.
166
144
  });
167
145
 
168
- // callbacks.
146
+ // callbacks (not recommended).
169
147
  client.getConnectionRecordingPreferences(params, (err, data) => {
170
148
  // process err and data.
171
149
  });
@@ -193,12 +171,14 @@ try {
193
171
  }
194
172
  ```
195
173
 
174
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
175
+
196
176
  ## Getting Help
197
177
 
198
178
  Please use these community resources for getting help.
199
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
179
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
200
180
 
201
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
181
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
202
182
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
203
183
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
204
184
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-ssm-guiconnect",
3
3
  "description": "AWS SDK for JavaScript Ssm Guiconnect 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-ssm-guiconnect",
@@ -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
  },