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