@aws-sdk/client-gamelift 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
@@ -66,8 +66,9 @@ and resources</a>
66
66
  </ul>
67
67
 
68
68
  ## Installing
69
- To install this package, simply type add or install @aws-sdk/client-gamelift
70
- using your favorite package manager:
69
+
70
+ To install this package, use the CLI of your favorite package manager:
71
+
71
72
  - `npm install @aws-sdk/client-gamelift`
72
73
  - `yarn add @aws-sdk/client-gamelift`
73
74
  - `pnpm add @aws-sdk/client-gamelift`
@@ -92,15 +93,15 @@ import { GameLiftClient, ListAliasesCommand } from "@aws-sdk/client-gamelift";
92
93
 
93
94
  ### Usage
94
95
 
95
- To send a request, you:
96
+ To send a request:
96
97
 
97
- - Initiate client with configuration (e.g. credentials, region).
98
- - Initiate command with input parameters.
99
- - Call `send` operation on client with command object as input.
100
- - If you are using a custom http handler, you may call `destroy()` to close open connections.
98
+ - Instantiate a client with configuration (e.g. credentials, region).
99
+ - See [docs/CLIENTS](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/CLIENTS.md) for configuration details.
100
+ - See [@aws-sdk/config](https://github.com/aws/aws-sdk-js-v3/blob/main/packages/config/README.md) for additional options.
101
+ - Instantiate a command with input parameters.
102
+ - Call the `send` operation on the client, providing the command object as input.
101
103
 
102
104
  ```js
103
- // a client can be shared by different commands.
104
105
  const client = new GameLiftClient({ region: "REGION" });
105
106
 
106
107
  const params = { /** input parameters */ };
@@ -109,7 +110,7 @@ const command = new ListAliasesCommand(params);
109
110
 
110
111
  #### Async/await
111
112
 
112
- We recommend using [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
113
+ We recommend using the [await](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
113
114
  operator to wait for the promise returned by send operation as follows:
114
115
 
115
116
  ```js
@@ -124,26 +125,9 @@ try {
124
125
  }
125
126
  ```
126
127
 
127
- Async-await is clean, concise, intuitive, easy to debug and has better error handling
128
- as compared to using Promise chains or callbacks.
129
-
130
128
  #### Promises
131
129
 
132
- You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining)
133
- to execute send operation.
134
-
135
- ```js
136
- client.send(command).then(
137
- (data) => {
138
- // process data.
139
- },
140
- (error) => {
141
- // error handling.
142
- }
143
- );
144
- ```
145
-
146
- Promises can also be called using `.catch()` and `.finally()` as follows:
130
+ You can also use [Promise chaining](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Using_promises#chaining).
147
131
 
148
132
  ```js
149
133
  client
@@ -159,27 +143,21 @@ client
159
143
  });
160
144
  ```
161
145
 
162
- #### Callbacks
163
-
164
- We do not recommend using callbacks because of [callback hell](http://callbackhell.com/),
165
- but they are supported by the send operation.
146
+ #### Aggregated client
166
147
 
167
- ```js
168
- // callbacks.
169
- client.send(command, (err, data) => {
170
- // process err and data.
171
- });
172
- ```
148
+ The aggregated client class is exported from the same package, but without the "Client" suffix.
173
149
 
174
- #### v2 compatible style
150
+ `GameLift` extends `GameLiftClient` and additionally supports all operations, waiters, and paginators as methods.
151
+ This style may be familiar to you from the AWS SDK for JavaScript v2.
175
152
 
176
- The client can also send requests using v2 compatible style.
177
- However, it results in a bigger bundle size and may be dropped in next major version. More details in the blog post
178
- on [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/)
153
+ If you are bundling the AWS SDK, we recommend using only the bare-bones client (`GameLiftClient`).
154
+ More details are in the blog post on
155
+ [modular packages in AWS SDK for JavaScript](https://aws.amazon.com/blogs/developer/modular-packages-in-aws-sdk-for-javascript/).
179
156
 
180
157
  ```ts
181
- import * as AWS from "@aws-sdk/client-gamelift";
182
- const client = new AWS.GameLift({ region: "REGION" });
158
+ import { GameLift } from "@aws-sdk/client-gamelift";
159
+
160
+ const client = new GameLift({ region: "REGION" });
183
161
 
184
162
  // async/await.
185
163
  try {
@@ -199,7 +177,7 @@ client
199
177
  // error handling.
200
178
  });
201
179
 
202
- // callbacks.
180
+ // callbacks (not recommended).
203
181
  client.listAliases(params, (err, data) => {
204
182
  // process err and data.
205
183
  });
@@ -227,12 +205,14 @@ try {
227
205
  }
228
206
  ```
229
207
 
208
+ See also [docs/ERROR_HANDLING](https://github.com/aws/aws-sdk-js-v3/blob/main/supplemental-docs/ERROR_HANDLING.md).
209
+
230
210
  ## Getting Help
231
211
 
232
212
  Please use these community resources for getting help.
233
- We use the GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
213
+ We use GitHub issues for tracking bugs and feature requests, but have limited bandwidth to address them.
234
214
 
235
- - Visit [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
215
+ - Visit the [Developer Guide](https://docs.aws.amazon.com/sdk-for-javascript/v3/developer-guide/welcome.html)
236
216
  or [API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/index.html).
237
217
  - Check out the blog posts tagged with [`aws-sdk-js`](https://aws.amazon.com/blogs/developer/tag/aws-sdk-js/)
238
218
  on AWS Developer Blog.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-gamelift",
3
3
  "description": "AWS SDK for JavaScript Gamelift 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-gamelift",
@@ -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
  },