@aws-sdk/client-kms 3.1008.0 → 3.1010.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
@@ -106,8 +106,9 @@ keys and assigning policies, by using the console.</p>
106
106
  </ul>
107
107
 
108
108
  ## Installing
109
- To install this package, simply type add or install @aws-sdk/client-kms
110
- using your favorite package manager:
109
+
110
+ To install this package, use the CLI of your favorite package manager:
111
+
111
112
  - `npm install @aws-sdk/client-kms`
112
113
  - `yarn add @aws-sdk/client-kms`
113
114
  - `pnpm add @aws-sdk/client-kms`
@@ -132,15 +133,15 @@ import { KMSClient, ListAliasesCommand } from "@aws-sdk/client-kms";
132
133
 
133
134
  ### Usage
134
135
 
135
- To send a request, you:
136
+ To send a request:
136
137
 
137
- - Initiate client with configuration (e.g. credentials, region).
138
- - Initiate command with input parameters.
139
- - Call `send` operation on client with command object as input.
140
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
138
+ - Instantiate a client with configuration (e.g. credentials, region).
139
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
140
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
141
+ - Instantiate a command with input parameters.
142
+ - Call the `send` operation on the client, providing the command object as input.
141
143
 
142
144
  ```js
143
- // a client can be shared by different commands.
144
145
  const client = new KMSClient({ region: "REGION" });
145
146
 
146
147
  const params = { /** input parameters */ };
@@ -149,7 +150,7 @@ const command = new ListAliasesCommand(params);
149
150
 
150
151
  #### Async/await
151
152
 
152
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
153
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
153
154
  operator to wait for the promise returned by send operation as follows:
154
155
 
155
156
  ```js
@@ -164,26 +165,9 @@ try {
164
165
  }
165
166
  ```
166
167
 
167
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
168
- as compared to using Promise chains or callbacks.
169
-
170
168
  #### Promises
171
169
 
172
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
173
- to execute send operation.
174
-
175
- ```js
176
- client.send(command).then(
177
- (data) => {
178
- // process data.
179
- },
180
- (error) => {
181
- // error handling.
182
- }
183
- );
184
- ```
185
-
186
- Promises can also be called using `.catch()` and `.finally()` as follows:
170
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
187
171
 
188
172
  ```js
189
173
  client
@@ -199,27 +183,21 @@ client
199
183
  });
200
184
  ```
201
185
 
202
- #### Callbacks
203
-
204
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
205
- but they are supported by the send operation.
186
+ #### Aggregated client
206
187
 
207
- ```js
208
- // callbacks.
209
- client.send(command, (err, data) => {
210
- // process err and data.
211
- });
212
- ```
188
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
213
189
 
214
- #### v2 compatible style
190
+ `KMS` extends `KMSClient` and additionally supports all operations, waiters, and paginators as methods.
191
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
215
192
 
216
- The client can also send requests using v2 compatible style.
217
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
218
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
193
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`KMSClient`).
194
+ More details are in the blog post on
195
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
219
196
 
220
197
  ```ts
221
- import * as AWS from "@aws-sdk/client-kms";
222
- const client = new AWS.KMS({ region: "REGION" });
198
+ import { KMS } from "@aws-sdk/client-kms";
199
+
200
+ const client = new KMS({ region: "REGION" });
223
201
 
224
202
  // async/await.
225
203
  try {
@@ -239,7 +217,7 @@ client
239
217
  // error handling.
240
218
  });
241
219
 
242
- // callbacks.
220
+ // callbacks (not recommended).
243
221
  client.listAliases(params, (err, data) => {
244
222
  // process err and data.
245
223
  });
@@ -267,12 +245,14 @@ try {
267
245
  }
268
246
  ```
269
247
 
248
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
249
+
270
250
  ## Getting Help
271
251
 
272
252
  Please use these community resources for getting help.
273
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
253
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
274
254
 
275
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
255
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
276
256
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
277
257
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
278
258
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-kms",
3
3
  "description": "AWS SDK for JavaScript Kms Client for Node.js, Browser and React Native",
4
- "version": "3.1008.0",
4
+ "version": "3.1010.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-kms",
@@ -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.20",
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.6",
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
  },