@aws-sdk/client-arc-region-switch 3.1008.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 +65 -46
  2. package/package.json +34 -34
package/README.md CHANGED
@@ -9,8 +9,9 @@ AWS SDK for JavaScript ARCRegionSwitch Client for Node.js, Browser and React Nat
9
9
  <p>Amazon Application Recovery Controller (ARC) Region switch helps you to quickly and reliably shift traffic away from an impaired Amazon Web Services Region to a healthy Region. With Region switch, you can create plans that define the steps to shift traffic for your application from one Amazon Web Services Region to another.</p> <p>Region switch provides a structured approach to multi-Region failover, helping you to meet your recovery time objectives (RTOs) and maintain business continuity during regional disruptions.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/region-switch.html">Region switch in ARC</a> in the <i>Amazon Application Recovery Controller User Guide</i>.</p>
10
10
 
11
11
  ## Installing
12
- To install this package, simply type add or install @aws-sdk/client-arc-region-switch
13
- using your favorite package manager:
12
+
13
+ To install this package, use the CLI of your favorite package manager:
14
+
14
15
  - `npm install @aws-sdk/client-arc-region-switch`
15
16
  - `yarn add @aws-sdk/client-arc-region-switch`
16
17
  - `pnpm add @aws-sdk/client-arc-region-switch`
@@ -35,24 +36,63 @@ import { ARCRegionSwitchClient, ListPlansCommand } from "@aws-sdk/client-arc-reg
35
36
 
36
37
  ### Usage
37
38
 
38
- To send a request, you:
39
+ To send a request:
39
40
 
40
- - Initiate client with configuration (e.g. credentials, region).
41
- - Initiate command with input parameters.
42
- - Call `send` operation on client with command object as input.
43
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
41
+ - Instantiate a client with configuration (e.g. credentials, region).
42
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
43
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
44
+ - Instantiate a command with input parameters.
45
+ - Call the `send` operation on the client, providing the command object as input.
44
46
 
45
47
  ```js
46
- // a client can be shared by different commands.
47
48
  const client = new ARCRegionSwitchClient({ region: "REGION" });
48
49
 
49
50
  const params = { /** input parameters */ };
50
51
  const command = new ListPlansCommand(params);
51
52
  ```
52
53
 
54
+ #### Supported Message Protocols
55
+
56
+ This client supports multiple protocols.
57
+
58
+ The default for this client is **AWS JSON (RPC) 1.0**.
59
+
60
+ We have selected this default based on our evaluation of the
61
+ performance characteristics of this protocol format in JavaScript. You don't need to change it,
62
+ but you have the option to do so, for example to support existing integrations or tests.
63
+ Selecting a non-default protocol changes the format
64
+ of the data sent over the network, but does not affect how you interact with the
65
+ client using JavaScript objects.
66
+
67
+ Install the `@aws-sdk/config` package to access alternate protocols.
68
+
69
+ See [AWS Protocols](https://smithy.io/2.0/aws/protocols/index.html) for more information.
70
+
71
+ ##### AWS JSON (RPC) 1.0
72
+
73
+ This protocol uses JSON payloads.
74
+ ```js
75
+ import { AwsJson1_0Protocol } from "@aws-sdk/config/protocol";
76
+
77
+ const client = new ARCRegionSwitchClient({
78
+ protocol: AwsJson1_0Protocol
79
+ });
80
+ ```
81
+
82
+ ##### Smithy RPC v2 CBOR
83
+
84
+ This protocol uses CBOR payloads.
85
+ ```js
86
+ import { AwsJson1_0Protocol } from "@aws-sdk/config/protocol";
87
+
88
+ const client = new ARCRegionSwitchClient({
89
+ protocol: AwsJson1_0Protocol
90
+ });
91
+ ```
92
+
53
93
  #### Async/await
54
94
 
55
- 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)
56
96
  operator to wait for the promise returned by send operation as follows:
57
97
 
58
98
  ```js
@@ -67,26 +107,9 @@ try {
67
107
  }
68
108
  ```
69
109
 
70
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
71
- as compared to using Promise chains or callbacks.
72
-
73
110
  #### Promises
74
111
 
75
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
76
- to execute send operation.
77
-
78
- ```js
79
- client.send(command).then(
80
- (data) => {
81
- // process data.
82
- },
83
- (error) => {
84
- // error handling.
85
- }
86
- );
87
- ```
88
-
89
- 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).
90
113
 
91
114
  ```js
92
115
  client
@@ -102,27 +125,21 @@ client
102
125
  });
103
126
  ```
104
127
 
105
- #### Callbacks
106
-
107
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
108
- but they are supported by the send operation.
128
+ #### Aggregated client
109
129
 
110
- ```js
111
- // callbacks.
112
- client.send(command, (err, data) => {
113
- // process err and data.
114
- });
115
- ```
130
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
116
131
 
117
- #### v2 compatible style
132
+ `ARCRegionSwitch` extends `ARCRegionSwitchClient` 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.
118
134
 
119
- The client can also send requests using v2 compatible style.
120
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
121
- 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 (`ARCRegionSwitchClient`).
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/).
122
138
 
123
139
  ```ts
124
- import * as AWS from "@aws-sdk/client-arc-region-switch";
125
- const client = new AWS.ARCRegionSwitch({ region: "REGION" });
140
+ import { ARCRegionSwitch } from "@aws-sdk/client-arc-region-switch";
141
+
142
+ const client = new ARCRegionSwitch({ region: "REGION" });
126
143
 
127
144
  // async/await.
128
145
  try {
@@ -142,7 +159,7 @@ client
142
159
  // error handling.
143
160
  });
144
161
 
145
- // callbacks.
162
+ // callbacks (not recommended).
146
163
  client.listPlans(params, (err, data) => {
147
164
  // process err and data.
148
165
  });
@@ -170,12 +187,14 @@ try {
170
187
  }
171
188
  ```
172
189
 
190
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
191
+
173
192
  ## Getting Help
174
193
 
175
194
  Please use these community resources for getting help.
176
- 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.
177
196
 
178
- - 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)
179
198
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
180
199
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
181
200
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-arc-region-switch",
3
3
  "description": "AWS SDK for JavaScript Arc Region Switch Client for Node.js, Browser and React Native",
4
- "version": "3.1008.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-arc-region-switch",
@@ -21,43 +21,43 @@
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.20",
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.6",
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
- "@smithy/util-waiter": "^4.2.12",
60
+ "@smithy/util-waiter": "^4.2.13",
61
61
  "tslib": "^2.6.2"
62
62
  },
63
63
  "devDependencies": {