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