@aws-sdk/client-gamelift 3.315.0 → 3.316.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.
@@ -104,2960 +104,692 @@ import { UpdateRuntimeConfigurationCommandInput, UpdateRuntimeConfigurationComma
104
104
  import { UpdateScriptCommandInput, UpdateScriptCommandOutput } from "./commands/UpdateScriptCommand";
105
105
  import { ValidateMatchmakingRuleSetCommandInput, ValidateMatchmakingRuleSetCommandOutput } from "./commands/ValidateMatchmakingRuleSetCommand";
106
106
  import { GameLiftClient } from "./GameLiftClient";
107
- /**
108
- * @public
109
- * <p>Amazon GameLift provides solutions for hosting session-based multiplayer game servers in the
110
- * cloud, including tools for deploying, operating, and scaling game servers. Built on
111
- * Amazon Web Services global computing infrastructure, GameLift helps you deliver high-performance,
112
- * high-reliability, low-cost game servers while dynamically scaling your resource usage to
113
- * meet player demand. </p>
114
- * <p>
115
- * <b>About GameLift solutions</b>
116
- * </p>
117
- * <p>Get more information on these GameLift solutions in the <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/">GameLift Developer Guide</a>.</p>
118
- * <ul>
119
- * <li>
120
- * <p>GameLift managed hosting -- GameLift offers a fully managed service to set up
121
- * and maintain computing machines for hosting, manage game session and player
122
- * session life cycle, and handle security, storage, and performance tracking. You
123
- * can use automatic scaling tools to balance player demand and hosting costs,
124
- * configure your game session management to minimize player latency, and add
125
- * FlexMatch for matchmaking.</p>
126
- * </li>
127
- * <li>
128
- * <p>Managed hosting with Realtime Servers -- With GameLift Realtime Servers, you can quickly configure
129
- * and set up ready-to-go game servers for your game. Realtime Servers provides a game server
130
- * framework with core GameLift infrastructure already built in. Then use the full
131
- * range of GameLift managed hosting features, including FlexMatch, for your
132
- * game.</p>
133
- * </li>
134
- * <li>
135
- * <p>GameLift FleetIQ -- Use GameLift FleetIQ as a standalone service while hosting your games using EC2
136
- * instances and Auto Scaling groups. GameLift FleetIQ provides optimizations for game
137
- * hosting, including boosting the viability of low-cost Spot Instances gaming. For
138
- * a complete solution, pair the GameLift FleetIQ and FlexMatch standalone services.</p>
139
- * </li>
140
- * <li>
141
- * <p>GameLift FlexMatch -- Add matchmaking to your game hosting solution. FlexMatch is a
142
- * customizable matchmaking service for multiplayer games. Use FlexMatch as
143
- * integrated with GameLift managed hosting or incorporate FlexMatch as a standalone
144
- * service into your own hosting solution.</p>
145
- * </li>
146
- * </ul>
147
- * <p>
148
- * <b>About this API Reference</b>
149
- * </p>
150
- * <p>This reference guide describes the low-level service API for Amazon GameLift. With each topic
151
- * in this guide, you can find links to language-specific SDK guides and the Amazon Web Services CLI
152
- * reference. Useful links:</p>
153
- * <ul>
154
- * <li>
155
- * <p>
156
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html">GameLift API
157
- * operations listed by tasks</a>
158
- * </p>
159
- * </li>
160
- * <li>
161
- * <p>
162
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-components.html"> GameLift tools
163
- * and resources</a>
164
- * </p>
165
- * </li>
166
- * </ul>
167
- */
168
- export declare class GameLift extends GameLiftClient {
169
- /**
170
- * @public
171
- * <p>Registers a player's acceptance or rejection of a proposed FlexMatch match. A
172
- * matchmaking configuration may require player acceptance; if so, then matches built with
173
- * that configuration cannot be completed unless all players accept the proposed match
174
- * within a specified time limit. </p>
175
- * <p>When FlexMatch builds a match, all the matchmaking tickets involved in the proposed
176
- * match are placed into status <code>REQUIRES_ACCEPTANCE</code>. This is a trigger for
177
- * your game to get acceptance from all players in the ticket. Acceptances are only valid
178
- * for tickets when they are in this status; all other acceptances result in an
179
- * error.</p>
180
- * <p>To register acceptance, specify the ticket ID, a response, and one or more players.
181
- * Once all players have registered acceptance, the matchmaking tickets advance to status
182
- * <code>PLACING</code>, where a new game session is created for the match. </p>
183
- * <p>If any player rejects the match, or if acceptances are not received before a specified
184
- * timeout, the proposed match is dropped. The matchmaking tickets are then handled in one
185
- * of two ways: For tickets where one or more players rejected the match or failed to
186
- * respond, the ticket status is set to <code>CANCELLED</code>, and processing is
187
- * terminated. For tickets where players have accepted or not yet responded, the ticket
188
- * status is returned to <code>SEARCHING</code> to find a new match. A new matchmaking
189
- * request for these players can be submitted as needed. </p>
190
- * <p>
191
- * <b>Learn more</b>
192
- * </p>
193
- * <p>
194
- * <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html">
195
- * Add FlexMatch to a game client</a>
196
- * </p>
197
- * <p>
198
- * <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html">
199
- * FlexMatch events</a> (reference)</p>
107
+ export interface GameLift {
108
+ /**
109
+ * @see {@link AcceptMatchCommand}
200
110
  */
201
111
  acceptMatch(args: AcceptMatchCommandInput, options?: __HttpHandlerOptions): Promise<AcceptMatchCommandOutput>;
202
112
  acceptMatch(args: AcceptMatchCommandInput, cb: (err: any, data?: AcceptMatchCommandOutput) => void): void;
203
113
  acceptMatch(args: AcceptMatchCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AcceptMatchCommandOutput) => void): void;
204
114
  /**
205
- * @public
206
- * <p>
207
- * <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b>
208
- * </p>
209
- * <p>Locates an available game server and
210
- * temporarily reserves it to host gameplay and players. This operation is called from a
211
- * game client or client service (such as a matchmaker) to request hosting resources for a
212
- * new game session. In response, GameLift FleetIQ locates an available game server, places it in
213
- * <code>CLAIMED</code> status for 60 seconds, and returns connection information that
214
- * players can use to connect to the game server. </p>
215
- * <p>To claim a game server, identify a game server group. You can also specify a game
216
- * server ID, although this approach bypasses GameLift FleetIQ placement optimization. Optionally,
217
- * include game data to pass to the game server at the start of a game session, such as a
218
- * game map or player information. </p>
219
- * <p>When a game server is successfully claimed, connection information is returned. A
220
- * claimed game server's utilization status remains <code>AVAILABLE</code> while the claim
221
- * status is set to <code>CLAIMED</code> for up to 60 seconds. This time period gives the
222
- * game server time to update its status to <code>UTILIZED</code> after players join. If
223
- * the game server's status is not updated within 60 seconds, the game server reverts to
224
- * unclaimed status and is available to be claimed by another request. The claim time
225
- * period is a fixed value and is not configurable.</p>
226
- * <p>If you try to claim a specific game server, this request will fail in the following
227
- * cases:</p>
228
- * <ul>
229
- * <li>
230
- * <p>If the game server utilization status is <code>UTILIZED</code>.</p>
231
- * </li>
232
- * <li>
233
- * <p>If the game server claim status is <code>CLAIMED</code>.</p>
234
- * </li>
235
- * </ul>
236
- * <note>
237
- * <p>When claiming a specific game server, this request will succeed even if the game
238
- * server is running on an instance in <code>DRAINING</code> status. To avoid this,
239
- * first check the instance status by calling <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameServerInstances.html">DescribeGameServerInstances</a> .</p>
240
- * </note>
241
- * <p>
242
- * <b>Learn more</b>
243
- * </p>
244
- * <p>
245
- * <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ
246
- * Guide</a>
247
- * </p>
115
+ * @see {@link ClaimGameServerCommand}
248
116
  */
249
117
  claimGameServer(args: ClaimGameServerCommandInput, options?: __HttpHandlerOptions): Promise<ClaimGameServerCommandOutput>;
250
118
  claimGameServer(args: ClaimGameServerCommandInput, cb: (err: any, data?: ClaimGameServerCommandOutput) => void): void;
251
119
  claimGameServer(args: ClaimGameServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ClaimGameServerCommandOutput) => void): void;
252
120
  /**
253
- * @public
254
- * <p>Creates an alias for a fleet. In most situations, you can use an alias ID in place of
255
- * a fleet ID. An alias provides a level of abstraction for a fleet that is useful when
256
- * redirecting player traffic from one fleet to another, such as when updating your game
257
- * build. </p>
258
- * <p>Amazon GameLift supports two types of routing strategies for aliases: simple and terminal. A
259
- * simple alias points to an active fleet. A terminal alias is used to display messaging or
260
- * link to a URL instead of routing players to an active fleet. For example, you might use
261
- * a terminal alias when a game version is no longer supported and you want to direct
262
- * players to an upgrade site. </p>
263
- * <p>To create a fleet alias, specify an alias name, routing strategy, and optional
264
- * description. Each simple alias can point to only one fleet, but a fleet can have
265
- * multiple aliases. If successful, a new alias record is returned, including an alias ID
266
- * and an ARN. You can reassign an alias to another fleet by calling
267
- * <code>UpdateAlias</code>.</p>
268
- * <p>
269
- * <b>Related actions</b>
270
- * </p>
271
- * <p>
272
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
273
- * </p>
121
+ * @see {@link CreateAliasCommand}
274
122
  */
275
123
  createAlias(args: CreateAliasCommandInput, options?: __HttpHandlerOptions): Promise<CreateAliasCommandOutput>;
276
124
  createAlias(args: CreateAliasCommandInput, cb: (err: any, data?: CreateAliasCommandOutput) => void): void;
277
125
  createAlias(args: CreateAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAliasCommandOutput) => void): void;
278
126
  /**
279
- * @public
280
- * <p>Creates a new Amazon GameLift build resource for your game server binary files. Combine game
281
- * server binaries into a zip file for use with Amazon GameLift. </p>
282
- * <important>
283
- * <p>When setting up a new game build for GameLift, we recommend using the CLI command <b>
284
- * <a href="https://docs.aws.amazon.com/cli/latest/reference/gamelift/upload-build.html">upload-build</a>
285
- * </b>. This helper command combines two tasks: (1) it
286
- * uploads your build files from a file directory to a GameLift Amazon S3 location, and (2)
287
- * it creates a new build resource.</p>
288
- * </important>
289
- * <p>You can use the operation in the following scenarios:</p>
290
- * <ul>
291
- * <li>
292
- * <p>To create a new game build with build files that are in an Amazon S3 location under
293
- * an Amazon Web Services account that you control. To use this option, you give Amazon GameLift access to
294
- * the Amazon S3 bucket. With permissions in place, specify a build name, operating
295
- * system, and the Amazon S3 storage location of your game build.</p>
296
- * </li>
297
- * <li>
298
- * <p>To directly upload your build files to a GameLift Amazon S3 location. To use this
299
- * option, specify a build name and operating system. This operation creates a new
300
- * build resource and also returns an Amazon S3 location with temporary access
301
- * credentials. Use the credentials to manually upload your build files to the
302
- * specified Amazon S3 location. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/UploadingObjects.html">Uploading Objects</a> in
303
- * the <i>Amazon S3 Developer Guide</i>. After you upload build files to
304
- * the GameLift Amazon S3 location, you can't update them. </p>
305
- * </li>
306
- * </ul>
307
- * <p>If successful, this operation creates a new build resource with a unique build ID and
308
- * places it in <code>INITIALIZED</code> status. A build must be in <code>READY</code>
309
- * status before you can create fleets with it.</p>
310
- * <p>
311
- * <b>Learn more</b>
312
- * </p>
313
- * <p>
314
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html">Uploading Your
315
- * Game</a>
316
- * </p>
317
- * <p>
318
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html#gamelift-build-cli-uploading-create-build"> Create a Build with Files in Amazon S3</a>
319
- * </p>
320
- * <p>
321
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
322
- * </p>
127
+ * @see {@link CreateBuildCommand}
323
128
  */
324
129
  createBuild(args: CreateBuildCommandInput, options?: __HttpHandlerOptions): Promise<CreateBuildCommandOutput>;
325
130
  createBuild(args: CreateBuildCommandInput, cb: (err: any, data?: CreateBuildCommandOutput) => void): void;
326
131
  createBuild(args: CreateBuildCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateBuildCommandOutput) => void): void;
327
132
  /**
328
- * @public
329
- * <p>Creates a fleet of Amazon Elastic Compute Cloud (Amazon Elastic Compute Cloud) instances to host your
330
- * custom game server or Realtime Servers. Use this operation to configure the computing resources for
331
- * your fleet and provide instructions for running game servers on each instance.</p>
332
- * <p>Most GameLift fleets can deploy instances to multiple locations, including the home
333
- * Region (where the fleet is created) and an optional set of remote locations. Fleets that
334
- * are created in the following Amazon Web Services Regions support multiple locations: us-east-1 (N.
335
- * Virginia), us-west-2 (Oregon), eu-central-1 (Frankfurt), eu-west-1 (Ireland),
336
- * ap-southeast-2 (Sydney), ap-northeast-1 (Tokyo), and ap-northeast-2 (Seoul). Fleets that
337
- * are created in other GameLift Regions can deploy instances in the fleet's home Region
338
- * only. All fleet instances use the same configuration regardless of location; however,
339
- * you can adjust capacity settings and turn auto-scaling on/off for each location.</p>
340
- * <p>To create a fleet, choose the hardware for your instances, specify a game server build
341
- * or Realtime script to deploy, and provide a runtime configuration to direct GameLift how
342
- * to start and run game servers on each instance in the fleet. Set permissions for inbound
343
- * traffic to your game servers, and enable optional features as needed. When creating a
344
- * multi-location fleet, provide a list of additional remote locations.</p>
345
- * <p>If you need to debug your fleet, fetch logs, view performance metrics or other actions
346
- * on the fleet, create the development fleet with port 22/3389 open. As a best practice,
347
- * we recommend opening ports for remote access only when you need them and closing them
348
- * when you're finished. </p>
349
- * <p>If successful, this operation creates a new Fleet resource and places it in
350
- * <code>NEW</code> status, which prompts GameLift to initiate the <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creation-workflow.html">fleet creation
351
- * workflow</a>.</p>
352
- * <p>
353
- * <b>Learn more</b>
354
- * </p>
355
- * <p>
356
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up
357
- * fleets</a>
358
- * </p>
359
- * <p>
360
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html#fleets-creating-debug-creation">Debug fleet creation issues</a>
361
- * </p>
362
- * <p>
363
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Multi-location fleets</a>
364
- * </p>
133
+ * @see {@link CreateFleetCommand}
365
134
  */
366
135
  createFleet(args: CreateFleetCommandInput, options?: __HttpHandlerOptions): Promise<CreateFleetCommandOutput>;
367
136
  createFleet(args: CreateFleetCommandInput, cb: (err: any, data?: CreateFleetCommandOutput) => void): void;
368
137
  createFleet(args: CreateFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFleetCommandOutput) => void): void;
369
138
  /**
370
- * @public
371
- * <p>Adds remote locations to a fleet and begins populating the new locations with EC2
372
- * instances. The new instances conform to the fleet's instance type, auto-scaling, and
373
- * other configuration settings. </p>
374
- * <note>
375
- * <p>This operation cannot be used with fleets that don't support remote locations.
376
- * Fleets can have multiple locations only if they reside in Amazon Web Services Regions that support
377
- * this feature and were created after the feature was released in March 2021.</p>
378
- * </note>
379
- * <p>To add fleet locations, specify the fleet to be updated and provide a list of one or
380
- * more locations. </p>
381
- * <p>If successful, this operation returns the list of added locations with their status
382
- * set to <code>NEW</code>. GameLift initiates the process of starting an instance in each
383
- * added location. You can track the status of each new location by monitoring location
384
- * creation events using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetEvents.html">DescribeFleetEvents</a>.</p>
385
- * <p>
386
- * <b>Learn more</b>
387
- * </p>
388
- * <p>
389
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up
390
- * fleets</a>
391
- * </p>
392
- * <p>
393
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Multi-location fleets</a>
394
- * </p>
139
+ * @see {@link CreateFleetLocationsCommand}
395
140
  */
396
141
  createFleetLocations(args: CreateFleetLocationsCommandInput, options?: __HttpHandlerOptions): Promise<CreateFleetLocationsCommandOutput>;
397
142
  createFleetLocations(args: CreateFleetLocationsCommandInput, cb: (err: any, data?: CreateFleetLocationsCommandOutput) => void): void;
398
143
  createFleetLocations(args: CreateFleetLocationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateFleetLocationsCommandOutput) => void): void;
399
144
  /**
400
- * @public
401
- * <p>
402
- * <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b>
403
- * </p>
404
- * <p>Creates a GameLift FleetIQ game server
405
- * group for managing game hosting on a collection of Amazon Elastic Compute Cloud instances for game hosting.
406
- * This operation creates the game server group, creates an Auto Scaling group in your
407
- * Amazon Web Services account, and establishes a link between the two groups. You can view the status of
408
- * your game server groups in the GameLift console. Game server group metrics and events are
409
- * emitted to Amazon CloudWatch.</p>
410
- * <p>Before creating a new game server group, you must have the following: </p>
411
- * <ul>
412
- * <li>
413
- * <p>An Amazon Elastic Compute Cloud launch template that specifies how to launch Amazon Elastic Compute Cloud instances
414
- * with your game server build. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html"> Launching an Instance from a Launch Template</a> in the
415
- * <i>Amazon Elastic Compute Cloud User Guide</i>. </p>
416
- * </li>
417
- * <li>
418
- * <p>An IAM role that extends limited access to your Amazon Web Services account to allow GameLift FleetIQ
419
- * to create and interact with the Auto Scaling group. For more information, see
420
- * <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-iam-permissions-roles.html">Create IAM
421
- * roles for cross-service interaction</a> in the <i>GameLift FleetIQ Developer
422
- * Guide</i>.</p>
423
- * </li>
424
- * </ul>
425
- * <p>To create a new game server group, specify a unique group name, IAM role and Amazon Elastic Compute Cloud
426
- * launch template, and provide a list of instance types that can be used in the group. You
427
- * must also set initial maximum and minimum limits on the group's instance count. You can
428
- * optionally set an Auto Scaling policy with target tracking based on a GameLift FleetIQ
429
- * metric.</p>
430
- * <p>Once the game server group and corresponding Auto Scaling group are created, you have
431
- * full access to change the Auto Scaling group's configuration as needed. Several
432
- * properties that are set when creating a game server group, including maximum/minimum
433
- * size and auto-scaling policy settings, must be updated directly in the Auto Scaling
434
- * group. Keep in mind that some Auto Scaling group properties are periodically updated by
435
- * GameLift FleetIQ as part of its balancing activities to optimize for availability and cost.</p>
436
- * <p>
437
- * <b>Learn more</b>
438
- * </p>
439
- * <p>
440
- * <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ
441
- * Guide</a>
442
- * </p>
145
+ * @see {@link CreateGameServerGroupCommand}
443
146
  */
444
147
  createGameServerGroup(args: CreateGameServerGroupCommandInput, options?: __HttpHandlerOptions): Promise<CreateGameServerGroupCommandOutput>;
445
148
  createGameServerGroup(args: CreateGameServerGroupCommandInput, cb: (err: any, data?: CreateGameServerGroupCommandOutput) => void): void;
446
149
  createGameServerGroup(args: CreateGameServerGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGameServerGroupCommandOutput) => void): void;
447
150
  /**
448
- * @public
449
- * <p>Creates a multiplayer game session for players in a specific fleet location. This
450
- * operation prompts an available server process to start a game session and retrieves
451
- * connection information for the new game session. As an alternative, consider using the
452
- * GameLift game session placement feature with <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html">StartGameSessionPlacement</a> , which uses FleetIQ algorithms and queues to
453
- * optimize the placement process.</p>
454
- * <p>When creating a game session, you specify exactly where you want to place it and
455
- * provide a set of game session configuration settings. The fleet must be in
456
- * <code>ACTIVE</code> status before a game session can be created in it. </p>
457
- * <p>This operation can be used in the following ways: </p>
458
- * <ul>
459
- * <li>
460
- * <p>To create a game session on an instance in a fleet's home Region, provide a
461
- * fleet or alias ID along with your game session configuration. </p>
462
- * </li>
463
- * <li>
464
- * <p>To create a game session on an instance in a fleet's remote location, provide
465
- * a fleet or alias ID and a location name, along with your game session
466
- * configuration. </p>
467
- * </li>
468
- * </ul>
469
- * <p>If successful, a workflow is initiated to start a new game session. A
470
- * <code>GameSession</code> object is returned containing the game session
471
- * configuration and status. When the status is <code>ACTIVE</code>, game session
472
- * connection information is provided and player sessions can be created for the game
473
- * session. By default, newly created game sessions are open to new players. You can
474
- * restrict new player access by using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html">UpdateGameSession</a> to change the game session's player session creation
475
- * policy.</p>
476
- * <p>Game session logs are retained for all active game sessions for 14 days. To access the
477
- * logs, call <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_GetGameSessionLogUrl.html">GetGameSessionLogUrl</a> to download the log files.</p>
478
- * <p>
479
- * <i>Available in Amazon GameLift Local.</i>
480
- * </p>
481
- * <p>
482
- * <b>Learn more</b>
483
- * </p>
484
- * <p>
485
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a game session</a>
486
- * </p>
487
- * <p>
488
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
489
- * </p>
151
+ * @see {@link CreateGameSessionCommand}
490
152
  */
491
153
  createGameSession(args: CreateGameSessionCommandInput, options?: __HttpHandlerOptions): Promise<CreateGameSessionCommandOutput>;
492
154
  createGameSession(args: CreateGameSessionCommandInput, cb: (err: any, data?: CreateGameSessionCommandOutput) => void): void;
493
155
  createGameSession(args: CreateGameSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGameSessionCommandOutput) => void): void;
494
156
  /**
495
- * @public
496
- * <p>Creates a placement queue that processes requests for new game sessions. A queue uses
497
- * FleetIQ algorithms to determine the best placement locations and find an available game
498
- * server there, then prompts the game server process to start a new game session. </p>
499
- * <p>A game session queue is configured with a set of destinations (GameLift fleets or
500
- * aliases), which determine the locations where the queue can place new game sessions.
501
- * These destinations can span multiple fleet types (Spot and On-Demand), instance types,
502
- * and Amazon Web Services Regions. If the queue includes multi-location fleets, the queue is able to
503
- * place game sessions in all of a fleet's remote locations. You can opt to filter out
504
- * individual locations if needed.</p>
505
- * <p>The queue configuration also determines how FleetIQ selects the best available placement
506
- * for a new game session. Before searching for an available game server, FleetIQ first
507
- * prioritizes the queue's destinations and locations, with the best placement locations on
508
- * top. You can set up the queue to use the FleetIQ default prioritization or provide an
509
- * alternate set of priorities.</p>
510
- * <p>To create a new queue, provide a name, timeout value, and a list of destinations.
511
- * Optionally, specify a sort configuration and/or a filter, and define a set of latency
512
- * cap policies. You can also include the ARN for an Amazon Simple Notification Service
513
- * (SNS) topic to receive notifications of game session placement activity. Notifications
514
- * using SNS or CloudWatch events is the preferred way to track placement activity.</p>
515
- * <p>If successful, a new <code>GameSessionQueue</code> object is returned with an assigned
516
- * queue ARN. New game session requests, which are submitted to queue with <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html">StartGameSessionPlacement</a> or <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartMatchmaking.html">StartMatchmaking</a>, reference a queue's name or ARN. </p>
517
- * <p>
518
- * <b>Learn more</b>
519
- * </p>
520
- * <p>
521
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-design.html">
522
- * Design a game session queue</a>
523
- * </p>
524
- * <p>
525
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-creating.html">
526
- * Create a game session queue</a>
527
- * </p>
528
- * <p>
529
- * <b>Related actions</b>
530
- * </p>
531
- * <p>
532
- * <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateGameSessionQueue.html">CreateGameSessionQueue</a>
533
- * |
534
- * <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionQueues.html">DescribeGameSessionQueues</a>
535
- * |
536
- * <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSessionQueue.html">UpdateGameSessionQueue</a>
537
- * |
538
- * <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteGameSessionQueue.html">DeleteGameSessionQueue</a>
539
- * |
540
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
541
- * </p>
157
+ * @see {@link CreateGameSessionQueueCommand}
542
158
  */
543
159
  createGameSessionQueue(args: CreateGameSessionQueueCommandInput, options?: __HttpHandlerOptions): Promise<CreateGameSessionQueueCommandOutput>;
544
160
  createGameSessionQueue(args: CreateGameSessionQueueCommandInput, cb: (err: any, data?: CreateGameSessionQueueCommandOutput) => void): void;
545
161
  createGameSessionQueue(args: CreateGameSessionQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateGameSessionQueueCommandOutput) => void): void;
546
162
  /**
547
- * @public
548
- * <p>Creates a custom location for use in an Anywhere fleet.</p>
163
+ * @see {@link CreateLocationCommand}
549
164
  */
550
165
  createLocation(args: CreateLocationCommandInput, options?: __HttpHandlerOptions): Promise<CreateLocationCommandOutput>;
551
166
  createLocation(args: CreateLocationCommandInput, cb: (err: any, data?: CreateLocationCommandOutput) => void): void;
552
167
  createLocation(args: CreateLocationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateLocationCommandOutput) => void): void;
553
168
  /**
554
- * @public
555
- * <p>Defines a new matchmaking configuration for use with FlexMatch. Whether your are using
556
- * FlexMatch with GameLift hosting or as a standalone matchmaking service, the matchmaking
557
- * configuration sets out rules for matching players and forming teams. If you're also
558
- * using GameLift hosting, it defines how to start game sessions for each match. Your
559
- * matchmaking system can use multiple configurations to handle different game scenarios.
560
- * All matchmaking requests identify the matchmaking configuration to use and provide
561
- * player attributes consistent with that configuration. </p>
562
- * <p>To create a matchmaking configuration, you must provide the following: configuration
563
- * name and FlexMatch mode (with or without GameLift hosting); a rule set that specifies how
564
- * to evaluate players and find acceptable matches; whether player acceptance is required;
565
- * and the maximum time allowed for a matchmaking attempt. When using FlexMatch with GameLift
566
- * hosting, you also need to identify the game session queue to use when starting a game
567
- * session for the match.</p>
568
- * <p>In addition, you must set up an Amazon Simple Notification Service topic to receive matchmaking notifications.
569
- * Provide the topic ARN in the matchmaking configuration.</p>
570
- * <p>
571
- * <b>Learn more</b>
572
- * </p>
573
- * <p>
574
- * <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-configuration.html"> Design a FlexMatch
575
- * matchmaker</a>
576
- * </p>
577
- * <p>
578
- * <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html"> Set up FlexMatch event
579
- * notification</a>
580
- * </p>
169
+ * @see {@link CreateMatchmakingConfigurationCommand}
581
170
  */
582
171
  createMatchmakingConfiguration(args: CreateMatchmakingConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<CreateMatchmakingConfigurationCommandOutput>;
583
172
  createMatchmakingConfiguration(args: CreateMatchmakingConfigurationCommandInput, cb: (err: any, data?: CreateMatchmakingConfigurationCommandOutput) => void): void;
584
173
  createMatchmakingConfiguration(args: CreateMatchmakingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMatchmakingConfigurationCommandOutput) => void): void;
585
174
  /**
586
- * @public
587
- * <p>Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of match
588
- * to create, such as the number and size of teams. It also sets the parameters for
589
- * acceptable player matches, such as minimum skill level or character type.</p>
590
- * <p>To create a matchmaking rule set, provide unique rule set name and the rule set body
591
- * in JSON format. Rule sets must be defined in the same Region as the matchmaking
592
- * configuration they are used with.</p>
593
- * <p>Since matchmaking rule sets cannot be edited, it is a good idea to check the rule set
594
- * syntax using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_ValidateMatchmakingRuleSet.html">ValidateMatchmakingRuleSet</a> before creating a new rule set.</p>
595
- * <p>
596
- * <b>Learn more</b>
597
- * </p>
598
- * <ul>
599
- * <li>
600
- * <p>
601
- * <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html">Build a rule
602
- * set</a>
603
- * </p>
604
- * </li>
605
- * <li>
606
- * <p>
607
- * <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-configuration.html">Design a
608
- * matchmaker</a>
609
- * </p>
610
- * </li>
611
- * <li>
612
- * <p>
613
- * <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-intro.html">Matchmaking with
614
- * FlexMatch</a>
615
- * </p>
616
- * </li>
617
- * </ul>
175
+ * @see {@link CreateMatchmakingRuleSetCommand}
618
176
  */
619
177
  createMatchmakingRuleSet(args: CreateMatchmakingRuleSetCommandInput, options?: __HttpHandlerOptions): Promise<CreateMatchmakingRuleSetCommandOutput>;
620
178
  createMatchmakingRuleSet(args: CreateMatchmakingRuleSetCommandInput, cb: (err: any, data?: CreateMatchmakingRuleSetCommandOutput) => void): void;
621
179
  createMatchmakingRuleSet(args: CreateMatchmakingRuleSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateMatchmakingRuleSetCommandOutput) => void): void;
622
180
  /**
623
- * @public
624
- * <p>Reserves an open player slot in a game session for a player. New player sessions can
625
- * be created in any game session with an open slot that is in <code>ACTIVE</code> status
626
- * and has a player creation policy of <code>ACCEPT_ALL</code>. You can add a group of
627
- * players to a game session with <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreatePlayerSessions.html">CreatePlayerSessions</a> . </p>
628
- * <p>To create a player session, specify a game session ID, player ID, and optionally a set
629
- * of player data. </p>
630
- * <p>If successful, a slot is reserved in the game session for the player and a new
631
- * <code>PlayerSessions</code> object is returned with a player session ID. The player
632
- * references the player session ID when sending a connection request to the game session,
633
- * and the game server can use it to validate the player reservation with the GameLift
634
- * service. Player sessions cannot be updated. </p>
635
- * <p>The maximum number of players per game session is 200. It is not adjustable. </p>
636
- * <p>
637
- * <b>Related actions</b>
638
- * </p>
639
- * <p>
640
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
641
- * </p>
181
+ * @see {@link CreatePlayerSessionCommand}
642
182
  */
643
183
  createPlayerSession(args: CreatePlayerSessionCommandInput, options?: __HttpHandlerOptions): Promise<CreatePlayerSessionCommandOutput>;
644
184
  createPlayerSession(args: CreatePlayerSessionCommandInput, cb: (err: any, data?: CreatePlayerSessionCommandOutput) => void): void;
645
185
  createPlayerSession(args: CreatePlayerSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePlayerSessionCommandOutput) => void): void;
646
186
  /**
647
- * @public
648
- * <p>Reserves open slots in a game session for a group of players. New player sessions can
649
- * be created in any game session with an open slot that is in <code>ACTIVE</code> status
650
- * and has a player creation policy of <code>ACCEPT_ALL</code>. To add a single player to a
651
- * game session, use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreatePlayerSession.html">CreatePlayerSession</a>
652
- * </p>
653
- * <p>To create player sessions, specify a game session ID and a list of player IDs.
654
- * Optionally, provide a set of player data for each player ID. </p>
655
- * <p>If successful, a slot is reserved in the game session for each player, and new
656
- * <code>PlayerSession</code> objects are returned with player session IDs. Each player
657
- * references their player session ID when sending a connection request to the game
658
- * session, and the game server can use it to validate the player reservation with the
659
- * GameLift service. Player sessions cannot be updated.</p>
660
- * <p>The maximum number of players per game session is 200. It is not adjustable. </p>
661
- * <p>
662
- * <b>Related actions</b>
663
- * </p>
664
- * <p>
665
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
666
- * </p>
187
+ * @see {@link CreatePlayerSessionsCommand}
667
188
  */
668
189
  createPlayerSessions(args: CreatePlayerSessionsCommandInput, options?: __HttpHandlerOptions): Promise<CreatePlayerSessionsCommandOutput>;
669
190
  createPlayerSessions(args: CreatePlayerSessionsCommandInput, cb: (err: any, data?: CreatePlayerSessionsCommandOutput) => void): void;
670
191
  createPlayerSessions(args: CreatePlayerSessionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreatePlayerSessionsCommandOutput) => void): void;
671
192
  /**
672
- * @public
673
- * <p>Creates a new script record for your Realtime Servers script. Realtime scripts are JavaScript that
674
- * provide configuration settings and optional custom game logic for your game. The script
675
- * is deployed when you create a Realtime Servers fleet to host your game sessions. Script logic is
676
- * executed during an active game session. </p>
677
- * <p>To create a new script record, specify a script name and provide the script file(s).
678
- * The script files and all dependencies must be zipped into a single file. You can pull
679
- * the zip file from either of these locations: </p>
680
- * <ul>
681
- * <li>
682
- * <p>A locally available directory. Use the <i>ZipFile</i> parameter
683
- * for this option.</p>
684
- * </li>
685
- * <li>
686
- * <p>An Amazon Simple Storage Service (Amazon S3) bucket under your Amazon Web Services account. Use the
687
- * <i>StorageLocation</i> parameter for this option. You'll need
688
- * to have an Identity Access Management (IAM) role that allows the Amazon GameLift service
689
- * to access your S3 bucket. </p>
690
- * </li>
691
- * </ul>
692
- * <p>If the call is successful, a new script record is created with a unique script ID. If
693
- * the script file is provided as a local file, the file is uploaded to an Amazon GameLift-owned S3
694
- * bucket and the script record's storage location reflects this location. If the script
695
- * file is provided as an S3 bucket, Amazon GameLift accesses the file at this storage location as
696
- * needed for deployment.</p>
697
- * <p>
698
- * <b>Learn more</b>
699
- * </p>
700
- *
701
- * <p>
702
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon GameLift Realtime Servers</a>
703
- * </p>
704
- * <p>
705
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/setting-up-role.html">Set Up a Role for Amazon GameLift Access</a>
706
- * </p>
707
- * <p>
708
- * <b>Related actions</b>
709
- * </p>
710
- * <p>
711
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
712
- * </p>
193
+ * @see {@link CreateScriptCommand}
713
194
  */
714
195
  createScript(args: CreateScriptCommandInput, options?: __HttpHandlerOptions): Promise<CreateScriptCommandOutput>;
715
196
  createScript(args: CreateScriptCommandInput, cb: (err: any, data?: CreateScriptCommandOutput) => void): void;
716
197
  createScript(args: CreateScriptCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateScriptCommandOutput) => void): void;
717
198
  /**
718
- * @public
719
- * <p>Requests authorization to create or delete a peer connection between the VPC for your
720
- * Amazon GameLift fleet and a virtual private cloud (VPC) in your Amazon Web Services account. VPC peering enables the game servers on
721
- * your fleet to communicate directly with other Amazon Web Services resources. After you've received
722
- * authorization, use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateVpcPeeringConnection.html">CreateVpcPeeringConnection</a> to establish the peering connection. For more
723
- * information, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with Amazon GameLift
724
- * Fleets</a>.</p>
725
- * <p>You can peer with VPCs that are owned by any Amazon Web Services account you have access to,
726
- * including the account that you use to manage your Amazon GameLift fleets. You cannot peer with
727
- * VPCs that are in different Regions.</p>
728
- * <p>To request authorization to create a connection, call this operation from the Amazon Web Services
729
- * account with the VPC that you want to peer to your Amazon GameLift fleet. For example, to enable
730
- * your game servers to retrieve data from a DynamoDB table, use the account that manages
731
- * that DynamoDB resource. Identify the following values: (1) The ID of the VPC that you
732
- * want to peer with, and (2) the ID of the Amazon Web Services account that you use to manage Amazon GameLift. If
733
- * successful, VPC peering is authorized for the specified VPC. </p>
734
- * <p>To request authorization to delete a connection, call this operation from the Amazon Web Services
735
- * account with the VPC that is peered with your Amazon GameLift fleet. Identify the following
736
- * values: (1) VPC ID that you want to delete the peering connection for, and (2) ID of the
737
- * Amazon Web Services account that you use to manage Amazon GameLift. </p>
738
- * <p>The authorization remains valid for 24 hours unless it is canceled. You must create or
739
- * delete the peering connection while the authorization is valid. </p>
740
- * <p>
741
- * <b>Related actions</b>
742
- * </p>
743
- * <p>
744
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
745
- * </p>
199
+ * @see {@link CreateVpcPeeringAuthorizationCommand}
746
200
  */
747
201
  createVpcPeeringAuthorization(args: CreateVpcPeeringAuthorizationCommandInput, options?: __HttpHandlerOptions): Promise<CreateVpcPeeringAuthorizationCommandOutput>;
748
202
  createVpcPeeringAuthorization(args: CreateVpcPeeringAuthorizationCommandInput, cb: (err: any, data?: CreateVpcPeeringAuthorizationCommandOutput) => void): void;
749
203
  createVpcPeeringAuthorization(args: CreateVpcPeeringAuthorizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVpcPeeringAuthorizationCommandOutput) => void): void;
750
204
  /**
751
- * @public
752
- * <p>Establishes a VPC peering connection between a virtual private cloud (VPC) in an Amazon Web Services account with the VPC
753
- * for your Amazon GameLift fleet. VPC peering enables the game servers on your fleet to communicate
754
- * directly with other Amazon Web Services resources. You can peer with VPCs in any Amazon Web Services account that
755
- * you have access to, including the account that you use to manage your Amazon GameLift fleets. You
756
- * cannot peer with VPCs that are in different Regions. For more information, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC
757
- * Peering with Amazon GameLift Fleets</a>.</p>
758
- * <p>Before calling this operation to establish the peering connection, you first need to
759
- * use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateVpcPeeringAuthorization.html">CreateVpcPeeringAuthorization</a> and identify the VPC you want to peer with.
760
- * Once the authorization for the specified VPC is issued, you have 24 hours to establish
761
- * the connection. These two operations handle all tasks necessary to peer the two VPCs,
762
- * including acceptance, updating routing tables, etc. </p>
763
- * <p>To establish the connection, call this operation from the Amazon Web Services account that is used
764
- * to manage the Amazon GameLift fleets. Identify the following values: (1) The ID of the fleet you
765
- * want to be enable a VPC peering connection for; (2) The Amazon Web Services account with the VPC that
766
- * you want to peer with; and (3) The ID of the VPC you want to peer with. This operation
767
- * is asynchronous. If successful, a connection request is created. You can use continuous
768
- * polling to track the request's status using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeVpcPeeringConnections.html">DescribeVpcPeeringConnections</a> , or by monitoring fleet events for success
769
- * or failure using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetEvents.html">DescribeFleetEvents</a> . </p>
770
- * <p>
771
- * <b>Related actions</b>
772
- * </p>
773
- * <p>
774
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
775
- * </p>
205
+ * @see {@link CreateVpcPeeringConnectionCommand}
776
206
  */
777
207
  createVpcPeeringConnection(args: CreateVpcPeeringConnectionCommandInput, options?: __HttpHandlerOptions): Promise<CreateVpcPeeringConnectionCommandOutput>;
778
208
  createVpcPeeringConnection(args: CreateVpcPeeringConnectionCommandInput, cb: (err: any, data?: CreateVpcPeeringConnectionCommandOutput) => void): void;
779
209
  createVpcPeeringConnection(args: CreateVpcPeeringConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateVpcPeeringConnectionCommandOutput) => void): void;
780
210
  /**
781
- * @public
782
- * <p>Deletes an alias. This operation removes all record of the alias. Game clients
783
- * attempting to access a server process using the deleted alias receive an error. To
784
- * delete an alias, specify the alias ID to be deleted.</p>
785
- * <p>
786
- * <b>Related actions</b>
787
- * </p>
788
- * <p>
789
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
790
- * </p>
211
+ * @see {@link DeleteAliasCommand}
791
212
  */
792
213
  deleteAlias(args: DeleteAliasCommandInput, options?: __HttpHandlerOptions): Promise<DeleteAliasCommandOutput>;
793
214
  deleteAlias(args: DeleteAliasCommandInput, cb: (err: any, data?: DeleteAliasCommandOutput) => void): void;
794
215
  deleteAlias(args: DeleteAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteAliasCommandOutput) => void): void;
795
216
  /**
796
- * @public
797
- * <p>Deletes a build. This operation permanently deletes the build resource and any
798
- * uploaded build files. Deleting a build does not affect the status of any active fleets
799
- * using the build, but you can no longer create new fleets with the deleted build.</p>
800
- * <p>To delete a build, specify the build ID. </p>
801
- * <p>
802
- * <b>Learn more</b>
803
- * </p>
804
- * <p>
805
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html"> Upload a Custom
806
- * Server Build</a>
807
- * </p>
808
- * <p>
809
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
810
- * </p>
217
+ * @see {@link DeleteBuildCommand}
811
218
  */
812
219
  deleteBuild(args: DeleteBuildCommandInput, options?: __HttpHandlerOptions): Promise<DeleteBuildCommandOutput>;
813
220
  deleteBuild(args: DeleteBuildCommandInput, cb: (err: any, data?: DeleteBuildCommandOutput) => void): void;
814
221
  deleteBuild(args: DeleteBuildCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteBuildCommandOutput) => void): void;
815
222
  /**
816
- * @public
817
- * <p>Deletes all resources and information related a fleet. Any current fleet instances,
818
- * including those in remote locations, are shut down. You don't need to call
819
- * <code>DeleteFleetLocations</code> separately.</p>
820
- * <note>
821
- * <p>If the fleet being deleted has a VPC peering connection, you first need to get a
822
- * valid authorization (good for 24 hours) by calling <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateVpcPeeringAuthorization.html">CreateVpcPeeringAuthorization</a>. You do not need to explicitly delete the
823
- * VPC peering connection.</p>
824
- * </note>
825
- * <p>To delete a fleet, specify the fleet ID to be terminated. During the deletion process
826
- * the fleet status is changed to <code>DELETING</code>. When completed, the status
827
- * switches to <code>TERMINATED</code> and the fleet event <code>FLEET_DELETED</code> is
828
- * sent.</p>
829
- * <p>
830
- * <b>Learn more</b>
831
- * </p>
832
- * <p>
833
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
834
- * Fleets</a>
835
- * </p>
223
+ * @see {@link DeleteFleetCommand}
836
224
  */
837
225
  deleteFleet(args: DeleteFleetCommandInput, options?: __HttpHandlerOptions): Promise<DeleteFleetCommandOutput>;
838
226
  deleteFleet(args: DeleteFleetCommandInput, cb: (err: any, data?: DeleteFleetCommandOutput) => void): void;
839
227
  deleteFleet(args: DeleteFleetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFleetCommandOutput) => void): void;
840
228
  /**
841
- * @public
842
- * <p>Removes locations from a multi-location fleet. When deleting a location, all game
843
- * server process and all instances that are still active in the location are shut down. </p>
844
- * <p>To delete fleet locations, identify the fleet ID and provide a list of the locations
845
- * to be deleted. </p>
846
- * <p>If successful, GameLift sets the location status to <code>DELETING</code>, and begins
847
- * to shut down existing server processes and terminate instances in each location being
848
- * deleted. When completed, the location status changes to <code>TERMINATED</code>.</p>
849
- * <p>
850
- * <b>Learn more</b>
851
- * </p>
852
- * <p>
853
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
854
- * fleets</a>
855
- * </p>
229
+ * @see {@link DeleteFleetLocationsCommand}
856
230
  */
857
231
  deleteFleetLocations(args: DeleteFleetLocationsCommandInput, options?: __HttpHandlerOptions): Promise<DeleteFleetLocationsCommandOutput>;
858
232
  deleteFleetLocations(args: DeleteFleetLocationsCommandInput, cb: (err: any, data?: DeleteFleetLocationsCommandOutput) => void): void;
859
233
  deleteFleetLocations(args: DeleteFleetLocationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteFleetLocationsCommandOutput) => void): void;
860
234
  /**
861
- * @public
862
- * <p>
863
- * <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b>
864
- * </p>
865
- * <p>Terminates a game server group
866
- * and permanently deletes the game server group record. You have several options for how
867
- * these resources are impacted when deleting the game server group. Depending on the type
868
- * of delete operation selected, this operation might affect these resources:</p>
869
- * <ul>
870
- * <li>
871
- * <p>The game server group</p>
872
- * </li>
873
- * <li>
874
- * <p>The corresponding Auto Scaling group</p>
875
- * </li>
876
- * <li>
877
- * <p>All game servers that are currently running in the group</p>
878
- * </li>
879
- * </ul>
880
- * <p>To delete a game server group, identify the game server group to delete and specify
881
- * the type of delete operation to initiate. Game server groups can only be deleted if they
882
- * are in <code>ACTIVE</code> or <code>ERROR</code> status.</p>
883
- * <p>If the delete request is successful, a series of operations are kicked off. The game
884
- * server group status is changed to <code>DELETE_SCHEDULED</code>, which prevents new game
885
- * servers from being registered and stops automatic scaling activity. Once all game
886
- * servers in the game server group are deregistered, GameLift FleetIQ can begin deleting resources.
887
- * If any of the delete operations fail, the game server group is placed in
888
- * <code>ERROR</code> status.</p>
889
- * <p>GameLift FleetIQ emits delete events to Amazon CloudWatch.</p>
890
- * <p>
891
- * <b>Learn more</b>
892
- * </p>
893
- * <p>
894
- * <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ
895
- * Guide</a>
896
- * </p>
235
+ * @see {@link DeleteGameServerGroupCommand}
897
236
  */
898
237
  deleteGameServerGroup(args: DeleteGameServerGroupCommandInput, options?: __HttpHandlerOptions): Promise<DeleteGameServerGroupCommandOutput>;
899
238
  deleteGameServerGroup(args: DeleteGameServerGroupCommandInput, cb: (err: any, data?: DeleteGameServerGroupCommandOutput) => void): void;
900
239
  deleteGameServerGroup(args: DeleteGameServerGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGameServerGroupCommandOutput) => void): void;
901
240
  /**
902
- * @public
903
- * <p>Deletes a game session queue. Once a queue is successfully deleted, unfulfilled <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html">StartGameSessionPlacement</a> requests that reference the queue will fail. To
904
- * delete a queue, specify the queue name.</p>
241
+ * @see {@link DeleteGameSessionQueueCommand}
905
242
  */
906
243
  deleteGameSessionQueue(args: DeleteGameSessionQueueCommandInput, options?: __HttpHandlerOptions): Promise<DeleteGameSessionQueueCommandOutput>;
907
244
  deleteGameSessionQueue(args: DeleteGameSessionQueueCommandInput, cb: (err: any, data?: DeleteGameSessionQueueCommandOutput) => void): void;
908
245
  deleteGameSessionQueue(args: DeleteGameSessionQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteGameSessionQueueCommandOutput) => void): void;
909
246
  /**
910
- * @public
911
- * <p>Deletes a custom location.</p>
912
- * <p>Before deleting a custom location, review any fleets currently using the custom
913
- * location and deregister the location if it is in use. For more information see, <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeregisterCompute.html">DeregisterCompute</a>.</p>
247
+ * @see {@link DeleteLocationCommand}
914
248
  */
915
249
  deleteLocation(args: DeleteLocationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteLocationCommandOutput>;
916
250
  deleteLocation(args: DeleteLocationCommandInput, cb: (err: any, data?: DeleteLocationCommandOutput) => void): void;
917
251
  deleteLocation(args: DeleteLocationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteLocationCommandOutput) => void): void;
918
252
  /**
919
- * @public
920
- * <p>Permanently removes a FlexMatch matchmaking configuration. To delete, specify the
921
- * configuration name. A matchmaking configuration cannot be deleted if it is being used in
922
- * any active matchmaking tickets.</p>
253
+ * @see {@link DeleteMatchmakingConfigurationCommand}
923
254
  */
924
255
  deleteMatchmakingConfiguration(args: DeleteMatchmakingConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteMatchmakingConfigurationCommandOutput>;
925
256
  deleteMatchmakingConfiguration(args: DeleteMatchmakingConfigurationCommandInput, cb: (err: any, data?: DeleteMatchmakingConfigurationCommandOutput) => void): void;
926
257
  deleteMatchmakingConfiguration(args: DeleteMatchmakingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMatchmakingConfigurationCommandOutput) => void): void;
927
258
  /**
928
- * @public
929
- * <p>Deletes an existing matchmaking rule set. To delete the rule set, provide the rule set
930
- * name. Rule sets cannot be deleted if they are currently being used by a matchmaking
931
- * configuration. </p>
932
- * <p>
933
- * <b>Learn more</b>
934
- * </p>
935
- * <ul>
936
- * <li>
937
- * <p>
938
- * <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html">Build a rule
939
- * set</a>
940
- * </p>
941
- * </li>
942
- * </ul>
259
+ * @see {@link DeleteMatchmakingRuleSetCommand}
943
260
  */
944
261
  deleteMatchmakingRuleSet(args: DeleteMatchmakingRuleSetCommandInput, options?: __HttpHandlerOptions): Promise<DeleteMatchmakingRuleSetCommandOutput>;
945
262
  deleteMatchmakingRuleSet(args: DeleteMatchmakingRuleSetCommandInput, cb: (err: any, data?: DeleteMatchmakingRuleSetCommandOutput) => void): void;
946
263
  deleteMatchmakingRuleSet(args: DeleteMatchmakingRuleSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteMatchmakingRuleSetCommandOutput) => void): void;
947
264
  /**
948
- * @public
949
- * <p>Deletes a fleet scaling policy. Once deleted, the policy is no longer in force and
950
- * GameLift removes all record of it. To delete a scaling policy, specify both the scaling
951
- * policy name and the fleet ID it is associated with.</p>
952
- * <p>To temporarily suspend scaling policies, use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_StopFleetActions.html">StopFleetActions</a>. This operation suspends all policies for the
953
- * fleet.</p>
265
+ * @see {@link DeleteScalingPolicyCommand}
954
266
  */
955
267
  deleteScalingPolicy(args: DeleteScalingPolicyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteScalingPolicyCommandOutput>;
956
268
  deleteScalingPolicy(args: DeleteScalingPolicyCommandInput, cb: (err: any, data?: DeleteScalingPolicyCommandOutput) => void): void;
957
269
  deleteScalingPolicy(args: DeleteScalingPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteScalingPolicyCommandOutput) => void): void;
958
270
  /**
959
- * @public
960
- * <p>Deletes a Realtime script. This operation permanently deletes the script record. If
961
- * script files were uploaded, they are also deleted (files stored in an S3 bucket are not
962
- * deleted). </p>
963
- * <p>To delete a script, specify the script ID. Before deleting a script, be sure to
964
- * terminate all fleets that are deployed with the script being deleted. Fleet instances
965
- * periodically check for script updates, and if the script record no longer exists, the
966
- * instance will go into an error state and be unable to host game sessions.</p>
967
- * <p>
968
- * <b>Learn more</b>
969
- * </p>
970
- * <p>
971
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon GameLift Realtime Servers</a>
972
- * </p>
973
- * <p>
974
- * <b>Related actions</b>
975
- * </p>
976
- * <p>
977
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
978
- * </p>
271
+ * @see {@link DeleteScriptCommand}
979
272
  */
980
273
  deleteScript(args: DeleteScriptCommandInput, options?: __HttpHandlerOptions): Promise<DeleteScriptCommandOutput>;
981
274
  deleteScript(args: DeleteScriptCommandInput, cb: (err: any, data?: DeleteScriptCommandOutput) => void): void;
982
275
  deleteScript(args: DeleteScriptCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteScriptCommandOutput) => void): void;
983
276
  /**
984
- * @public
985
- * <p>Cancels a pending VPC peering authorization for the specified VPC. If you need to
986
- * delete an existing VPC peering connection, use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DeleteVpcPeeringConnection.html">DeleteVpcPeeringConnection</a>.</p>
987
- * <p>
988
- * <b>Related actions</b>
989
- * </p>
990
- * <p>
991
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
992
- * </p>
277
+ * @see {@link DeleteVpcPeeringAuthorizationCommand}
993
278
  */
994
279
  deleteVpcPeeringAuthorization(args: DeleteVpcPeeringAuthorizationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteVpcPeeringAuthorizationCommandOutput>;
995
280
  deleteVpcPeeringAuthorization(args: DeleteVpcPeeringAuthorizationCommandInput, cb: (err: any, data?: DeleteVpcPeeringAuthorizationCommandOutput) => void): void;
996
281
  deleteVpcPeeringAuthorization(args: DeleteVpcPeeringAuthorizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVpcPeeringAuthorizationCommandOutput) => void): void;
997
282
  /**
998
- * @public
999
- * <p>Removes a VPC peering connection. To delete the connection, you must have a valid
1000
- * authorization for the VPC peering connection that you want to delete.. </p>
1001
- * <p>Once a valid authorization exists, call this operation from the Amazon Web Services account that is
1002
- * used to manage the Amazon GameLift fleets. Identify the connection to delete by the connection ID
1003
- * and fleet ID. If successful, the connection is removed. </p>
1004
- * <p>
1005
- * <b>Related actions</b>
1006
- * </p>
1007
- * <p>
1008
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
1009
- * </p>
283
+ * @see {@link DeleteVpcPeeringConnectionCommand}
1010
284
  */
1011
285
  deleteVpcPeeringConnection(args: DeleteVpcPeeringConnectionCommandInput, options?: __HttpHandlerOptions): Promise<DeleteVpcPeeringConnectionCommandOutput>;
1012
286
  deleteVpcPeeringConnection(args: DeleteVpcPeeringConnectionCommandInput, cb: (err: any, data?: DeleteVpcPeeringConnectionCommandOutput) => void): void;
1013
287
  deleteVpcPeeringConnection(args: DeleteVpcPeeringConnectionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteVpcPeeringConnectionCommandOutput) => void): void;
1014
288
  /**
1015
- * @public
1016
- * <p>Removes a compute resource from the specified fleet. Deregister your compute resources
1017
- * before you delete the compute.</p>
289
+ * @see {@link DeregisterComputeCommand}
1018
290
  */
1019
291
  deregisterCompute(args: DeregisterComputeCommandInput, options?: __HttpHandlerOptions): Promise<DeregisterComputeCommandOutput>;
1020
292
  deregisterCompute(args: DeregisterComputeCommandInput, cb: (err: any, data?: DeregisterComputeCommandOutput) => void): void;
1021
293
  deregisterCompute(args: DeregisterComputeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterComputeCommandOutput) => void): void;
1022
294
  /**
1023
- * @public
1024
- * <p>
1025
- * <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b>
1026
- * </p>
1027
- * <p>Removes the game server from a
1028
- * game server group. As a result of this operation, the deregistered game server can no
1029
- * longer be claimed and will not be returned in a list of active game servers. </p>
1030
- * <p>To deregister a game server, specify the game server group and game server ID. If
1031
- * successful, this operation emits a CloudWatch event with termination timestamp and
1032
- * reason.</p>
1033
- * <p>
1034
- * <b>Learn more</b>
1035
- * </p>
1036
- * <p>
1037
- * <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ
1038
- * Guide</a>
1039
- * </p>
295
+ * @see {@link DeregisterGameServerCommand}
1040
296
  */
1041
297
  deregisterGameServer(args: DeregisterGameServerCommandInput, options?: __HttpHandlerOptions): Promise<DeregisterGameServerCommandOutput>;
1042
298
  deregisterGameServer(args: DeregisterGameServerCommandInput, cb: (err: any, data?: DeregisterGameServerCommandOutput) => void): void;
1043
299
  deregisterGameServer(args: DeregisterGameServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeregisterGameServerCommandOutput) => void): void;
1044
300
  /**
1045
- * @public
1046
- * <p>Retrieves properties for an alias. This operation returns all alias metadata and
1047
- * settings. To get an alias's target fleet ID only, use <code>ResolveAlias</code>. </p>
1048
- * <p>To get alias properties, specify the alias ID. If successful, the requested alias
1049
- * record is returned.</p>
1050
- * <p>
1051
- * <b>Related actions</b>
1052
- * </p>
1053
- * <p>
1054
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
1055
- * </p>
301
+ * @see {@link DescribeAliasCommand}
1056
302
  */
1057
303
  describeAlias(args: DescribeAliasCommandInput, options?: __HttpHandlerOptions): Promise<DescribeAliasCommandOutput>;
1058
304
  describeAlias(args: DescribeAliasCommandInput, cb: (err: any, data?: DescribeAliasCommandOutput) => void): void;
1059
305
  describeAlias(args: DescribeAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeAliasCommandOutput) => void): void;
1060
306
  /**
1061
- * @public
1062
- * <p>Retrieves properties for a custom game build. To request a build resource, specify a
1063
- * build ID. If successful, an object containing the build properties is returned.</p>
1064
- * <p>
1065
- * <b>Learn more</b>
1066
- * </p>
1067
- * <p>
1068
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html"> Upload a Custom
1069
- * Server Build</a>
1070
- * </p>
1071
- * <p>
1072
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
1073
- * </p>
307
+ * @see {@link DescribeBuildCommand}
1074
308
  */
1075
309
  describeBuild(args: DescribeBuildCommandInput, options?: __HttpHandlerOptions): Promise<DescribeBuildCommandOutput>;
1076
310
  describeBuild(args: DescribeBuildCommandInput, cb: (err: any, data?: DescribeBuildCommandOutput) => void): void;
1077
311
  describeBuild(args: DescribeBuildCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeBuildCommandOutput) => void): void;
1078
312
  /**
1079
- * @public
1080
- * <p>Retrieves properties for a compute resource. To request a compute resource specify the
1081
- * fleet ID and compute name. If successful, GameLift returns an object containing the build
1082
- * properties.</p>
313
+ * @see {@link DescribeComputeCommand}
1083
314
  */
1084
315
  describeCompute(args: DescribeComputeCommandInput, options?: __HttpHandlerOptions): Promise<DescribeComputeCommandOutput>;
1085
316
  describeCompute(args: DescribeComputeCommandInput, cb: (err: any, data?: DescribeComputeCommandOutput) => void): void;
1086
317
  describeCompute(args: DescribeComputeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeComputeCommandOutput) => void): void;
1087
318
  /**
1088
- * @public
1089
- * <p>Retrieves the instance limits and current utilization for an Amazon Web Services Region or location.
1090
- * Instance limits control the number of instances, per instance type, per location, that
1091
- * your Amazon Web Services account can use. Learn more at <a href="http://aws.amazon.com/ec2/instance-types/">Amazon EC2 Instance Types</a>. The information
1092
- * returned includes the maximum number of instances allowed and your account's current
1093
- * usage across all fleets. This information can affect your ability to scale your GameLift
1094
- * fleets. You can request a limit increase for your account by using the <b>Service limits</b> page in the GameLift console.</p>
1095
- * <p>Instance limits differ based on whether the instances are deployed in a fleet's home
1096
- * Region or in a remote location. For remote locations, limits also differ based on the
1097
- * combination of home Region and remote location. All requests must specify an Amazon Web Services
1098
- * Region (either explicitly or as your default settings). To get the limit for a remote
1099
- * location, you must also specify the location. For example, the following requests all
1100
- * return different results: </p>
1101
- * <ul>
1102
- * <li>
1103
- * <p>Request specifies the Region <code>ap-northeast-1</code> with no location. The
1104
- * result is limits and usage data on all instance types that are deployed in
1105
- * <code>us-east-2</code>, by all of the fleets that reside in
1106
- * <code>ap-northeast-1</code>. </p>
1107
- * </li>
1108
- * <li>
1109
- * <p>Request specifies the Region <code>us-east-1</code> with location
1110
- * <code>ca-central-1</code>. The result is limits and usage data on all
1111
- * instance types that are deployed in <code>ca-central-1</code>, by all of the
1112
- * fleets that reside in <code>us-east-2</code>. These limits do not affect fleets
1113
- * in any other Regions that deploy instances to <code>ca-central-1</code>.</p>
1114
- * </li>
1115
- * <li>
1116
- * <p>Request specifies the Region <code>eu-west-1</code> with location
1117
- * <code>ca-central-1</code>. The result is limits and usage data on all
1118
- * instance types that are deployed in <code>ca-central-1</code>, by all of the
1119
- * fleets that reside in <code>eu-west-1</code>.</p>
1120
- * </li>
1121
- * </ul>
1122
- * <p>This operation can be used in the following ways:</p>
1123
- * <ul>
1124
- * <li>
1125
- * <p>To get limit and usage data for all instance types that are deployed in an
1126
- * Amazon Web Services Region by fleets that reside in the same Region: Specify the Region only.
1127
- * Optionally, specify a single instance type to retrieve information for.</p>
1128
- * </li>
1129
- * <li>
1130
- * <p>To get limit and usage data for all instance types that are deployed to a
1131
- * remote location by fleets that reside in different Amazon Web Services Region: Provide both
1132
- * the Amazon Web Services Region and the remote location. Optionally, specify a single instance
1133
- * type to retrieve information for.</p>
1134
- * </li>
1135
- * </ul>
1136
- * <p>If successful, an <code>EC2InstanceLimits</code> object is returned with limits and
1137
- * usage data for each requested instance type.</p>
1138
- * <p>
1139
- * <b>Learn more</b>
1140
- * </p>
1141
- * <p>
1142
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift fleets</a>
1143
- * </p>
319
+ * @see {@link DescribeEC2InstanceLimitsCommand}
1144
320
  */
1145
321
  describeEC2InstanceLimits(args: DescribeEC2InstanceLimitsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeEC2InstanceLimitsCommandOutput>;
1146
322
  describeEC2InstanceLimits(args: DescribeEC2InstanceLimitsCommandInput, cb: (err: any, data?: DescribeEC2InstanceLimitsCommandOutput) => void): void;
1147
323
  describeEC2InstanceLimits(args: DescribeEC2InstanceLimitsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeEC2InstanceLimitsCommandOutput) => void): void;
1148
324
  /**
1149
- * @public
1150
- * <p>Retrieves core fleet-wide properties, including the computing hardware and deployment
1151
- * configuration for all instances in the fleet.</p>
1152
- * <p>This operation can be used in the following ways: </p>
1153
- * <ul>
1154
- * <li>
1155
- * <p>To get attributes for one or more specific fleets, provide a list of fleet IDs
1156
- * or fleet ARNs. </p>
1157
- * </li>
1158
- * <li>
1159
- * <p>To get attributes for all fleets, do not provide a fleet identifier. </p>
1160
- * </li>
1161
- * </ul>
1162
- * <p>When requesting attributes for multiple fleets, use the pagination parameters to
1163
- * retrieve results as a set of sequential pages. </p>
1164
- * <p>If successful, a <code>FleetAttributes</code> object is returned for each fleet
1165
- * requested, unless the fleet identifier is not found. </p>
1166
- * <note>
1167
- * <p>Some API operations limit the number of fleet IDs that allowed in one request. If
1168
- * a request exceeds this limit, the request fails and the error message contains the
1169
- * maximum allowed number.</p>
1170
- * </note>
1171
- * <p>
1172
- * <b>Learn more</b>
1173
- * </p>
1174
- * <p>
1175
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
1176
- * fleets</a>
1177
- * </p>
325
+ * @see {@link DescribeFleetAttributesCommand}
1178
326
  */
1179
327
  describeFleetAttributes(args: DescribeFleetAttributesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeFleetAttributesCommandOutput>;
1180
328
  describeFleetAttributes(args: DescribeFleetAttributesCommandInput, cb: (err: any, data?: DescribeFleetAttributesCommandOutput) => void): void;
1181
329
  describeFleetAttributes(args: DescribeFleetAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFleetAttributesCommandOutput) => void): void;
1182
330
  /**
1183
- * @public
1184
- * <p>Retrieves the resource capacity settings for one or more fleets. The data returned
1185
- * includes the current fleet capacity (number of EC2 instances), and settings that can
1186
- * control how capacity scaling. For fleets with remote locations, this operation retrieves
1187
- * data for the fleet's home Region only.</p>
1188
- * <p>This operation can be used in the following ways: </p>
1189
- * <ul>
1190
- * <li>
1191
- * <p>To get capacity data for one or more specific fleets, provide a list of fleet
1192
- * IDs or fleet ARNs. </p>
1193
- * </li>
1194
- * <li>
1195
- * <p>To get capacity data for all fleets, do not provide a fleet identifier.
1196
- * </p>
1197
- * </li>
1198
- * </ul>
1199
- * <p>When requesting multiple fleets, use the pagination parameters to retrieve results as
1200
- * a set of sequential pages. </p>
1201
- * <p>If successful, a <code>FleetCapacity</code> object is returned for each requested
1202
- * fleet ID. Each FleetCapacity object includes a <code>Location</code> property, which is
1203
- * set to the fleet's home Region. When a list of fleet IDs is provided, attribute objects
1204
- * are returned only for fleets that currently exist.</p>
1205
- * <note>
1206
- * <p>Some API operations may limit the number of fleet IDs that are allowed in one
1207
- * request. If a request exceeds this limit, the request fails and the error message
1208
- * includes the maximum allowed.</p>
1209
- * </note>
1210
- * <p>
1211
- * <b>Learn more</b>
1212
- * </p>
1213
- * <p>
1214
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
1215
- * fleets</a>
1216
- * </p>
1217
- * <p>
1218
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet">GameLift metrics for fleets</a>
1219
- * </p>
331
+ * @see {@link DescribeFleetCapacityCommand}
1220
332
  */
1221
333
  describeFleetCapacity(args: DescribeFleetCapacityCommandInput, options?: __HttpHandlerOptions): Promise<DescribeFleetCapacityCommandOutput>;
1222
334
  describeFleetCapacity(args: DescribeFleetCapacityCommandInput, cb: (err: any, data?: DescribeFleetCapacityCommandOutput) => void): void;
1223
335
  describeFleetCapacity(args: DescribeFleetCapacityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFleetCapacityCommandOutput) => void): void;
1224
336
  /**
1225
- * @public
1226
- * <p>Retrieves entries from a fleet's event log. Fleet events are initiated by changes in
1227
- * status, such as during fleet creation and termination, changes in capacity, etc. If a
1228
- * fleet has multiple locations, events are also initiated by changes to status and
1229
- * capacity in remote locations. </p>
1230
- * <p>You can specify a time range to limit the result set. Use the pagination parameters to
1231
- * retrieve results as a set of sequential pages. </p>
1232
- * <p>If successful, a collection of event log entries matching the request are
1233
- * returned.</p>
1234
- * <p>
1235
- * <b>Learn more</b>
1236
- * </p>
1237
- * <p>
1238
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
1239
- * fleets</a>
1240
- * </p>
337
+ * @see {@link DescribeFleetEventsCommand}
1241
338
  */
1242
339
  describeFleetEvents(args: DescribeFleetEventsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeFleetEventsCommandOutput>;
1243
340
  describeFleetEvents(args: DescribeFleetEventsCommandInput, cb: (err: any, data?: DescribeFleetEventsCommandOutput) => void): void;
1244
341
  describeFleetEvents(args: DescribeFleetEventsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFleetEventsCommandOutput) => void): void;
1245
342
  /**
1246
- * @public
1247
- * <p>Retrieves information on a fleet's remote locations, including life-cycle status and
1248
- * any suspended fleet activity. </p>
1249
- * <p>This operation can be used in the following ways: </p>
1250
- * <ul>
1251
- * <li>
1252
- * <p>To get data for specific locations, provide a fleet identifier and a list of
1253
- * locations. Location data is returned in the order that it is requested. </p>
1254
- * </li>
1255
- * <li>
1256
- * <p>To get data for all locations, provide a fleet identifier only. Location data
1257
- * is returned in no particular order. </p>
1258
- * </li>
1259
- * </ul>
1260
- * <p>When requesting attributes for multiple locations, use the pagination parameters to
1261
- * retrieve results as a set of sequential pages. </p>
1262
- * <p>If successful, a <code>LocationAttributes</code> object is returned for each requested
1263
- * location. If the fleet does not have a requested location, no information is returned.
1264
- * This operation does not return the home Region. To get information on a fleet's home
1265
- * Region, call <code>DescribeFleetAttributes</code>.</p>
1266
- * <p>
1267
- * <b>Learn more</b>
1268
- * </p>
1269
- * <p>
1270
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting
1271
- * up GameLift fleets</a>
1272
- * </p>
343
+ * @see {@link DescribeFleetLocationAttributesCommand}
1273
344
  */
1274
345
  describeFleetLocationAttributes(args: DescribeFleetLocationAttributesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeFleetLocationAttributesCommandOutput>;
1275
346
  describeFleetLocationAttributes(args: DescribeFleetLocationAttributesCommandInput, cb: (err: any, data?: DescribeFleetLocationAttributesCommandOutput) => void): void;
1276
347
  describeFleetLocationAttributes(args: DescribeFleetLocationAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFleetLocationAttributesCommandOutput) => void): void;
1277
348
  /**
1278
- * @public
1279
- * <p>Retrieves the resource capacity settings for a fleet location. The data returned
1280
- * includes the current capacity (number of EC2 instances) and some scaling settings for
1281
- * the requested fleet location. Use this operation to retrieve capacity information for a
1282
- * fleet's remote location or home Region (you can also retrieve home Region capacity by
1283
- * calling <code>DescribeFleetCapacity</code>).</p>
1284
- * <p>To retrieve capacity data, identify a fleet and location. </p>
1285
- * <p>If successful, a <code>FleetCapacity</code> object is returned for the requested fleet
1286
- * location. </p>
1287
- * <p>
1288
- * <b>Learn more</b>
1289
- * </p>
1290
- * <p>
1291
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
1292
- * fleets</a>
1293
- * </p>
1294
- * <p>
1295
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet">GameLift metrics for fleets</a>
1296
- * </p>
349
+ * @see {@link DescribeFleetLocationCapacityCommand}
1297
350
  */
1298
351
  describeFleetLocationCapacity(args: DescribeFleetLocationCapacityCommandInput, options?: __HttpHandlerOptions): Promise<DescribeFleetLocationCapacityCommandOutput>;
1299
352
  describeFleetLocationCapacity(args: DescribeFleetLocationCapacityCommandInput, cb: (err: any, data?: DescribeFleetLocationCapacityCommandOutput) => void): void;
1300
353
  describeFleetLocationCapacity(args: DescribeFleetLocationCapacityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFleetLocationCapacityCommandOutput) => void): void;
1301
354
  /**
1302
- * @public
1303
- * <p>Retrieves current usage data for a fleet location. Utilization data provides a
1304
- * snapshot of current game hosting activity at the requested location. Use this operation
1305
- * to retrieve utilization information for a fleet's remote location or home Region (you
1306
- * can also retrieve home Region utilization by calling
1307
- * <code>DescribeFleetUtilization</code>).</p>
1308
- * <p>To retrieve utilization data, identify a fleet and location. </p>
1309
- * <p>If successful, a <code>FleetUtilization</code> object is returned for the requested
1310
- * fleet location. </p>
1311
- * <p>
1312
- * <b>Learn more</b>
1313
- * </p>
1314
- * <p>
1315
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
1316
- * fleets</a>
1317
- * </p>
1318
- * <p>
1319
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet">GameLift metrics for fleets</a>
1320
- * </p>
355
+ * @see {@link DescribeFleetLocationUtilizationCommand}
1321
356
  */
1322
357
  describeFleetLocationUtilization(args: DescribeFleetLocationUtilizationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeFleetLocationUtilizationCommandOutput>;
1323
358
  describeFleetLocationUtilization(args: DescribeFleetLocationUtilizationCommandInput, cb: (err: any, data?: DescribeFleetLocationUtilizationCommandOutput) => void): void;
1324
359
  describeFleetLocationUtilization(args: DescribeFleetLocationUtilizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFleetLocationUtilizationCommandOutput) => void): void;
1325
360
  /**
1326
- * @public
1327
- * <p>Retrieves a fleet's inbound connection permissions. Connection permissions specify the
1328
- * range of IP addresses and port settings that incoming traffic can use to access server
1329
- * processes in the fleet. Game sessions that are running on instances in the fleet must
1330
- * use connections that fall in this range.</p>
1331
- * <p>This operation can be used in the following ways: </p>
1332
- * <ul>
1333
- * <li>
1334
- * <p>To retrieve the inbound connection permissions for a fleet, identify the
1335
- * fleet's unique identifier. </p>
1336
- * </li>
1337
- * <li>
1338
- * <p>To check the status of recent updates to a fleet remote location, specify the
1339
- * fleet ID and a location. Port setting updates can take time to propagate across
1340
- * all locations. </p>
1341
- * </li>
1342
- * </ul>
1343
- * <p>If successful, a set of <code>IpPermission</code> objects is returned for the
1344
- * requested fleet ID. When a location is specified, a pending status is included. If the
1345
- * requested fleet has been deleted, the result set is empty.</p>
1346
- * <p>
1347
- * <b>Learn more</b>
1348
- * </p>
1349
- * <p>
1350
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
1351
- * fleets</a>
1352
- * </p>
361
+ * @see {@link DescribeFleetPortSettingsCommand}
1353
362
  */
1354
363
  describeFleetPortSettings(args: DescribeFleetPortSettingsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeFleetPortSettingsCommandOutput>;
1355
364
  describeFleetPortSettings(args: DescribeFleetPortSettingsCommandInput, cb: (err: any, data?: DescribeFleetPortSettingsCommandOutput) => void): void;
1356
365
  describeFleetPortSettings(args: DescribeFleetPortSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFleetPortSettingsCommandOutput) => void): void;
1357
366
  /**
1358
- * @public
1359
- * <p>Retrieves utilization statistics for one or more fleets. Utilization data provides a
1360
- * snapshot of how the fleet's hosting resources are currently being used. For fleets with
1361
- * remote locations, this operation retrieves data for the fleet's home Region only. See
1362
- * <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationUtilization.html">DescribeFleetLocationUtilization</a> to get utilization statistics for a
1363
- * fleet's remote locations.</p>
1364
- * <p>This operation can be used in the following ways: </p>
1365
- * <ul>
1366
- * <li>
1367
- * <p>To get utilization data for one or more specific fleets, provide a list of
1368
- * fleet IDs or fleet ARNs. </p>
1369
- * </li>
1370
- * <li>
1371
- * <p>To get utilization data for all fleets, do not provide a fleet identifier.
1372
- * </p>
1373
- * </li>
1374
- * </ul>
1375
- * <p>When requesting multiple fleets, use the pagination parameters to retrieve results as
1376
- * a set of sequential pages. </p>
1377
- * <p>If successful, a <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_FleetUtilization.html">FleetUtilization</a> object is returned for each requested fleet ID, unless the
1378
- * fleet identifier is not found. Each fleet utilization object includes a
1379
- * <code>Location</code> property, which is set to the fleet's home Region. </p>
1380
- * <note>
1381
- * <p>Some API operations may limit the number of fleet IDs allowed in one request. If a
1382
- * request exceeds this limit, the request fails and the error message includes the
1383
- * maximum allowed.</p>
1384
- * </note>
1385
- * <p>
1386
- * <b>Learn more</b>
1387
- * </p>
1388
- * <p>
1389
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
1390
- * Fleets</a>
1391
- * </p>
1392
- * <p>
1393
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet">GameLift Metrics for Fleets</a>
1394
- * </p>
367
+ * @see {@link DescribeFleetUtilizationCommand}
1395
368
  */
1396
369
  describeFleetUtilization(args: DescribeFleetUtilizationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeFleetUtilizationCommandOutput>;
1397
370
  describeFleetUtilization(args: DescribeFleetUtilizationCommandInput, cb: (err: any, data?: DescribeFleetUtilizationCommandOutput) => void): void;
1398
371
  describeFleetUtilization(args: DescribeFleetUtilizationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeFleetUtilizationCommandOutput) => void): void;
1399
372
  /**
1400
- * @public
1401
- * <p>
1402
- * <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b>
1403
- * </p>
1404
- * <p>Retrieves information for a
1405
- * registered game server. Information includes game server status, health check info, and
1406
- * the instance that the game server is running on. </p>
1407
- * <p>To retrieve game server information, specify the game server ID. If successful, the
1408
- * requested game server object is returned. </p>
1409
- * <p>
1410
- * <b>Learn more</b>
1411
- * </p>
1412
- * <p>
1413
- * <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ
1414
- * Guide</a>
1415
- * </p>
373
+ * @see {@link DescribeGameServerCommand}
1416
374
  */
1417
375
  describeGameServer(args: DescribeGameServerCommandInput, options?: __HttpHandlerOptions): Promise<DescribeGameServerCommandOutput>;
1418
376
  describeGameServer(args: DescribeGameServerCommandInput, cb: (err: any, data?: DescribeGameServerCommandOutput) => void): void;
1419
377
  describeGameServer(args: DescribeGameServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGameServerCommandOutput) => void): void;
1420
378
  /**
1421
- * @public
1422
- * <p>
1423
- * <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b>
1424
- * </p>
1425
- * <p>Retrieves information on a
1426
- * game server group. This operation returns only properties related to GameLift FleetIQ. To view or
1427
- * update properties for the corresponding Auto Scaling group, such as launch template,
1428
- * auto scaling policies, and maximum/minimum group size, access the Auto Scaling group
1429
- * directly.</p>
1430
- * <p>To get attributes for a game server group, provide a group name or ARN value. If
1431
- * successful, a <code>GameServerGroup</code> object is returned.</p>
1432
- * <p>
1433
- * <b>Learn more</b>
1434
- * </p>
1435
- * <p>
1436
- * <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ
1437
- * Guide</a>
1438
- * </p>
379
+ * @see {@link DescribeGameServerGroupCommand}
1439
380
  */
1440
381
  describeGameServerGroup(args: DescribeGameServerGroupCommandInput, options?: __HttpHandlerOptions): Promise<DescribeGameServerGroupCommandOutput>;
1441
382
  describeGameServerGroup(args: DescribeGameServerGroupCommandInput, cb: (err: any, data?: DescribeGameServerGroupCommandOutput) => void): void;
1442
383
  describeGameServerGroup(args: DescribeGameServerGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGameServerGroupCommandOutput) => void): void;
1443
384
  /**
1444
- * @public
1445
- * <p>
1446
- * <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b>
1447
- * </p>
1448
- * <p>Retrieves status
1449
- * information about the Amazon EC2 instances associated with a GameLift FleetIQ game server group.
1450
- * Use this operation to detect when instances are active or not available to host new game
1451
- * servers.</p>
1452
- * <p>To request status for all instances in the game server group, provide a game server
1453
- * group ID only. To request status for specific instances, provide the game server group
1454
- * ID and one or more instance IDs. Use the pagination parameters to retrieve results in
1455
- * sequential segments. If successful, a collection of <code>GameServerInstance</code>
1456
- * objects is returned. </p>
1457
- * <p>This operation is not designed to be called with every game server claim request; this
1458
- * practice can cause you to exceed your API limit, which results in errors. Instead, as a
1459
- * best practice, cache the results and refresh your cache no more than once every 10
1460
- * seconds.</p>
1461
- * <p>
1462
- * <b>Learn more</b>
1463
- * </p>
1464
- * <p>
1465
- * <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ
1466
- * Guide</a>
1467
- * </p>
385
+ * @see {@link DescribeGameServerInstancesCommand}
1468
386
  */
1469
387
  describeGameServerInstances(args: DescribeGameServerInstancesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeGameServerInstancesCommandOutput>;
1470
388
  describeGameServerInstances(args: DescribeGameServerInstancesCommandInput, cb: (err: any, data?: DescribeGameServerInstancesCommandOutput) => void): void;
1471
389
  describeGameServerInstances(args: DescribeGameServerInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGameServerInstancesCommandOutput) => void): void;
1472
390
  /**
1473
- * @public
1474
- * <p>Retrieves additional game session properties, including the game session protection
1475
- * policy in force, a set of one or more game sessions in a specific fleet location. You
1476
- * can optionally filter the results by current game session status.</p>
1477
- * <p>This operation can be used in the following ways: </p>
1478
- * <ul>
1479
- * <li>
1480
- * <p>To retrieve details for all game sessions that are currently running on all
1481
- * locations in a fleet, provide a fleet or alias ID, with an optional status
1482
- * filter. This approach returns details from the fleet's home Region and all
1483
- * remote locations.</p>
1484
- * </li>
1485
- * <li>
1486
- * <p>To retrieve details for all game sessions that are currently running on a
1487
- * specific fleet location, provide a fleet or alias ID and a location name, with
1488
- * optional status filter. The location can be the fleet's home Region or any
1489
- * remote location.</p>
1490
- * </li>
1491
- * <li>
1492
- * <p>To retrieve details for a specific game session, provide the game session ID.
1493
- * This approach looks for the game session ID in all fleets that reside in the
1494
- * Amazon Web Services Region defined in the request.</p>
1495
- * </li>
1496
- * </ul>
1497
- * <p>Use the pagination parameters to retrieve results as a set of sequential pages. </p>
1498
- * <p>If successful, a <code>GameSessionDetail</code> object is returned for each game
1499
- * session that matches the request.</p>
1500
- * <p>
1501
- * <b>Learn more</b>
1502
- * </p>
1503
- * <p>
1504
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#gamelift-sdk-client-api-find">Find a game session</a>
1505
- * </p>
1506
- * <p>
1507
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
1508
- * </p>
391
+ * @see {@link DescribeGameSessionDetailsCommand}
1509
392
  */
1510
393
  describeGameSessionDetails(args: DescribeGameSessionDetailsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeGameSessionDetailsCommandOutput>;
1511
394
  describeGameSessionDetails(args: DescribeGameSessionDetailsCommandInput, cb: (err: any, data?: DescribeGameSessionDetailsCommandOutput) => void): void;
1512
395
  describeGameSessionDetails(args: DescribeGameSessionDetailsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGameSessionDetailsCommandOutput) => void): void;
1513
396
  /**
1514
- * @public
1515
- * <p>Retrieves information, including current status, about a game session placement
1516
- * request. </p>
1517
- * <p>To get game session placement details, specify the placement ID.</p>
1518
- * <p>This operation is not designed to be continually called to track game session status.
1519
- * This practice can cause you to exceed your API limit, which results in errors. Instead,
1520
- * you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from
1521
- * FlexMatch or queues. Continuously polling with <code>DescribeGameSessionPlacement</code>
1522
- * should only be used for games in development with low game session usage. </p>
397
+ * @see {@link DescribeGameSessionPlacementCommand}
1523
398
  */
1524
399
  describeGameSessionPlacement(args: DescribeGameSessionPlacementCommandInput, options?: __HttpHandlerOptions): Promise<DescribeGameSessionPlacementCommandOutput>;
1525
400
  describeGameSessionPlacement(args: DescribeGameSessionPlacementCommandInput, cb: (err: any, data?: DescribeGameSessionPlacementCommandOutput) => void): void;
1526
401
  describeGameSessionPlacement(args: DescribeGameSessionPlacementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGameSessionPlacementCommandOutput) => void): void;
1527
402
  /**
1528
- * @public
1529
- * <p>Retrieves the properties for one or more game session queues. When requesting multiple
1530
- * queues, use the pagination parameters to retrieve results as a set of sequential pages.
1531
- * When specifying a list of queues, objects are returned only for queues that currently
1532
- * exist in the Region.</p>
1533
- * <p>
1534
- * <b>Learn more</b>
1535
- * </p>
1536
- * <p>
1537
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-console.html">
1538
- * View Your Queues</a>
1539
- * </p>
403
+ * @see {@link DescribeGameSessionQueuesCommand}
1540
404
  */
1541
405
  describeGameSessionQueues(args: DescribeGameSessionQueuesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeGameSessionQueuesCommandOutput>;
1542
406
  describeGameSessionQueues(args: DescribeGameSessionQueuesCommandInput, cb: (err: any, data?: DescribeGameSessionQueuesCommandOutput) => void): void;
1543
407
  describeGameSessionQueues(args: DescribeGameSessionQueuesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGameSessionQueuesCommandOutput) => void): void;
1544
408
  /**
1545
- * @public
1546
- * <p>Retrieves a set of one or more game sessions in a specific fleet location. You can
1547
- * optionally filter the results by current game session status.</p>
1548
- * <p>This operation can be used in the following ways: </p>
1549
- * <ul>
1550
- * <li>
1551
- * <p>To retrieve all game sessions that are currently running on all locations in a
1552
- * fleet, provide a fleet or alias ID, with an optional status filter. This
1553
- * approach returns all game sessions in the fleet's home Region and all remote
1554
- * locations.</p>
1555
- * </li>
1556
- * <li>
1557
- * <p>To retrieve all game sessions that are currently running on a specific fleet
1558
- * location, provide a fleet or alias ID and a location name, with optional status
1559
- * filter. The location can be the fleet's home Region or any remote
1560
- * location.</p>
1561
- * </li>
1562
- * <li>
1563
- * <p>To retrieve a specific game session, provide the game session ID. This
1564
- * approach looks for the game session ID in all fleets that reside in the Amazon Web Services
1565
- * Region defined in the request.</p>
1566
- * </li>
1567
- * </ul>
1568
- * <p>Use the pagination parameters to retrieve results as a set of sequential pages. </p>
1569
- * <p>If successful, a <code>GameSession</code> object is returned for each game session
1570
- * that matches the request.</p>
1571
- * <p>This operation is not designed to be continually called to track game session status.
1572
- * This practice can cause you to exceed your API limit, which results in errors. Instead,
1573
- * you must configure an Amazon Simple Notification Service (SNS) topic to receive notifications from FlexMatch or
1574
- * queues. Continuously polling with <code>DescribeGameSessions</code> should only be used
1575
- * for games in development with low game session usage. </p>
1576
- * <p>
1577
- * <i>Available in Amazon GameLift Local.</i>
1578
- * </p>
1579
- * <p>
1580
- * <b>Learn more</b>
1581
- * </p>
1582
- * <p>
1583
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#gamelift-sdk-client-api-find">Find a game session</a>
1584
- * </p>
1585
- * <p>
1586
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
1587
- * </p>
409
+ * @see {@link DescribeGameSessionsCommand}
1588
410
  */
1589
411
  describeGameSessions(args: DescribeGameSessionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeGameSessionsCommandOutput>;
1590
412
  describeGameSessions(args: DescribeGameSessionsCommandInput, cb: (err: any, data?: DescribeGameSessionsCommandOutput) => void): void;
1591
413
  describeGameSessions(args: DescribeGameSessionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeGameSessionsCommandOutput) => void): void;
1592
414
  /**
1593
- * @public
1594
- * <p>Retrieves information about a fleet's instances, including instance IDs, connection
1595
- * data, and status. </p>
1596
- * <p>This operation can be used in the following ways:</p>
1597
- * <ul>
1598
- * <li>
1599
- * <p>To get information on all instances that are deployed to a fleet's home
1600
- * Region, provide the fleet ID.</p>
1601
- * </li>
1602
- * <li>
1603
- * <p>To get information on all instances that are deployed to a fleet's remote
1604
- * location, provide the fleet ID and location name.</p>
1605
- * </li>
1606
- * <li>
1607
- * <p>To get information on a specific instance in a fleet, provide the fleet ID and
1608
- * instance ID.</p>
1609
- * </li>
1610
- * </ul>
1611
- * <p>Use the pagination parameters to retrieve results as a set of sequential pages. </p>
1612
- * <p>If successful, an <code>Instance</code> object is returned for each requested
1613
- * instance. Instances are not returned in any particular order. </p>
1614
- * <p>
1615
- * <b>Learn more</b>
1616
- * </p>
1617
- * <p>
1618
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html">Remotely Access Fleet
1619
- * Instances</a>
1620
- * </p>
1621
- * <p>
1622
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html">Debug Fleet
1623
- * Issues</a>
1624
- * </p>
1625
- * <p>
1626
- * <b>Related actions</b>
1627
- * </p>
1628
- * <p>
1629
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
1630
- * </p>
415
+ * @see {@link DescribeInstancesCommand}
1631
416
  */
1632
417
  describeInstances(args: DescribeInstancesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeInstancesCommandOutput>;
1633
418
  describeInstances(args: DescribeInstancesCommandInput, cb: (err: any, data?: DescribeInstancesCommandOutput) => void): void;
1634
419
  describeInstances(args: DescribeInstancesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeInstancesCommandOutput) => void): void;
1635
420
  /**
1636
- * @public
1637
- * <p>Retrieves one or more matchmaking tickets. Use this operation to retrieve ticket
1638
- * information, including--after a successful match is made--connection information for the
1639
- * resulting new game session. </p>
1640
- * <p>To request matchmaking tickets, provide a list of up to 10 ticket IDs. If the request
1641
- * is successful, a ticket object is returned for each requested ID that currently
1642
- * exists.</p>
1643
- * <p>This operation is not designed to be continually called to track matchmaking ticket
1644
- * status. This practice can cause you to exceed your API limit, which results in errors.
1645
- * Instead, as a best practice, set up an Amazon Simple Notification Service to receive notifications, and provide
1646
- * the topic ARN in the matchmaking configuration.</p>
1647
- * <p></p>
1648
- * <p>
1649
- * <b>Learn more</b>
1650
- * </p>
1651
- * <p>
1652
- * <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html">
1653
- * Add FlexMatch to a game client</a>
1654
- * </p>
1655
- * <p>
1656
- * <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html"> Set Up FlexMatch event
1657
- * notification</a>
1658
- * </p>
421
+ * @see {@link DescribeMatchmakingCommand}
1659
422
  */
1660
423
  describeMatchmaking(args: DescribeMatchmakingCommandInput, options?: __HttpHandlerOptions): Promise<DescribeMatchmakingCommandOutput>;
1661
424
  describeMatchmaking(args: DescribeMatchmakingCommandInput, cb: (err: any, data?: DescribeMatchmakingCommandOutput) => void): void;
1662
425
  describeMatchmaking(args: DescribeMatchmakingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMatchmakingCommandOutput) => void): void;
1663
426
  /**
1664
- * @public
1665
- * <p>Retrieves the details of FlexMatch matchmaking configurations. </p>
1666
- * <p>This operation offers the following options: (1) retrieve all matchmaking
1667
- * configurations, (2) retrieve configurations for a specified list, or (3) retrieve all
1668
- * configurations that use a specified rule set name. When requesting multiple items, use
1669
- * the pagination parameters to retrieve results as a set of sequential pages. </p>
1670
- * <p>If successful, a configuration is returned for each requested name. When specifying a
1671
- * list of names, only configurations that currently exist are returned. </p>
1672
- * <p>
1673
- * <b>Learn more</b>
1674
- * </p>
1675
- * <p>
1676
- * <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/matchmaker-build.html"> Setting up FlexMatch matchmakers</a>
1677
- * </p>
427
+ * @see {@link DescribeMatchmakingConfigurationsCommand}
1678
428
  */
1679
429
  describeMatchmakingConfigurations(args: DescribeMatchmakingConfigurationsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeMatchmakingConfigurationsCommandOutput>;
1680
430
  describeMatchmakingConfigurations(args: DescribeMatchmakingConfigurationsCommandInput, cb: (err: any, data?: DescribeMatchmakingConfigurationsCommandOutput) => void): void;
1681
431
  describeMatchmakingConfigurations(args: DescribeMatchmakingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMatchmakingConfigurationsCommandOutput) => void): void;
1682
432
  /**
1683
- * @public
1684
- * <p>Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing
1685
- * rule sets for the Region, or provide a list of one or more rule set names. When
1686
- * requesting multiple items, use the pagination parameters to retrieve results as a set of
1687
- * sequential pages. If successful, a rule set is returned for each requested name. </p>
1688
- * <p>
1689
- * <b>Learn more</b>
1690
- * </p>
1691
- * <ul>
1692
- * <li>
1693
- * <p>
1694
- * <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html">Build a rule
1695
- * set</a>
1696
- * </p>
1697
- * </li>
1698
- * </ul>
433
+ * @see {@link DescribeMatchmakingRuleSetsCommand}
1699
434
  */
1700
435
  describeMatchmakingRuleSets(args: DescribeMatchmakingRuleSetsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeMatchmakingRuleSetsCommandOutput>;
1701
436
  describeMatchmakingRuleSets(args: DescribeMatchmakingRuleSetsCommandInput, cb: (err: any, data?: DescribeMatchmakingRuleSetsCommandOutput) => void): void;
1702
437
  describeMatchmakingRuleSets(args: DescribeMatchmakingRuleSetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeMatchmakingRuleSetsCommandOutput) => void): void;
1703
438
  /**
1704
- * @public
1705
- * <p>Retrieves properties for one or more player sessions. </p>
1706
- * <p>This action can be used in the following ways: </p>
1707
- * <ul>
1708
- * <li>
1709
- * <p>To retrieve a specific player session, provide the player session ID
1710
- * only.</p>
1711
- * </li>
1712
- * <li>
1713
- * <p>To retrieve all player sessions in a game session, provide the game session ID
1714
- * only.</p>
1715
- * </li>
1716
- * <li>
1717
- * <p>To retrieve all player sessions for a specific player, provide a player ID
1718
- * only.</p>
1719
- * </li>
1720
- * </ul>
1721
- * <p>To request player sessions, specify either a player session ID, game session ID, or
1722
- * player ID. You can filter this request by player session status. Use the pagination
1723
- * parameters to retrieve results as a set of sequential pages. </p>
1724
- * <p>If successful, a <code>PlayerSession</code> object is returned for each session that
1725
- * matches the request.</p>
1726
- * <p>
1727
- * <b>Related actions</b>
1728
- * </p>
1729
- * <p>
1730
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
1731
- * </p>
439
+ * @see {@link DescribePlayerSessionsCommand}
1732
440
  */
1733
441
  describePlayerSessions(args: DescribePlayerSessionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribePlayerSessionsCommandOutput>;
1734
442
  describePlayerSessions(args: DescribePlayerSessionsCommandInput, cb: (err: any, data?: DescribePlayerSessionsCommandOutput) => void): void;
1735
443
  describePlayerSessions(args: DescribePlayerSessionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribePlayerSessionsCommandOutput) => void): void;
1736
444
  /**
1737
- * @public
1738
- * <p>Retrieves a fleet's runtime configuration settings. The runtime configuration tells
1739
- * GameLift which server processes to run (and how) on each instance in the fleet.</p>
1740
- * <p>To get the runtime configuration that is currently in forces for a fleet, provide the
1741
- * fleet ID. </p>
1742
- * <p>If successful, a <code>RuntimeConfiguration</code> object is returned for the
1743
- * requested fleet. If the requested fleet has been deleted, the result set is
1744
- * empty.</p>
1745
- * <p>
1746
- * <b>Learn more</b>
1747
- * </p>
1748
- * <p>
1749
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
1750
- * fleets</a>
1751
- * </p>
1752
- * <p>
1753
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html">Running multiple
1754
- * processes on a fleet</a>
1755
- * </p>
445
+ * @see {@link DescribeRuntimeConfigurationCommand}
1756
446
  */
1757
447
  describeRuntimeConfiguration(args: DescribeRuntimeConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<DescribeRuntimeConfigurationCommandOutput>;
1758
448
  describeRuntimeConfiguration(args: DescribeRuntimeConfigurationCommandInput, cb: (err: any, data?: DescribeRuntimeConfigurationCommandOutput) => void): void;
1759
449
  describeRuntimeConfiguration(args: DescribeRuntimeConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeRuntimeConfigurationCommandOutput) => void): void;
1760
450
  /**
1761
- * @public
1762
- * <p>Retrieves all scaling policies applied to a fleet.</p>
1763
- * <p>To get a fleet's scaling policies, specify the fleet ID. You can filter this request
1764
- * by policy status, such as to retrieve only active scaling policies. Use the pagination
1765
- * parameters to retrieve results as a set of sequential pages. If successful, set of
1766
- * <code>ScalingPolicy</code> objects is returned for the fleet.</p>
1767
- * <p>A fleet may have all of its scaling policies suspended. This operation does not affect
1768
- * the status of the scaling policies, which remains ACTIVE.</p>
451
+ * @see {@link DescribeScalingPoliciesCommand}
1769
452
  */
1770
453
  describeScalingPolicies(args: DescribeScalingPoliciesCommandInput, options?: __HttpHandlerOptions): Promise<DescribeScalingPoliciesCommandOutput>;
1771
454
  describeScalingPolicies(args: DescribeScalingPoliciesCommandInput, cb: (err: any, data?: DescribeScalingPoliciesCommandOutput) => void): void;
1772
455
  describeScalingPolicies(args: DescribeScalingPoliciesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeScalingPoliciesCommandOutput) => void): void;
1773
456
  /**
1774
- * @public
1775
- * <p>Retrieves properties for a Realtime script. </p>
1776
- * <p>To request a script record, specify the script ID. If successful, an object containing
1777
- * the script properties is returned.</p>
1778
- * <p>
1779
- * <b>Learn more</b>
1780
- * </p>
1781
- * <p>
1782
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon GameLift Realtime Servers</a>
1783
- * </p>
1784
- * <p>
1785
- * <b>Related actions</b>
1786
- * </p>
1787
- * <p>
1788
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
1789
- * </p>
457
+ * @see {@link DescribeScriptCommand}
1790
458
  */
1791
459
  describeScript(args: DescribeScriptCommandInput, options?: __HttpHandlerOptions): Promise<DescribeScriptCommandOutput>;
1792
460
  describeScript(args: DescribeScriptCommandInput, cb: (err: any, data?: DescribeScriptCommandOutput) => void): void;
1793
461
  describeScript(args: DescribeScriptCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeScriptCommandOutput) => void): void;
1794
462
  /**
1795
- * @public
1796
- * <p>Retrieves valid VPC peering authorizations that are pending for the Amazon Web Services account.
1797
- * This operation returns all VPC peering authorizations and requests for peering. This
1798
- * includes those initiated and received by this account. </p>
1799
- * <p>
1800
- * <b>Related actions</b>
1801
- * </p>
1802
- * <p>
1803
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
1804
- * </p>
463
+ * @see {@link DescribeVpcPeeringAuthorizationsCommand}
1805
464
  */
1806
465
  describeVpcPeeringAuthorizations(args: DescribeVpcPeeringAuthorizationsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeVpcPeeringAuthorizationsCommandOutput>;
1807
466
  describeVpcPeeringAuthorizations(args: DescribeVpcPeeringAuthorizationsCommandInput, cb: (err: any, data?: DescribeVpcPeeringAuthorizationsCommandOutput) => void): void;
1808
467
  describeVpcPeeringAuthorizations(args: DescribeVpcPeeringAuthorizationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVpcPeeringAuthorizationsCommandOutput) => void): void;
1809
468
  /**
1810
- * @public
1811
- * <p>Retrieves information on VPC peering connections. Use this operation to get peering
1812
- * information for all fleets or for one specific fleet ID. </p>
1813
- * <p>To retrieve connection information, call this operation from the Amazon Web Services account that is
1814
- * used to manage the Amazon GameLift fleets. Specify a fleet ID or leave the parameter empty to
1815
- * retrieve all connection records. If successful, the retrieved information includes both
1816
- * active and pending connections. Active connections identify the IpV4 CIDR block that the
1817
- * VPC uses to connect. </p>
1818
- * <p>
1819
- * <b>Related actions</b>
1820
- * </p>
1821
- * <p>
1822
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
1823
- * </p>
469
+ * @see {@link DescribeVpcPeeringConnectionsCommand}
1824
470
  */
1825
471
  describeVpcPeeringConnections(args: DescribeVpcPeeringConnectionsCommandInput, options?: __HttpHandlerOptions): Promise<DescribeVpcPeeringConnectionsCommandOutput>;
1826
472
  describeVpcPeeringConnections(args: DescribeVpcPeeringConnectionsCommandInput, cb: (err: any, data?: DescribeVpcPeeringConnectionsCommandOutput) => void): void;
1827
473
  describeVpcPeeringConnections(args: DescribeVpcPeeringConnectionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DescribeVpcPeeringConnectionsCommandOutput) => void): void;
1828
474
  /**
1829
- * @public
1830
- * <p>Requests remote access to a fleet instance. Remote access is useful for debugging,
1831
- * gathering benchmarking data, or observing activity in real time. </p>
1832
- * <p>To remotely access an instance, you need credentials that match the operating system
1833
- * of the instance. For a Windows instance, GameLift returns a user name and password as
1834
- * strings for use with a Windows Remote Desktop client. For a Linux instance, GameLift
1835
- * returns a user name and RSA private key, also as strings, for use with an SSH client.
1836
- * The private key must be saved in the proper format to a <code>.pem</code> file before
1837
- * using. If you're making this request using the CLI, saving the secret can be handled
1838
- * as part of the <code>GetInstanceAccess</code> request, as shown in one of the examples
1839
- * for this operation. </p>
1840
- * <p>To request access to a specific instance, specify the IDs of both the instance and the
1841
- * fleet it belongs to.</p>
1842
- * <p>
1843
- * <b>Learn more</b>
1844
- * </p>
1845
- * <p>
1846
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html">Remotely Access Fleet
1847
- * Instances</a>
1848
- * </p>
1849
- * <p>
1850
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html">Debug Fleet
1851
- * Issues</a>
1852
- * </p>
475
+ * @see {@link GetComputeAccessCommand}
1853
476
  */
1854
477
  getComputeAccess(args: GetComputeAccessCommandInput, options?: __HttpHandlerOptions): Promise<GetComputeAccessCommandOutput>;
1855
478
  getComputeAccess(args: GetComputeAccessCommandInput, cb: (err: any, data?: GetComputeAccessCommandOutput) => void): void;
1856
479
  getComputeAccess(args: GetComputeAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetComputeAccessCommandOutput) => void): void;
1857
480
  /**
1858
- * @public
1859
- * <p>Requests an authorization token from GameLift. The authorization token is used by your
1860
- * game server to authenticate with GameLift. Each authentication token has an expiration
1861
- * token. To continue using the compute resource to host your game server, regularly
1862
- * retrieve a new authorization token.</p>
481
+ * @see {@link GetComputeAuthTokenCommand}
1863
482
  */
1864
483
  getComputeAuthToken(args: GetComputeAuthTokenCommandInput, options?: __HttpHandlerOptions): Promise<GetComputeAuthTokenCommandOutput>;
1865
484
  getComputeAuthToken(args: GetComputeAuthTokenCommandInput, cb: (err: any, data?: GetComputeAuthTokenCommandOutput) => void): void;
1866
485
  getComputeAuthToken(args: GetComputeAuthTokenCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetComputeAuthTokenCommandOutput) => void): void;
1867
486
  /**
1868
- * @public
1869
- * <p>Retrieves the location of stored game session logs for a specified game session. When
1870
- * a game session is terminated, GameLift automatically stores the logs in Amazon S3 and
1871
- * retains them for 14 days. Use this URL to download the logs.</p>
1872
- * <note>
1873
- * <p>See the <a href="https://docs.aws.amazon.com/general/latest/gr/aws_service_limits.html#limits_gamelift">Amazon Web Services Service
1874
- * Limits</a> page for maximum log file sizes. Log files that exceed this limit
1875
- * are not saved.</p>
1876
- * </note>
1877
- * <p>
1878
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
1879
- * </p>
487
+ * @see {@link GetGameSessionLogUrlCommand}
1880
488
  */
1881
489
  getGameSessionLogUrl(args: GetGameSessionLogUrlCommandInput, options?: __HttpHandlerOptions): Promise<GetGameSessionLogUrlCommandOutput>;
1882
490
  getGameSessionLogUrl(args: GetGameSessionLogUrlCommandInput, cb: (err: any, data?: GetGameSessionLogUrlCommandOutput) => void): void;
1883
491
  getGameSessionLogUrl(args: GetGameSessionLogUrlCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetGameSessionLogUrlCommandOutput) => void): void;
1884
492
  /**
1885
- * @public
1886
- * <p>Requests remote access to a fleet instance. Remote access is useful for debugging,
1887
- * gathering benchmarking data, or observing activity in real time. </p>
1888
- * <p>To remotely access an instance, you need credentials that match the operating system
1889
- * of the instance. For a Windows instance, GameLift returns a user name and password as
1890
- * strings for use with a Windows Remote Desktop client. For a Linux instance, GameLift
1891
- * returns a user name and RSA private key, also as strings, for use with an SSH client.
1892
- * The private key must be saved in the proper format to a <code>.pem</code> file before
1893
- * using. If you're making this request using the CLI, saving the secret can be handled
1894
- * as part of the <code>GetInstanceAccess</code> request, as shown in one of the examples
1895
- * for this operation. </p>
1896
- * <p>To request access to a specific instance, specify the IDs of both the instance and the
1897
- * fleet it belongs to. You can retrieve a fleet's instance IDs by calling <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeInstances.html">DescribeInstances</a>. </p>
1898
- * <p>
1899
- * <b>Learn more</b>
1900
- * </p>
1901
- * <p>
1902
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html">Remotely Access Fleet
1903
- * Instances</a>
1904
- * </p>
1905
- * <p>
1906
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html">Debug Fleet
1907
- * Issues</a>
1908
- * </p>
1909
- * <p>
1910
- * <b>Related actions</b>
1911
- * </p>
1912
- * <p>
1913
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
1914
- * </p>
493
+ * @see {@link GetInstanceAccessCommand}
1915
494
  */
1916
495
  getInstanceAccess(args: GetInstanceAccessCommandInput, options?: __HttpHandlerOptions): Promise<GetInstanceAccessCommandOutput>;
1917
496
  getInstanceAccess(args: GetInstanceAccessCommandInput, cb: (err: any, data?: GetInstanceAccessCommandOutput) => void): void;
1918
497
  getInstanceAccess(args: GetInstanceAccessCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetInstanceAccessCommandOutput) => void): void;
1919
498
  /**
1920
- * @public
1921
- * <p>Retrieves all aliases for this Amazon Web Services account. You can filter the result set by alias
1922
- * name and/or routing strategy type. Use the pagination parameters to retrieve results in
1923
- * sequential pages.</p>
1924
- * <note>
1925
- * <p>Returned aliases are not listed in any particular order.</p>
1926
- * </note>
1927
- * <p>
1928
- * <b>Related actions</b>
1929
- * </p>
1930
- * <p>
1931
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
1932
- * </p>
499
+ * @see {@link ListAliasesCommand}
1933
500
  */
1934
501
  listAliases(args: ListAliasesCommandInput, options?: __HttpHandlerOptions): Promise<ListAliasesCommandOutput>;
1935
502
  listAliases(args: ListAliasesCommandInput, cb: (err: any, data?: ListAliasesCommandOutput) => void): void;
1936
503
  listAliases(args: ListAliasesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListAliasesCommandOutput) => void): void;
1937
504
  /**
1938
- * @public
1939
- * <p>Retrieves build resources for all builds associated with the Amazon Web Services account in use. You
1940
- * can limit results to builds that are in a specific status by using the
1941
- * <code>Status</code> parameter. Use the pagination parameters to retrieve results in
1942
- * a set of sequential pages. </p>
1943
- * <note>
1944
- * <p>Build resources are not listed in any particular order.</p>
1945
- * </note>
1946
- * <p>
1947
- * <b>Learn more</b>
1948
- * </p>
1949
- * <p>
1950
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html"> Upload a Custom
1951
- * Server Build</a>
1952
- * </p>
1953
- * <p>
1954
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
1955
- * </p>
505
+ * @see {@link ListBuildsCommand}
1956
506
  */
1957
507
  listBuilds(args: ListBuildsCommandInput, options?: __HttpHandlerOptions): Promise<ListBuildsCommandOutput>;
1958
508
  listBuilds(args: ListBuildsCommandInput, cb: (err: any, data?: ListBuildsCommandOutput) => void): void;
1959
509
  listBuilds(args: ListBuildsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListBuildsCommandOutput) => void): void;
1960
510
  /**
1961
- * @public
1962
- * <p>Retrieves all compute resources registered to a fleet in your Amazon Web Services account. You can filter the result set by location.</p>
511
+ * @see {@link ListComputeCommand}
1963
512
  */
1964
513
  listCompute(args: ListComputeCommandInput, options?: __HttpHandlerOptions): Promise<ListComputeCommandOutput>;
1965
514
  listCompute(args: ListComputeCommandInput, cb: (err: any, data?: ListComputeCommandOutput) => void): void;
1966
515
  listCompute(args: ListComputeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListComputeCommandOutput) => void): void;
1967
516
  /**
1968
- * @public
1969
- * <p>Retrieves a collection of fleet resources in an Amazon Web Services Region. You can call this
1970
- * operation to get fleets in a previously selected default Region (see <a href="https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.html">https://docs.aws.amazon.com/credref/latest/refdocs/setting-global-region.html</a>or
1971
- * specify a Region in your request. You can filter the result set to find only those
1972
- * fleets that are deployed with a specific build or script. For fleets that have multiple
1973
- * locations, this operation retrieves fleets based on their home Region only.</p>
1974
- * <p>This operation can be used in the following ways: </p>
1975
- * <ul>
1976
- * <li>
1977
- * <p>To get a list of all fleets in a Region, don't provide a build or script
1978
- * identifier. </p>
1979
- * </li>
1980
- * <li>
1981
- * <p>To get a list of all fleets where a specific custom game build is deployed,
1982
- * provide the build ID.</p>
1983
- * </li>
1984
- * <li>
1985
- * <p>To get a list of all Realtime Servers fleets with a specific configuration script,
1986
- * provide the script ID. </p>
1987
- * </li>
1988
- * </ul>
1989
- * <p>Use the pagination parameters to retrieve results as a set of sequential pages. </p>
1990
- * <p>If successful, a list of fleet IDs that match the request parameters is returned. A
1991
- * NextToken value is also returned if there are more result pages to retrieve.</p>
1992
- * <note>
1993
- * <p>Fleet resources are not listed in a particular order.</p>
1994
- * </note>
1995
- * <p>
1996
- * <b>Learn more</b>
1997
- * </p>
1998
- * <p>
1999
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
2000
- * fleets</a>
2001
- * </p>
517
+ * @see {@link ListFleetsCommand}
2002
518
  */
2003
519
  listFleets(args: ListFleetsCommandInput, options?: __HttpHandlerOptions): Promise<ListFleetsCommandOutput>;
2004
520
  listFleets(args: ListFleetsCommandInput, cb: (err: any, data?: ListFleetsCommandOutput) => void): void;
2005
521
  listFleets(args: ListFleetsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListFleetsCommandOutput) => void): void;
2006
522
  /**
2007
- * @public
2008
- * <p>Lists a game server groups.</p>
523
+ * @see {@link ListGameServerGroupsCommand}
2009
524
  */
2010
525
  listGameServerGroups(args: ListGameServerGroupsCommandInput, options?: __HttpHandlerOptions): Promise<ListGameServerGroupsCommandOutput>;
2011
526
  listGameServerGroups(args: ListGameServerGroupsCommandInput, cb: (err: any, data?: ListGameServerGroupsCommandOutput) => void): void;
2012
527
  listGameServerGroups(args: ListGameServerGroupsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGameServerGroupsCommandOutput) => void): void;
2013
528
  /**
2014
- * @public
2015
- * <p>
2016
- * <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b>
2017
- * </p>
2018
- * <p>Retrieves information on all game
2019
- * servers that are currently active in a specified game server group. You can opt to sort
2020
- * the list by game server age. Use the pagination parameters to retrieve results in a set
2021
- * of sequential segments. </p>
2022
- * <p>
2023
- * <b>Learn more</b>
2024
- * </p>
2025
- * <p>
2026
- * <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ
2027
- * Guide</a>
2028
- * </p>
529
+ * @see {@link ListGameServersCommand}
2029
530
  */
2030
531
  listGameServers(args: ListGameServersCommandInput, options?: __HttpHandlerOptions): Promise<ListGameServersCommandOutput>;
2031
532
  listGameServers(args: ListGameServersCommandInput, cb: (err: any, data?: ListGameServersCommandOutput) => void): void;
2032
533
  listGameServers(args: ListGameServersCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListGameServersCommandOutput) => void): void;
2033
534
  /**
2034
- * @public
2035
- * <p>Lists all custom and Amazon Web Services locations.</p>
535
+ * @see {@link ListLocationsCommand}
2036
536
  */
2037
537
  listLocations(args: ListLocationsCommandInput, options?: __HttpHandlerOptions): Promise<ListLocationsCommandOutput>;
2038
538
  listLocations(args: ListLocationsCommandInput, cb: (err: any, data?: ListLocationsCommandOutput) => void): void;
2039
539
  listLocations(args: ListLocationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListLocationsCommandOutput) => void): void;
2040
540
  /**
2041
- * @public
2042
- * <p>Retrieves script records for all Realtime scripts that are associated with the Amazon Web Services
2043
- * account in use. </p>
2044
- * <p>
2045
- * <b>Learn more</b>
2046
- * </p>
2047
- * <p>
2048
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon GameLift Realtime Servers</a>
2049
- * </p>
2050
- * <p>
2051
- * <b>Related actions</b>
2052
- * </p>
2053
- * <p>
2054
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
2055
- * </p>
541
+ * @see {@link ListScriptsCommand}
2056
542
  */
2057
543
  listScripts(args: ListScriptsCommandInput, options?: __HttpHandlerOptions): Promise<ListScriptsCommandOutput>;
2058
544
  listScripts(args: ListScriptsCommandInput, cb: (err: any, data?: ListScriptsCommandOutput) => void): void;
2059
545
  listScripts(args: ListScriptsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListScriptsCommandOutput) => void): void;
2060
546
  /**
2061
- * @public
2062
- * <p>Retrieves all tags that are assigned to a GameLift resource. Resource tags are used to
2063
- * organize Amazon Web Services resources for a range of purposes. This operation handles the permissions
2064
- * necessary to manage tags for the following GameLift resource types:</p>
2065
- * <ul>
2066
- * <li>
2067
- * <p>Build</p>
2068
- * </li>
2069
- * <li>
2070
- * <p>Script</p>
2071
- * </li>
2072
- * <li>
2073
- * <p>Fleet</p>
2074
- * </li>
2075
- * <li>
2076
- * <p>Alias</p>
2077
- * </li>
2078
- * <li>
2079
- * <p>GameSessionQueue</p>
2080
- * </li>
2081
- * <li>
2082
- * <p>MatchmakingConfiguration</p>
2083
- * </li>
2084
- * <li>
2085
- * <p>MatchmakingRuleSet</p>
2086
- * </li>
2087
- * </ul>
2088
- * <p>To list tags for a resource, specify the unique ARN value for the resource.</p>
2089
- * <p>
2090
- * <b>Learn more</b>
2091
- * </p>
2092
- * <p>
2093
- * <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services
2094
- * Resources</a> in the <i>Amazon Web Services General Reference</i>
2095
- * </p>
2096
- * <p>
2097
- * <a href="http://aws.amazon.com/answers/account-management/aws-tagging-strategies/">
2098
- * Amazon Web Services Tagging Strategies</a>
2099
- * </p>
2100
- * <p>
2101
- * <b>Related actions</b>
2102
- * </p>
2103
- * <p>
2104
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
2105
- * </p>
547
+ * @see {@link ListTagsForResourceCommand}
2106
548
  */
2107
549
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
2108
550
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
2109
551
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
2110
552
  /**
2111
- * @public
2112
- * <p>Creates or updates a scaling policy for a fleet. Scaling policies are used to
2113
- * automatically scale a fleet's hosting capacity to meet player demand. An active scaling
2114
- * policy instructs Amazon GameLift to track a fleet metric and automatically change the fleet's
2115
- * capacity when a certain threshold is reached. There are two types of scaling policies:
2116
- * target-based and rule-based. Use a target-based policy to quickly and efficiently manage
2117
- * fleet scaling; this option is the most commonly used. Use rule-based policies when you
2118
- * need to exert fine-grained control over auto-scaling. </p>
2119
- * <p>Fleets can have multiple scaling policies of each type in force at the same time; you
2120
- * can have one target-based policy, one or multiple rule-based scaling policies, or both.
2121
- * We recommend caution, however, because multiple auto-scaling policies can have
2122
- * unintended consequences.</p>
2123
- * <p>Learn more about how to work with auto-scaling in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-autoscaling.html">Set Up Fleet Automatic
2124
- * Scaling</a>.</p>
2125
- * <p>
2126
- * <b>Target-based policy</b>
2127
- * </p>
2128
- * <p>A target-based policy tracks a single metric: PercentAvailableGameSessions. This
2129
- * metric tells us how much of a fleet's hosting capacity is ready to host game sessions
2130
- * but is not currently in use. This is the fleet's buffer; it measures the additional
2131
- * player demand that the fleet could handle at current capacity. With a target-based
2132
- * policy, you set your ideal buffer size and leave it to Amazon GameLift to take whatever action is
2133
- * needed to maintain that target. </p>
2134
- * <p>For example, you might choose to maintain a 10% buffer for a fleet that has the
2135
- * capacity to host 100 simultaneous game sessions. This policy tells Amazon GameLift to take action
2136
- * whenever the fleet's available capacity falls below or rises above 10 game sessions.
2137
- * Amazon GameLift will start new instances or stop unused instances in order to return to the 10%
2138
- * buffer. </p>
2139
- * <p>To create or update a target-based policy, specify a fleet ID and name, and set the
2140
- * policy type to "TargetBased". Specify the metric to track (PercentAvailableGameSessions)
2141
- * and reference a <code>TargetConfiguration</code> object with your desired buffer value.
2142
- * Exclude all other parameters. On a successful request, the policy name is returned. The
2143
- * scaling policy is automatically in force as soon as it's successfully created. If the
2144
- * fleet's auto-scaling actions are temporarily suspended, the new policy will be in force
2145
- * once the fleet actions are restarted.</p>
2146
- * <p>
2147
- * <b>Rule-based policy</b>
2148
- * </p>
2149
- * <p>A rule-based policy tracks specified fleet metric, sets a threshold value, and
2150
- * specifies the type of action to initiate when triggered. With a rule-based policy, you
2151
- * can select from several available fleet metrics. Each policy specifies whether to scale
2152
- * up or scale down (and by how much), so you need one policy for each type of action. </p>
2153
- * <p>For example, a policy may make the following statement: "If the percentage of idle
2154
- * instances is greater than 20% for more than 15 minutes, then reduce the fleet capacity
2155
- * by 10%."</p>
2156
- * <p>A policy's rule statement has the following structure:</p>
2157
- * <p>If <code>[MetricName]</code> is <code>[ComparisonOperator]</code>
2158
- * <code>[Threshold]</code> for <code>[EvaluationPeriods]</code> minutes, then
2159
- * <code>[ScalingAdjustmentType]</code> to/by <code>[ScalingAdjustment]</code>.</p>
2160
- * <p>To implement the example, the rule statement would look like this:</p>
2161
- * <p>If <code>[PercentIdleInstances]</code> is <code>[GreaterThanThreshold]</code>
2162
- * <code>[20]</code> for <code>[15]</code> minutes, then
2163
- * <code>[PercentChangeInCapacity]</code> to/by <code>[10]</code>.</p>
2164
- * <p>To create or update a scaling policy, specify a unique combination of name and fleet
2165
- * ID, and set the policy type to "RuleBased". Specify the parameter values for a policy
2166
- * rule statement. On a successful request, the policy name is returned. Scaling policies
2167
- * are automatically in force as soon as they're successfully created. If the fleet's
2168
- * auto-scaling actions are temporarily suspended, the new policy will be in force once the
2169
- * fleet actions are restarted.</p>
553
+ * @see {@link PutScalingPolicyCommand}
2170
554
  */
2171
555
  putScalingPolicy(args: PutScalingPolicyCommandInput, options?: __HttpHandlerOptions): Promise<PutScalingPolicyCommandOutput>;
2172
556
  putScalingPolicy(args: PutScalingPolicyCommandInput, cb: (err: any, data?: PutScalingPolicyCommandOutput) => void): void;
2173
557
  putScalingPolicy(args: PutScalingPolicyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutScalingPolicyCommandOutput) => void): void;
2174
558
  /**
2175
- * @public
2176
- * <p>Registers your compute resources in a fleet you previously created. After you register
2177
- * a compute to your fleet, you can monitor and manage your compute using GameLift. The
2178
- * operation returns the compute resource containing SDK endpoint you can use to connect
2179
- * your game server to GameLift.</p>
2180
- * <p>
2181
- * <b>Learn more</b>
2182
- * </p>
2183
- * <ul>
2184
- * <li>
2185
- * <p>
2186
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-anywhere.html">Create an
2187
- * Anywhere fleet</a>
2188
- * </p>
2189
- * </li>
2190
- * <li>
2191
- * <p>
2192
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-testing.html">Test your
2193
- * integration</a>
2194
- * </p>
2195
- * </li>
2196
- * </ul>
559
+ * @see {@link RegisterComputeCommand}
2197
560
  */
2198
561
  registerCompute(args: RegisterComputeCommandInput, options?: __HttpHandlerOptions): Promise<RegisterComputeCommandOutput>;
2199
562
  registerCompute(args: RegisterComputeCommandInput, cb: (err: any, data?: RegisterComputeCommandOutput) => void): void;
2200
563
  registerCompute(args: RegisterComputeCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterComputeCommandOutput) => void): void;
2201
564
  /**
2202
- * @public
2203
- * <p>
2204
- * <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b>
2205
- * </p>
2206
- * <p>Creates a new game server
2207
- * resource and notifies GameLift FleetIQ that the game server is ready to host gameplay and players.
2208
- * This operation is called by a game server process that is running on an instance in a
2209
- * game server group. Registering game servers enables GameLift FleetIQ to track available game
2210
- * servers and enables game clients and services to claim a game server for a new game
2211
- * session. </p>
2212
- * <p>To register a game server, identify the game server group and instance where the game
2213
- * server is running, and provide a unique identifier for the game server. You can also
2214
- * include connection and game server data.</p>
2215
- * <p>Once a game server is successfully registered, it is put in status
2216
- * <code>AVAILABLE</code>. A request to register a game server may fail if the instance
2217
- * it is running on is in the process of shutting down as part of instance balancing or
2218
- * scale-down activity. </p>
2219
- * <p>
2220
- * <b>Learn more</b>
2221
- * </p>
2222
- * <p>
2223
- * <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ
2224
- * Guide</a>
2225
- * </p>
565
+ * @see {@link RegisterGameServerCommand}
2226
566
  */
2227
567
  registerGameServer(args: RegisterGameServerCommandInput, options?: __HttpHandlerOptions): Promise<RegisterGameServerCommandOutput>;
2228
568
  registerGameServer(args: RegisterGameServerCommandInput, cb: (err: any, data?: RegisterGameServerCommandOutput) => void): void;
2229
569
  registerGameServer(args: RegisterGameServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RegisterGameServerCommandOutput) => void): void;
2230
570
  /**
2231
- * @public
2232
- * <p>Retrieves a fresh set of credentials for use when uploading a new set of game build
2233
- * files to Amazon GameLift's Amazon S3. This is done as part of the build creation process; see
2234
- * <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateBuild.html">GameSession</a>.</p>
2235
- * <p>To request new credentials, specify the build ID as returned with an initial
2236
- * <code>CreateBuild</code> request. If successful, a new set of credentials are
2237
- * returned, along with the S3 storage location associated with the build ID.</p>
2238
- * <p>
2239
- * <b>Learn more</b>
2240
- * </p>
2241
- * <p>
2242
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html#gamelift-build-cli-uploading-create-build"> Create a Build with Files in S3</a>
2243
- * </p>
2244
- * <p>
2245
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
2246
- * </p>
571
+ * @see {@link RequestUploadCredentialsCommand}
2247
572
  */
2248
573
  requestUploadCredentials(args: RequestUploadCredentialsCommandInput, options?: __HttpHandlerOptions): Promise<RequestUploadCredentialsCommandOutput>;
2249
574
  requestUploadCredentials(args: RequestUploadCredentialsCommandInput, cb: (err: any, data?: RequestUploadCredentialsCommandOutput) => void): void;
2250
575
  requestUploadCredentials(args: RequestUploadCredentialsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RequestUploadCredentialsCommandOutput) => void): void;
2251
576
  /**
2252
- * @public
2253
- * <p>Retrieves the fleet ID that an alias is currently pointing to.</p>
2254
- * <p>
2255
- * <b>Related actions</b>
2256
- * </p>
2257
- * <p>
2258
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
2259
- * </p>
577
+ * @see {@link ResolveAliasCommand}
2260
578
  */
2261
579
  resolveAlias(args: ResolveAliasCommandInput, options?: __HttpHandlerOptions): Promise<ResolveAliasCommandOutput>;
2262
580
  resolveAlias(args: ResolveAliasCommandInput, cb: (err: any, data?: ResolveAliasCommandOutput) => void): void;
2263
581
  resolveAlias(args: ResolveAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResolveAliasCommandOutput) => void): void;
2264
582
  /**
2265
- * @public
2266
- * <p>
2267
- * <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b>
2268
- * </p>
2269
- * <p>Reinstates activity on a game
2270
- * server group after it has been suspended. A game server group might be suspended by the
2271
- * <a href="gamelift/latest/apireference/API_SuspendGameServerGroup.html">SuspendGameServerGroup</a> operation, or it might be suspended involuntarily
2272
- * due to a configuration problem. In the second case, you can manually resume activity on
2273
- * the group once the configuration problem has been resolved. Refer to the game server
2274
- * group status and status reason for more information on why group activity is
2275
- * suspended.</p>
2276
- * <p>To resume activity, specify a game server group ARN and the type of activity to be
2277
- * resumed. If successful, a <code>GameServerGroup</code> object is returned showing that
2278
- * the resumed activity is no longer listed in <code>SuspendedActions</code>. </p>
2279
- * <p>
2280
- * <b>Learn more</b>
2281
- * </p>
2282
- * <p>
2283
- * <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ
2284
- * Guide</a>
2285
- * </p>
583
+ * @see {@link ResumeGameServerGroupCommand}
2286
584
  */
2287
585
  resumeGameServerGroup(args: ResumeGameServerGroupCommandInput, options?: __HttpHandlerOptions): Promise<ResumeGameServerGroupCommandOutput>;
2288
586
  resumeGameServerGroup(args: ResumeGameServerGroupCommandInput, cb: (err: any, data?: ResumeGameServerGroupCommandOutput) => void): void;
2289
587
  resumeGameServerGroup(args: ResumeGameServerGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ResumeGameServerGroupCommandOutput) => void): void;
2290
588
  /**
2291
- * @public
2292
- * <p>Retrieves all active game sessions that match a set of search criteria and sorts them
2293
- * into a specified order. </p>
2294
- * <p>This operation is not designed to be continually called to track game session status.
2295
- * This practice can cause you to exceed your API limit, which results in errors. Instead,
2296
- * you must configure configure an Amazon Simple Notification Service (SNS) topic to receive notifications from
2297
- * FlexMatch or queues. Continuously polling game session status with
2298
- * <code>DescribeGameSessions</code> should only be used for games in development with
2299
- * low game session usage. </p>
2300
- * <p>When searching for game sessions, you specify exactly where you want to search and
2301
- * provide a search filter expression, a sort expression, or both. A search request can
2302
- * search only one fleet, but it can search all of a fleet's locations. </p>
2303
- * <p>This operation can be used in the following ways: </p>
2304
- * <ul>
2305
- * <li>
2306
- * <p>To search all game sessions that are currently running on all locations in a
2307
- * fleet, provide a fleet or alias ID. This approach returns game sessions in the
2308
- * fleet's home Region and all remote locations that fit the search
2309
- * criteria.</p>
2310
- * </li>
2311
- * <li>
2312
- * <p>To search all game sessions that are currently running on a specific fleet
2313
- * location, provide a fleet or alias ID and a location name. For location, you can
2314
- * specify a fleet's home Region or any remote location.</p>
2315
- * </li>
2316
- * </ul>
2317
- * <p>Use the pagination parameters to retrieve results as a set of sequential pages. </p>
2318
- * <p>If successful, a <code>GameSession</code> object is returned for each game session
2319
- * that matches the request. Search finds game sessions that are in <code>ACTIVE</code>
2320
- * status only. To retrieve information on game sessions in other statuses, use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessions.html">DescribeGameSessions</a> .</p>
2321
- * <p>You can search or sort by the following game session attributes:</p>
2322
- * <ul>
2323
- * <li>
2324
- * <p>
2325
- * <b>gameSessionId</b> -- A unique identifier for the game session. You can use either a
2326
- * <code>GameSessionId</code> or <code>GameSessionArn</code> value. </p>
2327
- * </li>
2328
- * <li>
2329
- * <p>
2330
- * <b>gameSessionName</b> -- Name assigned to a game
2331
- * session. Game session names do not need to be unique to a game session.</p>
2332
- * </li>
2333
- * <li>
2334
- * <p>
2335
- * <b>gameSessionProperties</b> -- Custom data defined
2336
- * in a game session's <code>GameProperty</code> parameter.
2337
- * <code>GameProperty</code> values are stored as key:value pairs; the filter
2338
- * expression must indicate the key and a string to search the data values for. For
2339
- * example, to search for game sessions with custom data containing the key:value
2340
- * pair "gameMode:brawl", specify the following:
2341
- * <code>gameSessionProperties.gameMode = "brawl"</code>. All custom data
2342
- * values are searched as strings.</p>
2343
- * </li>
2344
- * <li>
2345
- * <p>
2346
- * <b>maximumSessions</b> -- Maximum number of player
2347
- * sessions allowed for a game session.</p>
2348
- * </li>
2349
- * <li>
2350
- * <p>
2351
- * <b>creationTimeMillis</b> -- Value indicating when a
2352
- * game session was created. It is expressed in Unix time as milliseconds.</p>
2353
- * </li>
2354
- * <li>
2355
- * <p>
2356
- * <b>playerSessionCount</b> -- Number of players
2357
- * currently connected to a game session. This value changes rapidly as players
2358
- * join the session or drop out.</p>
2359
- * </li>
2360
- * <li>
2361
- * <p>
2362
- * <b>hasAvailablePlayerSessions</b> -- Boolean value
2363
- * indicating whether a game session has reached its maximum number of players. It
2364
- * is highly recommended that all search requests include this filter attribute to
2365
- * optimize search performance and return only sessions that players can join.
2366
- * </p>
2367
- * </li>
2368
- * </ul>
2369
- * <note>
2370
- * <p>Returned values for <code>playerSessionCount</code> and
2371
- * <code>hasAvailablePlayerSessions</code> change quickly as players join sessions
2372
- * and others drop out. Results should be considered a snapshot in time. Be sure to
2373
- * refresh search results often, and handle sessions that fill up before a player can
2374
- * join. </p>
2375
- * </note>
2376
- * <p>
2377
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
2378
- * </p>
589
+ * @see {@link SearchGameSessionsCommand}
2379
590
  */
2380
591
  searchGameSessions(args: SearchGameSessionsCommandInput, options?: __HttpHandlerOptions): Promise<SearchGameSessionsCommandOutput>;
2381
592
  searchGameSessions(args: SearchGameSessionsCommandInput, cb: (err: any, data?: SearchGameSessionsCommandOutput) => void): void;
2382
593
  searchGameSessions(args: SearchGameSessionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SearchGameSessionsCommandOutput) => void): void;
2383
594
  /**
2384
- * @public
2385
- * <p>Resumes certain types of activity on fleet instances that were suspended with <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_StopFleetActions.html">StopFleetActions</a>. For multi-location fleets, fleet actions are managed
2386
- * separately for each location. Currently, this operation is used to restart a fleet's
2387
- * auto-scaling activity.</p>
2388
- * <p>This operation can be used in the following ways: </p>
2389
- * <ul>
2390
- * <li>
2391
- * <p>To restart actions on instances in the fleet's home Region, provide a fleet ID
2392
- * and the type of actions to resume. </p>
2393
- * </li>
2394
- * <li>
2395
- * <p>To restart actions on instances in one of the fleet's remote locations,
2396
- * provide a fleet ID, a location name, and the type of actions to resume. </p>
2397
- * </li>
2398
- * </ul>
2399
- * <p>If successful, GameLift once again initiates scaling events as triggered by the fleet's
2400
- * scaling policies. If actions on the fleet location were never stopped, this operation
2401
- * will have no effect.</p>
2402
- * <p>
2403
- * <b>Learn more</b>
2404
- * </p>
2405
- * <p>
2406
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
2407
- * fleets</a>
2408
- * </p>
595
+ * @see {@link StartFleetActionsCommand}
2409
596
  */
2410
597
  startFleetActions(args: StartFleetActionsCommandInput, options?: __HttpHandlerOptions): Promise<StartFleetActionsCommandOutput>;
2411
598
  startFleetActions(args: StartFleetActionsCommandInput, cb: (err: any, data?: StartFleetActionsCommandOutput) => void): void;
2412
599
  startFleetActions(args: StartFleetActionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartFleetActionsCommandOutput) => void): void;
2413
600
  /**
2414
- * @public
2415
- * <p>Places a request for a new game session in a queue. When processing a placement
2416
- * request, Amazon GameLift searches for available resources on the queue's destinations, scanning
2417
- * each until it finds resources or the placement request times out.</p>
2418
- * <p>A game session placement request can also request player sessions. When a new game
2419
- * session is successfully created, Amazon GameLift creates a player session for each player
2420
- * included in the request.</p>
2421
- * <p>When placing a game session, by default Amazon GameLift tries each fleet in the order they are
2422
- * listed in the queue configuration. Ideally, a queue's destinations are listed in
2423
- * preference order.</p>
2424
- * <p>Alternatively, when requesting a game session with players, you can also provide
2425
- * latency data for each player in relevant Regions. Latency data indicates the performance
2426
- * lag a player experiences when connected to a fleet in the Region. Amazon GameLift uses latency
2427
- * data to reorder the list of destinations to place the game session in a Region with
2428
- * minimal lag. If latency data is provided for multiple players, Amazon GameLift calculates each
2429
- * Region's average lag for all players and reorders to get the best game play across all
2430
- * players. </p>
2431
- * <p>To place a new game session request, specify the following:</p>
2432
- * <ul>
2433
- * <li>
2434
- * <p>The queue name and a set of game session properties and settings</p>
2435
- * </li>
2436
- * <li>
2437
- * <p>A unique ID (such as a UUID) for the placement. You use this ID to track the
2438
- * status of the placement request</p>
2439
- * </li>
2440
- * <li>
2441
- * <p>(Optional) A set of player data and a unique player ID for each player that
2442
- * you are joining to the new game session (player data is optional, but if you
2443
- * include it, you must also provide a unique ID for each player)</p>
2444
- * </li>
2445
- * <li>
2446
- * <p>Latency data for all players (if you want to optimize game play for the
2447
- * players)</p>
2448
- * </li>
2449
- * </ul>
2450
- * <p>If successful, a new game session placement is created.</p>
2451
- * <p>To track the status of a placement request, call <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionPlacement.html">DescribeGameSessionPlacement</a> and check the request's status. If the status
2452
- * is <code>FULFILLED</code>, a new game session has been created and a game session ARN
2453
- * and Region are referenced. If the placement request times out, you can resubmit the
2454
- * request or retry it with a different queue. </p>
601
+ * @see {@link StartGameSessionPlacementCommand}
2455
602
  */
2456
603
  startGameSessionPlacement(args: StartGameSessionPlacementCommandInput, options?: __HttpHandlerOptions): Promise<StartGameSessionPlacementCommandOutput>;
2457
604
  startGameSessionPlacement(args: StartGameSessionPlacementCommandInput, cb: (err: any, data?: StartGameSessionPlacementCommandOutput) => void): void;
2458
605
  startGameSessionPlacement(args: StartGameSessionPlacementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartGameSessionPlacementCommandOutput) => void): void;
2459
606
  /**
2460
- * @public
2461
- * <p>Finds new players to fill open slots in currently running game sessions. The backfill
2462
- * match process is essentially identical to the process of forming new matches. Backfill
2463
- * requests use the same matchmaker that was used to make the original match, and they
2464
- * provide matchmaking data for all players currently in the game session. FlexMatch uses
2465
- * this information to select new players so that backfilled match continues to meet the
2466
- * original match requirements. </p>
2467
- * <p>When using FlexMatch with GameLift managed hosting, you can request a backfill match from
2468
- * a client service by calling this operation with a <code>GameSessions</code> ID. You also
2469
- * have the option of making backfill requests directly from your game server. In response
2470
- * to a request, FlexMatch creates player sessions for the new players, updates the
2471
- * <code>GameSession</code> resource, and sends updated matchmaking data to the game
2472
- * server. You can request a backfill match at any point after a game session is started.
2473
- * Each game session can have only one active backfill request at a time; a subsequent
2474
- * request automatically replaces the earlier request.</p>
2475
- * <p>When using FlexMatch as a standalone component, request a backfill match by calling this
2476
- * operation without a game session identifier. As with newly formed matches, matchmaking
2477
- * results are returned in a matchmaking event so that your game can update the game
2478
- * session that is being backfilled.</p>
2479
- * <p>To request a backfill match, specify a unique ticket ID, the original matchmaking
2480
- * configuration, and matchmaking data for all current players in the game session being
2481
- * backfilled. Optionally, specify the <code>GameSession</code> ARN. If successful, a match
2482
- * backfill ticket is created and returned with status set to QUEUED. Track the status of
2483
- * backfill tickets using the same method for tracking tickets for new matches.</p>
2484
- * <p>Only game sessions created by FlexMatch are supported for match backfill.</p>
2485
- * <p>
2486
- * <b>Learn more</b>
2487
- * </p>
2488
- * <p>
2489
- * <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html">
2490
- * Backfill existing games with FlexMatch</a>
2491
- * </p>
2492
- * <p>
2493
- * <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html">
2494
- * Matchmaking events</a> (reference)</p>
2495
- * <p>
2496
- * <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html">
2497
- * How GameLift FlexMatch works</a>
2498
- * </p>
607
+ * @see {@link StartMatchBackfillCommand}
2499
608
  */
2500
609
  startMatchBackfill(args: StartMatchBackfillCommandInput, options?: __HttpHandlerOptions): Promise<StartMatchBackfillCommandOutput>;
2501
610
  startMatchBackfill(args: StartMatchBackfillCommandInput, cb: (err: any, data?: StartMatchBackfillCommandOutput) => void): void;
2502
611
  startMatchBackfill(args: StartMatchBackfillCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartMatchBackfillCommandOutput) => void): void;
2503
612
  /**
2504
- * @public
2505
- * <p>Uses FlexMatch to create a game match for a group of players based on custom matchmaking
2506
- * rules. With games that use GameLift managed hosting, this operation also triggers GameLift
2507
- * to find hosting resources and start a new game session for the new match. Each
2508
- * matchmaking request includes information on one or more players and specifies the
2509
- * FlexMatch matchmaker to use. When a request is for multiple players, FlexMatch attempts to
2510
- * build a match that includes all players in the request, placing them in the same team
2511
- * and finding additional players as needed to fill the match. </p>
2512
- * <p>To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration,
2513
- * and include the players to be matched. You must also include any player attributes that
2514
- * are required by the matchmaking configuration's rule set. If successful, a matchmaking
2515
- * ticket is returned with status set to <code>QUEUED</code>. </p>
2516
- * <p>Track matchmaking events to respond as needed and acquire game session connection
2517
- * information for successfully completed matches. Ticket status updates are tracked using
2518
- * event notification through Amazon Simple Notification Service, which is defined in the matchmaking
2519
- * configuration.</p>
2520
- * <p>
2521
- * <b>Learn more</b>
2522
- * </p>
2523
- * <p>
2524
- * <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html">
2525
- * Add FlexMatch to a game client</a>
2526
- * </p>
2527
- * <p>
2528
- * <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html"> Set Up FlexMatch event
2529
- * notification</a>
2530
- * </p>
2531
- * <p>
2532
- * <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html">
2533
- * How GameLift FlexMatch works</a>
2534
- * </p>
613
+ * @see {@link StartMatchmakingCommand}
2535
614
  */
2536
615
  startMatchmaking(args: StartMatchmakingCommandInput, options?: __HttpHandlerOptions): Promise<StartMatchmakingCommandOutput>;
2537
616
  startMatchmaking(args: StartMatchmakingCommandInput, cb: (err: any, data?: StartMatchmakingCommandOutput) => void): void;
2538
617
  startMatchmaking(args: StartMatchmakingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StartMatchmakingCommandOutput) => void): void;
2539
618
  /**
2540
- * @public
2541
- * <p>Suspends certain types of activity in a fleet location. Currently, this operation is
2542
- * used to stop auto-scaling activity. For multi-location fleets, fleet actions are managed
2543
- * separately for each location. </p>
2544
- * <p>Stopping fleet actions has several potential purposes. It allows you to temporarily
2545
- * stop auto-scaling activity but retain your scaling policies for use in the future. For
2546
- * multi-location fleets, you can set up fleet-wide auto-scaling, and then opt out of it
2547
- * for certain locations. </p>
2548
- * <p>This operation can be used in the following ways: </p>
2549
- * <ul>
2550
- * <li>
2551
- * <p>To stop actions on instances in the fleet's home Region, provide a fleet ID
2552
- * and the type of actions to suspend. </p>
2553
- * </li>
2554
- * <li>
2555
- * <p>To stop actions on instances in one of the fleet's remote locations, provide a
2556
- * fleet ID, a location name, and the type of actions to suspend. </p>
2557
- * </li>
2558
- * </ul>
2559
- * <p>If successful, GameLift no longer initiates scaling events except in response to manual
2560
- * changes using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html">UpdateFleetCapacity</a>.</p>
2561
- * <p>
2562
- * <b>Learn more</b>
2563
- * </p>
2564
- * <p>
2565
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
2566
- * Fleets</a>
2567
- * </p>
619
+ * @see {@link StopFleetActionsCommand}
2568
620
  */
2569
621
  stopFleetActions(args: StopFleetActionsCommandInput, options?: __HttpHandlerOptions): Promise<StopFleetActionsCommandOutput>;
2570
622
  stopFleetActions(args: StopFleetActionsCommandInput, cb: (err: any, data?: StopFleetActionsCommandOutput) => void): void;
2571
623
  stopFleetActions(args: StopFleetActionsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopFleetActionsCommandOutput) => void): void;
2572
624
  /**
2573
- * @public
2574
- * <p>Cancels a game session placement that is in <code>PENDING</code> status. To stop a
2575
- * placement, provide the placement ID values. If successful, the placement is moved to
2576
- * <code>CANCELLED</code> status.</p>
625
+ * @see {@link StopGameSessionPlacementCommand}
2577
626
  */
2578
627
  stopGameSessionPlacement(args: StopGameSessionPlacementCommandInput, options?: __HttpHandlerOptions): Promise<StopGameSessionPlacementCommandOutput>;
2579
628
  stopGameSessionPlacement(args: StopGameSessionPlacementCommandInput, cb: (err: any, data?: StopGameSessionPlacementCommandOutput) => void): void;
2580
629
  stopGameSessionPlacement(args: StopGameSessionPlacementCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopGameSessionPlacementCommandOutput) => void): void;
2581
630
  /**
2582
- * @public
2583
- * <p>Cancels a matchmaking ticket or match backfill ticket that is currently being
2584
- * processed. To stop the matchmaking operation, specify the ticket ID. If successful, work
2585
- * on the ticket is stopped, and the ticket status is changed to
2586
- * <code>CANCELLED</code>.</p>
2587
- * <p>This call is also used to turn off automatic backfill for an individual game session.
2588
- * This is for game sessions that are created with a matchmaking configuration that has
2589
- * automatic backfill enabled. The ticket ID is included in the <code>MatchmakerData</code>
2590
- * of an updated game session object, which is provided to the game server.</p>
2591
- * <note>
2592
- * <p>If the operation is successful, the service sends back an empty JSON struct with
2593
- * the HTTP 200 response (not an empty HTTP body).</p>
2594
- * </note>
2595
- * <p>
2596
- * <b>Learn more</b>
2597
- * </p>
2598
- * <p>
2599
- * <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html">
2600
- * Add FlexMatch to a game client</a>
2601
- * </p>
631
+ * @see {@link StopMatchmakingCommand}
2602
632
  */
2603
633
  stopMatchmaking(args: StopMatchmakingCommandInput, options?: __HttpHandlerOptions): Promise<StopMatchmakingCommandOutput>;
2604
634
  stopMatchmaking(args: StopMatchmakingCommandInput, cb: (err: any, data?: StopMatchmakingCommandOutput) => void): void;
2605
635
  stopMatchmaking(args: StopMatchmakingCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopMatchmakingCommandOutput) => void): void;
2606
636
  /**
2607
- * @public
2608
- * <p>
2609
- * <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b>
2610
- * </p>
2611
- * <p>Temporarily stops activity on
2612
- * a game server group without terminating instances or the game server group. You can
2613
- * restart activity by calling <a href="gamelift/latest/apireference/API_ResumeGameServerGroup.html">ResumeGameServerGroup</a>. You can suspend the following activity:</p>
2614
- * <ul>
2615
- * <li>
2616
- * <p>
2617
- * <b>Instance type replacement</b> - This activity
2618
- * evaluates the current game hosting viability of all Spot instance types that are
2619
- * defined for the game server group. It updates the Auto Scaling group to remove
2620
- * nonviable Spot Instance types, which have a higher chance of game server
2621
- * interruptions. It then balances capacity across the remaining viable Spot
2622
- * Instance types. When this activity is suspended, the Auto Scaling group
2623
- * continues with its current balance, regardless of viability. Instance
2624
- * protection, utilization metrics, and capacity scaling activities continue to be
2625
- * active. </p>
2626
- * </li>
2627
- * </ul>
2628
- * <p>To suspend activity, specify a game server group ARN and the type of activity to be
2629
- * suspended. If successful, a <code>GameServerGroup</code> object is returned showing that
2630
- * the activity is listed in <code>SuspendedActions</code>.</p>
2631
- * <p>
2632
- * <b>Learn more</b>
2633
- * </p>
2634
- * <p>
2635
- * <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ
2636
- * Guide</a>
2637
- * </p>
637
+ * @see {@link SuspendGameServerGroupCommand}
2638
638
  */
2639
639
  suspendGameServerGroup(args: SuspendGameServerGroupCommandInput, options?: __HttpHandlerOptions): Promise<SuspendGameServerGroupCommandOutput>;
2640
640
  suspendGameServerGroup(args: SuspendGameServerGroupCommandInput, cb: (err: any, data?: SuspendGameServerGroupCommandOutput) => void): void;
2641
641
  suspendGameServerGroup(args: SuspendGameServerGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SuspendGameServerGroupCommandOutput) => void): void;
2642
642
  /**
2643
- * @public
2644
- * <p> Assigns a tag to a GameLift resource. Amazon Web Services resource tags provide an additional
2645
- * management tool set. You can use tags to organize resources, create IAM permissions
2646
- * policies to manage access to groups of resources, customize Amazon Web Services cost breakdowns, etc.
2647
- * This operation handles the permissions necessary to manage tags for the following
2648
- * GameLift resource types:</p>
2649
- * <ul>
2650
- * <li>
2651
- * <p>Build</p>
2652
- * </li>
2653
- * <li>
2654
- * <p>Script</p>
2655
- * </li>
2656
- * <li>
2657
- * <p>Fleet</p>
2658
- * </li>
2659
- * <li>
2660
- * <p>Alias</p>
2661
- * </li>
2662
- * <li>
2663
- * <p>GameSessionQueue</p>
2664
- * </li>
2665
- * <li>
2666
- * <p>MatchmakingConfiguration</p>
2667
- * </li>
2668
- * <li>
2669
- * <p>MatchmakingRuleSet</p>
2670
- * </li>
2671
- * </ul>
2672
- * <p>To add a tag to a resource, specify the unique ARN value for the resource and provide
2673
- * a tag list containing one or more tags. The operation succeeds even if the list includes
2674
- * tags that are already assigned to the specified resource. </p>
2675
- * <p>
2676
- * <b>Learn more</b>
2677
- * </p>
2678
- * <p>
2679
- * <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services
2680
- * Resources</a> in the <i>Amazon Web Services General Reference</i>
2681
- * </p>
2682
- * <p>
2683
- * <a href="http://aws.amazon.com/answers/account-management/aws-tagging-strategies/">
2684
- * Amazon Web Services Tagging Strategies</a>
2685
- * </p>
2686
- * <p>
2687
- * <b>Related actions</b>
2688
- * </p>
2689
- * <p>
2690
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
2691
- * </p>
643
+ * @see {@link TagResourceCommand}
2692
644
  */
2693
645
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
2694
646
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
2695
647
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
2696
648
  /**
2697
- * @public
2698
- * <p>Removes a tag that is assigned to a GameLift resource. Resource tags are used to
2699
- * organize Amazon Web Services resources for a range of purposes. This operation handles the permissions
2700
- * necessary to manage tags for the following GameLift resource types:</p>
2701
- * <ul>
2702
- * <li>
2703
- * <p>Build</p>
2704
- * </li>
2705
- * <li>
2706
- * <p>Script</p>
2707
- * </li>
2708
- * <li>
2709
- * <p>Fleet</p>
2710
- * </li>
2711
- * <li>
2712
- * <p>Alias</p>
2713
- * </li>
2714
- * <li>
2715
- * <p>GameSessionQueue</p>
2716
- * </li>
2717
- * <li>
2718
- * <p>MatchmakingConfiguration</p>
2719
- * </li>
2720
- * <li>
2721
- * <p>MatchmakingRuleSet</p>
2722
- * </li>
2723
- * </ul>
2724
- * <p>To remove a tag from a resource, specify the unique ARN value for the resource and
2725
- * provide a string list containing one or more tags to be removed. This operation succeeds
2726
- * even if the list includes tags that are not currently assigned to the specified
2727
- * resource.</p>
2728
- * <p>
2729
- * <b>Learn more</b>
2730
- * </p>
2731
- * <p>
2732
- * <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services
2733
- * Resources</a> in the <i>Amazon Web Services General Reference</i>
2734
- * </p>
2735
- * <p>
2736
- * <a href="http://aws.amazon.com/answers/account-management/aws-tagging-strategies/">
2737
- * Amazon Web Services Tagging Strategies</a>
2738
- * </p>
2739
- * <p>
2740
- * <b>Related actions</b>
2741
- * </p>
2742
- * <p>
2743
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
2744
- * </p>
649
+ * @see {@link UntagResourceCommand}
2745
650
  */
2746
651
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
2747
652
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
2748
653
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
2749
654
  /**
2750
- * @public
2751
- * <p>Updates properties for an alias. To update properties, specify the alias ID to be
2752
- * updated and provide the information to be changed. To reassign an alias to another
2753
- * fleet, provide an updated routing strategy. If successful, the updated alias record is
2754
- * returned.</p>
2755
- * <p>
2756
- * <b>Related actions</b>
2757
- * </p>
2758
- * <p>
2759
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
2760
- * </p>
655
+ * @see {@link UpdateAliasCommand}
2761
656
  */
2762
657
  updateAlias(args: UpdateAliasCommandInput, options?: __HttpHandlerOptions): Promise<UpdateAliasCommandOutput>;
2763
658
  updateAlias(args: UpdateAliasCommandInput, cb: (err: any, data?: UpdateAliasCommandOutput) => void): void;
2764
659
  updateAlias(args: UpdateAliasCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateAliasCommandOutput) => void): void;
2765
660
  /**
2766
- * @public
2767
- * <p>Updates metadata in a build resource, including the build name and version. To update
2768
- * the metadata, specify the build ID to update and provide the new values. If successful,
2769
- * a build object containing the updated metadata is returned.</p>
2770
- * <p>
2771
- * <b>Learn more</b>
2772
- * </p>
2773
- * <p>
2774
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html"> Upload a Custom
2775
- * Server Build</a>
2776
- * </p>
2777
- * <p>
2778
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
2779
- * </p>
661
+ * @see {@link UpdateBuildCommand}
2780
662
  */
2781
663
  updateBuild(args: UpdateBuildCommandInput, options?: __HttpHandlerOptions): Promise<UpdateBuildCommandOutput>;
2782
664
  updateBuild(args: UpdateBuildCommandInput, cb: (err: any, data?: UpdateBuildCommandOutput) => void): void;
2783
665
  updateBuild(args: UpdateBuildCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateBuildCommandOutput) => void): void;
2784
666
  /**
2785
- * @public
2786
- * <p>Updates a fleet's mutable attributes, including game session protection and resource
2787
- * creation limits.</p>
2788
- * <p>To update fleet attributes, specify the fleet ID and the property values that you want
2789
- * to change. </p>
2790
- * <p>If successful, an updated <code>FleetAttributes</code> object is returned.</p>
2791
- * <p>
2792
- * <b>Learn more</b>
2793
- * </p>
2794
- * <p>
2795
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
2796
- * fleets</a>
2797
- * </p>
667
+ * @see {@link UpdateFleetAttributesCommand}
2798
668
  */
2799
669
  updateFleetAttributes(args: UpdateFleetAttributesCommandInput, options?: __HttpHandlerOptions): Promise<UpdateFleetAttributesCommandOutput>;
2800
670
  updateFleetAttributes(args: UpdateFleetAttributesCommandInput, cb: (err: any, data?: UpdateFleetAttributesCommandOutput) => void): void;
2801
671
  updateFleetAttributes(args: UpdateFleetAttributesCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFleetAttributesCommandOutput) => void): void;
2802
672
  /**
2803
- * @public
2804
- * <p>Updates capacity settings for a fleet. For fleets with multiple locations, use this
2805
- * operation to manage capacity settings in each location individually. Fleet capacity
2806
- * determines the number of game sessions and players that can be hosted based on the fleet
2807
- * configuration. Use this operation to set the following fleet capacity properties: </p>
2808
- * <ul>
2809
- * <li>
2810
- * <p>Minimum/maximum size: Set hard limits on fleet capacity. GameLift cannot set
2811
- * the fleet's capacity to a value outside of this range, whether the capacity is
2812
- * changed manually or through automatic scaling. </p>
2813
- * </li>
2814
- * <li>
2815
- * <p>Desired capacity: Manually set the number of Amazon EC2 instances to be maintained
2816
- * in a fleet location. Before changing a fleet's desired capacity, you may want to
2817
- * call <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeEC2InstanceLimits.html">DescribeEC2InstanceLimits</a> to get the maximum capacity of the
2818
- * fleet's Amazon EC2 instance type. Alternatively, consider using automatic scaling to
2819
- * adjust capacity based on player demand.</p>
2820
- * </li>
2821
- * </ul>
2822
- * <p>This operation can be used in the following ways: </p>
2823
- * <ul>
2824
- * <li>
2825
- * <p>To update capacity for a fleet's home Region, or if the fleet has no remote
2826
- * locations, omit the <code>Location</code> parameter. The fleet must be in
2827
- * <code>ACTIVE</code> status. </p>
2828
- * </li>
2829
- * <li>
2830
- * <p>To update capacity for a fleet's remote location, include the
2831
- * <code>Location</code> parameter set to the location to be updated. The
2832
- * location must be in <code>ACTIVE</code> status.</p>
2833
- * </li>
2834
- * </ul>
2835
- * <p>If successful, capacity settings are updated immediately. In response a change in
2836
- * desired capacity, GameLift initiates steps to start new instances or terminate existing
2837
- * instances in the requested fleet location. This continues until the location's active
2838
- * instance count matches the new desired instance count. You can track a fleet's current
2839
- * capacity by calling <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html">DescribeFleetCapacity</a> or <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html">DescribeFleetLocationCapacity</a>. If the requested desired instance count is
2840
- * higher than the instance type's limit, the <code>LimitExceeded</code> exception
2841
- * occurs.</p>
2842
- * <p>
2843
- * <b>Learn more</b>
2844
- * </p>
2845
- * <p>
2846
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-manage-capacity.html">Scaling fleet
2847
- * capacity</a>
2848
- * </p>
673
+ * @see {@link UpdateFleetCapacityCommand}
2849
674
  */
2850
675
  updateFleetCapacity(args: UpdateFleetCapacityCommandInput, options?: __HttpHandlerOptions): Promise<UpdateFleetCapacityCommandOutput>;
2851
676
  updateFleetCapacity(args: UpdateFleetCapacityCommandInput, cb: (err: any, data?: UpdateFleetCapacityCommandOutput) => void): void;
2852
677
  updateFleetCapacity(args: UpdateFleetCapacityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFleetCapacityCommandOutput) => void): void;
2853
678
  /**
2854
- * @public
2855
- * <p>Updates permissions that allow inbound traffic to connect to game sessions that are
2856
- * being hosted on instances in the fleet. </p>
2857
- * <p>To update settings, specify the fleet ID to be updated and specify the changes to be
2858
- * made. List the permissions you want to add in
2859
- * <code>InboundPermissionAuthorizations</code>, and permissions you want to remove in
2860
- * <code>InboundPermissionRevocations</code>. Permissions to be removed must match
2861
- * existing fleet permissions. </p>
2862
- * <p>If successful, the fleet ID for the updated fleet is returned. For fleets with remote
2863
- * locations, port setting updates can take time to propagate across all locations. You can
2864
- * check the status of updates in each location by calling
2865
- * <code>DescribeFleetPortSettings</code> with a location name.</p>
2866
- * <p>
2867
- * <b>Learn more</b>
2868
- * </p>
2869
- * <p>
2870
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
2871
- * fleets</a>
2872
- * </p>
679
+ * @see {@link UpdateFleetPortSettingsCommand}
2873
680
  */
2874
681
  updateFleetPortSettings(args: UpdateFleetPortSettingsCommandInput, options?: __HttpHandlerOptions): Promise<UpdateFleetPortSettingsCommandOutput>;
2875
682
  updateFleetPortSettings(args: UpdateFleetPortSettingsCommandInput, cb: (err: any, data?: UpdateFleetPortSettingsCommandOutput) => void): void;
2876
683
  updateFleetPortSettings(args: UpdateFleetPortSettingsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateFleetPortSettingsCommandOutput) => void): void;
2877
684
  /**
2878
- * @public
2879
- * <p>
2880
- * <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b>
2881
- * </p>
2882
- * <p>Updates information about a
2883
- * registered game server to help GameLift FleetIQ to track game server availability. This operation
2884
- * is called by a game server process that is running on an instance in a game server
2885
- * group. </p>
2886
- * <p>Use this operation to update the following types of game server information. You can
2887
- * make all three types of updates in the same request:</p>
2888
- * <ul>
2889
- * <li>
2890
- * <p>To update the game server's utilization status, identify the game server and
2891
- * game server group and specify the current utilization status. Use this status to
2892
- * identify when game servers are currently hosting games and when they are
2893
- * available to be claimed.</p>
2894
- * </li>
2895
- * <li>
2896
- * <p>To report health status, identify the game server and game server group and
2897
- * set health check to <code>HEALTHY</code>. If a game server does not report
2898
- * health status for a certain length of time, the game server is no longer
2899
- * considered healthy. As a result, it will be eventually deregistered from the
2900
- * game server group to avoid affecting utilization metrics. The best practice is
2901
- * to report health every 60 seconds.</p>
2902
- * </li>
2903
- * <li>
2904
- * <p>To change game server metadata, provide updated game server data.</p>
2905
- * </li>
2906
- * </ul>
2907
- * <p>Once a game server is successfully updated, the relevant statuses and timestamps are
2908
- * updated.</p>
2909
- * <p>
2910
- * <b>Learn more</b>
2911
- * </p>
2912
- * <p>
2913
- * <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ
2914
- * Guide</a>
2915
- * </p>
685
+ * @see {@link UpdateGameServerCommand}
2916
686
  */
2917
687
  updateGameServer(args: UpdateGameServerCommandInput, options?: __HttpHandlerOptions): Promise<UpdateGameServerCommandOutput>;
2918
688
  updateGameServer(args: UpdateGameServerCommandInput, cb: (err: any, data?: UpdateGameServerCommandOutput) => void): void;
2919
689
  updateGameServer(args: UpdateGameServerCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGameServerCommandOutput) => void): void;
2920
690
  /**
2921
- * @public
2922
- * <p>
2923
- * <b>This operation is used with the GameLift FleetIQ solution and game server groups.</b>
2924
- * </p>
2925
- * <p>Updates GameLift FleetIQ-specific
2926
- * properties for a game server group. Many Auto Scaling group properties are updated on
2927
- * the Auto Scaling group directly, including the launch template, Auto Scaling policies,
2928
- * and maximum/minimum/desired instance counts.</p>
2929
- * <p>To update the game server group, specify the game server group ID and provide the
2930
- * updated values. Before applying the updates, the new values are validated to ensure that
2931
- * GameLift FleetIQ can continue to perform instance balancing activity. If successful, a
2932
- * <code>GameServerGroup</code> object is returned.</p>
2933
- * <p>
2934
- * <b>Learn more</b>
2935
- * </p>
2936
- * <p>
2937
- * <a href="https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html">GameLift FleetIQ
2938
- * Guide</a>
2939
- * </p>
691
+ * @see {@link UpdateGameServerGroupCommand}
2940
692
  */
2941
693
  updateGameServerGroup(args: UpdateGameServerGroupCommandInput, options?: __HttpHandlerOptions): Promise<UpdateGameServerGroupCommandOutput>;
2942
694
  updateGameServerGroup(args: UpdateGameServerGroupCommandInput, cb: (err: any, data?: UpdateGameServerGroupCommandOutput) => void): void;
2943
695
  updateGameServerGroup(args: UpdateGameServerGroupCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGameServerGroupCommandOutput) => void): void;
2944
696
  /**
2945
- * @public
2946
- * <p>Updates the mutable properties of a game session. </p>
2947
- * <p>To update a game session, specify the game session ID and the values you want to
2948
- * change. </p>
2949
- * <p>If successful, the updated <code>GameSession</code> object is returned. </p>
2950
- * <p>
2951
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
2952
- * </p>
697
+ * @see {@link UpdateGameSessionCommand}
2953
698
  */
2954
699
  updateGameSession(args: UpdateGameSessionCommandInput, options?: __HttpHandlerOptions): Promise<UpdateGameSessionCommandOutput>;
2955
700
  updateGameSession(args: UpdateGameSessionCommandInput, cb: (err: any, data?: UpdateGameSessionCommandOutput) => void): void;
2956
701
  updateGameSession(args: UpdateGameSessionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGameSessionCommandOutput) => void): void;
2957
702
  /**
2958
- * @public
2959
- * <p>Updates the configuration of a game session queue, which determines how the queue
2960
- * processes new game session requests. To update settings, specify the queue name to be
2961
- * updated and provide the new settings. When updating destinations, provide a complete
2962
- * list of destinations. </p>
2963
- * <p>
2964
- * <b>Learn more</b>
2965
- * </p>
2966
- * <p>
2967
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html">
2968
- * Using Multi-Region Queues</a>
2969
- * </p>
703
+ * @see {@link UpdateGameSessionQueueCommand}
2970
704
  */
2971
705
  updateGameSessionQueue(args: UpdateGameSessionQueueCommandInput, options?: __HttpHandlerOptions): Promise<UpdateGameSessionQueueCommandOutput>;
2972
706
  updateGameSessionQueue(args: UpdateGameSessionQueueCommandInput, cb: (err: any, data?: UpdateGameSessionQueueCommandOutput) => void): void;
2973
707
  updateGameSessionQueue(args: UpdateGameSessionQueueCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateGameSessionQueueCommandOutput) => void): void;
2974
708
  /**
2975
- * @public
2976
- * <p>Updates settings for a FlexMatch matchmaking configuration. These changes affect all
2977
- * matches and game sessions that are created after the update. To update settings, specify
2978
- * the configuration name to be updated and provide the new settings. </p>
2979
- * <p>
2980
- * <b>Learn more</b>
2981
- * </p>
2982
- * <p>
2983
- * <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-configuration.html"> Design a FlexMatch
2984
- * matchmaker</a>
2985
- * </p>
709
+ * @see {@link UpdateMatchmakingConfigurationCommand}
2986
710
  */
2987
711
  updateMatchmakingConfiguration(args: UpdateMatchmakingConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<UpdateMatchmakingConfigurationCommandOutput>;
2988
712
  updateMatchmakingConfiguration(args: UpdateMatchmakingConfigurationCommandInput, cb: (err: any, data?: UpdateMatchmakingConfigurationCommandOutput) => void): void;
2989
713
  updateMatchmakingConfiguration(args: UpdateMatchmakingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateMatchmakingConfigurationCommandOutput) => void): void;
2990
714
  /**
2991
- * @public
2992
- * <p>Updates the current runtime configuration for the specified fleet, which tells GameLift
2993
- * how to launch server processes on all instances in the fleet. You can update a fleet's
2994
- * runtime configuration at any time after the fleet is created; it does not need to be in
2995
- * <code>ACTIVE</code> status.</p>
2996
- * <p>To update runtime configuration, specify the fleet ID and provide a
2997
- * <code>RuntimeConfiguration</code> with an updated set of server process
2998
- * configurations.</p>
2999
- * <p>If successful, the fleet's runtime configuration settings are updated. Each instance
3000
- * in the fleet regularly checks for and retrieves updated runtime configurations.
3001
- * Instances immediately begin complying with the new configuration by launching new server
3002
- * processes or not replacing existing processes when they shut down. Updating a fleet's
3003
- * runtime configuration never affects existing server processes.</p>
3004
- * <p>
3005
- * <b>Learn more</b>
3006
- * </p>
3007
- * <p>
3008
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html">Setting up GameLift
3009
- * fleets</a>
3010
- * </p>
715
+ * @see {@link UpdateRuntimeConfigurationCommand}
3011
716
  */
3012
717
  updateRuntimeConfiguration(args: UpdateRuntimeConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<UpdateRuntimeConfigurationCommandOutput>;
3013
718
  updateRuntimeConfiguration(args: UpdateRuntimeConfigurationCommandInput, cb: (err: any, data?: UpdateRuntimeConfigurationCommandOutput) => void): void;
3014
719
  updateRuntimeConfiguration(args: UpdateRuntimeConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateRuntimeConfigurationCommandOutput) => void): void;
3015
720
  /**
3016
- * @public
3017
- * <p>Updates Realtime script metadata and content.</p>
3018
- * <p>To update script metadata, specify the script ID and provide updated name and/or
3019
- * version values. </p>
3020
- * <p>To update script content, provide an updated zip file by pointing to either a local
3021
- * file or an Amazon S3 bucket location. You can use either method regardless of how the
3022
- * original script was uploaded. Use the <i>Version</i> parameter to track
3023
- * updates to the script.</p>
3024
- * <p>If the call is successful, the updated metadata is stored in the script record and a
3025
- * revised script is uploaded to the Amazon GameLift service. Once the script is updated and
3026
- * acquired by a fleet instance, the new version is used for all new game sessions. </p>
3027
- * <p>
3028
- * <b>Learn more</b>
3029
- * </p>
3030
- * <p>
3031
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon GameLift Realtime Servers</a>
3032
- * </p>
3033
- * <p>
3034
- * <b>Related actions</b>
3035
- * </p>
3036
- * <p>
3037
- * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
3038
- * </p>
721
+ * @see {@link UpdateScriptCommand}
3039
722
  */
3040
723
  updateScript(args: UpdateScriptCommandInput, options?: __HttpHandlerOptions): Promise<UpdateScriptCommandOutput>;
3041
724
  updateScript(args: UpdateScriptCommandInput, cb: (err: any, data?: UpdateScriptCommandOutput) => void): void;
3042
725
  updateScript(args: UpdateScriptCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateScriptCommandOutput) => void): void;
3043
726
  /**
3044
- * @public
3045
- * <p>Validates the syntax of a matchmaking rule or rule set. This operation checks that the
3046
- * rule set is using syntactically correct JSON and that it conforms to allowed property
3047
- * expressions. To validate syntax, provide a rule set JSON string.</p>
3048
- * <p>
3049
- * <b>Learn more</b>
3050
- * </p>
3051
- * <ul>
3052
- * <li>
3053
- * <p>
3054
- * <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html">Build a rule
3055
- * set</a>
3056
- * </p>
3057
- * </li>
3058
- * </ul>
727
+ * @see {@link ValidateMatchmakingRuleSetCommand}
3059
728
  */
3060
729
  validateMatchmakingRuleSet(args: ValidateMatchmakingRuleSetCommandInput, options?: __HttpHandlerOptions): Promise<ValidateMatchmakingRuleSetCommandOutput>;
3061
730
  validateMatchmakingRuleSet(args: ValidateMatchmakingRuleSetCommandInput, cb: (err: any, data?: ValidateMatchmakingRuleSetCommandOutput) => void): void;
3062
731
  validateMatchmakingRuleSet(args: ValidateMatchmakingRuleSetCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ValidateMatchmakingRuleSetCommandOutput) => void): void;
3063
732
  }
733
+ /**
734
+ * @public
735
+ * <p>Amazon GameLift provides solutions for hosting session-based multiplayer game servers in the
736
+ * cloud, including tools for deploying, operating, and scaling game servers. Built on
737
+ * Amazon Web Services global computing infrastructure, GameLift helps you deliver high-performance,
738
+ * high-reliability, low-cost game servers while dynamically scaling your resource usage to
739
+ * meet player demand. </p>
740
+ * <p>
741
+ * <b>About GameLift solutions</b>
742
+ * </p>
743
+ * <p>Get more information on these GameLift solutions in the <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/">GameLift Developer Guide</a>.</p>
744
+ * <ul>
745
+ * <li>
746
+ * <p>GameLift managed hosting -- GameLift offers a fully managed service to set up
747
+ * and maintain computing machines for hosting, manage game session and player
748
+ * session life cycle, and handle security, storage, and performance tracking. You
749
+ * can use automatic scaling tools to balance player demand and hosting costs,
750
+ * configure your game session management to minimize player latency, and add
751
+ * FlexMatch for matchmaking.</p>
752
+ * </li>
753
+ * <li>
754
+ * <p>Managed hosting with Realtime Servers -- With GameLift Realtime Servers, you can quickly configure
755
+ * and set up ready-to-go game servers for your game. Realtime Servers provides a game server
756
+ * framework with core GameLift infrastructure already built in. Then use the full
757
+ * range of GameLift managed hosting features, including FlexMatch, for your
758
+ * game.</p>
759
+ * </li>
760
+ * <li>
761
+ * <p>GameLift FleetIQ -- Use GameLift FleetIQ as a standalone service while hosting your games using EC2
762
+ * instances and Auto Scaling groups. GameLift FleetIQ provides optimizations for game
763
+ * hosting, including boosting the viability of low-cost Spot Instances gaming. For
764
+ * a complete solution, pair the GameLift FleetIQ and FlexMatch standalone services.</p>
765
+ * </li>
766
+ * <li>
767
+ * <p>GameLift FlexMatch -- Add matchmaking to your game hosting solution. FlexMatch is a
768
+ * customizable matchmaking service for multiplayer games. Use FlexMatch as
769
+ * integrated with GameLift managed hosting or incorporate FlexMatch as a standalone
770
+ * service into your own hosting solution.</p>
771
+ * </li>
772
+ * </ul>
773
+ * <p>
774
+ * <b>About this API Reference</b>
775
+ * </p>
776
+ * <p>This reference guide describes the low-level service API for Amazon GameLift. With each topic
777
+ * in this guide, you can find links to language-specific SDK guides and the Amazon Web Services CLI
778
+ * reference. Useful links:</p>
779
+ * <ul>
780
+ * <li>
781
+ * <p>
782
+ * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html">GameLift API
783
+ * operations listed by tasks</a>
784
+ * </p>
785
+ * </li>
786
+ * <li>
787
+ * <p>
788
+ * <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-components.html"> GameLift tools
789
+ * and resources</a>
790
+ * </p>
791
+ * </li>
792
+ * </ul>
793
+ */
794
+ export declare class GameLift extends GameLiftClient implements GameLift {
795
+ }