@aws-sdk/client-gamelift 3.316.0 → 3.319.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.
- package/README.md +13 -13
- package/dist-cjs/endpoint/ruleset.js +3 -3
- package/dist-cjs/models/models_0.js +1 -0
- package/dist-cjs/protocols/Aws_json1_1.js +3 -0
- package/dist-es/endpoint/ruleset.js +3 -3
- package/dist-es/models/models_0.js +1 -0
- package/dist-es/protocols/Aws_json1_1.js +3 -0
- package/dist-types/GameLift.d.ts +20 -20
- package/dist-types/GameLiftClient.d.ts +20 -20
- package/dist-types/commands/AcceptMatchCommand.d.ts +6 -6
- package/dist-types/commands/ClaimGameServerCommand.d.ts +16 -16
- package/dist-types/commands/CreateAliasCommand.d.ts +5 -5
- package/dist-types/commands/CreateBuildCommand.d.ts +16 -16
- package/dist-types/commands/CreateFleetCommand.d.ts +13 -13
- package/dist-types/commands/CreateFleetLocationsCommand.d.ts +11 -7
- package/dist-types/commands/CreateGameServerGroupCommand.d.ts +17 -17
- package/dist-types/commands/CreateGameSessionCommand.d.ts +11 -11
- package/dist-types/commands/CreateGameSessionQueueCommand.d.ts +10 -10
- package/dist-types/commands/CreateLocationCommand.d.ts +1 -1
- package/dist-types/commands/CreateMatchmakingConfigurationCommand.d.ts +9 -9
- package/dist-types/commands/CreateMatchmakingRuleSetCommand.d.ts +7 -7
- package/dist-types/commands/CreatePlayerSessionCommand.d.ts +7 -7
- package/dist-types/commands/CreatePlayerSessionsCommand.d.ts +8 -8
- package/dist-types/commands/CreateScriptCommand.d.ts +11 -12
- package/dist-types/commands/CreateVpcPeeringAuthorizationCommand.d.ts +5 -5
- package/dist-types/commands/CreateVpcPeeringConnectionCommand.d.ts +3 -3
- package/dist-types/commands/DeleteAliasCommand.d.ts +2 -2
- package/dist-types/commands/DeleteBuildCommand.d.ts +4 -4
- package/dist-types/commands/DeleteFleetCommand.d.ts +4 -4
- package/dist-types/commands/DeleteFleetLocationsCommand.d.ts +4 -4
- package/dist-types/commands/DeleteGameServerGroupCommand.d.ts +13 -13
- package/dist-types/commands/DeleteLocationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteMatchmakingRuleSetCommand.d.ts +3 -3
- package/dist-types/commands/DeleteScalingPolicyCommand.d.ts +2 -2
- package/dist-types/commands/DeleteScriptCommand.d.ts +6 -6
- package/dist-types/commands/DeleteVpcPeeringAuthorizationCommand.d.ts +1 -1
- package/dist-types/commands/DeleteVpcPeeringConnectionCommand.d.ts +2 -2
- package/dist-types/commands/DeregisterGameServerCommand.d.ts +6 -6
- package/dist-types/commands/DescribeAliasCommand.d.ts +3 -3
- package/dist-types/commands/DescribeBuildCommand.d.ts +3 -3
- package/dist-types/commands/DescribeComputeCommand.d.ts +1 -1
- package/dist-types/commands/DescribeEC2InstanceLimitsCommand.d.ts +15 -15
- package/dist-types/commands/DescribeFleetAttributesCommand.d.ts +9 -9
- package/dist-types/commands/DescribeFleetCapacityCommand.d.ts +10 -10
- package/dist-types/commands/DescribeFleetEventsCommand.d.ts +3 -3
- package/dist-types/commands/DescribeFleetLocationAttributesCommand.d.ts +7 -7
- package/dist-types/commands/DescribeFleetLocationCapacityCommand.d.ts +4 -4
- package/dist-types/commands/DescribeFleetLocationUtilizationCommand.d.ts +4 -4
- package/dist-types/commands/DescribeFleetPortSettingsCommand.d.ts +7 -7
- package/dist-types/commands/DescribeFleetUtilizationCommand.d.ts +10 -10
- package/dist-types/commands/DescribeGameServerCommand.d.ts +6 -6
- package/dist-types/commands/DescribeGameServerGroupCommand.d.ts +7 -7
- package/dist-types/commands/DescribeGameServerInstancesCommand.d.ts +8 -8
- package/dist-types/commands/DescribeGameSessionDetailsCommand.d.ts +8 -8
- package/dist-types/commands/DescribeGameSessionPlacementCommand.d.ts +2 -2
- package/dist-types/commands/DescribeGameSessionQueuesCommand.d.ts +3 -3
- package/dist-types/commands/DescribeGameSessionsCommand.d.ts +10 -10
- package/dist-types/commands/DescribeInstancesCommand.d.ts +12 -12
- package/dist-types/commands/DescribeMatchmakingCommand.d.ts +6 -6
- package/dist-types/commands/DescribeMatchmakingConfigurationsCommand.d.ts +4 -4
- package/dist-types/commands/DescribeMatchmakingRuleSetsCommand.d.ts +3 -3
- package/dist-types/commands/DescribePlayerSessionsCommand.d.ts +9 -9
- package/dist-types/commands/DescribeRuntimeConfigurationCommand.d.ts +5 -5
- package/dist-types/commands/DescribeScalingPoliciesCommand.d.ts +2 -2
- package/dist-types/commands/DescribeScriptCommand.d.ts +6 -6
- package/dist-types/commands/DescribeVpcPeeringAuthorizationsCommand.d.ts +1 -1
- package/dist-types/commands/DescribeVpcPeeringConnectionsCommand.d.ts +2 -2
- package/dist-types/commands/GetComputeAccessCommand.d.ts +7 -7
- package/dist-types/commands/GetComputeAuthTokenCommand.d.ts +4 -4
- package/dist-types/commands/GetGameSessionLogUrlCommand.d.ts +4 -4
- package/dist-types/commands/GetInstanceAccessCommand.d.ts +9 -9
- package/dist-types/commands/ListAliasesCommand.d.ts +4 -4
- package/dist-types/commands/ListBuildsCommand.d.ts +5 -5
- package/dist-types/commands/ListFleetsCommand.d.ts +10 -10
- package/dist-types/commands/ListGameServersCommand.d.ts +5 -5
- package/dist-types/commands/ListScriptsCommand.d.ts +5 -5
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +8 -31
- package/dist-types/commands/PutScalingPolicyCommand.d.ts +14 -14
- package/dist-types/commands/RegisterComputeCommand.d.ts +5 -5
- package/dist-types/commands/RegisterGameServerCommand.d.ts +10 -10
- package/dist-types/commands/RequestUploadCredentialsCommand.d.ts +5 -5
- package/dist-types/commands/ResolveAliasCommand.d.ts +2 -2
- package/dist-types/commands/ResumeGameServerGroupCommand.d.ts +6 -6
- package/dist-types/commands/SearchGameSessionsCommand.d.ts +20 -20
- package/dist-types/commands/StartFleetActionsCommand.d.ts +6 -6
- package/dist-types/commands/StartGameSessionPlacementCommand.d.ts +11 -11
- package/dist-types/commands/StartMatchBackfillCommand.d.ts +9 -9
- package/dist-types/commands/StartMatchmakingCommand.d.ts +8 -8
- package/dist-types/commands/StopFleetActionsCommand.d.ts +7 -7
- package/dist-types/commands/StopMatchmakingCommand.d.ts +5 -5
- package/dist-types/commands/SuspendGameServerGroupCommand.d.ts +8 -8
- package/dist-types/commands/TagResourceCommand.d.ts +10 -34
- package/dist-types/commands/UntagResourceCommand.d.ts +10 -34
- package/dist-types/commands/UpdateAliasCommand.d.ts +2 -2
- package/dist-types/commands/UpdateBuildCommand.d.ts +3 -3
- package/dist-types/commands/UpdateFleetAttributesCommand.d.ts +5 -5
- package/dist-types/commands/UpdateFleetCapacityCommand.d.ts +10 -10
- package/dist-types/commands/UpdateFleetPortSettingsCommand.d.ts +5 -5
- package/dist-types/commands/UpdateGameServerCommand.d.ts +12 -12
- package/dist-types/commands/UpdateGameServerGroupCommand.d.ts +8 -8
- package/dist-types/commands/UpdateGameSessionCommand.d.ts +5 -5
- package/dist-types/commands/UpdateGameSessionQueueCommand.d.ts +3 -3
- package/dist-types/commands/UpdateMatchmakingConfigurationCommand.d.ts +2 -2
- package/dist-types/commands/UpdateRuntimeConfigurationCommand.d.ts +5 -5
- package/dist-types/commands/UpdateScriptCommand.d.ts +8 -8
- package/dist-types/commands/ValidateMatchmakingRuleSetCommand.d.ts +3 -3
- package/dist-types/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +591 -591
- package/dist-types/models/models_1.d.ts +22 -22
- package/dist-types/ts3.4/endpoint/EndpointParameters.d.ts +1 -1
- package/dist-types/ts3.4/models/models_0.d.ts +1 -0
- package/package.json +5 -5
|
@@ -108,23 +108,23 @@ export type RoutingStrategyType = (typeof RoutingStrategyType)[keyof typeof Rout
|
|
|
108
108
|
* <p>
|
|
109
109
|
* <b>Related actions</b>
|
|
110
110
|
* </p>
|
|
111
|
-
*
|
|
112
|
-
*
|
|
111
|
+
* <p>
|
|
112
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
113
113
|
* </p>
|
|
114
114
|
*/
|
|
115
115
|
export interface RoutingStrategy {
|
|
116
116
|
/**
|
|
117
117
|
* <p>The type of routing strategy for the alias.</p>
|
|
118
|
-
*
|
|
119
|
-
*
|
|
118
|
+
* <p>Possible routing types include the following:</p>
|
|
119
|
+
* <ul>
|
|
120
120
|
* <li>
|
|
121
|
-
*
|
|
122
|
-
*
|
|
121
|
+
* <p>
|
|
122
|
+
* <b>SIMPLE</b> - The alias resolves to one specific
|
|
123
123
|
* fleet. Use this type when routing to active fleets.</p>
|
|
124
124
|
* </li>
|
|
125
125
|
* <li>
|
|
126
|
-
*
|
|
127
|
-
*
|
|
126
|
+
* <p>
|
|
127
|
+
* <b>TERMINAL</b> - The alias does not resolve to a
|
|
128
128
|
* fleet but instead can be used to display a message to the user. A terminal alias
|
|
129
129
|
* throws a TerminalRoutingStrategyException with the message embedded.</p>
|
|
130
130
|
* </li>
|
|
@@ -146,8 +146,8 @@ export interface RoutingStrategy {
|
|
|
146
146
|
* <p>
|
|
147
147
|
* <b>Related actions</b>
|
|
148
148
|
* </p>
|
|
149
|
-
*
|
|
150
|
-
*
|
|
149
|
+
* <p>
|
|
150
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
151
151
|
* </p>
|
|
152
152
|
*/
|
|
153
153
|
export interface Alias {
|
|
@@ -160,7 +160,7 @@ export interface Alias {
|
|
|
160
160
|
*/
|
|
161
161
|
Name?: string;
|
|
162
162
|
/**
|
|
163
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a GameLift alias resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::alias/alias-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>. In a GameLift alias ARN, the resource ID matches the alias ID value.</p>
|
|
163
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift alias resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::alias/alias-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>. In a GameLift alias ARN, the resource ID matches the alias ID value.</p>
|
|
164
164
|
*/
|
|
165
165
|
AliasArn?: string;
|
|
166
166
|
/**
|
|
@@ -183,13 +183,13 @@ export interface Alias {
|
|
|
183
183
|
}
|
|
184
184
|
/**
|
|
185
185
|
* @public
|
|
186
|
-
* <p>GameLift Anywhere configuration options for your Anywhere fleets.</p>
|
|
186
|
+
* <p>Amazon GameLift Anywhere configuration options for your Anywhere fleets.</p>
|
|
187
187
|
*/
|
|
188
188
|
export interface AnywhereConfiguration {
|
|
189
189
|
/**
|
|
190
|
-
* <p>The cost to run your fleet per hour. GameLift uses the provided cost of your fleet to
|
|
191
|
-
* usage in queues. For more information about queues, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html">Setting
|
|
192
|
-
*
|
|
190
|
+
* <p>The cost to run your fleet per hour. Amazon GameLift uses the provided cost of your fleet to
|
|
191
|
+
* balance usage in queues. For more information about queues, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html">Setting
|
|
192
|
+
* up queues</a> in the <i>Amazon GameLift Developer Guide</i>.</p>
|
|
193
193
|
*/
|
|
194
194
|
Cost: string | undefined;
|
|
195
195
|
}
|
|
@@ -275,6 +275,7 @@ export declare const OperatingSystem: {
|
|
|
275
275
|
readonly AMAZON_LINUX: "AMAZON_LINUX";
|
|
276
276
|
readonly AMAZON_LINUX_2: "AMAZON_LINUX_2";
|
|
277
277
|
readonly WINDOWS_2012: "WINDOWS_2012";
|
|
278
|
+
readonly WINDOWS_2016: "WINDOWS_2016";
|
|
278
279
|
};
|
|
279
280
|
/**
|
|
280
281
|
* @public
|
|
@@ -297,7 +298,7 @@ export type BuildStatus = (typeof BuildStatus)[keyof typeof BuildStatus];
|
|
|
297
298
|
* @public
|
|
298
299
|
* <p>Properties describing a custom game build.</p>
|
|
299
300
|
* <p>
|
|
300
|
-
*
|
|
301
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
301
302
|
* </p>
|
|
302
303
|
*/
|
|
303
304
|
export interface Build {
|
|
@@ -306,38 +307,38 @@ export interface Build {
|
|
|
306
307
|
*/
|
|
307
308
|
BuildId?: string;
|
|
308
309
|
/**
|
|
309
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) assigned to a GameLift build resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>. In a GameLift build ARN, the resource ID matches the
|
|
310
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) assigned to a Amazon GameLift build resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::build/build-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>. In a GameLift build ARN, the resource ID matches the
|
|
310
311
|
* <i>BuildId</i> value.</p>
|
|
311
312
|
*/
|
|
312
313
|
BuildArn?: string;
|
|
313
314
|
/**
|
|
314
|
-
* <p>A descriptive label associated with a build. Build names
|
|
315
|
+
* <p>A descriptive label associated with a build. Build names don't need to be unique. It can be set using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateBuild.html">CreateBuild</a> or
|
|
315
316
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/UpdateBuild">UpdateBuild</a>.</p>
|
|
316
317
|
*/
|
|
317
318
|
Name?: string;
|
|
318
319
|
/**
|
|
319
|
-
* <p>Version information associated with a build or script. Version strings
|
|
320
|
+
* <p>Version information associated with a build or script. Version strings don't need to be unique.</p>
|
|
320
321
|
*/
|
|
321
322
|
Version?: string;
|
|
322
323
|
/**
|
|
323
324
|
* <p>Current status of the build.</p>
|
|
324
|
-
*
|
|
325
|
-
*
|
|
325
|
+
* <p>Possible build statuses include the following:</p>
|
|
326
|
+
* <ul>
|
|
326
327
|
* <li>
|
|
327
|
-
*
|
|
328
|
-
*
|
|
328
|
+
* <p>
|
|
329
|
+
* <b>INITIALIZED</b> -- A new build has been defined,
|
|
329
330
|
* but no files have been uploaded. You cannot create fleets for builds that are in
|
|
330
331
|
* this status. When a build is successfully created, the build status is set to
|
|
331
332
|
* this value. </p>
|
|
332
333
|
* </li>
|
|
333
334
|
* <li>
|
|
334
|
-
*
|
|
335
|
-
*
|
|
335
|
+
* <p>
|
|
336
|
+
* <b>READY</b> -- The game build has been successfully
|
|
336
337
|
* uploaded. You can now create new fleets for this build.</p>
|
|
337
338
|
* </li>
|
|
338
339
|
* <li>
|
|
339
|
-
*
|
|
340
|
-
*
|
|
340
|
+
* <p>
|
|
341
|
+
* <b>FAILED</b> -- The game build upload failed. You
|
|
341
342
|
* cannot create new fleets for this build. </p>
|
|
342
343
|
* </li>
|
|
343
344
|
* </ul>
|
|
@@ -359,7 +360,7 @@ export interface Build {
|
|
|
359
360
|
*/
|
|
360
361
|
CreationTime?: Date;
|
|
361
362
|
/**
|
|
362
|
-
* <p>The GameLift Server SDK version used to develop your game server.</p>
|
|
363
|
+
* <p>The Amazon GameLift Server SDK version used to develop your game server.</p>
|
|
363
364
|
*/
|
|
364
365
|
ServerSdkVersion?: string;
|
|
365
366
|
}
|
|
@@ -379,21 +380,21 @@ export type CertificateType = (typeof CertificateType)[keyof typeof CertificateT
|
|
|
379
380
|
* @public
|
|
380
381
|
* <p>Determines whether a TLS/SSL certificate is generated for a fleet. This feature must
|
|
381
382
|
* be enabled when creating the fleet. All instances in a fleet share the same certificate.
|
|
382
|
-
* The certificate can be retrieved by calling the <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk.html">GameLift Server
|
|
383
|
+
* The certificate can be retrieved by calling the <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk.html">Amazon GameLift Server
|
|
383
384
|
* SDK</a> operation <code>GetInstanceCertificate</code>. </p>
|
|
384
385
|
*/
|
|
385
386
|
export interface CertificateConfiguration {
|
|
386
387
|
/**
|
|
387
388
|
* <p>Indicates whether a TLS/SSL certificate is generated for a fleet. </p>
|
|
388
|
-
*
|
|
389
|
-
*
|
|
389
|
+
* <p>Valid values include: </p>
|
|
390
|
+
* <ul>
|
|
390
391
|
* <li>
|
|
391
|
-
*
|
|
392
|
+
* <p>
|
|
392
393
|
* <b>GENERATED</b> - Generate a TLS/SSL certificate
|
|
393
394
|
* for this fleet.</p>
|
|
394
395
|
* </li>
|
|
395
396
|
* <li>
|
|
396
|
-
*
|
|
397
|
+
* <p>
|
|
397
398
|
* <b>DISABLED</b> - (default) Do not generate a
|
|
398
399
|
* TLS/SSL certificate for this fleet. </p>
|
|
399
400
|
* </li>
|
|
@@ -407,11 +408,11 @@ export interface CertificateConfiguration {
|
|
|
407
408
|
export interface ClaimGameServerInput {
|
|
408
409
|
/**
|
|
409
410
|
* <p>A unique identifier for the game server group where the game server is running. If you are not specifying a game server to claim, this value identifies
|
|
410
|
-
* where you want GameLift FleetIQ to look for an available game server to claim. </p>
|
|
411
|
+
* where you want Amazon GameLift FleetIQ to look for an available game server to claim. </p>
|
|
411
412
|
*/
|
|
412
413
|
GameServerGroupName: string | undefined;
|
|
413
414
|
/**
|
|
414
|
-
* <p>A custom string that uniquely identifies the game server to claim. If this parameter is left empty, GameLift FleetIQ searches for an available
|
|
415
|
+
* <p>A custom string that uniquely identifies the game server to claim. If this parameter is left empty, Amazon GameLift FleetIQ searches for an available
|
|
415
416
|
* game server in the specified game server group.</p>
|
|
416
417
|
*/
|
|
417
418
|
GameServerId?: string;
|
|
@@ -447,11 +448,11 @@ export type GameServerUtilizationStatus = (typeof GameServerUtilizationStatus)[k
|
|
|
447
448
|
/**
|
|
448
449
|
* @public
|
|
449
450
|
* <p>
|
|
450
|
-
* <b>This data type is used with the GameLift FleetIQ and game server groups.</b>
|
|
451
|
+
* <b>This data type is used with the Amazon GameLift FleetIQ and game server groups.</b>
|
|
451
452
|
* </p>
|
|
452
453
|
* <p>Properties describing a game server that
|
|
453
454
|
* is running on an instance in a game server group. </p>
|
|
454
|
-
*
|
|
455
|
+
* <p>A game server is created by a successful call to <code>RegisterGameServer</code> and
|
|
455
456
|
* deleted by calling <code>DeregisterGameServer</code>. A game server is claimed to host a
|
|
456
457
|
* game session by calling <code>ClaimGameServer</code>. </p>
|
|
457
458
|
*/
|
|
@@ -497,15 +498,15 @@ export interface GameServer {
|
|
|
497
498
|
/**
|
|
498
499
|
* <p>Indicates whether the game server is currently available for new games or is busy.
|
|
499
500
|
* Possible statuses include:</p>
|
|
500
|
-
*
|
|
501
|
+
* <ul>
|
|
501
502
|
* <li>
|
|
502
|
-
*
|
|
503
|
+
* <p>
|
|
503
504
|
* <code>AVAILABLE</code> - The game server is available to be claimed. A game
|
|
504
505
|
* server that has been claimed remains in this status until it reports game
|
|
505
506
|
* hosting activity. </p>
|
|
506
507
|
* </li>
|
|
507
508
|
* <li>
|
|
508
|
-
*
|
|
509
|
+
* <p>
|
|
509
510
|
* <code>UTILIZED</code> - The game server is currently hosting a game session
|
|
510
511
|
* with players. </p>
|
|
511
512
|
* </li>
|
|
@@ -546,7 +547,7 @@ export interface ClaimGameServerOutput {
|
|
|
546
547
|
* <p>The requested operation would cause a conflict with the current state of a service
|
|
547
548
|
* resource associated with the request. Resolve the conflict before retrying this
|
|
548
549
|
* request.</p>
|
|
549
|
-
*
|
|
550
|
+
* <p></p>
|
|
550
551
|
*/
|
|
551
552
|
export declare class ConflictException extends __BaseException {
|
|
552
553
|
readonly name: "ConflictException";
|
|
@@ -738,7 +739,7 @@ export declare const EC2InstanceType: {
|
|
|
738
739
|
export type EC2InstanceType = (typeof EC2InstanceType)[keyof typeof EC2InstanceType];
|
|
739
740
|
/**
|
|
740
741
|
* @public
|
|
741
|
-
* <p>Resources used to host your game servers. A compute resource can be managed GameLift
|
|
742
|
+
* <p>Resources used to host your game servers. A compute resource can be managed Amazon GameLift
|
|
742
743
|
* Amazon EC2 instances or your own resources.</p>
|
|
743
744
|
*/
|
|
744
745
|
export interface Compute {
|
|
@@ -760,17 +761,18 @@ export interface Compute {
|
|
|
760
761
|
*/
|
|
761
762
|
ComputeArn?: string;
|
|
762
763
|
/**
|
|
763
|
-
* <p>The IP address of the compute resource. GameLift requires the DNS name or IP address to
|
|
764
|
+
* <p>The IP address of the compute resource. Amazon GameLift requires the DNS name or IP address to
|
|
764
765
|
* manage your compute resource.</p>
|
|
765
766
|
*/
|
|
766
767
|
IpAddress?: string;
|
|
767
768
|
/**
|
|
768
|
-
* <p>The DNS name of the compute resource. GameLift requires the DNS name or IP address to
|
|
769
|
+
* <p>The DNS name of the compute resource. Amazon GameLift requires the DNS name or IP address to
|
|
769
770
|
* manage your compute resource.</p>
|
|
770
771
|
*/
|
|
771
772
|
DnsName?: string;
|
|
772
773
|
/**
|
|
773
|
-
* <p>Current status of the compute. A compute must have an <code>ACTIVE</code> status to
|
|
774
|
+
* <p>Current status of the compute. A compute must have an <code>ACTIVE</code> status to
|
|
775
|
+
* host game sessions.</p>
|
|
774
776
|
*/
|
|
775
777
|
ComputeStatus?: ComputeStatus | string;
|
|
776
778
|
/**
|
|
@@ -787,12 +789,12 @@ export interface Compute {
|
|
|
787
789
|
*/
|
|
788
790
|
OperatingSystem?: OperatingSystem | string;
|
|
789
791
|
/**
|
|
790
|
-
* <p>
|
|
791
|
-
*
|
|
792
|
+
* <p>The compute type that the fleet uses. A fleet can use Anywhere compute resources that
|
|
793
|
+
* you own, or use managed Amazon EC2 instances.</p>
|
|
792
794
|
*/
|
|
793
795
|
Type?: EC2InstanceType | string;
|
|
794
796
|
/**
|
|
795
|
-
* <p>The endpoint connection details of the GameLift SDK endpoint that your game server
|
|
797
|
+
* <p>The endpoint connection details of the Amazon GameLift SDK endpoint that your game server
|
|
796
798
|
* connects to.</p>
|
|
797
799
|
*/
|
|
798
800
|
GameLiftServiceSdkEndpoint?: string;
|
|
@@ -811,33 +813,32 @@ export declare const ComputeType: {
|
|
|
811
813
|
export type ComputeType = (typeof ComputeType)[keyof typeof ComputeType];
|
|
812
814
|
/**
|
|
813
815
|
* @public
|
|
814
|
-
* <p>A label that can
|
|
815
|
-
*
|
|
816
|
+
* <p>A label that you can assign to a Amazon GameLift resource. </p>
|
|
817
|
+
* <p>
|
|
816
818
|
* <b>Learn more</b>
|
|
817
819
|
* </p>
|
|
818
|
-
*
|
|
820
|
+
* <p>
|
|
819
821
|
* <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services
|
|
820
822
|
* Resources</a> in the <i>Amazon Web Services General Reference</i>
|
|
821
823
|
* </p>
|
|
822
|
-
*
|
|
824
|
+
* <p>
|
|
823
825
|
* <a href="http://aws.amazon.com/answers/account-management/aws-tagging-strategies/">
|
|
824
826
|
* Amazon Web Services Tagging Strategies</a>
|
|
825
827
|
* </p>
|
|
826
828
|
* <p>
|
|
827
829
|
* <b>Related actions</b>
|
|
828
830
|
* </p>
|
|
829
|
-
*
|
|
831
|
+
* <p>
|
|
830
832
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
831
833
|
* </p>
|
|
832
834
|
*/
|
|
833
835
|
export interface Tag {
|
|
834
836
|
/**
|
|
835
|
-
* <p>The key for a developer-defined key
|
|
837
|
+
* <p>The key for a developer-defined key value pair for tagging an Amazon Web Services resource. </p>
|
|
836
838
|
*/
|
|
837
839
|
Key: string | undefined;
|
|
838
840
|
/**
|
|
839
|
-
* <p>The value for a developer-defined key
|
|
840
|
-
* </p>
|
|
841
|
+
* <p>The value for a developer-defined key value pair for tagging an Amazon Web Services resource. </p>
|
|
841
842
|
*/
|
|
842
843
|
Value: string | undefined;
|
|
843
844
|
}
|
|
@@ -912,10 +913,10 @@ export declare class TaggingFailedException extends __BaseException {
|
|
|
912
913
|
export interface S3Location {
|
|
913
914
|
/**
|
|
914
915
|
* <p>An Amazon S3 bucket identifier. Thename of the S3 bucket.</p>
|
|
915
|
-
*
|
|
916
|
-
* <p>GameLift doesn't support uploading from Amazon S3 buckets with names that contain a dot
|
|
916
|
+
* <note>
|
|
917
|
+
* <p>Amazon GameLift doesn't support uploading from Amazon S3 buckets with names that contain a dot
|
|
917
918
|
* (.).</p>
|
|
918
|
-
*
|
|
919
|
+
* </note>
|
|
919
920
|
*/
|
|
920
921
|
Bucket?: string;
|
|
921
922
|
/**
|
|
@@ -940,11 +941,11 @@ export interface S3Location {
|
|
|
940
941
|
*/
|
|
941
942
|
export interface CreateBuildInput {
|
|
942
943
|
/**
|
|
943
|
-
* <p>A descriptive label associated with a build. Build names
|
|
944
|
+
* <p>A descriptive label associated with a build. Build names don't need to be unique. You can change this value later. </p>
|
|
944
945
|
*/
|
|
945
946
|
Name?: string;
|
|
946
947
|
/**
|
|
947
|
-
* <p>Version information associated with a build or script. Version strings
|
|
948
|
+
* <p>Version information associated with a build or script. Version strings don't need to be unique. You can change this value later. </p>
|
|
948
949
|
*/
|
|
949
950
|
Version?: string;
|
|
950
951
|
/**
|
|
@@ -953,7 +954,7 @@ export interface CreateBuildInput {
|
|
|
953
954
|
* location must specify an Amazon S3 bucket name and key. The location must also specify a role
|
|
954
955
|
* ARN that you set up to allow Amazon GameLift to access your Amazon S3 bucket. The S3 bucket and your
|
|
955
956
|
* new build must be in the same Region.</p>
|
|
956
|
-
*
|
|
957
|
+
* <p>If a <code>StorageLocation</code> is specified, the size of your file can be found in
|
|
957
958
|
* your Amazon S3 bucket. Amazon GameLift will report a <code>SizeOnDisk</code> of 0. </p>
|
|
958
959
|
*/
|
|
959
960
|
StorageLocation?: S3Location;
|
|
@@ -961,8 +962,8 @@ export interface CreateBuildInput {
|
|
|
961
962
|
* <p>The operating system that you built the game server binaries to run on. This value
|
|
962
963
|
* determines the type of fleet resources that you can use for this build. If your game
|
|
963
964
|
* build contains multiple executables, they all must run on the same operating system. If
|
|
964
|
-
* an operating system
|
|
965
|
-
* default value (WINDOWS_2012). This value
|
|
965
|
+
* an operating system isn't specified when creating a build, Amazon GameLift uses the
|
|
966
|
+
* default value (WINDOWS_2012). This value can't be changed later.</p>
|
|
966
967
|
*/
|
|
967
968
|
OperatingSystem?: OperatingSystem | string;
|
|
968
969
|
/**
|
|
@@ -977,8 +978,9 @@ export interface CreateBuildInput {
|
|
|
977
978
|
*/
|
|
978
979
|
Tags?: Tag[];
|
|
979
980
|
/**
|
|
980
|
-
* <p>A server SDK version you used when integrating your game server build with GameLift. For more information see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-custom-intro.html">Integrate games
|
|
981
|
-
* with custom game servers</a
|
|
981
|
+
* <p>A server SDK version you used when integrating your game server build with Amazon GameLift. For more information see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-custom-intro.html">Integrate games
|
|
982
|
+
* with custom game servers</a>. By default Amazon GameLift sets this value to
|
|
983
|
+
* <code>4.0.2</code>.</p>
|
|
982
984
|
*/
|
|
983
985
|
ServerSdkVersion?: string;
|
|
984
986
|
}
|
|
@@ -1019,19 +1021,21 @@ export type IpProtocol = (typeof IpProtocol)[keyof typeof IpProtocol];
|
|
|
1019
1021
|
* <p>A range of IP addresses and port settings that allow inbound traffic to connect to
|
|
1020
1022
|
* server processes on an instance in a fleet. New game sessions are assigned an IP
|
|
1021
1023
|
* address/port number combination, which must fall into the fleet's allowed ranges. Fleets
|
|
1022
|
-
* with custom game builds must have permissions explicitly set. For Realtime Servers fleets, GameLift
|
|
1024
|
+
* with custom game builds must have permissions explicitly set. For Realtime Servers fleets, Amazon GameLift
|
|
1023
1025
|
* automatically opens two port ranges, one for TCP messaging and one for UDP.</p>
|
|
1024
1026
|
*/
|
|
1025
1027
|
export interface IpPermission {
|
|
1026
1028
|
/**
|
|
1027
1029
|
* <p>A starting value for a range of allowed port numbers.</p>
|
|
1028
|
-
*
|
|
1030
|
+
* <p>For fleets using Linux builds, only ports <code>22</code> and <code>1026-60000</code> are valid.</p>
|
|
1031
|
+
* <p>For fleets using Windows builds, only ports <code>1026-60000</code> are valid.</p>
|
|
1029
1032
|
*/
|
|
1030
1033
|
FromPort: number | undefined;
|
|
1031
1034
|
/**
|
|
1032
1035
|
* <p>An ending value for a range of allowed port numbers. Port numbers are end-inclusive.
|
|
1033
|
-
* This value must be
|
|
1034
|
-
*
|
|
1036
|
+
* This value must be equal to or greater than <code>FromPort</code>.</p>
|
|
1037
|
+
* <p>For fleets using Linux builds, only ports <code>22</code> and <code>1026-60000</code> are valid.</p>
|
|
1038
|
+
* <p>For fleets using Windows builds, only ports <code>1026-60000</code> are valid.</p>
|
|
1035
1039
|
*/
|
|
1036
1040
|
ToPort: number | undefined;
|
|
1037
1041
|
/**
|
|
@@ -1059,7 +1063,7 @@ export declare const FleetType: {
|
|
|
1059
1063
|
export type FleetType = (typeof FleetType)[keyof typeof FleetType];
|
|
1060
1064
|
/**
|
|
1061
1065
|
* @public
|
|
1062
|
-
* <p>A remote location where a multi-location fleet can deploy
|
|
1066
|
+
* <p>A remote location where a multi-location fleet can deploy game servers for game
|
|
1063
1067
|
* hosting. </p>
|
|
1064
1068
|
*/
|
|
1065
1069
|
export interface LocationConfiguration {
|
|
@@ -1085,8 +1089,8 @@ export type ProtectionPolicy = (typeof ProtectionPolicy)[keyof typeof Protection
|
|
|
1085
1089
|
* <p>A policy that puts limits on the number of game sessions that a player can create
|
|
1086
1090
|
* within a specified span of time. With this policy, you can control players' ability to
|
|
1087
1091
|
* consume available resources.</p>
|
|
1088
|
-
*
|
|
1089
|
-
* a <code>CreateGameSession</code> request, GameLift checks that the player (identified by
|
|
1092
|
+
* <p>The policy is evaluated when a player tries to create a new game session. On receiving
|
|
1093
|
+
* a <code>CreateGameSession</code> request, Amazon GameLift checks that the player (identified by
|
|
1090
1094
|
* <code>CreatorId</code>) has created fewer than game session limit in the specified
|
|
1091
1095
|
* time period.</p>
|
|
1092
1096
|
*/
|
|
@@ -1095,8 +1099,8 @@ export interface ResourceCreationLimitPolicy {
|
|
|
1095
1099
|
* <p>A policy that puts limits on the number of game sessions that a player can create
|
|
1096
1100
|
* within a specified span of time. With this policy, you can control players' ability to
|
|
1097
1101
|
* consume available resources.</p>
|
|
1098
|
-
*
|
|
1099
|
-
* a <code>CreateGameSession</code> request, GameLift checks that the player (identified by
|
|
1102
|
+
* <p>The policy is evaluated when a player tries to create a new game session. On receiving
|
|
1103
|
+
* a <code>CreateGameSession</code> request, Amazon GameLift checks that the player (identified by
|
|
1100
1104
|
* <code>CreatorId</code>) has created fewer than game session limit in the specified
|
|
1101
1105
|
* time period.</p>
|
|
1102
1106
|
*/
|
|
@@ -1117,13 +1121,13 @@ export interface ServerProcess {
|
|
|
1117
1121
|
* <p>The location of a game build executable or the Realtime script file that contains the
|
|
1118
1122
|
* <code>Init()</code> function. Game builds and Realtime scripts are installed on
|
|
1119
1123
|
* instances at the root: </p>
|
|
1120
|
-
*
|
|
1124
|
+
* <ul>
|
|
1121
1125
|
* <li>
|
|
1122
|
-
*
|
|
1126
|
+
* <p>Windows (custom game builds only): <code>C:\game</code>. Example:
|
|
1123
1127
|
* "<code>C:\game\MyGame\server.exe</code>" </p>
|
|
1124
1128
|
* </li>
|
|
1125
1129
|
* <li>
|
|
1126
|
-
*
|
|
1130
|
+
* <p>Linux: <code>/local/game</code>. Examples:
|
|
1127
1131
|
* "<code>/local/game/MyGame/server.exe</code>" or
|
|
1128
1132
|
* "<code>/local/game/MyRealtimeScript.js</code>"</p>
|
|
1129
1133
|
* </li>
|
|
@@ -1145,10 +1149,10 @@ export interface ServerProcess {
|
|
|
1145
1149
|
* @public
|
|
1146
1150
|
* <p>A collection of server process configurations that describe the set of processes to
|
|
1147
1151
|
* run on each instance in a fleet. Server processes run either an executable in a custom
|
|
1148
|
-
* game build or a Realtime Servers script. GameLift launches the configured processes, manages their
|
|
1152
|
+
* game build or a Realtime Servers script. Amazon GameLift launches the configured processes, manages their
|
|
1149
1153
|
* life cycle, and replaces them as needed. Each instance checks regularly for an updated
|
|
1150
1154
|
* runtime configuration. </p>
|
|
1151
|
-
*
|
|
1155
|
+
* <p>A Amazon GameLift instance is limited to 50 processes running concurrently. To calculate the
|
|
1152
1156
|
* total number of processes in a runtime configuration, add the values of the
|
|
1153
1157
|
* <code>ConcurrentExecutions</code> parameter for each server process. Learn more
|
|
1154
1158
|
* about <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html"> Running Multiple
|
|
@@ -1189,13 +1193,13 @@ export interface CreateFleetInput {
|
|
|
1189
1193
|
Description?: string;
|
|
1190
1194
|
/**
|
|
1191
1195
|
* <p>The unique identifier for a custom game server build to be deployed on fleet
|
|
1192
|
-
* instances. You can use either the build ID or ARN. The build must be uploaded to GameLift
|
|
1196
|
+
* instances. You can use either the build ID or ARN. The build must be uploaded to Amazon GameLift
|
|
1193
1197
|
* and in <code>READY</code> status. This fleet property cannot be changed later.</p>
|
|
1194
1198
|
*/
|
|
1195
1199
|
BuildId?: string;
|
|
1196
1200
|
/**
|
|
1197
1201
|
* <p>The unique identifier for a Realtime configuration script to be deployed on fleet
|
|
1198
|
-
* instances. You can use either the script ID or ARN. Scripts must be uploaded to GameLift
|
|
1202
|
+
* instances. You can use either the script ID or ARN. Scripts must be uploaded to Amazon GameLift
|
|
1199
1203
|
* prior to creating the fleet. This fleet property cannot be changed later.</p>
|
|
1200
1204
|
*/
|
|
1201
1205
|
ScriptId?: string;
|
|
@@ -1216,14 +1220,14 @@ export interface CreateFleetInput {
|
|
|
1216
1220
|
/**
|
|
1217
1221
|
* <p>
|
|
1218
1222
|
* <b>This parameter is no longer used.</b> To specify where
|
|
1219
|
-
* GameLift should store log files once a server process shuts down, use the GameLift server
|
|
1223
|
+
* Amazon GameLift should store log files once a server process shuts down, use the Amazon GameLift server
|
|
1220
1224
|
* API <code>ProcessReady()</code> and specify one or more directory paths in
|
|
1221
|
-
* <code>logParameters</code>. For more information, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-initialize">Initialize the server process</a> in the <i>GameLift Developer
|
|
1225
|
+
* <code>logParameters</code>. For more information, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-initialize">Initialize the server process</a> in the <i>Amazon GameLift Developer
|
|
1222
1226
|
* Guide</i>. </p>
|
|
1223
1227
|
*/
|
|
1224
1228
|
LogPaths?: string[];
|
|
1225
1229
|
/**
|
|
1226
|
-
* <p>The GameLift-supported Amazon EC2 instance type to use for all fleet instances. Instance
|
|
1230
|
+
* <p>The Amazon GameLift-supported Amazon EC2 instance type to use for all fleet instances. Instance
|
|
1227
1231
|
* type determines the computing resources that will be used to host your game servers,
|
|
1228
1232
|
* including CPU, memory, storage, and networking capacity. See <a href="http://aws.amazon.com/ec2/instance-types/">Amazon Elastic Compute Cloud Instance Types</a> for detailed descriptions
|
|
1229
1233
|
* of Amazon EC2 instance types.</p>
|
|
@@ -1232,7 +1236,7 @@ export interface CreateFleetInput {
|
|
|
1232
1236
|
/**
|
|
1233
1237
|
* <p>The allowed IP address ranges and port settings that allow inbound traffic to access
|
|
1234
1238
|
* game sessions on this fleet. If the fleet is hosting a custom game build, this property
|
|
1235
|
-
* must be set before players can connect to game sessions. For Realtime Servers fleets, GameLift
|
|
1239
|
+
* must be set before players can connect to game sessions. For Realtime Servers fleets, Amazon GameLift
|
|
1236
1240
|
* automatically sets TCP and UDP ranges. </p>
|
|
1237
1241
|
*/
|
|
1238
1242
|
EC2InboundPermissions?: IpPermission[];
|
|
@@ -1240,15 +1244,15 @@ export interface CreateFleetInput {
|
|
|
1240
1244
|
* <p>The status of termination protection for active game sessions on the fleet. By
|
|
1241
1245
|
* default, this property is set to <code>NoProtection</code>. You can also set game
|
|
1242
1246
|
* session protection for an individual game session by calling <a href="gamelift/latest/apireference/API_UpdateGameSession.html">UpdateGameSession</a>.</p>
|
|
1243
|
-
*
|
|
1247
|
+
* <ul>
|
|
1244
1248
|
* <li>
|
|
1245
|
-
*
|
|
1246
|
-
*
|
|
1249
|
+
* <p>
|
|
1250
|
+
* <b>NoProtection</b> - Game sessions can be terminated
|
|
1247
1251
|
* during active gameplay as a result of a scale-down event. </p>
|
|
1248
1252
|
* </li>
|
|
1249
1253
|
* <li>
|
|
1250
|
-
*
|
|
1251
|
-
*
|
|
1254
|
+
* <p>
|
|
1255
|
+
* <b>FullProtection</b> - Game sessions in
|
|
1252
1256
|
* <code>ACTIVE</code> status cannot be terminated during a scale-down
|
|
1253
1257
|
* event.</p>
|
|
1254
1258
|
* </li>
|
|
@@ -1260,12 +1264,12 @@ export interface CreateFleetInput {
|
|
|
1260
1264
|
* fleet. The runtime configuration defines one or more server process configurations, each
|
|
1261
1265
|
* identifying a build executable or Realtime script file and the number of processes of
|
|
1262
1266
|
* that type to run concurrently. </p>
|
|
1263
|
-
*
|
|
1267
|
+
* <note>
|
|
1264
1268
|
* <p>The <code>RuntimeConfiguration</code> parameter is required unless the fleet is
|
|
1265
1269
|
* being configured using the older parameters <code>ServerLaunchPath</code> and
|
|
1266
1270
|
* <code>ServerLaunchParameters</code>, which are still supported for backward
|
|
1267
1271
|
* compatibility.</p>
|
|
1268
|
-
*
|
|
1272
|
+
* </note>
|
|
1269
1273
|
*/
|
|
1270
1274
|
RuntimeConfiguration?: RuntimeConfiguration;
|
|
1271
1275
|
/**
|
|
@@ -1281,16 +1285,16 @@ export interface CreateFleetInput {
|
|
|
1281
1285
|
*/
|
|
1282
1286
|
MetricGroups?: string[];
|
|
1283
1287
|
/**
|
|
1284
|
-
* <p>Used when peering your GameLift fleet with a VPC, the unique identifier for the Amazon Web Services
|
|
1288
|
+
* <p>Used when peering your Amazon GameLift fleet with a VPC, the unique identifier for the Amazon Web Services
|
|
1285
1289
|
* account that owns the VPC. You can find your account ID in the Amazon Web Services Management Console under account
|
|
1286
1290
|
* settings. </p>
|
|
1287
1291
|
*/
|
|
1288
1292
|
PeerVpcAwsAccountId?: string;
|
|
1289
1293
|
/**
|
|
1290
|
-
* <p>A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The
|
|
1294
|
+
* <p>A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The
|
|
1291
1295
|
* VPC must be in the same Region as your fleet. To look up a VPC ID, use the
|
|
1292
1296
|
* <a href="https://console.aws.amazon.com/vpc/">VPC Dashboard</a> in the Amazon Web Services Management Console.
|
|
1293
|
-
* Learn more about VPC peering in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with GameLift Fleets</a>.</p>
|
|
1297
|
+
* Learn more about VPC peering in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with Amazon GameLift Fleets</a>.</p>
|
|
1294
1298
|
*/
|
|
1295
1299
|
PeerVpcId?: string;
|
|
1296
1300
|
/**
|
|
@@ -1310,29 +1314,31 @@ export interface CreateFleetInput {
|
|
|
1310
1314
|
*/
|
|
1311
1315
|
InstanceRoleArn?: string;
|
|
1312
1316
|
/**
|
|
1313
|
-
* <p>Prompts GameLift to generate a TLS/SSL certificate for the fleet. GameLift uses the
|
|
1317
|
+
* <p>Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet. Amazon GameLift uses the
|
|
1314
1318
|
* certificates to encrypt traffic between game clients and the game servers running on
|
|
1315
|
-
* GameLift. By default, the <code>CertificateConfiguration</code> is <code>DISABLED</code>.
|
|
1319
|
+
* Amazon GameLift. By default, the <code>CertificateConfiguration</code> is <code>DISABLED</code>.
|
|
1316
1320
|
* You can't change this property after you create the fleet. </p>
|
|
1317
|
-
*
|
|
1321
|
+
* <p>Certificate Manager (ACM) certificates expire after 13 months.
|
|
1318
1322
|
* Certificate expiration can cause fleets to fail, preventing players from connecting to
|
|
1319
1323
|
* instances in the fleet. We recommend you replace fleets before 13 months, consider using
|
|
1320
1324
|
* fleet aliases for a smooth transition.</p>
|
|
1321
|
-
*
|
|
1325
|
+
* <note>
|
|
1322
1326
|
* <p>ACM isn't available in all Amazon Web Services regions. A fleet creation request
|
|
1323
1327
|
* with certificate generation enabled in an unsupported Region, fails with a 4xx
|
|
1324
1328
|
* error. For more information about the supported Regions, see <a href="https://docs.aws.amazon.com/acm/latest/userguide/acm-regions.html">Supported
|
|
1325
1329
|
* Regions</a> in the <i>Certificate Manager User
|
|
1326
1330
|
* Guide</i>.</p>
|
|
1327
|
-
*
|
|
1331
|
+
* </note>
|
|
1328
1332
|
*/
|
|
1329
1333
|
CertificateConfiguration?: CertificateConfiguration;
|
|
1330
1334
|
/**
|
|
1331
1335
|
* <p>A set of remote locations to deploy additional instances to and manage as part of the
|
|
1332
1336
|
* fleet. This parameter can only be used when creating fleets in Amazon Web Services Regions that
|
|
1333
|
-
* support multiple locations. You can add any GameLift-supported Amazon Web Services Region as a remote
|
|
1337
|
+
* support multiple locations. You can add any Amazon GameLift-supported Amazon Web Services Region as a remote
|
|
1334
1338
|
* location, in the form of an Amazon Web Services Region code such as <code>us-west-2</code>. To create
|
|
1335
|
-
* a fleet with instances in the home Region only,
|
|
1339
|
+
* a fleet with instances in the home Region only, don't use this parameter. </p>
|
|
1340
|
+
* <p>To use this parameter, Amazon GameLift requires you to use your home location in the
|
|
1341
|
+
* request.</p>
|
|
1336
1342
|
*/
|
|
1337
1343
|
Locations?: LocationConfiguration[];
|
|
1338
1344
|
/**
|
|
@@ -1344,12 +1350,12 @@ export interface CreateFleetInput {
|
|
|
1344
1350
|
Tags?: Tag[];
|
|
1345
1351
|
/**
|
|
1346
1352
|
* <p>The type of compute resource used to host your game servers. You can use your own
|
|
1347
|
-
* compute resources with GameLift Anywhere or use Amazon EC2 instances with managed
|
|
1348
|
-
* GameLift
|
|
1353
|
+
* compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed
|
|
1354
|
+
* Amazon GameLift. By default, this property is set to <code>EC2</code>.</p>
|
|
1349
1355
|
*/
|
|
1350
1356
|
ComputeType?: ComputeType | string;
|
|
1351
1357
|
/**
|
|
1352
|
-
* <p>GameLift Anywhere configuration options.</p>
|
|
1358
|
+
* <p>Amazon GameLift Anywhere configuration options.</p>
|
|
1353
1359
|
*/
|
|
1354
1360
|
AnywhereConfiguration?: AnywhereConfiguration;
|
|
1355
1361
|
}
|
|
@@ -1386,7 +1392,7 @@ export declare const FleetAction: {
|
|
|
1386
1392
|
export type FleetAction = (typeof FleetAction)[keyof typeof FleetAction];
|
|
1387
1393
|
/**
|
|
1388
1394
|
* @public
|
|
1389
|
-
* <p>Describes a GameLift fleet of game hosting resources.</p>
|
|
1395
|
+
* <p>Describes a Amazon GameLift fleet of game hosting resources.</p>
|
|
1390
1396
|
* <p>
|
|
1391
1397
|
* <b>Related actions</b>
|
|
1392
1398
|
* </p>
|
|
@@ -1397,7 +1403,7 @@ export interface FleetAttributes {
|
|
|
1397
1403
|
*/
|
|
1398
1404
|
FleetId?: string;
|
|
1399
1405
|
/**
|
|
1400
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>. In a GameLift fleet ARN, the resource ID matches the <code>FleetId</code>
|
|
1406
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>. In a GameLift fleet ARN, the resource ID matches the <code>FleetId</code>
|
|
1401
1407
|
* value.</p>
|
|
1402
1408
|
*/
|
|
1403
1409
|
FleetArn?: string;
|
|
@@ -1432,36 +1438,36 @@ export interface FleetAttributes {
|
|
|
1432
1438
|
TerminationTime?: Date;
|
|
1433
1439
|
/**
|
|
1434
1440
|
* <p>Current status of the fleet. Possible fleet statuses include the following:</p>
|
|
1435
|
-
*
|
|
1441
|
+
* <ul>
|
|
1436
1442
|
* <li>
|
|
1437
|
-
*
|
|
1438
|
-
*
|
|
1443
|
+
* <p>
|
|
1444
|
+
* <b>NEW</b> -- A new fleet has been defined and desired
|
|
1439
1445
|
* instances is set to 1. </p>
|
|
1440
1446
|
* </li>
|
|
1441
1447
|
* <li>
|
|
1442
|
-
*
|
|
1443
|
-
*
|
|
1444
|
-
* GameLift is setting up the new fleet, creating new instances with the game build
|
|
1448
|
+
* <p>
|
|
1449
|
+
* <b>DOWNLOADING/VALIDATING/BUILDING/ACTIVATING</b> --
|
|
1450
|
+
* Amazon GameLift is setting up the new fleet, creating new instances with the game build
|
|
1445
1451
|
* or Realtime script and starting server processes.</p>
|
|
1446
1452
|
* </li>
|
|
1447
1453
|
* <li>
|
|
1448
|
-
*
|
|
1449
|
-
*
|
|
1454
|
+
* <p>
|
|
1455
|
+
* <b>ACTIVE</b> -- Hosts can now accept game
|
|
1450
1456
|
* sessions.</p>
|
|
1451
1457
|
* </li>
|
|
1452
1458
|
* <li>
|
|
1453
|
-
*
|
|
1454
|
-
*
|
|
1459
|
+
* <p>
|
|
1460
|
+
* <b>ERROR</b> -- An error occurred when downloading,
|
|
1455
1461
|
* validating, building, or activating the fleet.</p>
|
|
1456
1462
|
* </li>
|
|
1457
1463
|
* <li>
|
|
1458
|
-
*
|
|
1459
|
-
*
|
|
1464
|
+
* <p>
|
|
1465
|
+
* <b>DELETING</b> -- Hosts are responding to a delete
|
|
1460
1466
|
* fleet request.</p>
|
|
1461
1467
|
* </li>
|
|
1462
1468
|
* <li>
|
|
1463
|
-
*
|
|
1464
|
-
*
|
|
1469
|
+
* <p>
|
|
1470
|
+
* <b>TERMINATED</b> -- The fleet no longer
|
|
1465
1471
|
* exists.</p>
|
|
1466
1472
|
* </li>
|
|
1467
1473
|
* </ul>
|
|
@@ -1472,7 +1478,7 @@ export interface FleetAttributes {
|
|
|
1472
1478
|
*/
|
|
1473
1479
|
BuildId?: string;
|
|
1474
1480
|
/**
|
|
1475
|
-
* <p> The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) associated with the GameLift build resource that is deployed on instances in
|
|
1481
|
+
* <p> The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) associated with the Amazon GameLift build resource that is deployed on instances in
|
|
1476
1482
|
* this fleet. In a GameLift build ARN, the resource ID matches the <code>BuildId</code>
|
|
1477
1483
|
* value.</p>
|
|
1478
1484
|
*/
|
|
@@ -1505,22 +1511,22 @@ export interface FleetAttributes {
|
|
|
1505
1511
|
/**
|
|
1506
1512
|
* <p>
|
|
1507
1513
|
* <b>This parameter is no longer used.</b> Game session log
|
|
1508
|
-
* paths are now defined using the GameLift server API <code>ProcessReady()</code>
|
|
1514
|
+
* paths are now defined using the Amazon GameLift server API <code>ProcessReady()</code>
|
|
1509
1515
|
* <code>logParameters</code>. See more information in the <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api-ref.html#gamelift-sdk-server-api-ref-dataypes-process">Server API Reference</a>. </p>
|
|
1510
1516
|
*/
|
|
1511
1517
|
LogPaths?: string[];
|
|
1512
1518
|
/**
|
|
1513
1519
|
* <p>The type of game session protection to set on all new instances that are started in
|
|
1514
1520
|
* the fleet.</p>
|
|
1515
|
-
*
|
|
1521
|
+
* <ul>
|
|
1516
1522
|
* <li>
|
|
1517
|
-
*
|
|
1518
|
-
*
|
|
1523
|
+
* <p>
|
|
1524
|
+
* <b>NoProtection</b> -- The game session can be
|
|
1519
1525
|
* terminated during a scale-down event.</p>
|
|
1520
1526
|
* </li>
|
|
1521
1527
|
* <li>
|
|
1522
|
-
*
|
|
1523
|
-
*
|
|
1528
|
+
* <p>
|
|
1529
|
+
* <b>FullProtection</b> -- If the game session is in an
|
|
1524
1530
|
* <code>ACTIVE</code> status, it cannot be terminated during a scale-down
|
|
1525
1531
|
* event.</p>
|
|
1526
1532
|
* </li>
|
|
@@ -1536,8 +1542,8 @@ export interface FleetAttributes {
|
|
|
1536
1542
|
* <p>A policy that puts limits on the number of game sessions that a player can create
|
|
1537
1543
|
* within a specified span of time. With this policy, you can control players' ability to
|
|
1538
1544
|
* consume available resources.</p>
|
|
1539
|
-
*
|
|
1540
|
-
* a <code>CreateGameSession</code> request, GameLift checks that the player (identified by
|
|
1545
|
+
* <p>The policy is evaluated when a player tries to create a new game session. On receiving
|
|
1546
|
+
* a <code>CreateGameSession</code> request, Amazon GameLift checks that the player (identified by
|
|
1541
1547
|
* <code>CreatorId</code>) has created fewer than game session limit in the specified
|
|
1542
1548
|
* time period.</p>
|
|
1543
1549
|
*/
|
|
@@ -1565,18 +1571,18 @@ export interface FleetAttributes {
|
|
|
1565
1571
|
/**
|
|
1566
1572
|
* <p>Determines whether a TLS/SSL certificate is generated for a fleet. This feature must
|
|
1567
1573
|
* be enabled when creating the fleet. All instances in a fleet share the same certificate.
|
|
1568
|
-
* The certificate can be retrieved by calling the <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk.html">GameLift Server
|
|
1574
|
+
* The certificate can be retrieved by calling the <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk.html">Amazon GameLift Server
|
|
1569
1575
|
* SDK</a> operation <code>GetInstanceCertificate</code>. </p>
|
|
1570
1576
|
*/
|
|
1571
1577
|
CertificateConfiguration?: CertificateConfiguration;
|
|
1572
1578
|
/**
|
|
1573
1579
|
* <p>The type of compute resource used to host your game servers. You can use your own
|
|
1574
|
-
* compute resources with GameLift Anywhere or use Amazon EC2 instances with managed
|
|
1575
|
-
* GameLift.</p>
|
|
1580
|
+
* compute resources with Amazon GameLift Anywhere or use Amazon EC2 instances with managed
|
|
1581
|
+
* Amazon GameLift.</p>
|
|
1576
1582
|
*/
|
|
1577
1583
|
ComputeType?: ComputeType | string;
|
|
1578
1584
|
/**
|
|
1579
|
-
* <p>GameLift Anywhere configuration options for your Anywhere fleets.</p>
|
|
1585
|
+
* <p>Amazon GameLift Anywhere configuration options for your Anywhere fleets.</p>
|
|
1580
1586
|
*/
|
|
1581
1587
|
AnywhereConfiguration?: AnywhereConfiguration;
|
|
1582
1588
|
}
|
|
@@ -1586,41 +1592,41 @@ export interface FleetAttributes {
|
|
|
1586
1592
|
* describe a fleet's remote location or home Region. Life-cycle state tracks the progress
|
|
1587
1593
|
* of launching the first instance in a new location and preparing it for game hosting, and
|
|
1588
1594
|
* then removing all instances and deleting the location from the fleet.</p>
|
|
1589
|
-
*
|
|
1595
|
+
* <ul>
|
|
1590
1596
|
* <li>
|
|
1591
|
-
*
|
|
1592
|
-
*
|
|
1597
|
+
* <p>
|
|
1598
|
+
* <b>NEW</b> -- A new fleet location has been defined and desired
|
|
1593
1599
|
* instances is set to 1. </p>
|
|
1594
1600
|
* </li>
|
|
1595
1601
|
* <li>
|
|
1596
|
-
*
|
|
1597
|
-
*
|
|
1598
|
-
* GameLift is setting up the new fleet location, creating new instances with the game build
|
|
1602
|
+
* <p>
|
|
1603
|
+
* <b>DOWNLOADING/VALIDATING/BUILDING/ACTIVATING</b> --
|
|
1604
|
+
* Amazon GameLift is setting up the new fleet location, creating new instances with the game build
|
|
1599
1605
|
* or Realtime script and starting server processes.</p>
|
|
1600
1606
|
* </li>
|
|
1601
1607
|
* <li>
|
|
1602
|
-
*
|
|
1603
|
-
*
|
|
1608
|
+
* <p>
|
|
1609
|
+
* <b>ACTIVE</b> -- Hosts can now accept game
|
|
1604
1610
|
* sessions.</p>
|
|
1605
1611
|
* </li>
|
|
1606
1612
|
* <li>
|
|
1607
|
-
*
|
|
1608
|
-
*
|
|
1613
|
+
* <p>
|
|
1614
|
+
* <b>ERROR</b> -- An error occurred when downloading,
|
|
1609
1615
|
* validating, building, or activating the fleet location.</p>
|
|
1610
1616
|
* </li>
|
|
1611
1617
|
* <li>
|
|
1612
|
-
*
|
|
1613
|
-
*
|
|
1618
|
+
* <p>
|
|
1619
|
+
* <b>DELETING</b> -- Hosts are responding to a delete
|
|
1614
1620
|
* fleet location request.</p>
|
|
1615
1621
|
* </li>
|
|
1616
1622
|
* <li>
|
|
1617
|
-
*
|
|
1618
|
-
*
|
|
1623
|
+
* <p>
|
|
1624
|
+
* <b>TERMINATED</b> -- The fleet location no longer
|
|
1619
1625
|
* exists.</p>
|
|
1620
1626
|
* </li>
|
|
1621
1627
|
* <li>
|
|
1622
|
-
*
|
|
1623
|
-
*
|
|
1628
|
+
* <p>
|
|
1629
|
+
* <b>NOT_FOUND</b> -- The fleet location was not found. This could be because the custom location was removed or not created.
|
|
1624
1630
|
* </p>
|
|
1625
1631
|
* </li>
|
|
1626
1632
|
* </ul>
|
|
@@ -1647,7 +1653,7 @@ export interface CreateFleetOutput {
|
|
|
1647
1653
|
FleetAttributes?: FleetAttributes;
|
|
1648
1654
|
/**
|
|
1649
1655
|
* <p>The fleet's locations and life-cycle status of each location. For new fleets, the
|
|
1650
|
-
* status of all locations is set to <code>NEW</code>. During fleet creation, GameLift
|
|
1656
|
+
* status of all locations is set to <code>NEW</code>. During fleet creation, Amazon GameLift
|
|
1651
1657
|
* updates each location status as instances are deployed there and prepared for game
|
|
1652
1658
|
* hosting. This list includes an entry for the fleet's home Region. For fleets with no
|
|
1653
1659
|
* remote locations, only one entry, representing the home Region, is returned.</p>
|
|
@@ -1664,7 +1670,7 @@ export interface CreateFleetLocationsInput {
|
|
|
1664
1670
|
FleetId: string | undefined;
|
|
1665
1671
|
/**
|
|
1666
1672
|
* <p>A list of locations to deploy additional instances to and manage as part of the fleet.
|
|
1667
|
-
* You can add any GameLift-supported Amazon Web Services Region as a remote location, in the form of an
|
|
1673
|
+
* You can add any Amazon GameLift-supported Amazon Web Services Region as a remote location, in the form of an
|
|
1668
1674
|
* Amazon Web Services Region code such as <code>us-west-2</code>. </p>
|
|
1669
1675
|
*/
|
|
1670
1676
|
Locations: LocationConfiguration[] | undefined;
|
|
@@ -1678,13 +1684,13 @@ export interface CreateFleetLocationsOutput {
|
|
|
1678
1684
|
*/
|
|
1679
1685
|
FleetId?: string;
|
|
1680
1686
|
/**
|
|
1681
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>. </p>
|
|
1687
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>. </p>
|
|
1682
1688
|
*/
|
|
1683
1689
|
FleetArn?: string;
|
|
1684
1690
|
/**
|
|
1685
1691
|
* <p>The remote locations that are being added to the fleet, and the life-cycle status of
|
|
1686
1692
|
* each location. For new locations, the status is set to <code>NEW</code>. During location
|
|
1687
|
-
* creation, GameLift updates each location's status as instances are deployed there and
|
|
1693
|
+
* creation, Amazon GameLift updates each location's status as instances are deployed there and
|
|
1688
1694
|
* prepared for game hosting. This list does not include the fleet home Region or any
|
|
1689
1695
|
* remote locations that were already added to the fleet.</p>
|
|
1690
1696
|
*/
|
|
@@ -1708,11 +1714,11 @@ export declare class InvalidFleetStatusException extends __BaseException {
|
|
|
1708
1714
|
/**
|
|
1709
1715
|
* @public
|
|
1710
1716
|
* <p>
|
|
1711
|
-
* <b>This data type is used with the GameLift FleetIQ and game server groups.</b>
|
|
1717
|
+
* <b>This data type is used with the Amazon GameLift FleetIQ and game server groups.</b>
|
|
1712
1718
|
* </p>
|
|
1713
1719
|
* <p>Settings for a
|
|
1714
1720
|
* target-based scaling policy as part of a <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameServerGroupAutoScalingPolicy.html">GameServerGroupAutoScalingPolicy</a> . These settings are used to create a
|
|
1715
|
-
* target-based policy that tracks the GameLift FleetIQ metric
|
|
1721
|
+
* target-based policy that tracks the Amazon GameLift FleetIQ metric
|
|
1716
1722
|
* <code>"PercentUtilizedGameServers"</code> and specifies a target value for the
|
|
1717
1723
|
* metric. As player usage changes, the policy triggers to adjust the game server group
|
|
1718
1724
|
* capacity so that the metric returns to the target value. </p>
|
|
@@ -1726,7 +1732,7 @@ export interface TargetTrackingConfiguration {
|
|
|
1726
1732
|
/**
|
|
1727
1733
|
* @public
|
|
1728
1734
|
* <p>
|
|
1729
|
-
* <b>This data type is used with the GameLift FleetIQ and game server groups.</b>
|
|
1735
|
+
* <b>This data type is used with the Amazon GameLift FleetIQ and game server groups.</b>
|
|
1730
1736
|
* </p>
|
|
1731
1737
|
* <p>Configuration
|
|
1732
1738
|
* settings for intelligent automatic scaling that uses target tracking. These settings are
|
|
@@ -1738,14 +1744,14 @@ export interface TargetTrackingConfiguration {
|
|
|
1738
1744
|
export interface GameServerGroupAutoScalingPolicy {
|
|
1739
1745
|
/**
|
|
1740
1746
|
* <p>Length of time, in seconds, it takes for a new instance to start new game server
|
|
1741
|
-
* processes and register with GameLift FleetIQ. Specifying a warm-up time can be useful, particularly
|
|
1747
|
+
* processes and register with Amazon GameLift FleetIQ. Specifying a warm-up time can be useful, particularly
|
|
1742
1748
|
* with game servers that take a long time to start up, because it avoids prematurely
|
|
1743
1749
|
* starting new instances. </p>
|
|
1744
1750
|
*/
|
|
1745
1751
|
EstimatedInstanceWarmup?: number;
|
|
1746
1752
|
/**
|
|
1747
1753
|
* <p>Settings for a target-based scaling policy applied to Auto Scaling group. These
|
|
1748
|
-
* settings are used to create a target-based policy that tracks the GameLift FleetIQ metric
|
|
1754
|
+
* settings are used to create a target-based policy that tracks the Amazon GameLift FleetIQ metric
|
|
1749
1755
|
* <code>"PercentUtilizedGameServers"</code> and specifies a target value for the
|
|
1750
1756
|
* metric. As player usage changes, the policy triggers to adjust the game server group
|
|
1751
1757
|
* capacity so that the metric returns to the target value. </p>
|
|
@@ -1865,11 +1871,11 @@ export type GameServerGroupInstanceType = (typeof GameServerGroupInstanceType)[k
|
|
|
1865
1871
|
/**
|
|
1866
1872
|
* @public
|
|
1867
1873
|
* <p>
|
|
1868
|
-
* <b>This data type is used with the GameLift FleetIQ and game server groups.</b>
|
|
1874
|
+
* <b>This data type is used with the Amazon GameLift FleetIQ and game server groups.</b>
|
|
1869
1875
|
* </p>
|
|
1870
1876
|
* <p>An allowed instance type for a
|
|
1871
1877
|
* game server group. All game server groups must have at least two instance types defined
|
|
1872
|
-
* for it. GameLift FleetIQ periodically evaluates each defined instance type for viability. It then
|
|
1878
|
+
* for it. Amazon GameLift FleetIQ periodically evaluates each defined instance type for viability. It then
|
|
1873
1879
|
* updates the Auto Scaling group with the list of viable instance types.</p>
|
|
1874
1880
|
*/
|
|
1875
1881
|
export interface InstanceDefinition {
|
|
@@ -1879,7 +1885,7 @@ export interface InstanceDefinition {
|
|
|
1879
1885
|
InstanceType: GameServerGroupInstanceType | string | undefined;
|
|
1880
1886
|
/**
|
|
1881
1887
|
* <p>Instance weighting that indicates how much this instance type contributes to the total
|
|
1882
|
-
* capacity of a game server group. Instance weights are used by GameLift FleetIQ to calculate the
|
|
1888
|
+
* capacity of a game server group. Instance weights are used by Amazon GameLift FleetIQ to calculate the
|
|
1883
1889
|
* instance type's cost per unit hour and better identify the most cost-effective options.
|
|
1884
1890
|
* For detailed information on weighting instance capacity, see <a href="https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html">Instance
|
|
1885
1891
|
* Weighting</a> in the <i>Amazon Elastic Compute Cloud Auto Scaling User Guide</i>.
|
|
@@ -1890,7 +1896,7 @@ export interface InstanceDefinition {
|
|
|
1890
1896
|
/**
|
|
1891
1897
|
* @public
|
|
1892
1898
|
* <p>
|
|
1893
|
-
* <b>This data type is used with the GameLift FleetIQ and game server groups.</b>
|
|
1899
|
+
* <b>This data type is used with the Amazon GameLift FleetIQ and game server groups.</b>
|
|
1894
1900
|
* </p>
|
|
1895
1901
|
* <p>An Amazon Elastic Compute Cloud launch
|
|
1896
1902
|
* template that contains configuration settings and game server code to be deployed to all
|
|
@@ -1919,7 +1925,7 @@ export interface LaunchTemplateSpecification {
|
|
|
1919
1925
|
export interface CreateGameServerGroupInput {
|
|
1920
1926
|
/**
|
|
1921
1927
|
* <p>An identifier for the new game server group. This value is used to generate unique ARN
|
|
1922
|
-
* identifiers for the Amazon EC2 Auto Scaling group and the GameLift FleetIQ game server group. The name
|
|
1928
|
+
* identifiers for the Amazon EC2 Auto Scaling group and the Amazon GameLift FleetIQ game server group. The name
|
|
1923
1929
|
* must be unique per Region per Amazon Web Services account.</p>
|
|
1924
1930
|
*/
|
|
1925
1931
|
GameServerGroupName: string | undefined;
|
|
@@ -1930,7 +1936,7 @@ export interface CreateGameServerGroupInput {
|
|
|
1930
1936
|
RoleArn: string | undefined;
|
|
1931
1937
|
/**
|
|
1932
1938
|
* <p>The minimum number of instances allowed in the Amazon EC2 Auto Scaling group. During
|
|
1933
|
-
* automatic scaling events, GameLift FleetIQ and Amazon EC2 do not scale down the group below this
|
|
1939
|
+
* automatic scaling events, Amazon GameLift FleetIQ and Amazon EC2 do not scale down the group below this
|
|
1934
1940
|
* minimum. In production, this value should be set to at least 1. After the Auto Scaling
|
|
1935
1941
|
* group is created, update this value directly in the Auto Scaling group using the Amazon Web Services
|
|
1936
1942
|
* console or APIs.</p>
|
|
@@ -1938,7 +1944,7 @@ export interface CreateGameServerGroupInput {
|
|
|
1938
1944
|
MinSize: number | undefined;
|
|
1939
1945
|
/**
|
|
1940
1946
|
* <p>The maximum number of instances allowed in the Amazon EC2 Auto Scaling group. During
|
|
1941
|
-
* automatic scaling events, GameLift FleetIQ and EC2 do not scale up the group above this maximum.
|
|
1947
|
+
* automatic scaling events, Amazon GameLift FleetIQ and EC2 do not scale up the group above this maximum.
|
|
1942
1948
|
* After the Auto Scaling group is created, update this value directly in the Auto Scaling
|
|
1943
1949
|
* group using the Amazon Web Services console or APIs.</p>
|
|
1944
1950
|
*/
|
|
@@ -1951,18 +1957,18 @@ export interface CreateGameServerGroupInput {
|
|
|
1951
1957
|
* Template for an Auto Scaling Group</a> in the <i>Amazon Elastic Compute Cloud Auto Scaling
|
|
1952
1958
|
* User Guide</i>. After the Auto Scaling group is created, update this value
|
|
1953
1959
|
* directly in the Auto Scaling group using the Amazon Web Services console or APIs.</p>
|
|
1954
|
-
*
|
|
1960
|
+
* <note>
|
|
1955
1961
|
* <p>If you specify network interfaces in your launch template, you must explicitly set
|
|
1956
1962
|
* the property <code>AssociatePublicIpAddress</code> to "true". If no network
|
|
1957
|
-
* interface is specified in the launch template, GameLift FleetIQ uses your account's default
|
|
1963
|
+
* interface is specified in the launch template, Amazon GameLift FleetIQ uses your account's default
|
|
1958
1964
|
* VPC.</p>
|
|
1959
|
-
*
|
|
1965
|
+
* </note>
|
|
1960
1966
|
*/
|
|
1961
1967
|
LaunchTemplate: LaunchTemplateSpecification | undefined;
|
|
1962
1968
|
/**
|
|
1963
1969
|
* <p>The Amazon EC2 instance types and sizes to use in the Auto Scaling group. The instance
|
|
1964
1970
|
* definitions must specify at least two different instance types that are supported by
|
|
1965
|
-
* GameLift FleetIQ. For more information on instance types, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">EC2 Instance Types</a> in the
|
|
1971
|
+
* Amazon GameLift FleetIQ. For more information on instance types, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html">EC2 Instance Types</a> in the
|
|
1966
1972
|
* <i>Amazon Elastic Compute Cloud User Guide</i>. You can optionally specify capacity
|
|
1967
1973
|
* weighting for each instance type. If no weight value is specified for an instance type,
|
|
1968
1974
|
* it is set to the default value "1". For more information about capacity weighting, see
|
|
@@ -1980,9 +1986,9 @@ export interface CreateGameServerGroupInput {
|
|
|
1980
1986
|
*/
|
|
1981
1987
|
AutoScalingPolicy?: GameServerGroupAutoScalingPolicy;
|
|
1982
1988
|
/**
|
|
1983
|
-
* <p>Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the
|
|
1989
|
+
* <p>Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the
|
|
1984
1990
|
* game server group. Method options include the following:</p>
|
|
1985
|
-
*
|
|
1991
|
+
* <ul>
|
|
1986
1992
|
* <li>
|
|
1987
1993
|
* <p>
|
|
1988
1994
|
* <code>SPOT_ONLY</code> - Only Spot Instances are used in the game server group. If Spot
|
|
@@ -1992,7 +1998,7 @@ export interface CreateGameServerGroupInput {
|
|
|
1992
1998
|
* terminated (after current gameplay ends) and are not replaced.</p>
|
|
1993
1999
|
* </li>
|
|
1994
2000
|
* <li>
|
|
1995
|
-
*
|
|
2001
|
+
* <p>
|
|
1996
2002
|
* <code>SPOT_PREFERRED</code> - (default value) Spot Instances are used whenever available in
|
|
1997
2003
|
* the game server group. If Spot Instances are unavailable, the game server group
|
|
1998
2004
|
* continues to provide hosting capacity by falling back to On-Demand Instances.
|
|
@@ -2000,7 +2006,7 @@ export interface CreateGameServerGroupInput {
|
|
|
2000
2006
|
* and are replaced with new On-Demand Instances.</p>
|
|
2001
2007
|
* </li>
|
|
2002
2008
|
* <li>
|
|
2003
|
-
*
|
|
2009
|
+
* <p>
|
|
2004
2010
|
* <code>ON_DEMAND_ONLY</code> - Only On-Demand Instances are used in the game
|
|
2005
2011
|
* server group. No Spot Instances are used, even when available, while this
|
|
2006
2012
|
* balancing strategy is in force.</p>
|
|
@@ -2019,7 +2025,7 @@ export interface CreateGameServerGroupInput {
|
|
|
2019
2025
|
GameServerProtectionPolicy?: GameServerProtectionPolicy | string;
|
|
2020
2026
|
/**
|
|
2021
2027
|
* <p>A list of virtual private cloud (VPC) subnets to use with instances in the game server
|
|
2022
|
-
* group. By default, all GameLift FleetIQ-supported Availability Zones are used. You can use this
|
|
2028
|
+
* group. By default, all Amazon GameLift FleetIQ-supported Availability Zones are used. You can use this
|
|
2023
2029
|
* parameter to specify VPCs that you've set up. This property cannot be updated after the
|
|
2024
2030
|
* game server group is created, and the corresponding Auto Scaling group will always use
|
|
2025
2031
|
* the property value that is set with this request, even if the Auto Scaling group is
|
|
@@ -2065,12 +2071,12 @@ export type GameServerGroupAction = (typeof GameServerGroupAction)[keyof typeof
|
|
|
2065
2071
|
/**
|
|
2066
2072
|
* @public
|
|
2067
2073
|
* <p>
|
|
2068
|
-
* <b>This data type is used with the GameLift FleetIQ and game server groups.</b>
|
|
2074
|
+
* <b>This data type is used with the Amazon GameLift FleetIQ and game server groups.</b>
|
|
2069
2075
|
* </p>
|
|
2070
2076
|
* <p>Properties that describe a game
|
|
2071
2077
|
* server group resource. A game server group manages certain properties related to a
|
|
2072
2078
|
* corresponding Amazon EC2 Auto Scaling group. </p>
|
|
2073
|
-
*
|
|
2079
|
+
* <p>A game server group is created by a successful call to
|
|
2074
2080
|
* <code>CreateGameServerGroup</code> and deleted by calling
|
|
2075
2081
|
* <code>DeleteGameServerGroup</code>. Game server group activity can be temporarily
|
|
2076
2082
|
* suspended and resumed by calling <code>SuspendGameServerGroup</code> and
|
|
@@ -2092,14 +2098,14 @@ export interface GameServerGroup {
|
|
|
2092
2098
|
*/
|
|
2093
2099
|
RoleArn?: string;
|
|
2094
2100
|
/**
|
|
2095
|
-
* <p>The set of Amazon EC2 instance types that GameLift FleetIQ can use when balancing and automatically
|
|
2101
|
+
* <p>The set of Amazon EC2 instance types that Amazon GameLift FleetIQ can use when balancing and automatically
|
|
2096
2102
|
* scaling instances in the corresponding Auto Scaling group. </p>
|
|
2097
2103
|
*/
|
|
2098
2104
|
InstanceDefinitions?: InstanceDefinition[];
|
|
2099
2105
|
/**
|
|
2100
|
-
* <p>Indicates how GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the
|
|
2106
|
+
* <p>Indicates how Amazon GameLift FleetIQ balances the use of Spot Instances and On-Demand Instances in the
|
|
2101
2107
|
* game server group. Method options include the following:</p>
|
|
2102
|
-
*
|
|
2108
|
+
* <ul>
|
|
2103
2109
|
* <li>
|
|
2104
2110
|
* <p>
|
|
2105
2111
|
* <code>SPOT_ONLY</code> - Only Spot Instances are used in the game server group. If Spot
|
|
@@ -2109,7 +2115,7 @@ export interface GameServerGroup {
|
|
|
2109
2115
|
* terminated (after current gameplay ends) and are not replaced.</p>
|
|
2110
2116
|
* </li>
|
|
2111
2117
|
* <li>
|
|
2112
|
-
*
|
|
2118
|
+
* <p>
|
|
2113
2119
|
* <code>SPOT_PREFERRED</code> - (default value) Spot Instances are used whenever available in
|
|
2114
2120
|
* the game server group. If Spot Instances are unavailable, the game server group
|
|
2115
2121
|
* continues to provide hosting capacity by falling back to On-Demand Instances.
|
|
@@ -2117,7 +2123,7 @@ export interface GameServerGroup {
|
|
|
2117
2123
|
* and are replaced with new On-Demand Instances.</p>
|
|
2118
2124
|
* </li>
|
|
2119
2125
|
* <li>
|
|
2120
|
-
*
|
|
2126
|
+
* <p>
|
|
2121
2127
|
* <code>ON_DEMAND_ONLY</code> - Only On-Demand Instances are used in the game
|
|
2122
2128
|
* server group. No Spot Instances are used, even when available, while this
|
|
2123
2129
|
* balancing strategy is in force.</p>
|
|
@@ -2141,41 +2147,41 @@ export interface GameServerGroup {
|
|
|
2141
2147
|
AutoScalingGroupArn?: string;
|
|
2142
2148
|
/**
|
|
2143
2149
|
* <p>The current status of the game server group. Possible statuses include:</p>
|
|
2144
|
-
*
|
|
2150
|
+
* <ul>
|
|
2145
2151
|
* <li>
|
|
2146
|
-
*
|
|
2147
|
-
*
|
|
2152
|
+
* <p>
|
|
2153
|
+
* <code>NEW</code> - Amazon GameLift FleetIQ has validated the <code>CreateGameServerGroup()</code>
|
|
2148
2154
|
* request. </p>
|
|
2149
2155
|
* </li>
|
|
2150
2156
|
* <li>
|
|
2151
|
-
*
|
|
2152
|
-
* <code>ACTIVATING</code> - GameLift FleetIQ is setting up a game server group, which
|
|
2157
|
+
* <p>
|
|
2158
|
+
* <code>ACTIVATING</code> - Amazon GameLift FleetIQ is setting up a game server group, which
|
|
2153
2159
|
* includes creating an Auto Scaling group in your Amazon Web Services account. </p>
|
|
2154
2160
|
* </li>
|
|
2155
2161
|
* <li>
|
|
2156
|
-
*
|
|
2162
|
+
* <p>
|
|
2157
2163
|
* <code>ACTIVE</code> - The game server group has been successfully created.
|
|
2158
2164
|
* </p>
|
|
2159
2165
|
* </li>
|
|
2160
2166
|
* <li>
|
|
2161
|
-
*
|
|
2167
|
+
* <p>
|
|
2162
2168
|
* <code>DELETE_SCHEDULED</code> - A request to delete the game server group has
|
|
2163
2169
|
* been received. </p>
|
|
2164
2170
|
* </li>
|
|
2165
2171
|
* <li>
|
|
2166
|
-
*
|
|
2167
|
-
* <code>DELETING</code> - GameLift FleetIQ has received a valid
|
|
2168
|
-
* <code>DeleteGameServerGroup()</code> request and is processing it. GameLift FleetIQ
|
|
2172
|
+
* <p>
|
|
2173
|
+
* <code>DELETING</code> - Amazon GameLift FleetIQ has received a valid
|
|
2174
|
+
* <code>DeleteGameServerGroup()</code> request and is processing it. Amazon GameLift FleetIQ
|
|
2169
2175
|
* must first complete and release hosts before it deletes the Auto Scaling group
|
|
2170
2176
|
* and the game server group. </p>
|
|
2171
2177
|
* </li>
|
|
2172
2178
|
* <li>
|
|
2173
|
-
*
|
|
2179
|
+
* <p>
|
|
2174
2180
|
* <code>DELETED</code> - The game server group has been successfully deleted.
|
|
2175
2181
|
* </p>
|
|
2176
2182
|
* </li>
|
|
2177
2183
|
* <li>
|
|
2178
|
-
*
|
|
2184
|
+
* <p>
|
|
2179
2185
|
* <code>ERROR</code> - The asynchronous processes of activating or deleting a
|
|
2180
2186
|
* game server group has failed, resulting in an error state.</p>
|
|
2181
2187
|
* </li>
|
|
@@ -2206,7 +2212,7 @@ export interface GameServerGroup {
|
|
|
2206
2212
|
*/
|
|
2207
2213
|
export interface CreateGameServerGroupOutput {
|
|
2208
2214
|
/**
|
|
2209
|
-
* <p>The newly created game server group object, including the new ARN value for the GameLift FleetIQ
|
|
2215
|
+
* <p>The newly created game server group object, including the new ARN value for the Amazon GameLift FleetIQ
|
|
2210
2216
|
* game server group and the object's status. The Amazon EC2 Auto Scaling group ARN is initially
|
|
2211
2217
|
* null, since the group has not yet been created. This value is added once the game server
|
|
2212
2218
|
* group status reaches <code>ACTIVE</code>. </p>
|
|
@@ -2219,7 +2225,7 @@ export interface CreateGameServerGroupOutput {
|
|
|
2219
2225
|
* a game session request, these properties communicate details to be used when setting up
|
|
2220
2226
|
* the new game session. For example, a game property might specify a game mode, level, or
|
|
2221
2227
|
* map. Game properties are passed to the game server process when initiating a new game
|
|
2222
|
-
* session. For more information, see the <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#gamelift-sdk-client-api-create"> GameLift Developer Guide</a>.</p>
|
|
2228
|
+
* session. For more information, see the <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#gamelift-sdk-client-api-create"> Amazon GameLift Developer Guide</a>.</p>
|
|
2223
2229
|
*/
|
|
2224
2230
|
export interface GameProperty {
|
|
2225
2231
|
/**
|
|
@@ -2259,11 +2265,17 @@ export interface CreateGameSessionInput {
|
|
|
2259
2265
|
*/
|
|
2260
2266
|
GameProperties?: GameProperty[];
|
|
2261
2267
|
/**
|
|
2262
|
-
* <p>A unique identifier for a player or entity creating the game session.
|
|
2263
|
-
*
|
|
2264
|
-
*
|
|
2265
|
-
*
|
|
2266
|
-
*
|
|
2268
|
+
* <p>A unique identifier for a player or entity creating the game session. </p>
|
|
2269
|
+
* <p>If you add a resource creation limit policy to a fleet, the
|
|
2270
|
+
* <code>CreateGameSession</code> operation requires a <code>CreatorId</code>. Amazon GameLift
|
|
2271
|
+
* limits the number of game session creation requests with the same <code>CreatorId</code>
|
|
2272
|
+
* in a specified time period.</p>
|
|
2273
|
+
* <p>If you your fleet doesn't have a resource creation limit policy and you provide a
|
|
2274
|
+
* <code>CreatorId</code> in your <code>CreateGameSession</code> requests, Amazon GameLift
|
|
2275
|
+
* limits requests to one request per <code>CreatorId</code> per second.</p>
|
|
2276
|
+
* <p>To not limit <code>CreateGameSession</code> requests with the same
|
|
2277
|
+
* <code>CreatorId</code>, don't provide a <code>CreatorId</code> in your
|
|
2278
|
+
* <code>CreateGameSession</code> request.</p>
|
|
2267
2279
|
*/
|
|
2268
2280
|
CreatorId?: string;
|
|
2269
2281
|
/**
|
|
@@ -2271,7 +2283,7 @@ export interface CreateGameSessionInput {
|
|
|
2271
2283
|
* <i>This parameter is deprecated. Use <code>IdempotencyToken</code>
|
|
2272
2284
|
* instead.</i>
|
|
2273
2285
|
* </p>
|
|
2274
|
-
*
|
|
2286
|
+
* <p>Custom string that uniquely identifies a request for a new game session. Maximum token
|
|
2275
2287
|
* length is 48 characters. If provided, this string is included in the new game session's
|
|
2276
2288
|
* ID.</p>
|
|
2277
2289
|
*/
|
|
@@ -2339,13 +2351,13 @@ export type GameSessionStatusReason = (typeof GameSessionStatusReason)[keyof typ
|
|
|
2339
2351
|
/**
|
|
2340
2352
|
* @public
|
|
2341
2353
|
* <p>Properties describing a game session.</p>
|
|
2342
|
-
*
|
|
2354
|
+
* <p>A game session in ACTIVE status can host players. When a game session ends, its status
|
|
2343
2355
|
* is set to <code>TERMINATED</code>. </p>
|
|
2344
|
-
*
|
|
2356
|
+
* <p>Once the session ends, the game session object is retained for 30 days. This means you
|
|
2345
2357
|
* can reuse idempotency token values after this time. Game session logs are retained for
|
|
2346
2358
|
* 14 days.</p>
|
|
2347
2359
|
* <p>
|
|
2348
|
-
*
|
|
2360
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
2349
2361
|
* </p>
|
|
2350
2362
|
*/
|
|
2351
2363
|
export interface GameSession {
|
|
@@ -2399,7 +2411,7 @@ export interface GameSession {
|
|
|
2399
2411
|
*/
|
|
2400
2412
|
GameProperties?: GameProperty[];
|
|
2401
2413
|
/**
|
|
2402
|
-
* <p>The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.</p>
|
|
2414
|
+
* <p>The IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.</p>
|
|
2403
2415
|
*/
|
|
2404
2416
|
IpAddress?: string;
|
|
2405
2417
|
/**
|
|
@@ -2414,11 +2426,11 @@ export interface GameSession {
|
|
|
2414
2426
|
* <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses">Amazon EC2 Instance IP Addressing</a>.)</p>
|
|
2415
2427
|
* </li>
|
|
2416
2428
|
* </ul>
|
|
2417
|
-
*
|
|
2429
|
+
* <p>When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.</p>
|
|
2418
2430
|
*/
|
|
2419
2431
|
DnsName?: string;
|
|
2420
2432
|
/**
|
|
2421
|
-
* <p>The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number.</p>
|
|
2433
|
+
* <p>The port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.</p>
|
|
2422
2434
|
*/
|
|
2423
2435
|
Port?: number;
|
|
2424
2436
|
/**
|
|
@@ -2571,9 +2583,9 @@ export type PriorityType = (typeof PriorityType)[keyof typeof PriorityType];
|
|
|
2571
2583
|
* <p>Custom prioritization settings for use by a game session queue when placing new game
|
|
2572
2584
|
* sessions with available game servers. When defined, this configuration replaces the
|
|
2573
2585
|
* default FleetIQ prioritization process, which is as follows:</p>
|
|
2574
|
-
*
|
|
2586
|
+
* <ul>
|
|
2575
2587
|
* <li>
|
|
2576
|
-
*
|
|
2588
|
+
* <p>If player latency data is included in a game session request, destinations and
|
|
2577
2589
|
* locations are prioritized first based on lowest average latency (1), then on
|
|
2578
2590
|
* lowest hosting cost (2), then on destination list order (3), and finally on
|
|
2579
2591
|
* location (alphabetical) (4). This approach ensures that the queue's top priority
|
|
@@ -2581,7 +2593,7 @@ export type PriorityType = (typeof PriorityType)[keyof typeof PriorityType];
|
|
|
2581
2593
|
* latency is the same--where the hosting cost is less, etc.</p>
|
|
2582
2594
|
* </li>
|
|
2583
2595
|
* <li>
|
|
2584
|
-
*
|
|
2596
|
+
* <p>If player latency data is not included, destinations and locations are
|
|
2585
2597
|
* prioritized first on destination list order (1), and then on location
|
|
2586
2598
|
* (alphabetical) (2). This approach ensures that the queue's top priority is to
|
|
2587
2599
|
* place game sessions on the first destination fleet listed. If that fleet has
|
|
@@ -2589,31 +2601,31 @@ export type PriorityType = (typeof PriorityType)[keyof typeof PriorityType];
|
|
|
2589
2601
|
* listed alphabetically).</p>
|
|
2590
2602
|
* </li>
|
|
2591
2603
|
* </ul>
|
|
2592
|
-
*
|
|
2604
|
+
* <p>Changing the priority order will affect how game sessions are placed.</p>
|
|
2593
2605
|
*/
|
|
2594
2606
|
export interface PriorityConfiguration {
|
|
2595
2607
|
/**
|
|
2596
2608
|
* <p>The recommended sequence to use when prioritizing where to place new game sessions.
|
|
2597
2609
|
* Each type can only be listed once.</p>
|
|
2598
|
-
*
|
|
2610
|
+
* <ul>
|
|
2599
2611
|
* <li>
|
|
2600
|
-
*
|
|
2612
|
+
* <p>
|
|
2601
2613
|
* <code>LATENCY</code> -- FleetIQ prioritizes locations where the average player
|
|
2602
2614
|
* latency (provided in each game session request) is lowest. </p>
|
|
2603
2615
|
* </li>
|
|
2604
2616
|
* <li>
|
|
2605
|
-
*
|
|
2617
|
+
* <p>
|
|
2606
2618
|
* <code>COST</code> -- FleetIQ prioritizes destinations with the lowest current
|
|
2607
2619
|
* hosting costs. Cost is evaluated based on the location, instance type, and fleet
|
|
2608
2620
|
* type (Spot or On-Demand) for each destination in the queue.</p>
|
|
2609
2621
|
* </li>
|
|
2610
2622
|
* <li>
|
|
2611
|
-
*
|
|
2623
|
+
* <p>
|
|
2612
2624
|
* <code>DESTINATION</code> -- FleetIQ prioritizes based on the order that
|
|
2613
2625
|
* destinations are listed in the queue configuration.</p>
|
|
2614
2626
|
* </li>
|
|
2615
2627
|
* <li>
|
|
2616
|
-
*
|
|
2628
|
+
* <p>
|
|
2617
2629
|
* <code>LOCATION</code> -- FleetIQ prioritizes based on the provided order of
|
|
2618
2630
|
* locations, as defined in <code>LocationOrder</code>. </p>
|
|
2619
2631
|
* </li>
|
|
@@ -2696,7 +2708,7 @@ export interface GameSessionQueue {
|
|
|
2696
2708
|
*/
|
|
2697
2709
|
Name?: string;
|
|
2698
2710
|
/**
|
|
2699
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::gamesessionqueue/<queue name></code>. In a GameLift game session queue ARN, the resource ID matches the
|
|
2711
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::gamesessionqueue/<queue name></code>. In a Amazon GameLift game session queue ARN, the resource ID matches the
|
|
2700
2712
|
* <i>Name</i> value.</p>
|
|
2701
2713
|
*/
|
|
2702
2714
|
GameSessionQueueArn?: string;
|
|
@@ -2776,7 +2788,7 @@ export interface LocationModel {
|
|
|
2776
2788
|
*/
|
|
2777
2789
|
LocationName?: string;
|
|
2778
2790
|
/**
|
|
2779
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a GameLift location resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::location/location-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.</p>
|
|
2791
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift location resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::location/location-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.</p>
|
|
2780
2792
|
*/
|
|
2781
2793
|
LocationArn?: string;
|
|
2782
2794
|
}
|
|
@@ -2815,8 +2827,8 @@ export interface CreateMatchmakingConfigurationInput {
|
|
|
2815
2827
|
*/
|
|
2816
2828
|
Description?: string;
|
|
2817
2829
|
/**
|
|
2818
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::gamesessionqueue/<queue name></code>. Queues can be located in any Region. Queues are used to start new
|
|
2819
|
-
* GameLift-hosted game sessions for matches that are created with this matchmaking
|
|
2830
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::gamesessionqueue/<queue name></code>. Queues can be located in any Region. Queues are used to start new
|
|
2831
|
+
* Amazon GameLift-hosted game sessions for matches that are created with this matchmaking
|
|
2820
2832
|
* configuration. If <code>FlexMatchMode</code> is set to <code>STANDALONE</code>, do not
|
|
2821
2833
|
* set this parameter. </p>
|
|
2822
2834
|
*/
|
|
@@ -2878,25 +2890,25 @@ export interface CreateMatchmakingConfigurationInput {
|
|
|
2878
2890
|
* <p>The method used to backfill game sessions that are created with this matchmaking
|
|
2879
2891
|
* configuration. Specify <code>MANUAL</code> when your game manages backfill requests
|
|
2880
2892
|
* manually or does not use the match backfill feature. Specify <code>AUTOMATIC</code> to
|
|
2881
|
-
* have GameLift create a backfill request whenever a game session has one or more open
|
|
2893
|
+
* have Amazon GameLift create a backfill request whenever a game session has one or more open
|
|
2882
2894
|
* slots. Learn more about manual and automatic backfill in <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html"> Backfill Existing Games
|
|
2883
2895
|
* with FlexMatch</a>. Automatic backfill is not available when
|
|
2884
2896
|
* <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p>
|
|
2885
2897
|
*/
|
|
2886
2898
|
BackfillMode?: BackfillMode | string;
|
|
2887
2899
|
/**
|
|
2888
|
-
* <p>Indicates whether this matchmaking configuration is being used with GameLift hosting or
|
|
2900
|
+
* <p>Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or
|
|
2889
2901
|
* as a standalone matchmaking solution. </p>
|
|
2890
|
-
*
|
|
2902
|
+
* <ul>
|
|
2891
2903
|
* <li>
|
|
2892
|
-
*
|
|
2904
|
+
* <p>
|
|
2893
2905
|
* <b>STANDALONE</b> - FlexMatch forms matches and
|
|
2894
2906
|
* returns match information, including players and team assignments, in a <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded"> MatchmakingSucceeded</a> event.</p>
|
|
2895
2907
|
* </li>
|
|
2896
2908
|
* <li>
|
|
2897
|
-
*
|
|
2909
|
+
* <p>
|
|
2898
2910
|
* <b>WITH_QUEUE</b> - FlexMatch forms matches and uses
|
|
2899
|
-
* the specified GameLift queue to start a game session for the match. </p>
|
|
2911
|
+
* the specified Amazon GameLift queue to start a game session for the match. </p>
|
|
2900
2912
|
* </li>
|
|
2901
2913
|
* </ul>
|
|
2902
2914
|
*/
|
|
@@ -2921,7 +2933,7 @@ export interface MatchmakingConfiguration {
|
|
|
2921
2933
|
*/
|
|
2922
2934
|
Name?: string;
|
|
2923
2935
|
/**
|
|
2924
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a GameLift matchmaking configuration resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::matchmakingconfiguration/<matchmaking configuration name></code>. In a GameLift configuration ARN, the resource ID matches the
|
|
2936
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift matchmaking configuration resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::matchmakingconfiguration/<matchmaking configuration name></code>. In a Amazon GameLift configuration ARN, the resource ID matches the
|
|
2925
2937
|
* <i>Name</i> value.</p>
|
|
2926
2938
|
*/
|
|
2927
2939
|
ConfigurationArn?: string;
|
|
@@ -2930,8 +2942,8 @@ export interface MatchmakingConfiguration {
|
|
|
2930
2942
|
*/
|
|
2931
2943
|
Description?: string;
|
|
2932
2944
|
/**
|
|
2933
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::gamesessionqueue/<queue name></code>. Queues can be located in any Region. Queues are used to start new
|
|
2934
|
-
* GameLift-hosted game sessions for matches that are created with this matchmaking
|
|
2945
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::gamesessionqueue/<queue name></code>. Queues can be located in any Region. Queues are used to start new
|
|
2946
|
+
* Amazon GameLift-hosted game sessions for matches that are created with this matchmaking
|
|
2935
2947
|
* configuration. This property is not set when <code>FlexMatchMode</code> is set to
|
|
2936
2948
|
* <code>STANDALONE</code>.</p>
|
|
2937
2949
|
*/
|
|
@@ -3005,18 +3017,18 @@ export interface MatchmakingConfiguration {
|
|
|
3005
3017
|
*/
|
|
3006
3018
|
BackfillMode?: BackfillMode | string;
|
|
3007
3019
|
/**
|
|
3008
|
-
* <p>Indicates whether this matchmaking configuration is being used with GameLift hosting or
|
|
3020
|
+
* <p>Indicates whether this matchmaking configuration is being used with Amazon GameLift hosting or
|
|
3009
3021
|
* as a standalone matchmaking solution. </p>
|
|
3010
|
-
*
|
|
3022
|
+
* <ul>
|
|
3011
3023
|
* <li>
|
|
3012
|
-
*
|
|
3024
|
+
* <p>
|
|
3013
3025
|
* <b>STANDALONE</b> - FlexMatch forms matches and
|
|
3014
3026
|
* returns match information, including players and team assignments, in a <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded"> MatchmakingSucceeded</a> event.</p>
|
|
3015
3027
|
* </li>
|
|
3016
3028
|
* <li>
|
|
3017
|
-
*
|
|
3029
|
+
* <p>
|
|
3018
3030
|
* <b>WITH_QUEUE</b> - FlexMatch forms matches and uses
|
|
3019
|
-
* the specified GameLift queue to start a game session for the match. </p>
|
|
3031
|
+
* the specified Amazon GameLift queue to start a game session for the match. </p>
|
|
3020
3032
|
* </li>
|
|
3021
3033
|
* </ul>
|
|
3022
3034
|
*/
|
|
@@ -3059,24 +3071,24 @@ export interface CreateMatchmakingRuleSetInput {
|
|
|
3059
3071
|
* <p>Set of rule statements, used with FlexMatch, that determine how to build your player
|
|
3060
3072
|
* matches. Each rule set describes a type of group to be created and defines the
|
|
3061
3073
|
* parameters for acceptable player matches.</p>
|
|
3062
|
-
*
|
|
3074
|
+
* <p>A rule set may define the following elements for a match. For detailed information and
|
|
3063
3075
|
* examples showing how to construct a rule set, see <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html">Build a FlexMatch rule
|
|
3064
3076
|
* set</a>. </p>
|
|
3065
|
-
*
|
|
3077
|
+
* <ul>
|
|
3066
3078
|
* <li>
|
|
3067
|
-
*
|
|
3079
|
+
* <p>Teams -- Required. A rule set must define one or multiple teams for the match
|
|
3068
3080
|
* and set minimum and maximum team sizes. For example, a rule set might describe a
|
|
3069
3081
|
* 4x4 match that requires all eight slots to be filled. </p>
|
|
3070
3082
|
* </li>
|
|
3071
3083
|
* <li>
|
|
3072
|
-
*
|
|
3084
|
+
* <p>Player attributes -- Optional. These attributes specify a set of player
|
|
3073
3085
|
* characteristics to evaluate when looking for a match. Matchmaking requests that
|
|
3074
3086
|
* use a rule set with player attributes must provide the corresponding attribute
|
|
3075
3087
|
* values. For example, an attribute might specify a player's skill or
|
|
3076
3088
|
* level.</p>
|
|
3077
3089
|
* </li>
|
|
3078
3090
|
* <li>
|
|
3079
|
-
*
|
|
3091
|
+
* <p>Rules -- Optional. Rules define how to evaluate potential players for a match
|
|
3080
3092
|
* based on player attributes. A rule might specify minimum requirements for
|
|
3081
3093
|
* individual players, teams, or entire matches. For example, a rule might require
|
|
3082
3094
|
* each player to meet a certain skill level, each team to have at least one player
|
|
@@ -3085,7 +3097,7 @@ export interface CreateMatchmakingRuleSetInput {
|
|
|
3085
3097
|
* least one player in a certain role. </p>
|
|
3086
3098
|
* </li>
|
|
3087
3099
|
* <li>
|
|
3088
|
-
*
|
|
3100
|
+
* <p>Expansions -- Optional. Expansions allow you to relax the rules after a period
|
|
3089
3101
|
* of time when no acceptable matches are found. This feature lets you balance
|
|
3090
3102
|
* getting players into games in a reasonable amount of time instead of making them
|
|
3091
3103
|
* wait indefinitely for the best possible match. For example, you might use an
|
|
@@ -3100,7 +3112,7 @@ export interface MatchmakingRuleSet {
|
|
|
3100
3112
|
*/
|
|
3101
3113
|
RuleSetName?: string;
|
|
3102
3114
|
/**
|
|
3103
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a GameLift matchmaking rule set resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::matchmakingruleset/<ruleset name></code>. In a GameLift rule set ARN, the resource ID matches the
|
|
3115
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift matchmaking rule set resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::matchmakingruleset/<ruleset name></code>. In a GameLift rule set ARN, the resource ID matches the
|
|
3104
3116
|
* <i>RuleSetName</i> value.</p>
|
|
3105
3117
|
*/
|
|
3106
3118
|
RuleSetArn?: string;
|
|
@@ -3136,7 +3148,7 @@ export interface CreatePlayerSessionInput {
|
|
|
3136
3148
|
*/
|
|
3137
3149
|
PlayerId: string | undefined;
|
|
3138
3150
|
/**
|
|
3139
|
-
* <p>Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as needed for use in the game.</p>
|
|
3151
|
+
* <p>Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.</p>
|
|
3140
3152
|
*/
|
|
3141
3153
|
PlayerData?: string;
|
|
3142
3154
|
}
|
|
@@ -3167,8 +3179,8 @@ export type PlayerSessionStatus = (typeof PlayerSessionStatus)[keyof typeof Play
|
|
|
3167
3179
|
* <p>
|
|
3168
3180
|
* <b>Related actions</b>
|
|
3169
3181
|
* </p>
|
|
3170
|
-
*
|
|
3171
|
-
*
|
|
3182
|
+
* <p>
|
|
3183
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
3172
3184
|
* </p>
|
|
3173
3185
|
*/
|
|
3174
3186
|
export interface PlayerSession {
|
|
@@ -3203,27 +3215,27 @@ export interface PlayerSession {
|
|
|
3203
3215
|
TerminationTime?: Date;
|
|
3204
3216
|
/**
|
|
3205
3217
|
* <p>Current status of the player session.</p>
|
|
3206
|
-
*
|
|
3207
|
-
*
|
|
3218
|
+
* <p>Possible player session statuses include the following:</p>
|
|
3219
|
+
* <ul>
|
|
3208
3220
|
* <li>
|
|
3209
|
-
*
|
|
3210
|
-
*
|
|
3221
|
+
* <p>
|
|
3222
|
+
* <b>RESERVED</b> -- The player session request has been
|
|
3211
3223
|
* received, but the player has not yet connected to the server process and/or been
|
|
3212
3224
|
* validated. </p>
|
|
3213
3225
|
* </li>
|
|
3214
3226
|
* <li>
|
|
3215
|
-
*
|
|
3216
|
-
*
|
|
3227
|
+
* <p>
|
|
3228
|
+
* <b>ACTIVE</b> -- The player has been validated by the
|
|
3217
3229
|
* server process and is currently connected.</p>
|
|
3218
3230
|
* </li>
|
|
3219
3231
|
* <li>
|
|
3220
|
-
*
|
|
3221
|
-
*
|
|
3232
|
+
* <p>
|
|
3233
|
+
* <b>COMPLETED</b> -- The player connection has been
|
|
3222
3234
|
* dropped.</p>
|
|
3223
3235
|
* </li>
|
|
3224
3236
|
* <li>
|
|
3225
|
-
*
|
|
3226
|
-
*
|
|
3237
|
+
* <p>
|
|
3238
|
+
* <b>TIMEDOUT</b> -- A player session request was
|
|
3227
3239
|
* received, but the player did not connect and/or was not validated within the
|
|
3228
3240
|
* timeout limit (60 seconds).</p>
|
|
3229
3241
|
* </li>
|
|
@@ -3231,7 +3243,7 @@ export interface PlayerSession {
|
|
|
3231
3243
|
*/
|
|
3232
3244
|
Status?: PlayerSessionStatus | string;
|
|
3233
3245
|
/**
|
|
3234
|
-
* <p>The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.</p>
|
|
3246
|
+
* <p>The IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.</p>
|
|
3235
3247
|
*/
|
|
3236
3248
|
IpAddress?: string;
|
|
3237
3249
|
/**
|
|
@@ -3246,7 +3258,7 @@ export interface PlayerSession {
|
|
|
3246
3258
|
* <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses">Amazon EC2 Instance IP Addressing</a>.)</p>
|
|
3247
3259
|
* </li>
|
|
3248
3260
|
* </ul>
|
|
3249
|
-
*
|
|
3261
|
+
* <p>When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.</p>
|
|
3250
3262
|
*/
|
|
3251
3263
|
DnsName?: string;
|
|
3252
3264
|
/**
|
|
@@ -3255,7 +3267,7 @@ export interface PlayerSession {
|
|
|
3255
3267
|
*/
|
|
3256
3268
|
Port?: number;
|
|
3257
3269
|
/**
|
|
3258
|
-
* <p>Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as needed for use in the game. </p>
|
|
3270
|
+
* <p>Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game. </p>
|
|
3259
3271
|
*/
|
|
3260
3272
|
PlayerData?: string;
|
|
3261
3273
|
}
|
|
@@ -3331,12 +3343,12 @@ export interface CreatePlayerSessionsOutput {
|
|
|
3331
3343
|
*/
|
|
3332
3344
|
export interface CreateScriptInput {
|
|
3333
3345
|
/**
|
|
3334
|
-
* <p>A descriptive label that is associated with a script. Script names
|
|
3346
|
+
* <p>A descriptive label that is associated with a script. Script names don't need to be unique. You can use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateScript.html">UpdateScript</a> to
|
|
3335
3347
|
* change this value later. </p>
|
|
3336
3348
|
*/
|
|
3337
3349
|
Name?: string;
|
|
3338
3350
|
/**
|
|
3339
|
-
* <p>Version information associated with a build or script. Version strings
|
|
3351
|
+
* <p>Version information associated with a build or script. Version strings don't need to be unique. You can use <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateScript.html">UpdateScript</a> to
|
|
3340
3352
|
* change this value later. </p>
|
|
3341
3353
|
*/
|
|
3342
3354
|
Version?: string;
|
|
@@ -3353,7 +3365,7 @@ export interface CreateScriptInput {
|
|
|
3353
3365
|
/**
|
|
3354
3366
|
* <p>A data object containing your Realtime scripts and dependencies as a zip file. The zip
|
|
3355
3367
|
* file can have one or multiple files. Maximum size of a zip file is 5 MB.</p>
|
|
3356
|
-
*
|
|
3368
|
+
* <p>When using the Amazon Web Services CLI tool to create a script, this parameter is set to the zip
|
|
3357
3369
|
* file name. It must be prepended with the string "fileb://" to indicate that the file
|
|
3358
3370
|
* data is a binary object. For example: <code>--zip-file
|
|
3359
3371
|
* fileb://myRealtimeScript.zip</code>.</p>
|
|
@@ -3377,8 +3389,8 @@ export interface CreateScriptInput {
|
|
|
3377
3389
|
* <p>
|
|
3378
3390
|
* <b>Related actions</b>
|
|
3379
3391
|
* </p>
|
|
3380
|
-
*
|
|
3381
|
-
*
|
|
3392
|
+
* <p>
|
|
3393
|
+
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
3382
3394
|
* </p>
|
|
3383
3395
|
*/
|
|
3384
3396
|
export interface Script {
|
|
@@ -3387,16 +3399,16 @@ export interface Script {
|
|
|
3387
3399
|
*/
|
|
3388
3400
|
ScriptId?: string;
|
|
3389
3401
|
/**
|
|
3390
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the
|
|
3402
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift script resource and uniquely identifies it. ARNs are unique across all Regions. In a GameLift script ARN, the resource ID matches the
|
|
3391
3403
|
* <i>ScriptId</i> value.</p>
|
|
3392
3404
|
*/
|
|
3393
3405
|
ScriptArn?: string;
|
|
3394
3406
|
/**
|
|
3395
|
-
* <p>A descriptive label that is associated with a script. Script names
|
|
3407
|
+
* <p>A descriptive label that is associated with a script. Script names don't need to be unique.</p>
|
|
3396
3408
|
*/
|
|
3397
3409
|
Name?: string;
|
|
3398
3410
|
/**
|
|
3399
|
-
* <p>Version information associated with a build or script. Version strings
|
|
3411
|
+
* <p>Version information associated with a build or script. Version strings don't need to be unique.</p>
|
|
3400
3412
|
*/
|
|
3401
3413
|
Version?: string;
|
|
3402
3414
|
/**
|
|
@@ -3438,15 +3450,15 @@ export interface CreateScriptOutput {
|
|
|
3438
3450
|
*/
|
|
3439
3451
|
export interface CreateVpcPeeringAuthorizationInput {
|
|
3440
3452
|
/**
|
|
3441
|
-
* <p>A unique identifier for the Amazon Web Services account that you use to manage your GameLift fleet.
|
|
3453
|
+
* <p>A unique identifier for the Amazon Web Services account that you use to manage your Amazon GameLift fleet.
|
|
3442
3454
|
* You can find your Account ID in the Amazon Web Services Management Console under account settings.</p>
|
|
3443
3455
|
*/
|
|
3444
3456
|
GameLiftAwsAccountId: string | undefined;
|
|
3445
3457
|
/**
|
|
3446
|
-
* <p>A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The
|
|
3458
|
+
* <p>A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The
|
|
3447
3459
|
* VPC must be in the same Region as your fleet. To look up a VPC ID, use the
|
|
3448
3460
|
* <a href="https://console.aws.amazon.com/vpc/">VPC Dashboard</a> in the Amazon Web Services Management Console.
|
|
3449
|
-
* Learn more about VPC peering in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with GameLift Fleets</a>.</p>
|
|
3461
|
+
* Learn more about VPC peering in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with Amazon GameLift Fleets</a>.</p>
|
|
3450
3462
|
*/
|
|
3451
3463
|
PeerVpcId: string | undefined;
|
|
3452
3464
|
}
|
|
@@ -3456,16 +3468,16 @@ export interface CreateVpcPeeringAuthorizationInput {
|
|
|
3456
3468
|
* Amazon GameLift fleet and another VPC on an account you have access to. This authorization
|
|
3457
3469
|
* must exist and be valid for the peering connection to be established. Authorizations are
|
|
3458
3470
|
* valid for 24 hours after they are issued.</p>
|
|
3459
|
-
*
|
|
3471
|
+
* <p>
|
|
3460
3472
|
* <b>Related actions</b>
|
|
3461
3473
|
* </p>
|
|
3462
|
-
*
|
|
3474
|
+
* <p>
|
|
3463
3475
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
3464
3476
|
* </p>
|
|
3465
3477
|
*/
|
|
3466
3478
|
export interface VpcPeeringAuthorization {
|
|
3467
3479
|
/**
|
|
3468
|
-
* <p>A unique identifier for the Amazon Web Services account that you use to manage your GameLift fleet.
|
|
3480
|
+
* <p>A unique identifier for the Amazon Web Services account that you use to manage your Amazon GameLift fleet.
|
|
3469
3481
|
* You can find your Account ID in the Amazon Web Services Management Console under account settings.</p>
|
|
3470
3482
|
*/
|
|
3471
3483
|
GameLiftAwsAccountId?: string;
|
|
@@ -3474,10 +3486,10 @@ export interface VpcPeeringAuthorization {
|
|
|
3474
3486
|
*/
|
|
3475
3487
|
PeerVpcAwsAccountId?: string;
|
|
3476
3488
|
/**
|
|
3477
|
-
* <p>A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The
|
|
3489
|
+
* <p>A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The
|
|
3478
3490
|
* VPC must be in the same Region as your fleet. To look up a VPC ID, use the
|
|
3479
3491
|
* <a href="https://console.aws.amazon.com/vpc/">VPC Dashboard</a> in the Amazon Web Services Management Console.
|
|
3480
|
-
* Learn more about VPC peering in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with GameLift Fleets</a>.</p>
|
|
3492
|
+
* Learn more about VPC peering in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with Amazon GameLift Fleets</a>.</p>
|
|
3481
3493
|
*/
|
|
3482
3494
|
PeerVpcId?: string;
|
|
3483
3495
|
/**
|
|
@@ -3515,10 +3527,10 @@ export interface CreateVpcPeeringConnectionInput {
|
|
|
3515
3527
|
*/
|
|
3516
3528
|
PeerVpcAwsAccountId: string | undefined;
|
|
3517
3529
|
/**
|
|
3518
|
-
* <p>A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The
|
|
3530
|
+
* <p>A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The
|
|
3519
3531
|
* VPC must be in the same Region as your fleet. To look up a VPC ID, use the
|
|
3520
3532
|
* <a href="https://console.aws.amazon.com/vpc/">VPC Dashboard</a> in the Amazon Web Services Management Console.
|
|
3521
|
-
* Learn more about VPC peering in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with GameLift Fleets</a>.</p>
|
|
3533
|
+
* Learn more about VPC peering in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with Amazon GameLift Fleets</a>.</p>
|
|
3522
3534
|
*/
|
|
3523
3535
|
PeerVpcId: string | undefined;
|
|
3524
3536
|
}
|
|
@@ -3578,7 +3590,7 @@ export interface DeleteFleetLocationsOutput {
|
|
|
3578
3590
|
*/
|
|
3579
3591
|
FleetId?: string;
|
|
3580
3592
|
/**
|
|
3581
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.</p>
|
|
3593
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.</p>
|
|
3582
3594
|
*/
|
|
3583
3595
|
FleetArn?: string;
|
|
3584
3596
|
/**
|
|
@@ -3610,21 +3622,21 @@ export interface DeleteGameServerGroupInput {
|
|
|
3610
3622
|
GameServerGroupName: string | undefined;
|
|
3611
3623
|
/**
|
|
3612
3624
|
* <p>The type of delete to perform. Options include the following:</p>
|
|
3613
|
-
*
|
|
3625
|
+
* <ul>
|
|
3614
3626
|
* <li>
|
|
3615
|
-
*
|
|
3627
|
+
* <p>
|
|
3616
3628
|
* <code>SAFE_DELETE</code> – (default) Terminates the game server group and
|
|
3617
3629
|
* Amazon EC2 Auto Scaling group only when it has no game servers that are in
|
|
3618
3630
|
* <code>UTILIZED</code> status.</p>
|
|
3619
3631
|
* </li>
|
|
3620
3632
|
* <li>
|
|
3621
|
-
*
|
|
3633
|
+
* <p>
|
|
3622
3634
|
* <code>FORCE_DELETE</code> – Terminates the game server group, including all
|
|
3623
3635
|
* active game servers regardless of their utilization status, and the Amazon EC2 Auto
|
|
3624
3636
|
* Scaling group. </p>
|
|
3625
3637
|
* </li>
|
|
3626
3638
|
* <li>
|
|
3627
|
-
*
|
|
3639
|
+
* <p>
|
|
3628
3640
|
* <code>RETAIN</code> – Does a safe delete of the game server group but retains
|
|
3629
3641
|
* the Amazon EC2 Auto Scaling group as is.</p>
|
|
3630
3642
|
* </li>
|
|
@@ -3726,15 +3738,15 @@ export interface DeleteScriptInput {
|
|
|
3726
3738
|
*/
|
|
3727
3739
|
export interface DeleteVpcPeeringAuthorizationInput {
|
|
3728
3740
|
/**
|
|
3729
|
-
* <p>A unique identifier for the Amazon Web Services account that you use to manage your GameLift fleet.
|
|
3741
|
+
* <p>A unique identifier for the Amazon Web Services account that you use to manage your Amazon GameLift fleet.
|
|
3730
3742
|
* You can find your Account ID in the Amazon Web Services Management Console under account settings.</p>
|
|
3731
3743
|
*/
|
|
3732
3744
|
GameLiftAwsAccountId: string | undefined;
|
|
3733
3745
|
/**
|
|
3734
|
-
* <p>A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The
|
|
3746
|
+
* <p>A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The
|
|
3735
3747
|
* VPC must be in the same Region as your fleet. To look up a VPC ID, use the
|
|
3736
3748
|
* <a href="https://console.aws.amazon.com/vpc/">VPC Dashboard</a> in the Amazon Web Services Management Console.
|
|
3737
|
-
* Learn more about VPC peering in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with GameLift Fleets</a>.</p>
|
|
3749
|
+
* Learn more about VPC peering in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with Amazon GameLift Fleets</a>.</p>
|
|
3738
3750
|
*/
|
|
3739
3751
|
PeerVpcId: string | undefined;
|
|
3740
3752
|
}
|
|
@@ -3858,7 +3870,7 @@ export interface DescribeComputeOutput {
|
|
|
3858
3870
|
*/
|
|
3859
3871
|
export interface DescribeEC2InstanceLimitsInput {
|
|
3860
3872
|
/**
|
|
3861
|
-
* <p>Name of an Amazon EC2 instance type that is supported in GameLift. A fleet instance type
|
|
3873
|
+
* <p>Name of an Amazon EC2 instance type that is supported in Amazon GameLift. A fleet instance type
|
|
3862
3874
|
* determines the computing resources of each instance in the fleet, including CPU, memory,
|
|
3863
3875
|
* storage, and networking capacity. Do not specify a value for this parameter to retrieve
|
|
3864
3876
|
* limits for all instance types.</p>
|
|
@@ -3872,10 +3884,10 @@ export interface DescribeEC2InstanceLimitsInput {
|
|
|
3872
3884
|
}
|
|
3873
3885
|
/**
|
|
3874
3886
|
* @public
|
|
3875
|
-
* <p>The GameLift service limits for an Amazon EC2 instance type and current utilization. GameLift
|
|
3887
|
+
* <p>The Amazon GameLift service limits for an Amazon EC2 instance type and current utilization. Amazon GameLift
|
|
3876
3888
|
* allows Amazon Web Services accounts a maximum number of instances, per instance type, per Amazon Web Services Region
|
|
3877
|
-
* or location, for use with GameLift. You can request an limit increase for your account by
|
|
3878
|
-
* using the <b>Service limits</b> page in the GameLift
|
|
3889
|
+
* or location, for use with Amazon GameLift. You can request an limit increase for your account by
|
|
3890
|
+
* using the <b>Service limits</b> page in the Amazon GameLift
|
|
3879
3891
|
* console.</p>
|
|
3880
3892
|
*/
|
|
3881
3893
|
export interface EC2InstanceLimit {
|
|
@@ -4011,7 +4023,7 @@ export interface EC2InstanceCounts {
|
|
|
4011
4023
|
* </p>
|
|
4012
4024
|
* <p>
|
|
4013
4025
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html">DescribeFleetCapacity</a> | <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html">DescribeFleetLocationCapacity</a> | <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html">UpdateFleetCapacity</a>
|
|
4014
|
-
*
|
|
4026
|
+
* </p>
|
|
4015
4027
|
*/
|
|
4016
4028
|
export interface FleetCapacity {
|
|
4017
4029
|
/**
|
|
@@ -4019,7 +4031,7 @@ export interface FleetCapacity {
|
|
|
4019
4031
|
*/
|
|
4020
4032
|
FleetId?: string;
|
|
4021
4033
|
/**
|
|
4022
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.</p>
|
|
4034
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.</p>
|
|
4023
4035
|
*/
|
|
4024
4036
|
FleetArn?: string;
|
|
4025
4037
|
/**
|
|
@@ -4130,7 +4142,7 @@ export declare const EventCode: {
|
|
|
4130
4142
|
export type EventCode = (typeof EventCode)[keyof typeof EventCode];
|
|
4131
4143
|
/**
|
|
4132
4144
|
* @public
|
|
4133
|
-
* <p>Log entry describing an event that involves GameLift resources (such as a fleet). In
|
|
4145
|
+
* <p>Log entry describing an event that involves Amazon GameLift resources (such as a fleet). In
|
|
4134
4146
|
* addition to tracking activity, event codes and messages can provide additional
|
|
4135
4147
|
* information for troubleshooting and debugging problems.</p>
|
|
4136
4148
|
*/
|
|
@@ -4145,59 +4157,55 @@ export interface Event {
|
|
|
4145
4157
|
ResourceId?: string;
|
|
4146
4158
|
/**
|
|
4147
4159
|
* <p>The type of event being logged. </p>
|
|
4148
|
-
*
|
|
4149
|
-
*
|
|
4150
|
-
* <p>
|
|
4160
|
+
* <p>
|
|
4151
4161
|
* <b>Fleet state transition events:</b>
|
|
4152
4162
|
* </p>
|
|
4153
|
-
*
|
|
4163
|
+
* <ul>
|
|
4154
4164
|
* <li>
|
|
4155
|
-
*
|
|
4165
|
+
* <p>FLEET_CREATED -- A fleet resource was successfully created with a status of
|
|
4156
4166
|
* <code>NEW</code>. Event messaging includes the fleet ID.</p>
|
|
4157
4167
|
* </li>
|
|
4158
4168
|
* <li>
|
|
4159
|
-
*
|
|
4169
|
+
* <p>FLEET_STATE_DOWNLOADING -- Fleet status changed from <code>NEW</code> to
|
|
4160
4170
|
* <code>DOWNLOADING</code>. The compressed build has started downloading to a
|
|
4161
4171
|
* fleet instance for installation.</p>
|
|
4162
4172
|
* </li>
|
|
4163
4173
|
* <li>
|
|
4164
|
-
*
|
|
4165
|
-
* to <code>VALIDATING</code>. GameLift has successfully downloaded the build and is
|
|
4174
|
+
* <p>FLEET_STATE_VALIDATING -- Fleet status changed from <code>DOWNLOADING</code>
|
|
4175
|
+
* to <code>VALIDATING</code>. Amazon GameLift has successfully downloaded the build and is
|
|
4166
4176
|
* now validating the build files.</p>
|
|
4167
4177
|
* </li>
|
|
4168
4178
|
* <li>
|
|
4169
|
-
*
|
|
4170
|
-
* <code>BUILDING</code>. GameLift has successfully verified the build files and
|
|
4179
|
+
* <p>FLEET_STATE_BUILDING -- Fleet status changed from <code>VALIDATING</code> to
|
|
4180
|
+
* <code>BUILDING</code>. Amazon GameLift has successfully verified the build files and
|
|
4171
4181
|
* is now running the installation scripts.</p>
|
|
4172
4182
|
* </li>
|
|
4173
4183
|
* <li>
|
|
4174
|
-
*
|
|
4175
|
-
* <code>ACTIVATING</code>. GameLift is trying to launch an instance and test
|
|
4176
|
-
* the connectivity between the build and the GameLift Service via the Server
|
|
4184
|
+
* <p>FLEET_STATE_ACTIVATING -- Fleet status changed from <code>BUILDING</code> to
|
|
4185
|
+
* <code>ACTIVATING</code>. Amazon GameLift is trying to launch an instance and test
|
|
4186
|
+
* the connectivity between the build and the Amazon GameLift Service via the Server
|
|
4177
4187
|
* SDK.</p>
|
|
4178
4188
|
* </li>
|
|
4179
4189
|
* <li>
|
|
4180
|
-
*
|
|
4190
|
+
* <p>FLEET_STATE_ACTIVE -- The fleet's status changed from <code>ACTIVATING</code>
|
|
4181
4191
|
* to <code>ACTIVE</code>. The fleet is now ready to host game sessions.</p>
|
|
4182
4192
|
* </li>
|
|
4183
4193
|
* <li>
|
|
4184
|
-
*
|
|
4194
|
+
* <p>FLEET_STATE_ERROR -- The Fleet's status changed to <code>ERROR</code>.
|
|
4185
4195
|
* Describe the fleet event message for more details.</p>
|
|
4186
4196
|
* </li>
|
|
4187
4197
|
* </ul>
|
|
4188
|
-
*
|
|
4189
|
-
*
|
|
4190
|
-
* <p>
|
|
4198
|
+
* <p>
|
|
4191
4199
|
* <b>Fleet creation events (ordered by fleet creation
|
|
4192
4200
|
* activity):</b>
|
|
4193
4201
|
* </p>
|
|
4194
|
-
*
|
|
4202
|
+
* <ul>
|
|
4195
4203
|
* <li>
|
|
4196
|
-
*
|
|
4204
|
+
* <p>FLEET_BINARY_DOWNLOAD_FAILED -- The build failed to download to the fleet
|
|
4197
4205
|
* instance.</p>
|
|
4198
4206
|
* </li>
|
|
4199
4207
|
* <li>
|
|
4200
|
-
*
|
|
4208
|
+
* <p>FLEET_CREATION_EXTRACTING_BUILD -- The game server build was successfully
|
|
4201
4209
|
* downloaded to an instance, and the build files are now being extracted from the
|
|
4202
4210
|
* uploaded build and saved to an instance. Failure at this stage prevents a fleet
|
|
4203
4211
|
* from moving to ACTIVE status. Logs for this stage display a list of the files
|
|
@@ -4205,7 +4213,7 @@ export interface Event {
|
|
|
4205
4213
|
* in <i>PreSignedLogUrl</i>.</p>
|
|
4206
4214
|
* </li>
|
|
4207
4215
|
* <li>
|
|
4208
|
-
*
|
|
4216
|
+
* <p>FLEET_CREATION_RUNNING_INSTALLER -- The game server build files were
|
|
4209
4217
|
* successfully extracted, and the GameLift is now running the build's install
|
|
4210
4218
|
* script (if one is included). Failure in this stage prevents a fleet from moving
|
|
4211
4219
|
* to ACTIVE status. Logs for this stage list the installation steps and whether or
|
|
@@ -4213,59 +4221,57 @@ export interface Event {
|
|
|
4213
4221
|
* <i>PreSignedLogUrl</i>.</p>
|
|
4214
4222
|
* </li>
|
|
4215
4223
|
* <li>
|
|
4216
|
-
*
|
|
4224
|
+
* <p>FLEET_CREATION_VALIDATING_RUNTIME_CONFIG -- The build process was successful,
|
|
4217
4225
|
* and the GameLift is now verifying that the game server launch paths, which are
|
|
4218
4226
|
* specified in the fleet's runtime configuration, exist. If any listed launch path
|
|
4219
|
-
* exists, GameLift tries to launch a game server process and waits for the process
|
|
4227
|
+
* exists, Amazon GameLift tries to launch a game server process and waits for the process
|
|
4220
4228
|
* to report ready. Failures in this stage prevent a fleet from moving to
|
|
4221
4229
|
* <code>ACTIVE</code> status. Logs for this stage list the launch paths in the
|
|
4222
4230
|
* runtime configuration and indicate whether each is found. Access the logs by
|
|
4223
4231
|
* using the URL in <i>PreSignedLogUrl</i>.</p>
|
|
4224
4232
|
* </li>
|
|
4225
4233
|
* <li>
|
|
4226
|
-
*
|
|
4234
|
+
* <p>FLEET_VALIDATION_LAUNCH_PATH_NOT_FOUND -- Validation of the runtime
|
|
4227
4235
|
* configuration failed because the executable specified in a launch path does not
|
|
4228
4236
|
* exist on the instance.</p>
|
|
4229
4237
|
* </li>
|
|
4230
4238
|
* <li>
|
|
4231
|
-
*
|
|
4239
|
+
* <p>FLEET_VALIDATION_EXECUTABLE_RUNTIME_FAILURE -- Validation of the runtime
|
|
4232
4240
|
* configuration failed because the executable specified in a launch path failed to
|
|
4233
4241
|
* run on the fleet instance.</p>
|
|
4234
4242
|
* </li>
|
|
4235
4243
|
* <li>
|
|
4236
|
-
*
|
|
4244
|
+
* <p>FLEET_VALIDATION_TIMED_OUT -- Validation of the fleet at the end of creation
|
|
4237
4245
|
* timed out. Try fleet creation again.</p>
|
|
4238
4246
|
* </li>
|
|
4239
4247
|
* <li>
|
|
4240
|
-
*
|
|
4248
|
+
* <p>FLEET_ACTIVATION_FAILED -- The fleet failed to successfully complete one of
|
|
4241
4249
|
* the steps in the fleet activation process. This event code indicates that the
|
|
4242
4250
|
* game build was successfully downloaded to a fleet instance, built, and
|
|
4243
4251
|
* validated, but was not able to start a server process. For more information, see
|
|
4244
4252
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html#fleets-creating-debug-creation">Debug Fleet Creation Issues</a>.</p>
|
|
4245
4253
|
* </li>
|
|
4246
4254
|
* <li>
|
|
4247
|
-
*
|
|
4255
|
+
* <p>FLEET_ACTIVATION_FAILED_NO_INSTANCES -- Fleet creation was not able to obtain
|
|
4248
4256
|
* any instances based on the input fleet attributes. Try again at a different time
|
|
4249
4257
|
* or choose a different combination of fleet attributes such as fleet type,
|
|
4250
4258
|
* instance type, etc.</p>
|
|
4251
4259
|
* </li>
|
|
4252
4260
|
* <li>
|
|
4253
|
-
*
|
|
4261
|
+
* <p>FLEET_INITIALIZATION_FAILED -- A generic exception occurred during fleet
|
|
4254
4262
|
* creation. Describe the fleet event message for more details.</p>
|
|
4255
4263
|
* </li>
|
|
4256
4264
|
* </ul>
|
|
4257
|
-
*
|
|
4258
|
-
*
|
|
4259
|
-
* <p>
|
|
4265
|
+
* <p>
|
|
4260
4266
|
* <b>VPC peering events:</b>
|
|
4261
4267
|
* </p>
|
|
4262
|
-
*
|
|
4268
|
+
* <ul>
|
|
4263
4269
|
* <li>
|
|
4264
|
-
*
|
|
4265
|
-
* between the VPC for an GameLift fleet and a VPC in your Amazon Web Services account.</p>
|
|
4270
|
+
* <p>FLEET_VPC_PEERING_SUCCEEDED -- A VPC peering connection has been established
|
|
4271
|
+
* between the VPC for an Amazon GameLift fleet and a VPC in your Amazon Web Services account.</p>
|
|
4266
4272
|
* </li>
|
|
4267
4273
|
* <li>
|
|
4268
|
-
*
|
|
4274
|
+
* <p>FLEET_VPC_PEERING_FAILED -- A requested VPC peering connection has failed.
|
|
4269
4275
|
* Event details and status information provide additional detail. A common reason
|
|
4270
4276
|
* for peering failure is that the two VPCs have overlapping CIDR blocks of IPv4
|
|
4271
4277
|
* addresses. To resolve this, change the CIDR block for the VPC in your Amazon Web Services
|
|
@@ -4273,97 +4279,89 @@ export interface Event {
|
|
|
4273
4279
|
* </p>
|
|
4274
4280
|
* </li>
|
|
4275
4281
|
* <li>
|
|
4276
|
-
*
|
|
4282
|
+
* <p>FLEET_VPC_PEERING_DELETED -- A VPC peering connection has been successfully
|
|
4277
4283
|
* deleted.</p>
|
|
4278
4284
|
* </li>
|
|
4279
4285
|
* </ul>
|
|
4280
|
-
*
|
|
4281
|
-
*
|
|
4282
|
-
* <p>
|
|
4286
|
+
* <p>
|
|
4283
4287
|
* <b>Spot instance events:</b>
|
|
4284
4288
|
* </p>
|
|
4285
|
-
*
|
|
4289
|
+
* <ul>
|
|
4286
4290
|
* <li>
|
|
4287
|
-
*
|
|
4291
|
+
* <p> INSTANCE_INTERRUPTED -- A spot instance was interrupted by EC2 with a
|
|
4288
4292
|
* two-minute notification.</p>
|
|
4289
4293
|
* </li>
|
|
4290
4294
|
* </ul>
|
|
4291
|
-
*
|
|
4292
|
-
*
|
|
4293
|
-
* <p>
|
|
4295
|
+
* <p>
|
|
4294
4296
|
* <b>Server process events:</b>
|
|
4295
4297
|
* </p>
|
|
4296
|
-
*
|
|
4298
|
+
* <ul>
|
|
4297
4299
|
* <li>
|
|
4298
|
-
*
|
|
4300
|
+
* <p>SERVER_PROCESS_INVALID_PATH -- The game server executable or script could not
|
|
4299
4301
|
* be found based on the Fleet runtime configuration. Check that the launch path is
|
|
4300
4302
|
* correct based on the operating system of the Fleet.</p>
|
|
4301
4303
|
* </li>
|
|
4302
4304
|
* <li>
|
|
4303
|
-
*
|
|
4305
|
+
* <p>SERVER_PROCESS_SDK_INITIALIZATION_TIMEOUT -- The server process did not call
|
|
4304
4306
|
* InitSDK() within the time expected. Check your game session log to see why
|
|
4305
4307
|
* InitSDK() was not called in time.</p>
|
|
4306
4308
|
* </li>
|
|
4307
4309
|
* <li>
|
|
4308
|
-
*
|
|
4310
|
+
* <p>SERVER_PROCESS_PROCESS_READY_TIMEOUT -- The server process did not call
|
|
4309
4311
|
* ProcessReady() within the time expected after calling InitSDK(). Check your game
|
|
4310
4312
|
* session log to see why ProcessReady() was not called in time.</p>
|
|
4311
4313
|
* </li>
|
|
4312
4314
|
* <li>
|
|
4313
|
-
*
|
|
4315
|
+
* <p>SERVER_PROCESS_CRASHED -- The server process exited without calling
|
|
4314
4316
|
* ProcessEnding(). Check your game session log to see why ProcessEnding() was not
|
|
4315
4317
|
* called.</p>
|
|
4316
4318
|
* </li>
|
|
4317
4319
|
* <li>
|
|
4318
|
-
*
|
|
4320
|
+
* <p>SERVER_PROCESS_TERMINATED_UNHEALTHY -- The server process did not report a
|
|
4319
4321
|
* valid health check for too long and was therefore terminated by GameLift. Check
|
|
4320
4322
|
* your game session log to see if the thread became stuck processing a synchronous
|
|
4321
4323
|
* task for too long.</p>
|
|
4322
4324
|
* </li>
|
|
4323
4325
|
* <li>
|
|
4324
|
-
*
|
|
4326
|
+
* <p>SERVER_PROCESS_FORCE_TERMINATED -- The server process did not exit cleanly
|
|
4325
4327
|
* after OnProcessTerminate() was sent within the time expected. Check your game
|
|
4326
4328
|
* session log to see why termination took longer than expected.</p>
|
|
4327
4329
|
* </li>
|
|
4328
4330
|
* <li>
|
|
4329
|
-
*
|
|
4331
|
+
* <p>SERVER_PROCESS_PROCESS_EXIT_TIMEOUT -- The server process did not exit cleanly
|
|
4330
4332
|
* within the time expected after calling ProcessEnding(). Check your game session
|
|
4331
4333
|
* log to see why termination took longer than expected.</p>
|
|
4332
4334
|
* </li>
|
|
4333
4335
|
* </ul>
|
|
4334
|
-
*
|
|
4335
|
-
*
|
|
4336
|
-
* <p>
|
|
4336
|
+
* <p>
|
|
4337
4337
|
* <b>Game session events:</b>
|
|
4338
4338
|
* </p>
|
|
4339
|
-
*
|
|
4339
|
+
* <ul>
|
|
4340
4340
|
* <li>
|
|
4341
|
-
*
|
|
4341
|
+
* <p>GAME_SESSION_ACTIVATION_TIMEOUT -- GameSession failed to activate within the
|
|
4342
4342
|
* expected time. Check your game session log to see why ActivateGameSession() took
|
|
4343
4343
|
* longer to complete than expected.</p>
|
|
4344
4344
|
* </li>
|
|
4345
4345
|
* </ul>
|
|
4346
|
-
*
|
|
4347
|
-
*
|
|
4348
|
-
* <p>
|
|
4346
|
+
* <p>
|
|
4349
4347
|
* <b>Other fleet events:</b>
|
|
4350
4348
|
* </p>
|
|
4351
|
-
*
|
|
4349
|
+
* <ul>
|
|
4352
4350
|
* <li>
|
|
4353
|
-
*
|
|
4351
|
+
* <p>FLEET_SCALING_EVENT -- A change was made to the fleet's capacity settings
|
|
4354
4352
|
* (desired instances, minimum/maximum scaling limits). Event messaging includes
|
|
4355
4353
|
* the new capacity settings.</p>
|
|
4356
4354
|
* </li>
|
|
4357
4355
|
* <li>
|
|
4358
|
-
*
|
|
4356
|
+
* <p>FLEET_NEW_GAME_SESSION_PROTECTION_POLICY_UPDATED -- A change was made to the
|
|
4359
4357
|
* fleet's game session protection policy setting. Event messaging includes both
|
|
4360
4358
|
* the old and new policy setting. </p>
|
|
4361
4359
|
* </li>
|
|
4362
4360
|
* <li>
|
|
4363
|
-
*
|
|
4361
|
+
* <p>FLEET_DELETED -- A request to delete a fleet was initiated.</p>
|
|
4364
4362
|
* </li>
|
|
4365
4363
|
* <li>
|
|
4366
|
-
*
|
|
4364
|
+
* <p> GENERIC_EVENT -- An unspecified event has occurred.</p>
|
|
4367
4365
|
* </li>
|
|
4368
4366
|
* </ul>
|
|
4369
4367
|
*/
|
|
@@ -4379,7 +4377,7 @@ export interface Event {
|
|
|
4379
4377
|
/**
|
|
4380
4378
|
* <p>Location of stored logs with additional detail that is related to the event. This is
|
|
4381
4379
|
* useful for debugging issues. The URL is valid for 15 minutes. You can also access fleet
|
|
4382
|
-
* creation logs through the GameLift console.</p>
|
|
4380
|
+
* creation logs through the Amazon GameLift console.</p>
|
|
4383
4381
|
*/
|
|
4384
4382
|
PreSignedLogUrl?: string;
|
|
4385
4383
|
}
|
|
@@ -4460,7 +4458,7 @@ export interface DescribeFleetLocationAttributesOutput {
|
|
|
4460
4458
|
*/
|
|
4461
4459
|
FleetId?: string;
|
|
4462
4460
|
/**
|
|
4463
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.</p>
|
|
4461
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.</p>
|
|
4464
4462
|
*/
|
|
4465
4463
|
FleetArn?: string;
|
|
4466
4464
|
/**
|
|
@@ -4526,7 +4524,7 @@ export interface FleetUtilization {
|
|
|
4526
4524
|
*/
|
|
4527
4525
|
FleetId?: string;
|
|
4528
4526
|
/**
|
|
4529
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.</p>
|
|
4527
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.</p>
|
|
4530
4528
|
*/
|
|
4531
4529
|
FleetArn?: string;
|
|
4532
4530
|
/**
|
|
@@ -4589,7 +4587,7 @@ export interface DescribeFleetPortSettingsOutput {
|
|
|
4589
4587
|
*/
|
|
4590
4588
|
FleetId?: string;
|
|
4591
4589
|
/**
|
|
4592
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.</p>
|
|
4590
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.</p>
|
|
4593
4591
|
*/
|
|
4594
4592
|
FleetArn?: string;
|
|
4595
4593
|
/**
|
|
@@ -4722,14 +4720,14 @@ export type GameServerInstanceStatus = (typeof GameServerInstanceStatus)[keyof t
|
|
|
4722
4720
|
/**
|
|
4723
4721
|
* @public
|
|
4724
4722
|
* <p>
|
|
4725
|
-
* <b>This data type is used with the GameLift FleetIQ and game server groups.</b>
|
|
4723
|
+
* <b>This data type is used with the Amazon GameLift FleetIQ and game server groups.</b>
|
|
4726
4724
|
* </p>
|
|
4727
4725
|
* <p> Additional properties,
|
|
4728
4726
|
* including status, that describe an EC2 instance in a game server group. Instance
|
|
4729
4727
|
* configurations are set with game server group properties (see
|
|
4730
4728
|
* <code>DescribeGameServerGroup</code> and with the EC2 launch template that was used
|
|
4731
4729
|
* when creating the game server group. </p>
|
|
4732
|
-
*
|
|
4730
|
+
* <p>Retrieve game server instances for a game server group by calling
|
|
4733
4731
|
* <code>DescribeGameServerInstances</code>. </p>
|
|
4734
4732
|
*/
|
|
4735
4733
|
export interface GameServerInstance {
|
|
@@ -4817,15 +4815,15 @@ export interface GameSessionDetail {
|
|
|
4817
4815
|
GameSession?: GameSession;
|
|
4818
4816
|
/**
|
|
4819
4817
|
* <p>Current status of protection for the game session.</p>
|
|
4820
|
-
*
|
|
4818
|
+
* <ul>
|
|
4821
4819
|
* <li>
|
|
4822
|
-
*
|
|
4823
|
-
*
|
|
4820
|
+
* <p>
|
|
4821
|
+
* <b>NoProtection</b> -- The game session can be
|
|
4824
4822
|
* terminated during a scale-down event.</p>
|
|
4825
4823
|
* </li>
|
|
4826
4824
|
* <li>
|
|
4827
|
-
*
|
|
4828
|
-
*
|
|
4825
|
+
* <p>
|
|
4826
|
+
* <b>FullProtection</b> -- If the game session is in an
|
|
4829
4827
|
* <code>ACTIVE</code> status, it cannot be terminated during a scale-down
|
|
4830
4828
|
* event.</p>
|
|
4831
4829
|
* </li>
|
|
@@ -4924,33 +4922,33 @@ export interface GameSessionPlacement {
|
|
|
4924
4922
|
GameSessionQueueName?: string;
|
|
4925
4923
|
/**
|
|
4926
4924
|
* <p>Current status of the game session placement request.</p>
|
|
4927
|
-
*
|
|
4925
|
+
* <ul>
|
|
4928
4926
|
* <li>
|
|
4929
|
-
*
|
|
4930
|
-
*
|
|
4927
|
+
* <p>
|
|
4928
|
+
* <b>PENDING</b> -- The placement request is currently
|
|
4931
4929
|
* in the queue waiting to be processed.</p>
|
|
4932
4930
|
* </li>
|
|
4933
4931
|
* <li>
|
|
4934
|
-
*
|
|
4935
|
-
*
|
|
4932
|
+
* <p>
|
|
4933
|
+
* <b>FULFILLED</b> -- A new game session and player
|
|
4936
4934
|
* sessions (if requested) have been successfully created. Values for
|
|
4937
4935
|
* <i>GameSessionArn</i> and
|
|
4938
4936
|
* <i>GameSessionRegion</i> are available. </p>
|
|
4939
4937
|
* </li>
|
|
4940
4938
|
* <li>
|
|
4941
|
-
*
|
|
4942
|
-
*
|
|
4939
|
+
* <p>
|
|
4940
|
+
* <b>CANCELLED</b> -- The placement request was
|
|
4943
4941
|
* canceled.</p>
|
|
4944
4942
|
* </li>
|
|
4945
4943
|
* <li>
|
|
4946
|
-
*
|
|
4947
|
-
*
|
|
4944
|
+
* <p>
|
|
4945
|
+
* <b>TIMED_OUT</b> -- A new game session was not
|
|
4948
4946
|
* successfully created before the time limit expired. You can resubmit the
|
|
4949
4947
|
* placement request as needed.</p>
|
|
4950
4948
|
* </li>
|
|
4951
4949
|
* <li>
|
|
4952
|
-
*
|
|
4953
|
-
*
|
|
4950
|
+
* <p>
|
|
4951
|
+
* <b>FAILED</b> -- Amazon GameLift is not able to complete the
|
|
4954
4952
|
* process of placing the game session. Common reasons are the game session
|
|
4955
4953
|
* terminated before the placement process was completed, or an unexpected internal
|
|
4956
4954
|
* error.</p>
|
|
@@ -5001,7 +4999,7 @@ export interface GameSessionPlacement {
|
|
|
5001
4999
|
*/
|
|
5002
5000
|
EndTime?: Date;
|
|
5003
5001
|
/**
|
|
5004
|
-
* <p>The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is
|
|
5002
|
+
* <p>The IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is
|
|
5005
5003
|
* <code>FULFILLED</code>). </p>
|
|
5006
5004
|
*/
|
|
5007
5005
|
IpAddress?: string;
|
|
@@ -5017,11 +5015,11 @@ export interface GameSessionPlacement {
|
|
|
5017
5015
|
* <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses">Amazon EC2 Instance IP Addressing</a>.)</p>
|
|
5018
5016
|
* </li>
|
|
5019
5017
|
* </ul>
|
|
5020
|
-
*
|
|
5018
|
+
* <p>When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.</p>
|
|
5021
5019
|
*/
|
|
5022
5020
|
DnsName?: string;
|
|
5023
5021
|
/**
|
|
5024
|
-
* <p>The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is
|
|
5022
|
+
* <p>The port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is
|
|
5025
5023
|
* <code>FULFILLED</code>).</p>
|
|
5026
5024
|
*/
|
|
5027
5025
|
Port?: number;
|
|
@@ -5184,7 +5182,7 @@ export type InstanceStatus = (typeof InstanceStatus)[keyof typeof InstanceStatus
|
|
|
5184
5182
|
/**
|
|
5185
5183
|
* @public
|
|
5186
5184
|
* <p>Represents an EC2 instance of virtual computing resources that hosts one or more game
|
|
5187
|
-
* servers. In GameLift, a fleet can contain zero or more instances.</p>
|
|
5185
|
+
* servers. In Amazon GameLift, a fleet can contain zero or more instances.</p>
|
|
5188
5186
|
* <p>
|
|
5189
5187
|
* <b>Related actions</b>
|
|
5190
5188
|
* </p>
|
|
@@ -5195,7 +5193,7 @@ export interface Instance {
|
|
|
5195
5193
|
*/
|
|
5196
5194
|
FleetId?: string;
|
|
5197
5195
|
/**
|
|
5198
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.</p>
|
|
5196
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.</p>
|
|
5199
5197
|
*/
|
|
5200
5198
|
FleetArn?: string;
|
|
5201
5199
|
/**
|
|
@@ -5218,7 +5216,7 @@ export interface Instance {
|
|
|
5218
5216
|
* <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses">Amazon EC2 Instance IP Addressing</a>.)</p>
|
|
5219
5217
|
* </li>
|
|
5220
5218
|
* </ul>
|
|
5221
|
-
*
|
|
5219
|
+
* <p>When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.</p>
|
|
5222
5220
|
*/
|
|
5223
5221
|
DnsName?: string;
|
|
5224
5222
|
/**
|
|
@@ -5231,23 +5229,23 @@ export interface Instance {
|
|
|
5231
5229
|
Type?: EC2InstanceType | string;
|
|
5232
5230
|
/**
|
|
5233
5231
|
* <p>Current status of the instance. Possible statuses include the following:</p>
|
|
5234
|
-
*
|
|
5232
|
+
* <ul>
|
|
5235
5233
|
* <li>
|
|
5236
|
-
*
|
|
5237
|
-
*
|
|
5234
|
+
* <p>
|
|
5235
|
+
* <b>PENDING</b> -- The instance is in the process of
|
|
5238
5236
|
* being created and launching server processes as defined in the fleet's run-time
|
|
5239
5237
|
* configuration. </p>
|
|
5240
5238
|
* </li>
|
|
5241
5239
|
* <li>
|
|
5242
|
-
*
|
|
5243
|
-
*
|
|
5240
|
+
* <p>
|
|
5241
|
+
* <b>ACTIVE</b> -- The instance has been successfully
|
|
5244
5242
|
* created and at least one server process has successfully launched and reported
|
|
5245
|
-
* back to GameLift that it is ready to host a game session. The instance is now
|
|
5243
|
+
* back to Amazon GameLift that it is ready to host a game session. The instance is now
|
|
5246
5244
|
* considered ready to host game sessions. </p>
|
|
5247
5245
|
* </li>
|
|
5248
5246
|
* <li>
|
|
5249
|
-
*
|
|
5250
|
-
*
|
|
5247
|
+
* <p>
|
|
5248
|
+
* <b>TERMINATING</b> -- The instance is in the process
|
|
5251
5249
|
* of shutting down. This may happen to reduce capacity during a scaling down event
|
|
5252
5250
|
* or to recycle resources in the event of a problem.</p>
|
|
5253
5251
|
* </li>
|
|
@@ -5291,7 +5289,7 @@ export interface DescribeMatchmakingInput {
|
|
|
5291
5289
|
* <p>Represents a new player session that is created as a result of a successful FlexMatch
|
|
5292
5290
|
* match. A successful match automatically creates new player sessions for every player ID
|
|
5293
5291
|
* in the original matchmaking request. </p>
|
|
5294
|
-
*
|
|
5292
|
+
* <p>When players connect to the match's game session, they must include both player ID and
|
|
5295
5293
|
* player session ID in order to claim their assigned player slot.</p>
|
|
5296
5294
|
*/
|
|
5297
5295
|
export interface MatchedPlayerSession {
|
|
@@ -5318,7 +5316,7 @@ export interface GameSessionConnectionInfo {
|
|
|
5318
5316
|
*/
|
|
5319
5317
|
GameSessionArn?: string;
|
|
5320
5318
|
/**
|
|
5321
|
-
* <p>The IP address of the game session. To connect to a GameLift game server, an app needs both the IP address and port number.</p>
|
|
5319
|
+
* <p>The IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.</p>
|
|
5322
5320
|
*/
|
|
5323
5321
|
IpAddress?: string;
|
|
5324
5322
|
/**
|
|
@@ -5333,11 +5331,11 @@ export interface GameSessionConnectionInfo {
|
|
|
5333
5331
|
* <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses">Amazon EC2 Instance IP Addressing</a>.)</p>
|
|
5334
5332
|
* </li>
|
|
5335
5333
|
* </ul>
|
|
5336
|
-
*
|
|
5334
|
+
* <p>When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.</p>
|
|
5337
5335
|
*/
|
|
5338
5336
|
DnsName?: string;
|
|
5339
5337
|
/**
|
|
5340
|
-
* <p>The port number for the game session. To connect to a GameLift game server, an app needs both the IP address and port number.</p>
|
|
5338
|
+
* <p>The port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number.</p>
|
|
5341
5339
|
*/
|
|
5342
5340
|
Port?: number;
|
|
5343
5341
|
/**
|
|
@@ -5362,7 +5360,7 @@ export interface Player {
|
|
|
5362
5360
|
* Player attribute keys must match the <i>playerAttributes</i> used in a
|
|
5363
5361
|
* matchmaking rule set. Example: <code>"PlayerAttributes": \{"skill": \{"N": "23"\},
|
|
5364
5362
|
* "gameMode": \{"S": "deathmatch"\}\}</code>.</p>
|
|
5365
|
-
*
|
|
5363
|
+
* <p>You can provide up to 10 <code>PlayerAttributes</code>.</p>
|
|
5366
5364
|
*/
|
|
5367
5365
|
PlayerAttributes?: Record<string, AttributeValue>;
|
|
5368
5366
|
/**
|
|
@@ -5373,7 +5371,7 @@ export interface Player {
|
|
|
5373
5371
|
/**
|
|
5374
5372
|
* <p>A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to @aws; Regions. If this property is present, FlexMatch considers placing the match only in
|
|
5375
5373
|
* Regions for which latency is reported. </p>
|
|
5376
|
-
*
|
|
5374
|
+
* <p>If a matchmaker has a rule that evaluates player latency, players must report latency
|
|
5377
5375
|
* in order to be matched. If no latency is reported in this scenario, FlexMatch assumes that
|
|
5378
5376
|
* no Regions are available to the player and the ticket is not matchable. </p>
|
|
5379
5377
|
*/
|
|
@@ -5421,58 +5419,58 @@ export interface MatchmakingTicket {
|
|
|
5421
5419
|
ConfigurationArn?: string;
|
|
5422
5420
|
/**
|
|
5423
5421
|
* <p>Current status of the matchmaking request.</p>
|
|
5424
|
-
*
|
|
5422
|
+
* <ul>
|
|
5425
5423
|
* <li>
|
|
5426
|
-
*
|
|
5427
|
-
*
|
|
5424
|
+
* <p>
|
|
5425
|
+
* <b>QUEUED</b> -- The matchmaking request has been
|
|
5428
5426
|
* received and is currently waiting to be processed.</p>
|
|
5429
5427
|
* </li>
|
|
5430
5428
|
* <li>
|
|
5431
|
-
*
|
|
5432
|
-
*
|
|
5429
|
+
* <p>
|
|
5430
|
+
* <b>SEARCHING</b> -- The matchmaking request is
|
|
5433
5431
|
* currently being processed. </p>
|
|
5434
5432
|
* </li>
|
|
5435
5433
|
* <li>
|
|
5436
|
-
*
|
|
5437
|
-
*
|
|
5434
|
+
* <p>
|
|
5435
|
+
* <b>REQUIRES_ACCEPTANCE</b> -- A match has been
|
|
5438
5436
|
* proposed and the players must accept the match. This status is used only with
|
|
5439
5437
|
* requests that use a matchmaking configuration with a player acceptance
|
|
5440
5438
|
* requirement.</p>
|
|
5441
5439
|
* </li>
|
|
5442
5440
|
* <li>
|
|
5443
|
-
*
|
|
5444
|
-
*
|
|
5441
|
+
* <p>
|
|
5442
|
+
* <b>PLACING</b> -- The FlexMatch engine has matched
|
|
5445
5443
|
* players and is in the process of placing a new game session for the
|
|
5446
5444
|
* match.</p>
|
|
5447
5445
|
* </li>
|
|
5448
5446
|
* <li>
|
|
5449
|
-
*
|
|
5450
|
-
*
|
|
5447
|
+
* <p>
|
|
5448
|
+
* <b>COMPLETED</b> -- Players have been matched and a
|
|
5451
5449
|
* game session is ready to host the players. A ticket in this state contains the
|
|
5452
5450
|
* necessary connection information for players.</p>
|
|
5453
5451
|
* </li>
|
|
5454
5452
|
* <li>
|
|
5455
|
-
*
|
|
5456
|
-
*
|
|
5453
|
+
* <p>
|
|
5454
|
+
* <b>FAILED</b> -- The matchmaking request was not
|
|
5457
5455
|
* completed.</p>
|
|
5458
5456
|
* </li>
|
|
5459
5457
|
* <li>
|
|
5460
|
-
*
|
|
5461
|
-
*
|
|
5458
|
+
* <p>
|
|
5459
|
+
* <b>CANCELLED</b> -- The matchmaking request was
|
|
5462
5460
|
* canceled. This may be the result of a <code>StopMatchmaking</code> operation or
|
|
5463
5461
|
* a proposed match that one or more players failed to accept.</p>
|
|
5464
5462
|
* </li>
|
|
5465
5463
|
* <li>
|
|
5466
|
-
*
|
|
5467
|
-
*
|
|
5464
|
+
* <p>
|
|
5465
|
+
* <b>TIMED_OUT</b> -- The matchmaking request was not
|
|
5468
5466
|
* successful within the duration specified in the matchmaking configuration.
|
|
5469
5467
|
* </p>
|
|
5470
5468
|
* </li>
|
|
5471
5469
|
* </ul>
|
|
5472
|
-
*
|
|
5470
|
+
* <note>
|
|
5473
5471
|
* <p>Matchmaking requests that fail to successfully complete (statuses FAILED,
|
|
5474
5472
|
* CANCELLED, TIMED_OUT) can be resubmitted as new requests with new ticket IDs.</p>
|
|
5475
|
-
*
|
|
5473
|
+
* </note>
|
|
5476
5474
|
*/
|
|
5477
5475
|
Status?: MatchmakingConfigurationStatus | string;
|
|
5478
5476
|
/**
|
|
@@ -5610,27 +5608,27 @@ export interface DescribePlayerSessionsInput {
|
|
|
5610
5608
|
* <p>Player session status to filter results on. Note that when a PlayerSessionId or
|
|
5611
5609
|
* PlayerId is provided in a DescribePlayerSessions request, then the
|
|
5612
5610
|
* PlayerSessionStatusFilter has no effect on the response.</p>
|
|
5613
|
-
*
|
|
5614
|
-
*
|
|
5611
|
+
* <p>Possible player session statuses include the following:</p>
|
|
5612
|
+
* <ul>
|
|
5615
5613
|
* <li>
|
|
5616
|
-
*
|
|
5617
|
-
*
|
|
5614
|
+
* <p>
|
|
5615
|
+
* <b>RESERVED</b> -- The player session request has been
|
|
5618
5616
|
* received, but the player has not yet connected to the server process and/or been
|
|
5619
5617
|
* validated. </p>
|
|
5620
5618
|
* </li>
|
|
5621
5619
|
* <li>
|
|
5622
|
-
*
|
|
5623
|
-
*
|
|
5620
|
+
* <p>
|
|
5621
|
+
* <b>ACTIVE</b> -- The player has been validated by the
|
|
5624
5622
|
* server process and is currently connected.</p>
|
|
5625
5623
|
* </li>
|
|
5626
5624
|
* <li>
|
|
5627
|
-
*
|
|
5628
|
-
*
|
|
5625
|
+
* <p>
|
|
5626
|
+
* <b>COMPLETED</b> -- The player connection has been
|
|
5629
5627
|
* dropped.</p>
|
|
5630
5628
|
* </li>
|
|
5631
5629
|
* <li>
|
|
5632
|
-
*
|
|
5633
|
-
*
|
|
5630
|
+
* <p>
|
|
5631
|
+
* <b>TIMEDOUT</b> -- A player session request was
|
|
5634
5632
|
* received, but the player did not connect and/or was not validated within the
|
|
5635
5633
|
* timeout limit (60 seconds).</p>
|
|
5636
5634
|
* </li>
|
|
@@ -5709,40 +5707,40 @@ export interface DescribeScalingPoliciesInput {
|
|
|
5709
5707
|
/**
|
|
5710
5708
|
* <p>Scaling policy status to filter results on. A scaling policy is only in force when in
|
|
5711
5709
|
* an <code>ACTIVE</code> status.</p>
|
|
5712
|
-
*
|
|
5710
|
+
* <ul>
|
|
5713
5711
|
* <li>
|
|
5714
|
-
*
|
|
5715
|
-
*
|
|
5712
|
+
* <p>
|
|
5713
|
+
* <b>ACTIVE</b> -- The scaling policy is currently in
|
|
5716
5714
|
* force.</p>
|
|
5717
5715
|
* </li>
|
|
5718
5716
|
* <li>
|
|
5719
|
-
*
|
|
5720
|
-
*
|
|
5717
|
+
* <p>
|
|
5718
|
+
* <b>UPDATEREQUESTED</b> -- A request to update the
|
|
5721
5719
|
* scaling policy has been received.</p>
|
|
5722
5720
|
* </li>
|
|
5723
5721
|
* <li>
|
|
5724
|
-
*
|
|
5725
|
-
*
|
|
5722
|
+
* <p>
|
|
5723
|
+
* <b>UPDATING</b> -- A change is being made to the
|
|
5726
5724
|
* scaling policy.</p>
|
|
5727
5725
|
* </li>
|
|
5728
5726
|
* <li>
|
|
5729
|
-
*
|
|
5730
|
-
*
|
|
5727
|
+
* <p>
|
|
5728
|
+
* <b>DELETEREQUESTED</b> -- A request to delete the
|
|
5731
5729
|
* scaling policy has been received.</p>
|
|
5732
5730
|
* </li>
|
|
5733
5731
|
* <li>
|
|
5734
|
-
*
|
|
5735
|
-
*
|
|
5732
|
+
* <p>
|
|
5733
|
+
* <b>DELETING</b> -- The scaling policy is being
|
|
5736
5734
|
* deleted.</p>
|
|
5737
5735
|
* </li>
|
|
5738
5736
|
* <li>
|
|
5739
|
-
*
|
|
5740
|
-
*
|
|
5737
|
+
* <p>
|
|
5738
|
+
* <b>DELETED</b> -- The scaling policy has been
|
|
5741
5739
|
* deleted.</p>
|
|
5742
5740
|
* </li>
|
|
5743
5741
|
* <li>
|
|
5744
|
-
*
|
|
5745
|
-
*
|
|
5742
|
+
* <p>
|
|
5743
|
+
* <b>ERROR</b> -- An error occurred in creating the
|
|
5746
5744
|
* policy. It should be removed and recreated.</p>
|
|
5747
5745
|
* </li>
|
|
5748
5746
|
* </ul>
|
|
@@ -5838,7 +5836,7 @@ export interface ScalingPolicy {
|
|
|
5838
5836
|
*/
|
|
5839
5837
|
FleetId?: string;
|
|
5840
5838
|
/**
|
|
5841
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.</p>
|
|
5839
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.</p>
|
|
5842
5840
|
*/
|
|
5843
5841
|
FleetArn?: string;
|
|
5844
5842
|
/**
|
|
@@ -5849,40 +5847,40 @@ export interface ScalingPolicy {
|
|
|
5849
5847
|
* <p>Current status of the scaling policy. The scaling policy can be in force only when in
|
|
5850
5848
|
* an <code>ACTIVE</code> status. Scaling policies can be suspended for individual fleets.
|
|
5851
5849
|
* If the policy is suspended for a fleet, the policy status does not change.</p>
|
|
5852
|
-
*
|
|
5850
|
+
* <ul>
|
|
5853
5851
|
* <li>
|
|
5854
|
-
*
|
|
5855
|
-
*
|
|
5852
|
+
* <p>
|
|
5853
|
+
* <b>ACTIVE</b> -- The scaling policy can be used for
|
|
5856
5854
|
* auto-scaling a fleet.</p>
|
|
5857
5855
|
* </li>
|
|
5858
5856
|
* <li>
|
|
5859
|
-
*
|
|
5860
|
-
*
|
|
5857
|
+
* <p>
|
|
5858
|
+
* <b>UPDATE_REQUESTED</b> -- A request to update the
|
|
5861
5859
|
* scaling policy has been received.</p>
|
|
5862
5860
|
* </li>
|
|
5863
5861
|
* <li>
|
|
5864
|
-
*
|
|
5865
|
-
*
|
|
5862
|
+
* <p>
|
|
5863
|
+
* <b>UPDATING</b> -- A change is being made to the
|
|
5866
5864
|
* scaling policy.</p>
|
|
5867
5865
|
* </li>
|
|
5868
5866
|
* <li>
|
|
5869
|
-
*
|
|
5870
|
-
*
|
|
5867
|
+
* <p>
|
|
5868
|
+
* <b>DELETE_REQUESTED</b> -- A request to delete the
|
|
5871
5869
|
* scaling policy has been received.</p>
|
|
5872
5870
|
* </li>
|
|
5873
5871
|
* <li>
|
|
5874
|
-
*
|
|
5875
|
-
*
|
|
5872
|
+
* <p>
|
|
5873
|
+
* <b>DELETING</b> -- The scaling policy is being
|
|
5876
5874
|
* deleted.</p>
|
|
5877
5875
|
* </li>
|
|
5878
5876
|
* <li>
|
|
5879
|
-
*
|
|
5880
|
-
*
|
|
5877
|
+
* <p>
|
|
5878
|
+
* <b>DELETED</b> -- The scaling policy has been
|
|
5881
5879
|
* deleted.</p>
|
|
5882
5880
|
* </li>
|
|
5883
5881
|
* <li>
|
|
5884
|
-
*
|
|
5885
|
-
*
|
|
5882
|
+
* <p>
|
|
5883
|
+
* <b>ERROR</b> -- An error occurred in creating the
|
|
5886
5884
|
* policy. It should be removed and recreated.</p>
|
|
5887
5885
|
* </li>
|
|
5888
5886
|
* </ul>
|
|
@@ -5894,21 +5892,21 @@ export interface ScalingPolicy {
|
|
|
5894
5892
|
ScalingAdjustment?: number;
|
|
5895
5893
|
/**
|
|
5896
5894
|
* <p>The type of adjustment to make to a fleet's instance count.</p>
|
|
5897
|
-
*
|
|
5895
|
+
* <ul>
|
|
5898
5896
|
* <li>
|
|
5899
|
-
*
|
|
5900
|
-
*
|
|
5897
|
+
* <p>
|
|
5898
|
+
* <b>ChangeInCapacity</b> -- add (or subtract) the
|
|
5901
5899
|
* scaling adjustment value from the current instance count. Positive values scale
|
|
5902
5900
|
* up while negative values scale down.</p>
|
|
5903
5901
|
* </li>
|
|
5904
5902
|
* <li>
|
|
5905
|
-
*
|
|
5906
|
-
*
|
|
5903
|
+
* <p>
|
|
5904
|
+
* <b>ExactCapacity</b> -- set the instance count to the
|
|
5907
5905
|
* scaling adjustment value.</p>
|
|
5908
5906
|
* </li>
|
|
5909
5907
|
* <li>
|
|
5910
|
-
*
|
|
5911
|
-
*
|
|
5908
|
+
* <p>
|
|
5909
|
+
* <b>PercentChangeInCapacity</b> -- increase or reduce
|
|
5912
5910
|
* the current instance count by the scaling adjustment, read as a percentage.
|
|
5913
5911
|
* Positive values scale up while negative values scale down.</p>
|
|
5914
5912
|
* </li>
|
|
@@ -5932,65 +5930,65 @@ export interface ScalingPolicy {
|
|
|
5932
5930
|
* <p>Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For
|
|
5933
5931
|
* detailed descriptions of fleet metrics, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html">Monitor Amazon GameLift
|
|
5934
5932
|
* with Amazon CloudWatch</a>. </p>
|
|
5935
|
-
*
|
|
5933
|
+
* <ul>
|
|
5936
5934
|
* <li>
|
|
5937
|
-
*
|
|
5935
|
+
* <p>
|
|
5938
5936
|
* <b>ActivatingGameSessions</b> -- Game sessions in
|
|
5939
5937
|
* the process of being created.</p>
|
|
5940
5938
|
* </li>
|
|
5941
5939
|
* <li>
|
|
5942
|
-
*
|
|
5940
|
+
* <p>
|
|
5943
5941
|
* <b>ActiveGameSessions</b> -- Game sessions that
|
|
5944
5942
|
* are currently running.</p>
|
|
5945
5943
|
* </li>
|
|
5946
5944
|
* <li>
|
|
5947
|
-
*
|
|
5945
|
+
* <p>
|
|
5948
5946
|
* <b>ActiveInstances</b> -- Fleet instances that
|
|
5949
5947
|
* are currently running at least one game session.</p>
|
|
5950
5948
|
* </li>
|
|
5951
5949
|
* <li>
|
|
5952
|
-
*
|
|
5950
|
+
* <p>
|
|
5953
5951
|
* <b>AvailableGameSessions</b> -- Additional game
|
|
5954
5952
|
* sessions that fleet could host simultaneously, given current capacity.</p>
|
|
5955
5953
|
* </li>
|
|
5956
5954
|
* <li>
|
|
5957
|
-
*
|
|
5955
|
+
* <p>
|
|
5958
5956
|
* <b>AvailablePlayerSessions</b> -- Empty player
|
|
5959
5957
|
* slots in currently active game sessions. This includes game sessions that are
|
|
5960
5958
|
* not currently accepting players. Reserved player slots are not
|
|
5961
5959
|
* included.</p>
|
|
5962
5960
|
* </li>
|
|
5963
5961
|
* <li>
|
|
5964
|
-
*
|
|
5962
|
+
* <p>
|
|
5965
5963
|
* <b>CurrentPlayerSessions</b> -- Player slots in
|
|
5966
5964
|
* active game sessions that are being used by a player or are reserved for a
|
|
5967
5965
|
* player. </p>
|
|
5968
5966
|
* </li>
|
|
5969
5967
|
* <li>
|
|
5970
|
-
*
|
|
5968
|
+
* <p>
|
|
5971
5969
|
* <b>IdleInstances</b> -- Active instances that are
|
|
5972
5970
|
* currently hosting zero game sessions. </p>
|
|
5973
5971
|
* </li>
|
|
5974
5972
|
* <li>
|
|
5975
|
-
*
|
|
5973
|
+
* <p>
|
|
5976
5974
|
* <b>PercentAvailableGameSessions</b> -- Unused
|
|
5977
5975
|
* percentage of the total number of game sessions that a fleet could host
|
|
5978
5976
|
* simultaneously, given current capacity. Use this metric for a target-based
|
|
5979
5977
|
* scaling policy.</p>
|
|
5980
5978
|
* </li>
|
|
5981
5979
|
* <li>
|
|
5982
|
-
*
|
|
5980
|
+
* <p>
|
|
5983
5981
|
* <b>PercentIdleInstances</b> -- Percentage of the
|
|
5984
5982
|
* total number of active instances that are hosting zero game sessions.</p>
|
|
5985
5983
|
* </li>
|
|
5986
5984
|
* <li>
|
|
5987
|
-
*
|
|
5985
|
+
* <p>
|
|
5988
5986
|
* <b>QueueDepth</b> -- Pending game session
|
|
5989
5987
|
* placement requests, in any queue, where the current fleet is the top-priority
|
|
5990
5988
|
* destination.</p>
|
|
5991
5989
|
* </li>
|
|
5992
5990
|
* <li>
|
|
5993
|
-
*
|
|
5991
|
+
* <p>
|
|
5994
5992
|
* <b>WaitTime</b> -- Current wait time for pending
|
|
5995
5993
|
* game session placement requests, in any queue, where the current fleet is the
|
|
5996
5994
|
* top-priority destination. </p>
|
|
@@ -6103,7 +6101,7 @@ export interface VpcPeeringConnectionStatus {
|
|
|
6103
6101
|
* <p>
|
|
6104
6102
|
* <b>Related actions</b>
|
|
6105
6103
|
* </p>
|
|
6106
|
-
*
|
|
6104
|
+
* <p>
|
|
6107
6105
|
* <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a>
|
|
6108
6106
|
* </p>
|
|
6109
6107
|
*/
|
|
@@ -6134,10 +6132,10 @@ export interface VpcPeeringConnection {
|
|
|
6134
6132
|
*/
|
|
6135
6133
|
Status?: VpcPeeringConnectionStatus;
|
|
6136
6134
|
/**
|
|
6137
|
-
* <p>A unique identifier for a VPC with resources to be accessed by your GameLift fleet. The
|
|
6135
|
+
* <p>A unique identifier for a VPC with resources to be accessed by your Amazon GameLift fleet. The
|
|
6138
6136
|
* VPC must be in the same Region as your fleet. To look up a VPC ID, use the
|
|
6139
6137
|
* <a href="https://console.aws.amazon.com/vpc/">VPC Dashboard</a> in the Amazon Web Services Management Console.
|
|
6140
|
-
* Learn more about VPC peering in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with GameLift Fleets</a>.</p>
|
|
6138
|
+
* Learn more about VPC peering in <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html">VPC Peering with Amazon GameLift Fleets</a>.</p>
|
|
6141
6139
|
*/
|
|
6142
6140
|
PeerVpcId?: string;
|
|
6143
6141
|
/**
|
|
@@ -6166,7 +6164,7 @@ export interface DesiredPlayerSession {
|
|
|
6166
6164
|
*/
|
|
6167
6165
|
PlayerId?: string;
|
|
6168
6166
|
/**
|
|
6169
|
-
* <p>Developer-defined information related to a player. GameLift does not use this data, so it can be formatted as needed for use in the game.</p>
|
|
6167
|
+
* <p>Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.</p>
|
|
6170
6168
|
*/
|
|
6171
6169
|
PlayerData?: string;
|
|
6172
6170
|
}
|
|
@@ -6192,7 +6190,7 @@ export interface GetComputeAccessOutput {
|
|
|
6192
6190
|
*/
|
|
6193
6191
|
FleetId?: string;
|
|
6194
6192
|
/**
|
|
6195
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.</p>
|
|
6193
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.</p>
|
|
6196
6194
|
*/
|
|
6197
6195
|
FleetArn?: string;
|
|
6198
6196
|
/**
|
|
@@ -6200,7 +6198,9 @@ export interface GetComputeAccessOutput {
|
|
|
6200
6198
|
*/
|
|
6201
6199
|
ComputeName?: string;
|
|
6202
6200
|
/**
|
|
6203
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a GameLift compute resource and uniquely identifies it.
|
|
6201
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift compute resource and uniquely identifies it.
|
|
6202
|
+
* ARNs are unique across all Regions. Format is
|
|
6203
|
+
* <code>arn:aws:gamelift:<region>::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.</p>
|
|
6204
6204
|
*/
|
|
6205
6205
|
ComputeArn?: string;
|
|
6206
6206
|
/**
|
|
@@ -6217,7 +6217,7 @@ export interface GetComputeAuthTokenInput {
|
|
|
6217
6217
|
*/
|
|
6218
6218
|
FleetId: string | undefined;
|
|
6219
6219
|
/**
|
|
6220
|
-
* <p>The name of the compute resource you are requesting the
|
|
6220
|
+
* <p>The name of the compute resource you are requesting the authentication token
|
|
6221
6221
|
* for.</p>
|
|
6222
6222
|
*/
|
|
6223
6223
|
ComputeName: string | undefined;
|
|
@@ -6231,28 +6231,30 @@ export interface GetComputeAuthTokenOutput {
|
|
|
6231
6231
|
*/
|
|
6232
6232
|
FleetId?: string;
|
|
6233
6233
|
/**
|
|
6234
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.</p>
|
|
6234
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.</p>
|
|
6235
6235
|
*/
|
|
6236
6236
|
FleetArn?: string;
|
|
6237
6237
|
/**
|
|
6238
|
-
* <p>The name of the compute resource you are requesting the
|
|
6238
|
+
* <p>The name of the compute resource you are requesting the authentication token
|
|
6239
6239
|
* for.</p>
|
|
6240
6240
|
*/
|
|
6241
6241
|
ComputeName?: string;
|
|
6242
6242
|
/**
|
|
6243
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a GameLift compute resource and uniquely identifies it.
|
|
6243
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift compute resource and uniquely identifies it.
|
|
6244
|
+
* ARNs are unique across all Regions. Format is
|
|
6245
|
+
* <code>arn:aws:gamelift:<region>::compute/compute-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>
|
|
6244
6246
|
* </p>
|
|
6245
6247
|
*/
|
|
6246
6248
|
ComputeArn?: string;
|
|
6247
6249
|
/**
|
|
6248
|
-
* <p>The
|
|
6249
|
-
* GameLift.</p>
|
|
6250
|
+
* <p>The authentication token that your game server uses to authenticate with
|
|
6251
|
+
* Amazon GameLift.</p>
|
|
6250
6252
|
*/
|
|
6251
6253
|
AuthToken?: string;
|
|
6252
6254
|
/**
|
|
6253
|
-
* <p>The amount of time until the
|
|
6254
|
-
* the compute resource for game server hosting, renew the
|
|
6255
|
-
* this operation again.</p>
|
|
6255
|
+
* <p>The amount of time until the authentication token is no longer valid. To continue
|
|
6256
|
+
* using the compute resource for game server hosting, renew the authentication token by
|
|
6257
|
+
* using this operation again.</p>
|
|
6256
6258
|
*/
|
|
6257
6259
|
ExpirationTimestamp?: Date;
|
|
6258
6260
|
}
|
|
@@ -6352,16 +6354,16 @@ export interface ListAliasesInput {
|
|
|
6352
6354
|
/**
|
|
6353
6355
|
* <p>The routing type to filter results on. Use this parameter to retrieve only aliases
|
|
6354
6356
|
* with a certain routing type. To retrieve all aliases, leave this parameter empty.</p>
|
|
6355
|
-
*
|
|
6356
|
-
*
|
|
6357
|
+
* <p>Possible routing types include the following:</p>
|
|
6358
|
+
* <ul>
|
|
6357
6359
|
* <li>
|
|
6358
|
-
*
|
|
6359
|
-
*
|
|
6360
|
+
* <p>
|
|
6361
|
+
* <b>SIMPLE</b> -- The alias resolves to one specific
|
|
6360
6362
|
* fleet. Use this type when routing to active fleets.</p>
|
|
6361
6363
|
* </li>
|
|
6362
6364
|
* <li>
|
|
6363
|
-
*
|
|
6364
|
-
*
|
|
6365
|
+
* <p>
|
|
6366
|
+
* <b>TERMINAL</b> -- The alias does not resolve to a
|
|
6365
6367
|
* fleet but instead can be used to display a message to the user. A terminal alias
|
|
6366
6368
|
* throws a TerminalRoutingStrategyException with the <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_RoutingStrategy.html">RoutingStrategy</a> message embedded.</p>
|
|
6367
6369
|
* </li>
|
|
@@ -6401,23 +6403,23 @@ export interface ListBuildsInput {
|
|
|
6401
6403
|
/**
|
|
6402
6404
|
* <p>Build status to filter results by. To retrieve all builds, leave this parameter
|
|
6403
6405
|
* empty.</p>
|
|
6404
|
-
*
|
|
6405
|
-
*
|
|
6406
|
+
* <p>Possible build statuses include the following:</p>
|
|
6407
|
+
* <ul>
|
|
6406
6408
|
* <li>
|
|
6407
|
-
*
|
|
6408
|
-
*
|
|
6409
|
+
* <p>
|
|
6410
|
+
* <b>INITIALIZED</b> -- A new build has been defined,
|
|
6409
6411
|
* but no files have been uploaded. You cannot create fleets for builds that are in
|
|
6410
6412
|
* this status. When a build is successfully created, the build status is set to
|
|
6411
6413
|
* this value. </p>
|
|
6412
6414
|
* </li>
|
|
6413
6415
|
* <li>
|
|
6414
|
-
*
|
|
6415
|
-
*
|
|
6416
|
+
* <p>
|
|
6417
|
+
* <b>READY</b> -- The game build has been successfully
|
|
6416
6418
|
* uploaded. You can now create new fleets for this build.</p>
|
|
6417
6419
|
* </li>
|
|
6418
6420
|
* <li>
|
|
6419
|
-
*
|
|
6420
|
-
*
|
|
6421
|
+
* <p>
|
|
6422
|
+
* <b>FAILED</b> -- The game build upload failed. You
|
|
6421
6423
|
* cannot create new fleets for this build. </p>
|
|
6422
6424
|
* </li>
|
|
6423
6425
|
* </ul>
|
|
@@ -6428,7 +6430,7 @@ export interface ListBuildsInput {
|
|
|
6428
6430
|
*/
|
|
6429
6431
|
Limit?: number;
|
|
6430
6432
|
/**
|
|
6431
|
-
* <p>A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set,
|
|
6433
|
+
* <p>A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, don't specify a value.</p>
|
|
6432
6434
|
*/
|
|
6433
6435
|
NextToken?: string;
|
|
6434
6436
|
}
|
|
@@ -6644,7 +6646,7 @@ export interface ListScriptsInput {
|
|
|
6644
6646
|
*/
|
|
6645
6647
|
Limit?: number;
|
|
6646
6648
|
/**
|
|
6647
|
-
* <p>A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set,
|
|
6649
|
+
* <p>A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, don't specify a value.</p>
|
|
6648
6650
|
*/
|
|
6649
6651
|
NextToken?: string;
|
|
6650
6652
|
}
|
|
@@ -6666,10 +6668,10 @@ export interface ListScriptsOutput {
|
|
|
6666
6668
|
*/
|
|
6667
6669
|
export interface ListTagsForResourceRequest {
|
|
6668
6670
|
/**
|
|
6669
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that
|
|
6670
|
-
*
|
|
6671
|
-
*
|
|
6672
|
-
*
|
|
6671
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that uniquely identifies
|
|
6672
|
+
* the Amazon GameLift resource that you want to retrieve tags for. Amazon GameLift includes resource ARNs in
|
|
6673
|
+
* the data object for the resource. You can retrieve the ARN by calling a
|
|
6674
|
+
* <code>List</code> or <code>Describe</code> operation for the resource type. </p>
|
|
6673
6675
|
*/
|
|
6674
6676
|
ResourceARN: string | undefined;
|
|
6675
6677
|
}
|
|
@@ -6678,7 +6680,7 @@ export interface ListTagsForResourceRequest {
|
|
|
6678
6680
|
*/
|
|
6679
6681
|
export interface ListTagsForResourceResponse {
|
|
6680
6682
|
/**
|
|
6681
|
-
* <p>The collection of tags
|
|
6683
|
+
* <p>The collection of tags assigned to the resource. </p>
|
|
6682
6684
|
*/
|
|
6683
6685
|
Tags?: Tag[];
|
|
6684
6686
|
}
|
|
@@ -6701,21 +6703,21 @@ export interface PutScalingPolicyInput {
|
|
|
6701
6703
|
ScalingAdjustment?: number;
|
|
6702
6704
|
/**
|
|
6703
6705
|
* <p>The type of adjustment to make to a fleet's instance count:</p>
|
|
6704
|
-
*
|
|
6706
|
+
* <ul>
|
|
6705
6707
|
* <li>
|
|
6706
|
-
*
|
|
6707
|
-
*
|
|
6708
|
+
* <p>
|
|
6709
|
+
* <b>ChangeInCapacity</b> -- add (or subtract) the
|
|
6708
6710
|
* scaling adjustment value from the current instance count. Positive values scale
|
|
6709
6711
|
* up while negative values scale down.</p>
|
|
6710
6712
|
* </li>
|
|
6711
6713
|
* <li>
|
|
6712
|
-
*
|
|
6713
|
-
*
|
|
6714
|
+
* <p>
|
|
6715
|
+
* <b>ExactCapacity</b> -- set the instance count to the
|
|
6714
6716
|
* scaling adjustment value.</p>
|
|
6715
6717
|
* </li>
|
|
6716
6718
|
* <li>
|
|
6717
|
-
*
|
|
6718
|
-
*
|
|
6719
|
+
* <p>
|
|
6720
|
+
* <b>PercentChangeInCapacity</b> -- increase or reduce
|
|
6719
6721
|
* the current instance count by the scaling adjustment, read as a percentage.
|
|
6720
6722
|
* Positive values scale up while negative values scale down; for example, a value
|
|
6721
6723
|
* of "-10" scales the fleet down by 10%.</p>
|
|
@@ -6741,65 +6743,65 @@ export interface PutScalingPolicyInput {
|
|
|
6741
6743
|
* <p>Name of the Amazon GameLift-defined metric that is used to trigger a scaling adjustment. For
|
|
6742
6744
|
* detailed descriptions of fleet metrics, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html">Monitor Amazon GameLift
|
|
6743
6745
|
* with Amazon CloudWatch</a>. </p>
|
|
6744
|
-
*
|
|
6746
|
+
* <ul>
|
|
6745
6747
|
* <li>
|
|
6746
|
-
*
|
|
6748
|
+
* <p>
|
|
6747
6749
|
* <b>ActivatingGameSessions</b> -- Game sessions in
|
|
6748
6750
|
* the process of being created.</p>
|
|
6749
6751
|
* </li>
|
|
6750
6752
|
* <li>
|
|
6751
|
-
*
|
|
6753
|
+
* <p>
|
|
6752
6754
|
* <b>ActiveGameSessions</b> -- Game sessions that
|
|
6753
6755
|
* are currently running.</p>
|
|
6754
6756
|
* </li>
|
|
6755
6757
|
* <li>
|
|
6756
|
-
*
|
|
6758
|
+
* <p>
|
|
6757
6759
|
* <b>ActiveInstances</b> -- Fleet instances that
|
|
6758
6760
|
* are currently running at least one game session.</p>
|
|
6759
6761
|
* </li>
|
|
6760
6762
|
* <li>
|
|
6761
|
-
*
|
|
6763
|
+
* <p>
|
|
6762
6764
|
* <b>AvailableGameSessions</b> -- Additional game
|
|
6763
6765
|
* sessions that fleet could host simultaneously, given current capacity.</p>
|
|
6764
6766
|
* </li>
|
|
6765
6767
|
* <li>
|
|
6766
|
-
*
|
|
6768
|
+
* <p>
|
|
6767
6769
|
* <b>AvailablePlayerSessions</b> -- Empty player
|
|
6768
6770
|
* slots in currently active game sessions. This includes game sessions that are
|
|
6769
6771
|
* not currently accepting players. Reserved player slots are not
|
|
6770
6772
|
* included.</p>
|
|
6771
6773
|
* </li>
|
|
6772
6774
|
* <li>
|
|
6773
|
-
*
|
|
6775
|
+
* <p>
|
|
6774
6776
|
* <b>CurrentPlayerSessions</b> -- Player slots in
|
|
6775
6777
|
* active game sessions that are being used by a player or are reserved for a
|
|
6776
6778
|
* player. </p>
|
|
6777
6779
|
* </li>
|
|
6778
6780
|
* <li>
|
|
6779
|
-
*
|
|
6781
|
+
* <p>
|
|
6780
6782
|
* <b>IdleInstances</b> -- Active instances that are
|
|
6781
6783
|
* currently hosting zero game sessions. </p>
|
|
6782
6784
|
* </li>
|
|
6783
6785
|
* <li>
|
|
6784
|
-
*
|
|
6786
|
+
* <p>
|
|
6785
6787
|
* <b>PercentAvailableGameSessions</b> -- Unused
|
|
6786
6788
|
* percentage of the total number of game sessions that a fleet could host
|
|
6787
6789
|
* simultaneously, given current capacity. Use this metric for a target-based
|
|
6788
6790
|
* scaling policy.</p>
|
|
6789
6791
|
* </li>
|
|
6790
6792
|
* <li>
|
|
6791
|
-
*
|
|
6793
|
+
* <p>
|
|
6792
6794
|
* <b>PercentIdleInstances</b> -- Percentage of the
|
|
6793
6795
|
* total number of active instances that are hosting zero game sessions.</p>
|
|
6794
6796
|
* </li>
|
|
6795
6797
|
* <li>
|
|
6796
|
-
*
|
|
6798
|
+
* <p>
|
|
6797
6799
|
* <b>QueueDepth</b> -- Pending game session
|
|
6798
6800
|
* placement requests, in any queue, where the current fleet is the top-priority
|
|
6799
6801
|
* destination.</p>
|
|
6800
6802
|
* </li>
|
|
6801
6803
|
* <li>
|
|
6802
|
-
*
|
|
6804
|
+
* <p>
|
|
6803
6805
|
* <b>WaitTime</b> -- Current wait time for pending
|
|
6804
6806
|
* game session placement requests, in any queue, where the current fleet is the
|
|
6805
6807
|
* top-priority destination. </p>
|
|
@@ -6845,16 +6847,16 @@ export interface RegisterComputeInput {
|
|
|
6845
6847
|
ComputeName: string | undefined;
|
|
6846
6848
|
/**
|
|
6847
6849
|
* <p>The path to the TLS certificate on your compute resource. The path and certificate are
|
|
6848
|
-
* not validated by GameLift.</p>
|
|
6850
|
+
* not validated by Amazon GameLift.</p>
|
|
6849
6851
|
*/
|
|
6850
6852
|
CertificatePath?: string;
|
|
6851
6853
|
/**
|
|
6852
|
-
* <p>The DNS name of the compute resource. GameLift requires the DNS name or IP address to
|
|
6854
|
+
* <p>The DNS name of the compute resource. Amazon GameLift requires the DNS name or IP address to
|
|
6853
6855
|
* manage your compute resource.</p>
|
|
6854
6856
|
*/
|
|
6855
6857
|
DnsName?: string;
|
|
6856
6858
|
/**
|
|
6857
|
-
* <p>The IP address of the compute resource. GameLift requires the DNS name or IP address to
|
|
6859
|
+
* <p>The IP address of the compute resource. Amazon GameLift requires the DNS name or IP address to
|
|
6858
6860
|
* manage your compute resource.</p>
|
|
6859
6861
|
*/
|
|
6860
6862
|
IpAddress?: string;
|
|
@@ -7010,11 +7012,11 @@ export interface SearchGameSessionsInput {
|
|
|
7010
7012
|
* <p>String containing the search criteria for the session search. If no filter expression
|
|
7011
7013
|
* is included, the request returns results for all game sessions in the fleet that are in
|
|
7012
7014
|
* <code>ACTIVE</code> status.</p>
|
|
7013
|
-
*
|
|
7015
|
+
* <p>A filter expression can contain one or multiple conditions. Each condition consists of
|
|
7014
7016
|
* the following:</p>
|
|
7015
|
-
*
|
|
7017
|
+
* <ul>
|
|
7016
7018
|
* <li>
|
|
7017
|
-
*
|
|
7019
|
+
* <p>
|
|
7018
7020
|
* <b>Operand</b> -- Name of a game session attribute.
|
|
7019
7021
|
* Valid values are <code>gameSessionName</code>, <code>gameSessionId</code>,
|
|
7020
7022
|
* <code>gameSessionProperties</code>, <code>maximumSessions</code>,
|
|
@@ -7022,13 +7024,13 @@ export interface SearchGameSessionsInput {
|
|
|
7022
7024
|
* <code>hasAvailablePlayerSessions</code>.</p>
|
|
7023
7025
|
* </li>
|
|
7024
7026
|
* <li>
|
|
7025
|
-
*
|
|
7027
|
+
* <p>
|
|
7026
7028
|
* <b>Comparator</b> -- Valid comparators are:
|
|
7027
7029
|
* <code>=</code>, <code><></code>, <code><</code>, <code>></code>,
|
|
7028
7030
|
* <code><=</code>, <code>>=</code>. </p>
|
|
7029
7031
|
* </li>
|
|
7030
7032
|
* <li>
|
|
7031
|
-
*
|
|
7033
|
+
* <p>
|
|
7032
7034
|
* <b>Value</b> -- Value to be searched for. Values may
|
|
7033
7035
|
* be numbers, boolean values (true/false) or strings depending on the operand.
|
|
7034
7036
|
* String values are case sensitive and must be enclosed in single quotes. Special
|
|
@@ -7039,32 +7041,32 @@ export interface SearchGameSessionsInput {
|
|
|
7039
7041
|
* 1'"</code>. </p>
|
|
7040
7042
|
* </li>
|
|
7041
7043
|
* </ul>
|
|
7042
|
-
*
|
|
7044
|
+
* <p>To chain multiple conditions in a single expression, use the logical keywords
|
|
7043
7045
|
* <code>AND</code>, <code>OR</code>, and <code>NOT</code> and parentheses as needed.
|
|
7044
7046
|
* For example: <code>x AND y AND NOT z</code>, <code>NOT (x OR y)</code>.</p>
|
|
7045
|
-
*
|
|
7047
|
+
* <p>Session search evaluates conditions from left to right using the following precedence
|
|
7046
7048
|
* rules:</p>
|
|
7047
|
-
*
|
|
7049
|
+
* <ol>
|
|
7048
7050
|
* <li>
|
|
7049
|
-
*
|
|
7050
|
-
*
|
|
7051
|
+
* <p>
|
|
7052
|
+
* <code>=</code>, <code><></code>, <code><</code>, <code>></code>,
|
|
7051
7053
|
* <code><=</code>, <code>>=</code>
|
|
7052
|
-
*
|
|
7054
|
+
* </p>
|
|
7053
7055
|
* </li>
|
|
7054
7056
|
* <li>
|
|
7055
|
-
*
|
|
7057
|
+
* <p>Parentheses</p>
|
|
7056
7058
|
* </li>
|
|
7057
7059
|
* <li>
|
|
7058
|
-
*
|
|
7060
|
+
* <p>NOT</p>
|
|
7059
7061
|
* </li>
|
|
7060
7062
|
* <li>
|
|
7061
|
-
*
|
|
7063
|
+
* <p>AND</p>
|
|
7062
7064
|
* </li>
|
|
7063
7065
|
* <li>
|
|
7064
|
-
*
|
|
7066
|
+
* <p>OR</p>
|
|
7065
7067
|
* </li>
|
|
7066
7068
|
* </ol>
|
|
7067
|
-
*
|
|
7069
|
+
* <p>For example, this filter expression retrieves game sessions hosting at least ten
|
|
7068
7070
|
* players that have an open player slot: <code>"maximumSessions>=10 AND
|
|
7069
7071
|
* hasAvailablePlayerSessions=true"</code>. </p>
|
|
7070
7072
|
*/
|
|
@@ -7073,22 +7075,22 @@ export interface SearchGameSessionsInput {
|
|
|
7073
7075
|
* <p>Instructions on how to sort the search results. If no sort expression is included, the
|
|
7074
7076
|
* request returns results in random order. A sort expression consists of the following
|
|
7075
7077
|
* elements:</p>
|
|
7076
|
-
*
|
|
7078
|
+
* <ul>
|
|
7077
7079
|
* <li>
|
|
7078
|
-
*
|
|
7079
|
-
*
|
|
7080
|
+
* <p>
|
|
7081
|
+
* <b>Operand</b> -- Name of a game session attribute.
|
|
7080
7082
|
* Valid values are <code>gameSessionName</code>, <code>gameSessionId</code>,
|
|
7081
7083
|
* <code>gameSessionProperties</code>, <code>maximumSessions</code>,
|
|
7082
7084
|
* <code>creationTimeMillis</code>, <code>playerSessionCount</code>,
|
|
7083
7085
|
* <code>hasAvailablePlayerSessions</code>.</p>
|
|
7084
7086
|
* </li>
|
|
7085
7087
|
* <li>
|
|
7086
|
-
*
|
|
7087
|
-
*
|
|
7088
|
+
* <p>
|
|
7089
|
+
* <b>Order</b> -- Valid sort orders are <code>ASC</code>
|
|
7088
7090
|
* (ascending) and <code>DESC</code> (descending).</p>
|
|
7089
7091
|
* </li>
|
|
7090
7092
|
* </ul>
|
|
7091
|
-
*
|
|
7093
|
+
* <p>For example, this sort expression returns the oldest active sessions first:
|
|
7092
7094
|
* <code>"SortExpression": "creationTimeMillis ASC"</code>. Results with a null value
|
|
7093
7095
|
* for the sort operand are returned at the end of the list.</p>
|
|
7094
7096
|
*/
|
|
@@ -7144,7 +7146,7 @@ export interface StartFleetActionsOutput {
|
|
|
7144
7146
|
*/
|
|
7145
7147
|
FleetId?: string;
|
|
7146
7148
|
/**
|
|
7147
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.</p>
|
|
7149
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.</p>
|
|
7148
7150
|
*/
|
|
7149
7151
|
FleetArn?: string;
|
|
7150
7152
|
}
|
|
@@ -7227,20 +7229,20 @@ export interface StartMatchBackfillInput {
|
|
|
7227
7229
|
* <p>Match information on all players that are currently assigned to the game session. This
|
|
7228
7230
|
* information is used by the matchmaker to find new players and add them to the existing
|
|
7229
7231
|
* game.</p>
|
|
7230
|
-
*
|
|
7232
|
+
* <p>You can include up to 199 <code>Players</code> in a <code>StartMatchBackfill</code>
|
|
7231
7233
|
* request.</p>
|
|
7232
|
-
*
|
|
7234
|
+
* <ul>
|
|
7233
7235
|
* <li>
|
|
7234
|
-
*
|
|
7236
|
+
* <p>PlayerID, PlayerAttributes, Team -- This information is maintained in the
|
|
7235
7237
|
* <code>GameSession</code> object, <code>MatchmakerData</code> property, for
|
|
7236
7238
|
* all players who are currently assigned to the game session. The matchmaker data
|
|
7237
7239
|
* is in JSON syntax, formatted as a string. For more details, see <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data">
|
|
7238
7240
|
* Match Data</a>. </p>
|
|
7239
|
-
*
|
|
7241
|
+
* <p>The backfill request must specify the team membership for every player. Do not
|
|
7240
7242
|
* specify team if you are not using backfill.</p>
|
|
7241
7243
|
* </li>
|
|
7242
7244
|
* <li>
|
|
7243
|
-
*
|
|
7245
|
+
* <p>LatencyInMs -- If the matchmaker uses player latency, include a latency value,
|
|
7244
7246
|
* in milliseconds, for the Region that the game session is currently in. Do not
|
|
7245
7247
|
* include latency values for any other Region.</p>
|
|
7246
7248
|
* </li>
|
|
@@ -7280,7 +7282,7 @@ export interface StartMatchmakingInput {
|
|
|
7280
7282
|
* and may contain player attributes and latency data to be used in the matchmaking
|
|
7281
7283
|
* process. After a successful match, <code>Player</code> objects contain the name of the
|
|
7282
7284
|
* team the player is assigned to.</p>
|
|
7283
|
-
*
|
|
7285
|
+
* <p>You can include up to 10 <code>Players</code> in a <code>StartMatchmaking</code>
|
|
7284
7286
|
* request.</p>
|
|
7285
7287
|
*/
|
|
7286
7288
|
Players: Player[] | undefined;
|
|
@@ -7323,7 +7325,7 @@ export interface StopFleetActionsOutput {
|
|
|
7323
7325
|
*/
|
|
7324
7326
|
FleetId?: string;
|
|
7325
7327
|
/**
|
|
7326
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.</p>
|
|
7328
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.</p>
|
|
7327
7329
|
*/
|
|
7328
7330
|
FleetArn?: string;
|
|
7329
7331
|
}
|
|
@@ -7389,17 +7391,17 @@ export interface SuspendGameServerGroupOutput {
|
|
|
7389
7391
|
*/
|
|
7390
7392
|
export interface TagResourceRequest {
|
|
7391
7393
|
/**
|
|
7392
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that
|
|
7393
|
-
*
|
|
7394
|
-
*
|
|
7395
|
-
*
|
|
7394
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that uniquely identifies
|
|
7395
|
+
* the Amazon GameLift resource that you want to assign tags to. Amazon GameLift includes resource ARNs in
|
|
7396
|
+
* the data object for the resource. You can retrieve the ARN by calling a
|
|
7397
|
+
* <code>List</code> or <code>Describe</code> operation for the resource type. </p>
|
|
7396
7398
|
*/
|
|
7397
7399
|
ResourceARN: string | undefined;
|
|
7398
7400
|
/**
|
|
7399
|
-
* <p>A list of one or more tags to assign to the specified GameLift resource. Tags are
|
|
7401
|
+
* <p>A list of one or more tags to assign to the specified Amazon GameLift resource. Tags are
|
|
7400
7402
|
* developer-defined and structured as key-value pairs. The maximum tag limit may be lower
|
|
7401
7403
|
* than stated. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">
|
|
7402
|
-
* Tagging Amazon Web Services Resources</a> for
|
|
7404
|
+
* Tagging Amazon Web Services Resources</a> for tagging limits.</p>
|
|
7403
7405
|
*/
|
|
7404
7406
|
Tags: Tag[] | undefined;
|
|
7405
7407
|
}
|
|
@@ -7413,16 +7415,14 @@ export interface TagResourceResponse {
|
|
|
7413
7415
|
*/
|
|
7414
7416
|
export interface UntagResourceRequest {
|
|
7415
7417
|
/**
|
|
7416
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that
|
|
7417
|
-
*
|
|
7418
|
-
*
|
|
7419
|
-
*
|
|
7418
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that uniquely identifies
|
|
7419
|
+
* the Amazon GameLift resource that you want to remove tags from. Amazon GameLift includes resource ARNs in
|
|
7420
|
+
* the data object for the resource. You can retrieve the ARN by calling a
|
|
7421
|
+
* <code>List</code> or <code>Describe</code> operation for the resource type. </p>
|
|
7420
7422
|
*/
|
|
7421
7423
|
ResourceARN: string | undefined;
|
|
7422
7424
|
/**
|
|
7423
|
-
* <p>A list of one or more tag keys to remove from the specified GameLift resource.
|
|
7424
|
-
* Amazon Web Services resource can have only one tag with a specific tag key, so specifying the tag key
|
|
7425
|
-
* identifies which tag to remove. </p>
|
|
7425
|
+
* <p>A list of one or more tag keys to remove from the specified Amazon GameLift resource. </p>
|
|
7426
7426
|
*/
|
|
7427
7427
|
TagKeys: string[] | undefined;
|
|
7428
7428
|
}
|
|
@@ -7472,11 +7472,11 @@ export interface UpdateBuildInput {
|
|
|
7472
7472
|
*/
|
|
7473
7473
|
BuildId: string | undefined;
|
|
7474
7474
|
/**
|
|
7475
|
-
* <p>A descriptive label associated with a build. Build names
|
|
7475
|
+
* <p>A descriptive label associated with a build. Build names don't need to be unique. </p>
|
|
7476
7476
|
*/
|
|
7477
7477
|
Name?: string;
|
|
7478
7478
|
/**
|
|
7479
|
-
* <p>Version information associated with a build or script. Version strings
|
|
7479
|
+
* <p>Version information associated with a build or script. Version strings don't need to be unique.</p>
|
|
7480
7480
|
*/
|
|
7481
7481
|
Version?: string;
|
|
7482
7482
|
}
|
|
@@ -7510,15 +7510,15 @@ export interface UpdateFleetAttributesInput {
|
|
|
7510
7510
|
* <p>The game session protection policy to apply to all new instances created in this
|
|
7511
7511
|
* fleet. Instances that already exist are not affected. You can set protection for
|
|
7512
7512
|
* individual instances using <a href="https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateGameSession.html">UpdateGameSession</a> .</p>
|
|
7513
|
-
*
|
|
7513
|
+
* <ul>
|
|
7514
7514
|
* <li>
|
|
7515
|
-
*
|
|
7516
|
-
*
|
|
7515
|
+
* <p>
|
|
7516
|
+
* <b>NoProtection</b> -- The game session can be
|
|
7517
7517
|
* terminated during a scale-down event.</p>
|
|
7518
7518
|
* </li>
|
|
7519
7519
|
* <li>
|
|
7520
|
-
*
|
|
7521
|
-
*
|
|
7520
|
+
* <p>
|
|
7521
|
+
* <b>FullProtection</b> -- If the game session is in an
|
|
7522
7522
|
* <code>ACTIVE</code> status, it cannot be terminated during a scale-down
|
|
7523
7523
|
* event.</p>
|
|
7524
7524
|
* </li>
|
|
@@ -7538,7 +7538,7 @@ export interface UpdateFleetAttributesInput {
|
|
|
7538
7538
|
*/
|
|
7539
7539
|
MetricGroups?: string[];
|
|
7540
7540
|
/**
|
|
7541
|
-
* <p>GameLift Anywhere configuration options.</p>
|
|
7541
|
+
* <p>Amazon GameLift Anywhere configuration options.</p>
|
|
7542
7542
|
*/
|
|
7543
7543
|
AnywhereConfiguration?: AnywhereConfiguration;
|
|
7544
7544
|
}
|
|
@@ -7551,7 +7551,7 @@ export interface UpdateFleetAttributesOutput {
|
|
|
7551
7551
|
*/
|
|
7552
7552
|
FleetId?: string;
|
|
7553
7553
|
/**
|
|
7554
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.</p>
|
|
7554
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>.</p>
|
|
7555
7555
|
*/
|
|
7556
7556
|
FleetArn?: string;
|
|
7557
7557
|
}
|
|
@@ -7594,7 +7594,7 @@ export interface UpdateFleetCapacityOutput {
|
|
|
7594
7594
|
*/
|
|
7595
7595
|
FleetId?: string;
|
|
7596
7596
|
/**
|
|
7597
|
-
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>. </p>
|
|
7597
|
+
* <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912</code>. </p>
|
|
7598
7598
|
*/
|
|
7599
7599
|
FleetArn?: string;
|
|
7600
7600
|
/**
|