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