@aws-sdk/client-global-accelerator 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 +26 -46
  2. package/package.json +33 -33
package/README.md CHANGED
@@ -56,8 +56,9 @@ directed to healthy endpoints.</p>
56
56
  <a href="https://docs.aws.amazon.com/global-accelerator/latest/dg/what-is-global-accelerator.html">Global Accelerator Developer Guide</a>.</p>
57
57
 
58
58
  ## Installing
59
- To install this package, simply type add or install @aws-sdk/client-global-accelerator
60
- using your favorite package manager:
59
+
60
+ To install this package, use the CLI of your favorite package manager:
61
+
61
62
  - `npm install @aws-sdk/client-global-accelerator`
62
63
  - `yarn add @aws-sdk/client-global-accelerator`
63
64
  - `pnpm add @aws-sdk/client-global-accelerator`
@@ -82,15 +83,15 @@ import { GlobalAcceleratorClient, ListAcceleratorsCommand } from "@aws-sdk/clien
82
83
 
83
84
  ### Usage
84
85
 
85
- To send a request, you:
86
+ To send a request:
86
87
 
87
- - Initiate client with configuration (e.g. credentials, region).
88
- - Initiate command with input parameters.
89
- - Call `send` operation on client with command object as input.
90
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
88
+ - Instantiate a client with configuration (e.g. credentials, region).
89
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
90
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
91
+ - Instantiate a command with input parameters.
92
+ - Call the `send` operation on the client, providing the command object as input.
91
93
 
92
94
  ```js
93
- // a client can be shared by different commands.
94
95
  const client = new GlobalAcceleratorClient({ region: "REGION" });
95
96
 
96
97
  const params = { /** input parameters */ };
@@ -99,7 +100,7 @@ const command = new ListAcceleratorsCommand(params);
99
100
 
100
101
  #### Async/await
101
102
 
102
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
103
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
103
104
  operator to wait for the promise returned by send operation as follows:
104
105
 
105
106
  ```js
@@ -114,26 +115,9 @@ try {
114
115
  }
115
116
  ```
116
117
 
117
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
118
- as compared to using Promise chains or callbacks.
119
-
120
118
  #### Promises
121
119
 
122
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
123
- to execute send operation.
124
-
125
- ```js
126
- client.send(command).then(
127
- (data) => {
128
- // process data.
129
- },
130
- (error) => {
131
- // error handling.
132
- }
133
- );
134
- ```
135
-
136
- Promises can also be called using `.catch()` and `.finally()` as follows:
120
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
137
121
 
138
122
  ```js
139
123
  client
@@ -149,27 +133,21 @@ client
149
133
  });
150
134
  ```
151
135
 
152
- #### Callbacks
153
-
154
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
155
- but they are supported by the send operation.
136
+ #### Aggregated client
156
137
 
157
- ```js
158
- // callbacks.
159
- client.send(command, (err, data) => {
160
- // process err and data.
161
- });
162
- ```
138
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
163
139
 
164
- #### v2 compatible style
140
+ `GlobalAccelerator` extends `GlobalAcceleratorClient` and additionally supports all operations, waiters, and paginators as methods.
141
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
165
142
 
166
- The client can also send requests using v2 compatible style.
167
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
168
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
143
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`GlobalAcceleratorClient`).
144
+ More details are in the blog post on
145
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
169
146
 
170
147
  ```ts
171
- import * as AWS from "@aws-sdk/client-global-accelerator";
172
- const client = new AWS.GlobalAccelerator({ region: "REGION" });
148
+ import { GlobalAccelerator } from "@aws-sdk/client-global-accelerator";
149
+
150
+ const client = new GlobalAccelerator({ region: "REGION" });
173
151
 
174
152
  // async/await.
175
153
  try {
@@ -189,7 +167,7 @@ client
189
167
  // error handling.
190
168
  });
191
169
 
192
- // callbacks.
170
+ // callbacks (not recommended).
193
171
  client.listAccelerators(params, (err, data) => {
194
172
  // process err and data.
195
173
  });
@@ -217,12 +195,14 @@ try {
217
195
  }
218
196
  ```
219
197
 
198
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
199
+
220
200
  ## Getting Help
221
201
 
222
202
  Please use these community resources for getting help.
223
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
203
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
224
204
 
225
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
205
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
226
206
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
227
207
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
228
208
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-global-accelerator",
3
3
  "description": "AWS SDK for JavaScript Global Accelerator 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-global-accelerator",
@@ -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
  },