@aws-sdk/client-data-pipeline 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
@@ -25,8 +25,9 @@ the task assigned to it by the web service, reporting progress to the web servic
25
25
  When the task is done, the task runner reports the final success or failure of the task to the web service.</p>
26
26
 
27
27
  ## Installing
28
- To install this package, simply type add or install @aws-sdk/client-data-pipeline
29
- using your favorite package manager:
28
+
29
+ To install this package, use the CLI of your favorite package manager:
30
+
30
31
  - `npm install @aws-sdk/client-data-pipeline`
31
32
  - `yarn add @aws-sdk/client-data-pipeline`
32
33
  - `pnpm add @aws-sdk/client-data-pipeline`
@@ -51,15 +52,15 @@ import { DataPipelineClient, ListPipelinesCommand } from "@aws-sdk/client-data-p
51
52
 
52
53
  ### Usage
53
54
 
54
- To send a request, you:
55
+ To send a request:
55
56
 
56
- - Initiate client with configuration (e.g. credentials, region).
57
- - Initiate command with input parameters.
58
- - Call `send` operation on client with command object as input.
59
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
57
+ - Instantiate a client with configuration (e.g. credentials, region).
58
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
59
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
60
+ - Instantiate a command with input parameters.
61
+ - Call the `send` operation on the client, providing the command object as input.
60
62
 
61
63
  ```js
62
- // a client can be shared by different commands.
63
64
  const client = new DataPipelineClient({ region: "REGION" });
64
65
 
65
66
  const params = { /** input parameters */ };
@@ -68,7 +69,7 @@ const command = new ListPipelinesCommand(params);
68
69
 
69
70
  #### Async/await
70
71
 
71
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
72
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
72
73
  operator to wait for the promise returned by send operation as follows:
73
74
 
74
75
  ```js
@@ -83,26 +84,9 @@ try {
83
84
  }
84
85
  ```
85
86
 
86
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
87
- as compared to using Promise chains or callbacks.
88
-
89
87
  #### Promises
90
88
 
91
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
92
- to execute send operation.
93
-
94
- ```js
95
- client.send(command).then(
96
- (data) => {
97
- // process data.
98
- },
99
- (error) => {
100
- // error handling.
101
- }
102
- );
103
- ```
104
-
105
- Promises can also be called using `.catch()` and `.finally()` as follows:
89
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
106
90
 
107
91
  ```js
108
92
  client
@@ -118,27 +102,21 @@ client
118
102
  });
119
103
  ```
120
104
 
121
- #### Callbacks
122
-
123
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
124
- but they are supported by the send operation.
105
+ #### Aggregated client
125
106
 
126
- ```js
127
- // callbacks.
128
- client.send(command, (err, data) => {
129
- // process err and data.
130
- });
131
- ```
107
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
132
108
 
133
- #### v2 compatible style
109
+ `DataPipeline` extends `DataPipelineClient` and additionally supports all operations, waiters, and paginators as methods.
110
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
134
111
 
135
- The client can also send requests using v2 compatible style.
136
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
137
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
112
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`DataPipelineClient`).
113
+ More details are in the blog post on
114
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
138
115
 
139
116
  ```ts
140
- import * as AWS from "@aws-sdk/client-data-pipeline";
141
- const client = new AWS.DataPipeline({ region: "REGION" });
117
+ import { DataPipeline } from "@aws-sdk/client-data-pipeline";
118
+
119
+ const client = new DataPipeline({ region: "REGION" });
142
120
 
143
121
  // async/await.
144
122
  try {
@@ -158,7 +136,7 @@ client
158
136
  // error handling.
159
137
  });
160
138
 
161
- // callbacks.
139
+ // callbacks (not recommended).
162
140
  client.listPipelines(params, (err, data) => {
163
141
  // process err and data.
164
142
  });
@@ -186,12 +164,14 @@ try {
186
164
  }
187
165
  ```
188
166
 
167
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
168
+
189
169
  ## Getting Help
190
170
 
191
171
  Please use these community resources for getting help.
192
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
172
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
193
173
 
194
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
174
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
195
175
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
196
176
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
197
177
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-data-pipeline",
3
3
  "description": "AWS SDK for JavaScript Data Pipeline 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-data-pipeline",
@@ -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
  },