@aws-sdk/client-codedeploy 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 +34 -34
package/README.md CHANGED
@@ -101,8 +101,9 @@ details about Amazon ECS service deployments.</p>
101
101
  </ul>
102
102
 
103
103
  ## Installing
104
- To install this package, simply type add or install @aws-sdk/client-codedeploy
105
- using your favorite package manager:
104
+
105
+ To install this package, use the CLI of your favorite package manager:
106
+
106
107
  - `npm install @aws-sdk/client-codedeploy`
107
108
  - `yarn add @aws-sdk/client-codedeploy`
108
109
  - `pnpm add @aws-sdk/client-codedeploy`
@@ -127,15 +128,15 @@ import { CodeDeployClient, ListApplicationsCommand } from "@aws-sdk/client-coded
127
128
 
128
129
  ### Usage
129
130
 
130
- To send a request, you:
131
+ To send a request:
131
132
 
132
- - Initiate client with configuration (e.g. credentials, region).
133
- - Initiate command with input parameters.
134
- - Call `send` operation on client with command object as input.
135
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
133
+ - Instantiate a client with configuration (e.g. credentials, region).
134
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
135
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
136
+ - Instantiate a command with input parameters.
137
+ - Call the `send` operation on the client, providing the command object as input.
136
138
 
137
139
  ```js
138
- // a client can be shared by different commands.
139
140
  const client = new CodeDeployClient({ region: "REGION" });
140
141
 
141
142
  const params = { /** input parameters */ };
@@ -144,7 +145,7 @@ const command = new ListApplicationsCommand(params);
144
145
 
145
146
  #### Async/await
146
147
 
147
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
148
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
148
149
  operator to wait for the promise returned by send operation as follows:
149
150
 
150
151
  ```js
@@ -159,26 +160,9 @@ try {
159
160
  }
160
161
  ```
161
162
 
162
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
163
- as compared to using Promise chains or callbacks.
164
-
165
163
  #### Promises
166
164
 
167
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
168
- to execute send operation.
169
-
170
- ```js
171
- client.send(command).then(
172
- (data) => {
173
- // process data.
174
- },
175
- (error) => {
176
- // error handling.
177
- }
178
- );
179
- ```
180
-
181
- Promises can also be called using `.catch()` and `.finally()` as follows:
165
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
182
166
 
183
167
  ```js
184
168
  client
@@ -194,27 +178,21 @@ client
194
178
  });
195
179
  ```
196
180
 
197
- #### Callbacks
198
-
199
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
200
- but they are supported by the send operation.
181
+ #### Aggregated client
201
182
 
202
- ```js
203
- // callbacks.
204
- client.send(command, (err, data) => {
205
- // process err and data.
206
- });
207
- ```
183
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
208
184
 
209
- #### v2 compatible style
185
+ `CodeDeploy` extends `CodeDeployClient` and additionally supports all operations, waiters, and paginators as methods.
186
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
210
187
 
211
- The client can also send requests using v2 compatible style.
212
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
213
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
188
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`CodeDeployClient`).
189
+ More details are in the blog post on
190
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
214
191
 
215
192
  ```ts
216
- import * as AWS from "@aws-sdk/client-codedeploy";
217
- const client = new AWS.CodeDeploy({ region: "REGION" });
193
+ import { CodeDeploy } from "@aws-sdk/client-codedeploy";
194
+
195
+ const client = new CodeDeploy({ region: "REGION" });
218
196
 
219
197
  // async/await.
220
198
  try {
@@ -234,7 +212,7 @@ client
234
212
  // error handling.
235
213
  });
236
214
 
237
- // callbacks.
215
+ // callbacks (not recommended).
238
216
  client.listApplications(params, (err, data) => {
239
217
  // process err and data.
240
218
  });
@@ -262,12 +240,14 @@ try {
262
240
  }
263
241
  ```
264
242
 
243
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
244
+
265
245
  ## Getting Help
266
246
 
267
247
  Please use these community resources for getting help.
268
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
248
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
269
249
 
270
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
250
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
271
251
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
272
252
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
273
253
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-codedeploy",
3
3
  "description": "AWS SDK for JavaScript Codedeploy 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-codedeploy",
@@ -23,43 +23,43 @@
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
- "@smithy/util-waiter": "^4.2.12",
62
+ "@smithy/util-waiter": "^4.2.13",
63
63
  "tslib": "^2.6.2"
64
64
  },
65
65
  "devDependencies": {