@aws-sdk/client-codepipeline 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
@@ -205,8 +205,9 @@ success.</p>
205
205
  </ul>
206
206
 
207
207
  ## Installing
208
- To install this package, simply type add or install @aws-sdk/client-codepipeline
209
- using your favorite package manager:
208
+
209
+ To install this package, use the CLI of your favorite package manager:
210
+
210
211
  - `npm install @aws-sdk/client-codepipeline`
211
212
  - `yarn add @aws-sdk/client-codepipeline`
212
213
  - `pnpm add @aws-sdk/client-codepipeline`
@@ -231,15 +232,15 @@ import { CodePipelineClient, ListActionTypesCommand } from "@aws-sdk/client-code
231
232
 
232
233
  ### Usage
233
234
 
234
- To send a request, you:
235
+ To send a request:
235
236
 
236
- - Initiate client with configuration (e.g. credentials, region).
237
- - Initiate command with input parameters.
238
- - Call `send` operation on client with command object as input.
239
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
237
+ - Instantiate a client with configuration (e.g. credentials, region).
238
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
239
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
240
+ - Instantiate a command with input parameters.
241
+ - Call the `send` operation on the client, providing the command object as input.
240
242
 
241
243
  ```js
242
- // a client can be shared by different commands.
243
244
  const client = new CodePipelineClient({ region: "REGION" });
244
245
 
245
246
  const params = { /** input parameters */ };
@@ -248,7 +249,7 @@ const command = new ListActionTypesCommand(params);
248
249
 
249
250
  #### Async/await
250
251
 
251
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
252
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
252
253
  operator to wait for the promise returned by send operation as follows:
253
254
 
254
255
  ```js
@@ -263,26 +264,9 @@ try {
263
264
  }
264
265
  ```
265
266
 
266
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
267
- as compared to using Promise chains or callbacks.
268
-
269
267
  #### Promises
270
268
 
271
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
272
- to execute send operation.
273
-
274
- ```js
275
- client.send(command).then(
276
- (data) => {
277
- // process data.
278
- },
279
- (error) => {
280
- // error handling.
281
- }
282
- );
283
- ```
284
-
285
- Promises can also be called using `.catch()` and `.finally()` as follows:
269
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
286
270
 
287
271
  ```js
288
272
  client
@@ -298,27 +282,21 @@ client
298
282
  });
299
283
  ```
300
284
 
301
- #### Callbacks
302
-
303
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
304
- but they are supported by the send operation.
285
+ #### Aggregated client
305
286
 
306
- ```js
307
- // callbacks.
308
- client.send(command, (err, data) => {
309
- // process err and data.
310
- });
311
- ```
287
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
312
288
 
313
- #### v2 compatible style
289
+ `CodePipeline` extends `CodePipelineClient` and additionally supports all operations, waiters, and paginators as methods.
290
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
314
291
 
315
- The client can also send requests using v2 compatible style.
316
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
317
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
292
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`CodePipelineClient`).
293
+ More details are in the blog post on
294
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
318
295
 
319
296
  ```ts
320
- import * as AWS from "@aws-sdk/client-codepipeline";
321
- const client = new AWS.CodePipeline({ region: "REGION" });
297
+ import { CodePipeline } from "@aws-sdk/client-codepipeline";
298
+
299
+ const client = new CodePipeline({ region: "REGION" });
322
300
 
323
301
  // async/await.
324
302
  try {
@@ -338,7 +316,7 @@ client
338
316
  // error handling.
339
317
  });
340
318
 
341
- // callbacks.
319
+ // callbacks (not recommended).
342
320
  client.listActionTypes(params, (err, data) => {
343
321
  // process err and data.
344
322
  });
@@ -366,12 +344,14 @@ try {
366
344
  }
367
345
  ```
368
346
 
347
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
348
+
369
349
  ## Getting Help
370
350
 
371
351
  Please use these community resources for getting help.
372
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
352
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
373
353
 
374
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
354
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
375
355
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
376
356
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
377
357
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-codepipeline",
3
3
  "description": "AWS SDK for JavaScript Codepipeline 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-codepipeline",
@@ -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
  },