@aws-sdk/client-pinpoint-email 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
@@ -37,8 +37,9 @@ minimizing latency. To learn more about the number of Availability Zones that ar
37
37
  available in each Region, see <a href="http://aws.amazon.com/about-aws/global-infrastructure/">AWS Global Infrastructure</a>.</p>
38
38
 
39
39
  ## Installing
40
- To install this package, simply type add or install @aws-sdk/client-pinpoint-email
41
- using your favorite package manager:
40
+
41
+ To install this package, use the CLI of your favorite package manager:
42
+
42
43
  - `npm install @aws-sdk/client-pinpoint-email`
43
44
  - `yarn add @aws-sdk/client-pinpoint-email`
44
45
  - `pnpm add @aws-sdk/client-pinpoint-email`
@@ -63,15 +64,15 @@ import { PinpointEmailClient, ListConfigurationSetsCommand } from "@aws-sdk/clie
63
64
 
64
65
  ### Usage
65
66
 
66
- To send a request, you:
67
+ To send a request:
67
68
 
68
- - Initiate client with configuration (e.g. credentials, region).
69
- - Initiate command with input parameters.
70
- - Call `send` operation on client with command object as input.
71
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
69
+ - Instantiate a client with configuration (e.g. credentials, region).
70
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
71
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
72
+ - Instantiate a command with input parameters.
73
+ - Call the `send` operation on the client, providing the command object as input.
72
74
 
73
75
  ```js
74
- // a client can be shared by different commands.
75
76
  const client = new PinpointEmailClient({ region: "REGION" });
76
77
 
77
78
  const params = { /** input parameters */ };
@@ -80,7 +81,7 @@ const command = new ListConfigurationSetsCommand(params);
80
81
 
81
82
  #### Async/await
82
83
 
83
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
84
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
84
85
  operator to wait for the promise returned by send operation as follows:
85
86
 
86
87
  ```js
@@ -95,26 +96,9 @@ try {
95
96
  }
96
97
  ```
97
98
 
98
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
99
- as compared to using Promise chains or callbacks.
100
-
101
99
  #### Promises
102
100
 
103
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
104
- to execute send operation.
105
-
106
- ```js
107
- client.send(command).then(
108
- (data) => {
109
- // process data.
110
- },
111
- (error) => {
112
- // error handling.
113
- }
114
- );
115
- ```
116
-
117
- Promises can also be called using `.catch()` and `.finally()` as follows:
101
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
118
102
 
119
103
  ```js
120
104
  client
@@ -130,27 +114,21 @@ client
130
114
  });
131
115
  ```
132
116
 
133
- #### Callbacks
134
-
135
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
136
- but they are supported by the send operation.
117
+ #### Aggregated client
137
118
 
138
- ```js
139
- // callbacks.
140
- client.send(command, (err, data) => {
141
- // process err and data.
142
- });
143
- ```
119
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
144
120
 
145
- #### v2 compatible style
121
+ `PinpointEmail` extends `PinpointEmailClient` and additionally supports all operations, waiters, and paginators as methods.
122
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
146
123
 
147
- The client can also send requests using v2 compatible style.
148
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
149
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
124
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`PinpointEmailClient`).
125
+ More details are in the blog post on
126
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
150
127
 
151
128
  ```ts
152
- import * as AWS from "@aws-sdk/client-pinpoint-email";
153
- const client = new AWS.PinpointEmail({ region: "REGION" });
129
+ import { PinpointEmail } from "@aws-sdk/client-pinpoint-email";
130
+
131
+ const client = new PinpointEmail({ region: "REGION" });
154
132
 
155
133
  // async/await.
156
134
  try {
@@ -170,7 +148,7 @@ client
170
148
  // error handling.
171
149
  });
172
150
 
173
- // callbacks.
151
+ // callbacks (not recommended).
174
152
  client.listConfigurationSets(params, (err, data) => {
175
153
  // process err and data.
176
154
  });
@@ -198,12 +176,14 @@ try {
198
176
  }
199
177
  ```
200
178
 
179
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
180
+
201
181
  ## Getting Help
202
182
 
203
183
  Please use these community resources for getting help.
204
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
184
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
205
185
 
206
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
186
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
207
187
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
208
188
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
209
189
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-pinpoint-email",
3
3
  "description": "AWS SDK for JavaScript Pinpoint Email 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-pinpoint-email",
@@ -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
  },