@aws-sdk/client-appflow 3.1007.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
@@ -43,8 +43,9 @@ the <a href="https://help.salesforce.com/articleView?id=remoteaccess_authenticat
43
43
  </a> documentation.</p>
44
44
 
45
45
  ## Installing
46
- To install this package, simply type add or install @aws-sdk/client-appflow
47
- using your favorite package manager:
46
+
47
+ To install this package, use the CLI of your favorite package manager:
48
+
48
49
  - `npm install @aws-sdk/client-appflow`
49
50
  - `yarn add @aws-sdk/client-appflow`
50
51
  - `pnpm add @aws-sdk/client-appflow`
@@ -69,15 +70,15 @@ import { AppflowClient, ListFlowsCommand } from "@aws-sdk/client-appflow";
69
70
 
70
71
  ### Usage
71
72
 
72
- To send a request, you:
73
+ To send a request:
73
74
 
74
- - Initiate client with configuration (e.g. credentials, region).
75
- - Initiate command with input parameters.
76
- - Call `send` operation on client with command object as input.
77
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
75
+ - Instantiate a client with configuration (e.g. credentials, region).
76
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
77
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
78
+ - Instantiate a command with input parameters.
79
+ - Call the `send` operation on the client, providing the command object as input.
78
80
 
79
81
  ```js
80
- // a client can be shared by different commands.
81
82
  const client = new AppflowClient({ region: "REGION" });
82
83
 
83
84
  const params = { /** input parameters */ };
@@ -86,7 +87,7 @@ const command = new ListFlowsCommand(params);
86
87
 
87
88
  #### Async/await
88
89
 
89
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
90
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
90
91
  operator to wait for the promise returned by send operation as follows:
91
92
 
92
93
  ```js
@@ -101,26 +102,9 @@ try {
101
102
  }
102
103
  ```
103
104
 
104
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
105
- as compared to using Promise chains or callbacks.
106
-
107
105
  #### Promises
108
106
 
109
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
110
- to execute send operation.
111
-
112
- ```js
113
- client.send(command).then(
114
- (data) => {
115
- // process data.
116
- },
117
- (error) => {
118
- // error handling.
119
- }
120
- );
121
- ```
122
-
123
- Promises can also be called using `.catch()` and `.finally()` as follows:
107
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
124
108
 
125
109
  ```js
126
110
  client
@@ -136,27 +120,21 @@ client
136
120
  });
137
121
  ```
138
122
 
139
- #### Callbacks
140
-
141
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
142
- but they are supported by the send operation.
123
+ #### Aggregated client
143
124
 
144
- ```js
145
- // callbacks.
146
- client.send(command, (err, data) => {
147
- // process err and data.
148
- });
149
- ```
125
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
150
126
 
151
- #### v2 compatible style
127
+ `Appflow` extends `AppflowClient` and additionally supports all operations, waiters, and paginators as methods.
128
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
152
129
 
153
- The client can also send requests using v2 compatible style.
154
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
155
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
130
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`AppflowClient`).
131
+ More details are in the blog post on
132
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
156
133
 
157
134
  ```ts
158
- import * as AWS from "@aws-sdk/client-appflow";
159
- const client = new AWS.Appflow({ region: "REGION" });
135
+ import { Appflow } from "@aws-sdk/client-appflow";
136
+
137
+ const client = new Appflow({ region: "REGION" });
160
138
 
161
139
  // async/await.
162
140
  try {
@@ -176,7 +154,7 @@ client
176
154
  // error handling.
177
155
  });
178
156
 
179
- // callbacks.
157
+ // callbacks (not recommended).
180
158
  client.listFlows(params, (err, data) => {
181
159
  // process err and data.
182
160
  });
@@ -204,12 +182,14 @@ try {
204
182
  }
205
183
  ```
206
184
 
185
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
186
+
207
187
  ## Getting Help
208
188
 
209
189
  Please use these community resources for getting help.
210
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
190
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
211
191
 
212
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
192
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
213
193
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
214
194
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
215
195
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-appflow",
3
3
  "description": "AWS SDK for JavaScript Appflow Client for Node.js, Browser and React Native",
4
- "version": "3.1007.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-appflow",
@@ -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.19",
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.5",
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
  },