aws-sdk-gamelift 1.35.0 → 1.36.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-gamelift.rb +1 -1
- data/lib/aws-sdk-gamelift/client.rb +645 -504
- data/lib/aws-sdk-gamelift/client_api.rb +158 -5
- data/lib/aws-sdk-gamelift/types.rb +645 -470
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 643faf0fb7357b1685bc6baff8b979a8f99d417ffc070415dd705a15fc67b727
|
4
|
+
data.tar.gz: 789736af3e9d8a1079e777a371987d73f2dc6ccd501f4432ef4eb178ab3fa949
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 3a339c92f286893711c325282e2d2e82e9aeb7886be3e09aabae47dbb9a80fd00ddda2171930fbdc87877ad6925740c85ca65465311baa375cf74823c6618105
|
7
|
+
data.tar.gz: e94aa48acd4b152ba7f289b06716e25e37fb66b60000494b452122e115d8bdb3195815ae861394a72d2f6f1e28a9fef1f445f88e7ca0e8a35125f84926fb43b8
|
data/lib/aws-sdk-gamelift.rb
CHANGED
@@ -416,47 +416,46 @@ module Aws::GameLift
|
|
416
416
|
req.send_request(options)
|
417
417
|
end
|
418
418
|
|
419
|
-
# **This
|
420
|
-
#
|
419
|
+
# **This operation is used with the Amazon GameLift FleetIQ solution and
|
420
|
+
# game server groups.**
|
421
421
|
#
|
422
422
|
# Locates an available game server and temporarily reserves it to host
|
423
|
-
# gameplay and players. This
|
424
|
-
# service (such as a matchmaker) to request hosting resources for
|
425
|
-
# game session. In response, GameLift FleetIQ
|
426
|
-
# game server in
|
427
|
-
#
|
428
|
-
#
|
429
|
-
#
|
430
|
-
#
|
431
|
-
#
|
432
|
-
#
|
433
|
-
#
|
434
|
-
#
|
435
|
-
# consolidate gameplay on as few instances as possible to minimize
|
436
|
-
# hosting costs. For the second option, you request a specific game
|
437
|
-
# server by its ID. This option results in a less efficient claiming
|
438
|
-
# process because it does not take advantage of consolidation and may
|
439
|
-
# fail if the requested game server is unavailable.
|
440
|
-
#
|
441
|
-
# To claim a game server, identify a game server group and (optionally)
|
442
|
-
# a game server ID. If your game requires that game data be provided to
|
443
|
-
# the game server at the start of a game, such as a game map or player
|
444
|
-
# information, you can provide it in your claim request.
|
423
|
+
# gameplay and players. This operation is called from a game client or
|
424
|
+
# client service (such as a matchmaker) to request hosting resources for
|
425
|
+
# a new game session. In response, GameLift FleetIQ locates an available
|
426
|
+
# game server, places it in `CLAIMED` status for 60 seconds, and returns
|
427
|
+
# connection information that players can use to connect to the game
|
428
|
+
# server.
|
429
|
+
#
|
430
|
+
# To claim a game server, identify a game server group. You can also
|
431
|
+
# specify a game server ID, although this approach bypasses GameLift
|
432
|
+
# FleetIQ placement optimization. Optionally, include game data to pass
|
433
|
+
# to the game server at the start of a game session, such as a game map
|
434
|
+
# or player information.
|
445
435
|
#
|
446
436
|
# When a game server is successfully claimed, connection information is
|
447
437
|
# returned. A claimed game server's utilization status remains
|
448
|
-
# AVAILABLE
|
449
|
-
# seconds. This time period
|
450
|
-
#
|
451
|
-
# server's status is not updated within 60 seconds, the game
|
452
|
-
# reverts to unclaimed status and is available to be claimed by
|
453
|
-
# request.
|
438
|
+
# `AVAILABLE` while the claim status is set to `CLAIMED` for up to 60
|
439
|
+
# seconds. This time period gives the game server time to update its
|
440
|
+
# status to `UTILIZED` (using UpdateGameServer) once players join. If
|
441
|
+
# the game server's status is not updated within 60 seconds, the game
|
442
|
+
# server reverts to unclaimed status and is available to be claimed by
|
443
|
+
# another request. The claim time period is a fixed value and is not
|
444
|
+
# configurable.
|
454
445
|
#
|
455
446
|
# If you try to claim a specific game server, this request will fail in
|
456
|
-
# the following cases:
|
457
|
-
#
|
458
|
-
#
|
459
|
-
#
|
447
|
+
# the following cases:
|
448
|
+
#
|
449
|
+
# * If the game server utilization status is `UTILIZED`.
|
450
|
+
#
|
451
|
+
# * If the game server claim status is `CLAIMED`.
|
452
|
+
#
|
453
|
+
# <note markdown="1"> When claiming a specific game server, this request will succeed even
|
454
|
+
# if the game server is running on an instance in `DRAINING` status. To
|
455
|
+
# avoid this, first check the instance status by calling
|
456
|
+
# DescribeGameServerInstances.
|
457
|
+
#
|
458
|
+
# </note>
|
460
459
|
#
|
461
460
|
# **Learn more**
|
462
461
|
#
|
@@ -478,14 +477,13 @@ module Aws::GameLift
|
|
478
477
|
#
|
479
478
|
#
|
480
479
|
#
|
481
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
480
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
482
481
|
#
|
483
482
|
# @option params [required, String] :game_server_group_name
|
484
|
-
#
|
485
|
-
#
|
486
|
-
#
|
487
|
-
#
|
488
|
-
# either the GameServerGroup name or ARN value.
|
483
|
+
# A unique identifier for the game server group where the game server is
|
484
|
+
# running. Use either the GameServerGroup name or ARN value.. If you are
|
485
|
+
# not specifying a game server to claim, this value identifies where you
|
486
|
+
# want GameLift FleetIQ to look for an available game server to claim.
|
489
487
|
#
|
490
488
|
# @option params [String] :game_server_id
|
491
489
|
# A custom string that uniquely identifies the game server to claim. If
|
@@ -494,7 +492,9 @@ module Aws::GameLift
|
|
494
492
|
#
|
495
493
|
# @option params [String] :game_server_data
|
496
494
|
# A set of custom game server properties, formatted as a single string
|
497
|
-
# value
|
495
|
+
# value. This data is passed to a game client or service when it
|
496
|
+
# requests information on game servers using ListGameServers or
|
497
|
+
# ClaimGameServer.
|
498
498
|
#
|
499
499
|
# @return [Types::ClaimGameServerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
500
500
|
#
|
@@ -516,7 +516,6 @@ module Aws::GameLift
|
|
516
516
|
# resp.game_server.instance_id #=> String
|
517
517
|
# resp.game_server.connection_info #=> String
|
518
518
|
# resp.game_server.game_server_data #=> String
|
519
|
-
# resp.game_server.custom_sort_key #=> String
|
520
519
|
# resp.game_server.claim_status #=> String, one of "CLAIMED"
|
521
520
|
# resp.game_server.utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
|
522
521
|
# resp.game_server.registration_time #=> Time
|
@@ -651,12 +650,13 @@ module Aws::GameLift
|
|
651
650
|
#
|
652
651
|
# * To directly upload your build files to a GameLift S3 location. To
|
653
652
|
# use this option, first call `CreateBuild` and specify a build name
|
654
|
-
# and operating system. This
|
655
|
-
# also returns an S3 location with temporary access credentials.
|
656
|
-
# the credentials to manually upload your build files to the
|
657
|
-
# S3 location. For more information, see [Uploading
|
658
|
-
# *Amazon S3 Developer Guide*. Build files can be
|
659
|
-
# GameLift S3 location once only; that can't be
|
653
|
+
# and operating system. This operation creates a new build resource
|
654
|
+
# and also returns an S3 location with temporary access credentials.
|
655
|
+
# Use the credentials to manually upload your build files to the
|
656
|
+
# specified S3 location. For more information, see [Uploading
|
657
|
+
# Objects][1] in the *Amazon S3 Developer Guide*. Build files can be
|
658
|
+
# uploaded to the GameLift S3 location once only; that can't be
|
659
|
+
# updated.
|
660
660
|
#
|
661
661
|
# If successful, this operation creates a new build resource with a
|
662
662
|
# unique build ID and places it in `INITIALIZED` status. A build must be
|
@@ -1119,54 +1119,49 @@ module Aws::GameLift
|
|
1119
1119
|
req.send_request(options)
|
1120
1120
|
end
|
1121
1121
|
|
1122
|
-
# **This
|
1123
|
-
#
|
1124
|
-
#
|
1125
|
-
# Creates a GameLift FleetIQ game server group
|
1126
|
-
# EC2 instances for game hosting.
|
1127
|
-
# server group,
|
1128
|
-
# AWS account and establishes a link between the two groups.
|
1129
|
-
# full control over configuration of the Auto Scaling group, but
|
1130
|
-
# GameLift FleetIQ routinely certain Auto Scaling group properties in
|
1131
|
-
# order to optimize the group's instances for low-cost game hosting.
|
1122
|
+
# **This operation is used with the Amazon GameLift FleetIQ solution and
|
1123
|
+
# game server groups.**
|
1124
|
+
#
|
1125
|
+
# Creates a GameLift FleetIQ game server group for managing game hosting
|
1126
|
+
# on a collection of Amazon EC2 instances for game hosting. This
|
1127
|
+
# operation creates the game server group, creates an Auto Scaling group
|
1128
|
+
# in your AWS account, and establishes a link between the two groups.
|
1132
1129
|
# You can view the status of your game server groups in the GameLift
|
1133
|
-
#
|
1130
|
+
# console. Game server group metrics and events are emitted to Amazon
|
1134
1131
|
# CloudWatch.
|
1135
1132
|
#
|
1136
|
-
#
|
1133
|
+
# Before creating a new game server group, you must have the following:
|
1137
1134
|
#
|
1138
|
-
# * An EC2 launch template
|
1139
|
-
#
|
1140
|
-
#
|
1141
|
-
#
|
1142
|
-
# Launch Template][1] in the *Amazon EC2 User Guide*.
|
1135
|
+
# * An Amazon EC2 launch template that specifies how to launch Amazon
|
1136
|
+
# EC2 instances with your game server build. For more information, see
|
1137
|
+
# [ Launching an Instance from a Launch Template][1] in the *Amazon
|
1138
|
+
# EC2 User Guide*.
|
1143
1139
|
#
|
1144
|
-
# * An IAM role
|
1145
|
-
#
|
1146
|
-
#
|
1147
|
-
#
|
1148
|
-
# principal access for GameLift, see [ Specifying a Principal in a
|
1149
|
-
# Policy][2] in the *Amazon S3 Developer Guide*.
|
1140
|
+
# * An IAM role that extends limited access to your AWS account to allow
|
1141
|
+
# GameLift FleetIQ to create and interact with the Auto Scaling group.
|
1142
|
+
# For more information, see [Create IAM roles for cross-service
|
1143
|
+
# interaction][2] in the *GameLift FleetIQ Developer Guide*.
|
1150
1144
|
#
|
1151
|
-
# To create a new game server group,
|
1152
|
-
# role and EC2 launch template
|
1153
|
-
#
|
1154
|
-
# minimum limits on the group's instance count. You can optionally
|
1155
|
-
# an
|
1156
|
-
# metric.
|
1145
|
+
# To create a new game server group, specify a unique group name, IAM
|
1146
|
+
# role and Amazon EC2 launch template, and provide a list of instance
|
1147
|
+
# types that can be used in the group. You must also set initial maximum
|
1148
|
+
# and minimum limits on the group's instance count. You can optionally
|
1149
|
+
# set an Auto Scaling policy with target tracking based on a GameLift
|
1150
|
+
# FleetIQ metric.
|
1157
1151
|
#
|
1158
1152
|
# Once the game server group and corresponding Auto Scaling group are
|
1159
1153
|
# created, you have full access to change the Auto Scaling group's
|
1160
|
-
# configuration as needed.
|
1161
|
-
#
|
1162
|
-
#
|
1154
|
+
# configuration as needed. Several properties that are set when creating
|
1155
|
+
# a game server group, including maximum/minimum size and auto-scaling
|
1156
|
+
# policy settings, must be updated directly in the Auto Scaling group.
|
1157
|
+
# Keep in mind that some Auto Scaling group properties are periodically
|
1158
|
+
# updated by GameLift FleetIQ as part of its balancing activities to
|
1159
|
+
# optimize for availability and cost.
|
1163
1160
|
#
|
1164
1161
|
# **Learn more**
|
1165
1162
|
#
|
1166
1163
|
# [GameLift FleetIQ Guide][3]
|
1167
1164
|
#
|
1168
|
-
# [Updating a GameLift FleetIQ-Linked Auto Scaling Group][4]
|
1169
|
-
#
|
1170
1165
|
# **Related operations**
|
1171
1166
|
#
|
1172
1167
|
# * CreateGameServerGroup
|
@@ -1183,12 +1178,13 @@ module Aws::GameLift
|
|
1183
1178
|
#
|
1184
1179
|
# * SuspendGameServerGroup
|
1185
1180
|
#
|
1181
|
+
# * DescribeGameServerInstances
|
1182
|
+
#
|
1186
1183
|
#
|
1187
1184
|
#
|
1188
1185
|
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html
|
1189
|
-
# [2]: https://docs.aws.amazon.com/
|
1190
|
-
# [3]: https://docs.aws.amazon.com/gamelift/latest/
|
1191
|
-
# [4]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-asgroups.html
|
1186
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-iam-permissions-roles.html
|
1187
|
+
# [3]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
1192
1188
|
#
|
1193
1189
|
# @option params [required, String] :game_server_group_name
|
1194
1190
|
# An identifier for the new game server group. This value is used to
|
@@ -1198,9 +1194,7 @@ module Aws::GameLift
|
|
1198
1194
|
#
|
1199
1195
|
# @option params [required, String] :role_arn
|
1200
1196
|
# The Amazon Resource Name ([ARN][1]) for an IAM role that allows Amazon
|
1201
|
-
# GameLift to access your EC2 Auto Scaling groups.
|
1202
|
-
# validated to ensure that it contains the necessary permissions for
|
1203
|
-
# game server groups.
|
1197
|
+
# GameLift to access your EC2 Auto Scaling groups.
|
1204
1198
|
#
|
1205
1199
|
#
|
1206
1200
|
#
|
@@ -1208,14 +1202,18 @@ module Aws::GameLift
|
|
1208
1202
|
#
|
1209
1203
|
# @option params [required, Integer] :min_size
|
1210
1204
|
# The minimum number of instances allowed in the EC2 Auto Scaling group.
|
1211
|
-
# During
|
1212
|
-
# the group below this minimum. In production, this value should be
|
1213
|
-
# to at least 1.
|
1205
|
+
# During automatic scaling events, GameLift FleetIQ and EC2 do not scale
|
1206
|
+
# down the group below this minimum. In production, this value should be
|
1207
|
+
# set to at least 1. After the Auto Scaling group is created, update
|
1208
|
+
# this value directly in the Auto Scaling group using the AWS console or
|
1209
|
+
# APIs.
|
1214
1210
|
#
|
1215
1211
|
# @option params [required, Integer] :max_size
|
1216
1212
|
# The maximum number of instances allowed in the EC2 Auto Scaling group.
|
1217
|
-
# During
|
1218
|
-
# the group above this maximum.
|
1213
|
+
# During automatic scaling events, GameLift FleetIQ and EC2 do not scale
|
1214
|
+
# up the group above this maximum. After the Auto Scaling group is
|
1215
|
+
# created, update this value directly in the Auto Scaling group using
|
1216
|
+
# the AWS console or APIs.
|
1219
1217
|
#
|
1220
1218
|
# @option params [required, Types::LaunchTemplateSpecification] :launch_template
|
1221
1219
|
# The EC2 launch template that contains configuration settings and game
|
@@ -1223,72 +1221,88 @@ module Aws::GameLift
|
|
1223
1221
|
# You can specify the template using either the template name or ID. For
|
1224
1222
|
# help with creating a launch template, see [Creating a Launch Template
|
1225
1223
|
# for an Auto Scaling Group][1] in the *Amazon EC2 Auto Scaling User
|
1226
|
-
# Guide*.
|
1224
|
+
# Guide*. After the Auto Scaling group is created, update this value
|
1225
|
+
# directly in the Auto Scaling group using the AWS console or APIs.
|
1227
1226
|
#
|
1228
1227
|
#
|
1229
1228
|
#
|
1230
1229
|
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html
|
1231
1230
|
#
|
1232
1231
|
# @option params [required, Array<Types::InstanceDefinition>] :instance_definitions
|
1233
|
-
#
|
1234
|
-
#
|
1235
|
-
#
|
1236
|
-
#
|
1237
|
-
#
|
1232
|
+
# The EC2 instance types and sizes to use in the Auto Scaling group. The
|
1233
|
+
# instance definitions must specify at least two different instance
|
1234
|
+
# types that are supported by GameLift FleetIQ. For more information on
|
1235
|
+
# instance types, see [EC2 Instance Types][1] in the *Amazon EC2 User
|
1236
|
+
# Guide*. You can optionally specify capacity weighting for each
|
1237
|
+
# instance type. If no weight value is specified for an instance type,
|
1238
|
+
# it is set to the default value "1". For more information about
|
1239
|
+
# capacity weighting, see [ Instance Weighting for Amazon EC2 Auto
|
1240
|
+
# Scaling][2] in the Amazon EC2 Auto Scaling User Guide.
|
1238
1241
|
#
|
1239
1242
|
#
|
1240
1243
|
#
|
1241
1244
|
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html
|
1245
|
+
# [2]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html
|
1242
1246
|
#
|
1243
1247
|
# @option params [Types::GameServerGroupAutoScalingPolicy] :auto_scaling_policy
|
1244
1248
|
# Configuration settings to define a scaling policy for the Auto Scaling
|
1245
1249
|
# group that is optimized for game hosting. The scaling policy uses the
|
1246
|
-
# metric "PercentUtilizedGameServers" to maintain a buffer of idle
|
1250
|
+
# metric `"PercentUtilizedGameServers"` to maintain a buffer of idle
|
1247
1251
|
# game servers that can immediately accommodate new games and players.
|
1248
|
-
#
|
1249
|
-
#
|
1252
|
+
# After the Auto Scaling group is created, update this value directly in
|
1253
|
+
# the Auto Scaling group using the AWS console or APIs.
|
1250
1254
|
#
|
1251
1255
|
# @option params [String] :balancing_strategy
|
1252
|
-
#
|
1253
|
-
#
|
1254
|
-
#
|
1255
|
-
#
|
1256
|
-
#
|
1257
|
-
#
|
1258
|
-
# group provides no hosting capacity
|
1259
|
-
#
|
1260
|
-
#
|
1261
|
-
#
|
1262
|
-
#
|
1263
|
-
#
|
1264
|
-
#
|
1265
|
-
#
|
1266
|
-
# On-Demand
|
1256
|
+
# Indicates how GameLift FleetIQ balances the use of Spot Instances and
|
1257
|
+
# On-Demand Instances in the game server group. Method options include
|
1258
|
+
# the following:
|
1259
|
+
#
|
1260
|
+
# * `SPOT_ONLY` - Only Spot Instances are used in the game server group.
|
1261
|
+
# If Spot Instances are unavailable or not viable for game hosting,
|
1262
|
+
# the game server group provides no hosting capacity until Spot
|
1263
|
+
# Instances can again be used. Until then, no new instances are
|
1264
|
+
# started, and the existing nonviable Spot Instances are terminated
|
1265
|
+
# (after current gameplay ends) and are not replaced.
|
1266
|
+
#
|
1267
|
+
# * `SPOT_PREFERRED` - (default value) Spot Instances are used whenever
|
1268
|
+
# available in the game server group. If Spot Instances are
|
1269
|
+
# unavailable, the game server group continues to provide hosting
|
1270
|
+
# capacity by falling back to On-Demand Instances. Existing nonviable
|
1271
|
+
# Spot Instances are terminated (after current gameplay ends) and are
|
1272
|
+
# replaced with new On-Demand Instances.
|
1273
|
+
#
|
1274
|
+
# * `ON_DEMAND_ONLY` - Only On-Demand Instances are used in the game
|
1275
|
+
# server group. No Spot Instances are used, even when available, while
|
1276
|
+
# this balancing strategy is in force.
|
1267
1277
|
#
|
1268
1278
|
# @option params [String] :game_server_protection_policy
|
1269
1279
|
# A flag that indicates whether instances in the game server group are
|
1270
1280
|
# protected from early termination. Unprotected instances that have
|
1271
|
-
# active game servers running
|
1281
|
+
# active game servers running might be terminated during a scale-down
|
1272
1282
|
# event, causing players to be dropped from the game. Protected
|
1273
1283
|
# instances cannot be terminated while there are active game servers
|
1274
|
-
# running
|
1284
|
+
# running except in the event of a forced game server group deletion
|
1285
|
+
# (see ). An exception to this is with Spot Instances, which can be
|
1275
1286
|
# terminated by AWS regardless of protection status. This property is
|
1276
|
-
# set to
|
1287
|
+
# set to `NO_PROTECTION` by default.
|
1277
1288
|
#
|
1278
1289
|
# @option params [Array<String>] :vpc_subnets
|
1279
1290
|
# A list of virtual private cloud (VPC) subnets to use with instances in
|
1280
1291
|
# the game server group. By default, all GameLift FleetIQ-supported
|
1281
|
-
#
|
1282
|
-
# that you've set up.
|
1292
|
+
# Availability Zones are used. You can use this parameter to specify
|
1293
|
+
# VPCs that you've set up. This property cannot be updated after the
|
1294
|
+
# game server group is created, and the corresponding Auto Scaling group
|
1295
|
+
# will always use the property value that is set with this request, even
|
1296
|
+
# if the Auto Scaling group is updated directly
|
1283
1297
|
#
|
1284
1298
|
# @option params [Array<Types::Tag>] :tags
|
1285
1299
|
# A list of labels to assign to the new game server group resource. Tags
|
1286
|
-
# are developer-defined key-value pairs. Tagging AWS resources
|
1287
|
-
#
|
1288
|
-
#
|
1289
|
-
#
|
1290
|
-
#
|
1291
|
-
#
|
1300
|
+
# are developer-defined key-value pairs. Tagging AWS resources is useful
|
1301
|
+
# for resource management, access management, and cost allocation. For
|
1302
|
+
# more information, see [ Tagging AWS Resources][1] in the *AWS General
|
1303
|
+
# Reference*. Once the resource is created, you can use TagResource,
|
1304
|
+
# UntagResource, and ListTagsForResource to add, remove, and view tags,
|
1305
|
+
# respectively. The maximum tag limit may be lower than stated. See the
|
1292
1306
|
# AWS General Reference for actual tagging limits.
|
1293
1307
|
#
|
1294
1308
|
#
|
@@ -1323,7 +1337,7 @@ module Aws::GameLift
|
|
1323
1337
|
# target_value: 1.0, # required
|
1324
1338
|
# },
|
1325
1339
|
# },
|
1326
|
-
# balancing_strategy: "SPOT_ONLY", # accepts SPOT_ONLY, SPOT_PREFERRED
|
1340
|
+
# balancing_strategy: "SPOT_ONLY", # accepts SPOT_ONLY, SPOT_PREFERRED, ON_DEMAND_ONLY
|
1327
1341
|
# game_server_protection_policy: "NO_PROTECTION", # accepts NO_PROTECTION, FULL_PROTECTION
|
1328
1342
|
# vpc_subnets: ["VpcSubnet"],
|
1329
1343
|
# tags: [
|
@@ -1342,7 +1356,7 @@ module Aws::GameLift
|
|
1342
1356
|
# resp.game_server_group.instance_definitions #=> Array
|
1343
1357
|
# resp.game_server_group.instance_definitions[0].instance_type #=> String, one of "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge"
|
1344
1358
|
# resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
|
1345
|
-
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED"
|
1359
|
+
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED", "ON_DEMAND_ONLY"
|
1346
1360
|
# resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
|
1347
1361
|
# resp.game_server_group.auto_scaling_group_arn #=> String
|
1348
1362
|
# resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
|
@@ -1361,8 +1375,8 @@ module Aws::GameLift
|
|
1361
1375
|
req.send_request(options)
|
1362
1376
|
end
|
1363
1377
|
|
1364
|
-
# Creates a multiplayer game session for players. This
|
1365
|
-
# game session record and assigns an available server process in the
|
1378
|
+
# Creates a multiplayer game session for players. This operation creates
|
1379
|
+
# a game session record and assigns an available server process in the
|
1366
1380
|
# specified fleet to host the game session. A fleet must have an
|
1367
1381
|
# `ACTIVE` status before a game session can be created in it.
|
1368
1382
|
#
|
@@ -1693,20 +1707,17 @@ module Aws::GameLift
|
|
1693
1707
|
# use when placing a new game session for the match; and the maximum
|
1694
1708
|
# time allowed for a matchmaking attempt.
|
1695
1709
|
#
|
1696
|
-
#
|
1697
|
-
#
|
1698
|
-
#
|
1699
|
-
#
|
1700
|
-
#
|
1701
|
-
# configuration. Since notifications promise only "best effort"
|
1702
|
-
# delivery, we recommend calling `DescribeMatchmaking` if no
|
1703
|
-
# notifications are received within 30 seconds.
|
1710
|
+
# To track the progress of matchmaking tickets, set up an Amazon Simple
|
1711
|
+
# Notification Service (SNS) to receive notifications, and provide the
|
1712
|
+
# topic ARN in the matchmaking configuration. An alternative method,
|
1713
|
+
# continuously poling ticket status with DescribeMatchmaking, should
|
1714
|
+
# only be used for games in development with low matchmaking usage.
|
1704
1715
|
#
|
1705
1716
|
# **Learn more**
|
1706
1717
|
#
|
1707
1718
|
# [ Design a FlexMatch Matchmaker][1]
|
1708
1719
|
#
|
1709
|
-
# [
|
1720
|
+
# [ Set Up FlexMatch Event Notification][2]
|
1710
1721
|
#
|
1711
1722
|
# **Related operations**
|
1712
1723
|
#
|
@@ -2474,7 +2485,7 @@ module Aws::GameLift
|
|
2474
2485
|
req.send_request(options)
|
2475
2486
|
end
|
2476
2487
|
|
2477
|
-
# Deletes an alias. This
|
2488
|
+
# Deletes an alias. This operation removes all record of the alias. Game
|
2478
2489
|
# clients attempting to access a server process using the deleted alias
|
2479
2490
|
# receive an error. To delete an alias, specify the alias ID to be
|
2480
2491
|
# deleted.
|
@@ -2512,7 +2523,7 @@ module Aws::GameLift
|
|
2512
2523
|
req.send_request(options)
|
2513
2524
|
end
|
2514
2525
|
|
2515
|
-
# Deletes a build. This
|
2526
|
+
# Deletes a build. This operation permanently deletes the build resource
|
2516
2527
|
# and any uploaded build files. Deleting a build does not affect the
|
2517
2528
|
# status of any active fleets using the build, but you can no longer
|
2518
2529
|
# create new fleets with the deleted build.
|
@@ -2570,7 +2581,7 @@ module Aws::GameLift
|
|
2570
2581
|
# the VPC peering connection--this is done as part of the delete fleet
|
2571
2582
|
# process.
|
2572
2583
|
#
|
2573
|
-
# This
|
2584
|
+
# This operation removes the fleet and its resources. Once a fleet is
|
2574
2585
|
# deleted, you can no longer use any of the resource in that fleet.
|
2575
2586
|
#
|
2576
2587
|
# **Learn more**
|
@@ -2616,27 +2627,33 @@ module Aws::GameLift
|
|
2616
2627
|
req.send_request(options)
|
2617
2628
|
end
|
2618
2629
|
|
2619
|
-
# **This
|
2620
|
-
#
|
2630
|
+
# **This operation is used with the Amazon GameLift FleetIQ solution and
|
2631
|
+
# game server groups.**
|
2621
2632
|
#
|
2622
2633
|
# Terminates a game server group and permanently deletes the game server
|
2623
2634
|
# group record. You have several options for how these resources are
|
2624
2635
|
# impacted when deleting the game server group. Depending on the type of
|
2625
|
-
# delete
|
2626
|
-
# resources:
|
2627
|
-
#
|
2636
|
+
# delete operation selected, this operation might affect these
|
2637
|
+
# resources:
|
2638
|
+
#
|
2639
|
+
# * The game server group
|
2640
|
+
#
|
2641
|
+
# * The corresponding Auto Scaling group
|
2642
|
+
#
|
2643
|
+
# * All game servers that are currently running in the group
|
2628
2644
|
#
|
2629
2645
|
# To delete a game server group, identify the game server group to
|
2630
|
-
# delete and specify the type of delete
|
2631
|
-
# groups can only be deleted if they are in ACTIVE or ERROR
|
2646
|
+
# delete and specify the type of delete operation to initiate. Game
|
2647
|
+
# server groups can only be deleted if they are in `ACTIVE` or `ERROR`
|
2648
|
+
# status.
|
2632
2649
|
#
|
2633
|
-
# If the delete request is successful, a series of
|
2634
|
-
# off. The game server group status is changed to
|
2650
|
+
# If the delete request is successful, a series of operations are kicked
|
2651
|
+
# off. The game server group status is changed to `DELETE_SCHEDULED`,
|
2635
2652
|
# which prevents new game servers from being registered and stops
|
2636
|
-
#
|
2637
|
-
# are
|
2638
|
-
# any of the delete
|
2639
|
-
# ERROR status.
|
2653
|
+
# automatic scaling activity. Once all game servers in the game server
|
2654
|
+
# group are deregistered, GameLift FleetIQ can begin deleting resources.
|
2655
|
+
# If any of the delete operations fail, the game server group is placed
|
2656
|
+
# in `ERROR` status.
|
2640
2657
|
#
|
2641
2658
|
# GameLift FleetIQ emits delete events to Amazon CloudWatch.
|
2642
2659
|
#
|
@@ -2660,26 +2677,29 @@ module Aws::GameLift
|
|
2660
2677
|
#
|
2661
2678
|
# * SuspendGameServerGroup
|
2662
2679
|
#
|
2680
|
+
# * DescribeGameServerInstances
|
2663
2681
|
#
|
2664
2682
|
#
|
2665
|
-
#
|
2683
|
+
#
|
2684
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
2666
2685
|
#
|
2667
2686
|
# @option params [required, String] :game_server_group_name
|
2668
|
-
#
|
2669
|
-
#
|
2687
|
+
# A unique identifier for the game server group. Use either the
|
2688
|
+
# GameServerGroup name or ARN value.
|
2670
2689
|
#
|
2671
2690
|
# @option params [String] :delete_option
|
2672
|
-
# The type of delete to perform. Options include:
|
2691
|
+
# The type of delete to perform. Options include the following:
|
2673
2692
|
#
|
2674
|
-
# *
|
2675
|
-
# group only when it has no game servers that are in
|
2693
|
+
# * `SAFE_DELETE` – Terminates the game server group and EC2 Auto
|
2694
|
+
# Scaling group only when it has no game servers that are in
|
2695
|
+
# `UTILIZED` status.
|
2676
2696
|
#
|
2677
|
-
# *
|
2697
|
+
# * `FORCE_DELETE` – Terminates the game server group, including all
|
2678
2698
|
# active game servers regardless of their utilization status, and the
|
2679
2699
|
# EC2 Auto Scaling group.
|
2680
2700
|
#
|
2681
|
-
# * RETAIN – Does a safe delete of the game server group but retains
|
2682
|
-
# EC2 Auto Scaling group as is.
|
2701
|
+
# * `RETAIN` – Does a safe delete of the game server group but retains
|
2702
|
+
# the EC2 Auto Scaling group as is.
|
2683
2703
|
#
|
2684
2704
|
# @return [Types::DeleteGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2685
2705
|
#
|
@@ -2700,7 +2720,7 @@ module Aws::GameLift
|
|
2700
2720
|
# resp.game_server_group.instance_definitions #=> Array
|
2701
2721
|
# resp.game_server_group.instance_definitions[0].instance_type #=> String, one of "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge"
|
2702
2722
|
# resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
|
2703
|
-
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED"
|
2723
|
+
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED", "ON_DEMAND_ONLY"
|
2704
2724
|
# resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
|
2705
2725
|
# resp.game_server_group.auto_scaling_group_arn #=> String
|
2706
2726
|
# resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
|
@@ -2719,9 +2739,9 @@ module Aws::GameLift
|
|
2719
2739
|
req.send_request(options)
|
2720
2740
|
end
|
2721
2741
|
|
2722
|
-
# Deletes a game session queue.
|
2723
|
-
# StartGameSessionPlacement requests that reference
|
2724
|
-
# fail. To delete a queue, specify the queue name.
|
2742
|
+
# Deletes a game session queue. Once a queue is successfully deleted,
|
2743
|
+
# unfulfilled StartGameSessionPlacement requests that reference the
|
2744
|
+
# queue will fail. To delete a queue, specify the queue name.
|
2725
2745
|
#
|
2726
2746
|
# **Learn more**
|
2727
2747
|
#
|
@@ -2860,8 +2880,8 @@ module Aws::GameLift
|
|
2860
2880
|
req.send_request(options)
|
2861
2881
|
end
|
2862
2882
|
|
2863
|
-
# Deletes a fleet scaling policy.
|
2864
|
-
#
|
2883
|
+
# Deletes a fleet scaling policy. Once deleted, the policy is no longer
|
2884
|
+
# in force and GameLift removes all record of it. To delete a scaling
|
2865
2885
|
# policy, specify both the scaling policy name and the fleet ID it is
|
2866
2886
|
# associated with.
|
2867
2887
|
#
|
@@ -2914,9 +2934,9 @@ module Aws::GameLift
|
|
2914
2934
|
req.send_request(options)
|
2915
2935
|
end
|
2916
2936
|
|
2917
|
-
# Deletes a Realtime script. This
|
2918
|
-
# record. If script files were uploaded, they are also deleted
|
2919
|
-
# stored in an S3 bucket are not deleted).
|
2937
|
+
# Deletes a Realtime script. This operation permanently deletes the
|
2938
|
+
# script record. If script files were uploaded, they are also deleted
|
2939
|
+
# (files stored in an S3 bucket are not deleted).
|
2920
2940
|
#
|
2921
2941
|
# To delete a script, specify the script ID. Before deleting a script,
|
2922
2942
|
# be sure to terminate all fleets that are deployed with the script
|
@@ -3067,16 +3087,16 @@ module Aws::GameLift
|
|
3067
3087
|
req.send_request(options)
|
3068
3088
|
end
|
3069
3089
|
|
3070
|
-
# **This
|
3071
|
-
#
|
3090
|
+
# **This operation is used with the Amazon GameLift FleetIQ solution and
|
3091
|
+
# game server groups.**
|
3072
3092
|
#
|
3073
|
-
# Removes the game server
|
3074
|
-
#
|
3075
|
-
#
|
3093
|
+
# Removes the game server from a game server group. As a result of this
|
3094
|
+
# operation, the deregistered game server can no longer be claimed and
|
3095
|
+
# will not be returned in a list of active game servers.
|
3076
3096
|
#
|
3077
|
-
# To
|
3078
|
-
# server ID. If successful, this
|
3079
|
-
# termination
|
3097
|
+
# To deregister a game server, specify the game server group and game
|
3098
|
+
# server ID. If successful, this operation emits a CloudWatch event with
|
3099
|
+
# termination timestamp and reason.
|
3080
3100
|
#
|
3081
3101
|
# **Learn more**
|
3082
3102
|
#
|
@@ -3098,15 +3118,15 @@ module Aws::GameLift
|
|
3098
3118
|
#
|
3099
3119
|
#
|
3100
3120
|
#
|
3101
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
3121
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
3102
3122
|
#
|
3103
3123
|
# @option params [required, String] :game_server_group_name
|
3104
|
-
#
|
3105
|
-
#
|
3106
|
-
# value.
|
3124
|
+
# A unique identifier for the game server group where the game server is
|
3125
|
+
# running. Use either the GameServerGroup name or ARN value.
|
3107
3126
|
#
|
3108
3127
|
# @option params [required, String] :game_server_id
|
3109
|
-
#
|
3128
|
+
# A custom string that uniquely identifies the game server to
|
3129
|
+
# deregister.
|
3110
3130
|
#
|
3111
3131
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3112
3132
|
#
|
@@ -3320,7 +3340,7 @@ module Aws::GameLift
|
|
3320
3340
|
# pages. If successful, a FleetAttributes object is returned for each
|
3321
3341
|
# fleet requested, unless the fleet identifier is not found.
|
3322
3342
|
#
|
3323
|
-
# <note markdown="1"> Some API
|
3343
|
+
# <note markdown="1"> Some API operations may limit the number of fleet IDs allowed in one
|
3324
3344
|
# request. If a request exceeds this limit, the request fails and the
|
3325
3345
|
# error message includes the maximum allowed number.
|
3326
3346
|
#
|
@@ -3377,16 +3397,18 @@ module Aws::GameLift
|
|
3377
3397
|
#
|
3378
3398
|
# @option params [String] :next_token
|
3379
3399
|
# Token that indicates the start of the next sequential page of results.
|
3380
|
-
# Use the token that is returned with a previous call to this
|
3381
|
-
# start at the beginning of the result set, do not specify a value.
|
3382
|
-
# parameter is ignored when the request specifies one or a list of
|
3383
|
-
# IDs.
|
3400
|
+
# Use the token that is returned with a previous call to this operation.
|
3401
|
+
# To start at the beginning of the result set, do not specify a value.
|
3402
|
+
# This parameter is ignored when the request specifies one or a list of
|
3403
|
+
# fleet IDs.
|
3384
3404
|
#
|
3385
3405
|
# @return [Types::DescribeFleetAttributesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3386
3406
|
#
|
3387
3407
|
# * {Types::DescribeFleetAttributesOutput#fleet_attributes #fleet_attributes} => Array<Types::FleetAttributes>
|
3388
3408
|
# * {Types::DescribeFleetAttributesOutput#next_token #next_token} => String
|
3389
3409
|
#
|
3410
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3411
|
+
#
|
3390
3412
|
# @example Request syntax with placeholder values
|
3391
3413
|
#
|
3392
3414
|
# resp = client.describe_fleet_attributes({
|
@@ -3449,7 +3471,7 @@ module Aws::GameLift
|
|
3449
3471
|
# requested fleet ID. When a list of fleet IDs is provided, attribute
|
3450
3472
|
# objects are returned only for fleets that currently exist.
|
3451
3473
|
#
|
3452
|
-
# <note markdown="1"> Some API
|
3474
|
+
# <note markdown="1"> Some API operations may limit the number of fleet IDs allowed in one
|
3453
3475
|
# request. If a request exceeds this limit, the request fails and the
|
3454
3476
|
# error message includes the maximum allowed.
|
3455
3477
|
#
|
@@ -3506,16 +3528,18 @@ module Aws::GameLift
|
|
3506
3528
|
#
|
3507
3529
|
# @option params [String] :next_token
|
3508
3530
|
# Token that indicates the start of the next sequential page of results.
|
3509
|
-
# Use the token that is returned with a previous call to this
|
3510
|
-
# start at the beginning of the result set, do not specify a value.
|
3511
|
-
# parameter is ignored when the request specifies one or a list of
|
3512
|
-
# IDs.
|
3531
|
+
# Use the token that is returned with a previous call to this operation.
|
3532
|
+
# To start at the beginning of the result set, do not specify a value.
|
3533
|
+
# This parameter is ignored when the request specifies one or a list of
|
3534
|
+
# fleet IDs.
|
3513
3535
|
#
|
3514
3536
|
# @return [Types::DescribeFleetCapacityOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3515
3537
|
#
|
3516
3538
|
# * {Types::DescribeFleetCapacityOutput#fleet_capacity #fleet_capacity} => Array<Types::FleetCapacity>
|
3517
3539
|
# * {Types::DescribeFleetCapacityOutput#next_token #next_token} => String
|
3518
3540
|
#
|
3541
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3542
|
+
#
|
3519
3543
|
# @example Request syntax with placeholder values
|
3520
3544
|
#
|
3521
3545
|
# resp = client.describe_fleet_capacity({
|
@@ -3611,14 +3635,16 @@ module Aws::GameLift
|
|
3611
3635
|
#
|
3612
3636
|
# @option params [String] :next_token
|
3613
3637
|
# Token that indicates the start of the next sequential page of results.
|
3614
|
-
# Use the token that is returned with a previous call to this
|
3615
|
-
# start at the beginning of the result set, do not specify a value.
|
3638
|
+
# Use the token that is returned with a previous call to this operation.
|
3639
|
+
# To start at the beginning of the result set, do not specify a value.
|
3616
3640
|
#
|
3617
3641
|
# @return [Types::DescribeFleetEventsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3618
3642
|
#
|
3619
3643
|
# * {Types::DescribeFleetEventsOutput#events #events} => Array<Types::Event>
|
3620
3644
|
# * {Types::DescribeFleetEventsOutput#next_token #next_token} => String
|
3621
3645
|
#
|
3646
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3647
|
+
#
|
3622
3648
|
# @example Request syntax with placeholder values
|
3623
3649
|
#
|
3624
3650
|
# resp = client.describe_fleet_events({
|
@@ -3738,7 +3764,7 @@ module Aws::GameLift
|
|
3738
3764
|
# pages. If successful, a FleetUtilization object is returned for each
|
3739
3765
|
# requested fleet ID, unless the fleet identifier is not found.
|
3740
3766
|
#
|
3741
|
-
# <note markdown="1"> Some API
|
3767
|
+
# <note markdown="1"> Some API operations may limit the number of fleet IDs allowed in one
|
3742
3768
|
# request. If a request exceeds this limit, the request fails and the
|
3743
3769
|
# error message includes the maximum allowed.
|
3744
3770
|
#
|
@@ -3798,16 +3824,18 @@ module Aws::GameLift
|
|
3798
3824
|
#
|
3799
3825
|
# @option params [String] :next_token
|
3800
3826
|
# Token that indicates the start of the next sequential page of results.
|
3801
|
-
# Use the token that is returned with a previous call to this
|
3802
|
-
# start at the beginning of the result set, do not specify a value.
|
3803
|
-
# parameter is ignored when the request specifies one or a list of
|
3804
|
-
# IDs.
|
3827
|
+
# Use the token that is returned with a previous call to this operation.
|
3828
|
+
# To start at the beginning of the result set, do not specify a value.
|
3829
|
+
# This parameter is ignored when the request specifies one or a list of
|
3830
|
+
# fleet IDs.
|
3805
3831
|
#
|
3806
3832
|
# @return [Types::DescribeFleetUtilizationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3807
3833
|
#
|
3808
3834
|
# * {Types::DescribeFleetUtilizationOutput#fleet_utilization #fleet_utilization} => Array<Types::FleetUtilization>
|
3809
3835
|
# * {Types::DescribeFleetUtilizationOutput#next_token #next_token} => String
|
3810
3836
|
#
|
3837
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3838
|
+
#
|
3811
3839
|
# @example Request syntax with placeholder values
|
3812
3840
|
#
|
3813
3841
|
# resp = client.describe_fleet_utilization({
|
@@ -3835,12 +3863,12 @@ module Aws::GameLift
|
|
3835
3863
|
req.send_request(options)
|
3836
3864
|
end
|
3837
3865
|
|
3838
|
-
# **This
|
3839
|
-
#
|
3866
|
+
# **This operation is used with the Amazon GameLift FleetIQ solution and
|
3867
|
+
# game server groups.**
|
3840
3868
|
#
|
3841
|
-
# Retrieves information for a game server
|
3842
|
-
#
|
3843
|
-
# server is running on.
|
3869
|
+
# Retrieves information for a registered game server. Information
|
3870
|
+
# includes game server status, health check info, and the instance that
|
3871
|
+
# the game server is running on.
|
3844
3872
|
#
|
3845
3873
|
# To retrieve game server information, specify the game server ID. If
|
3846
3874
|
# successful, the requested game server object is returned.
|
@@ -3865,14 +3893,15 @@ module Aws::GameLift
|
|
3865
3893
|
#
|
3866
3894
|
#
|
3867
3895
|
#
|
3868
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
3896
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
3869
3897
|
#
|
3870
3898
|
# @option params [required, String] :game_server_group_name
|
3871
|
-
#
|
3899
|
+
# A unique identifier for the game server group where the game server is
|
3872
3900
|
# running. Use either the GameServerGroup name or ARN value.
|
3873
3901
|
#
|
3874
3902
|
# @option params [required, String] :game_server_id
|
3875
|
-
#
|
3903
|
+
# A custom string that uniquely identifies the game server information
|
3904
|
+
# to be retrieved.
|
3876
3905
|
#
|
3877
3906
|
# @return [Types::DescribeGameServerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3878
3907
|
#
|
@@ -3893,7 +3922,6 @@ module Aws::GameLift
|
|
3893
3922
|
# resp.game_server.instance_id #=> String
|
3894
3923
|
# resp.game_server.connection_info #=> String
|
3895
3924
|
# resp.game_server.game_server_data #=> String
|
3896
|
-
# resp.game_server.custom_sort_key #=> String
|
3897
3925
|
# resp.game_server.claim_status #=> String, one of "CLAIMED"
|
3898
3926
|
# resp.game_server.utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
|
3899
3927
|
# resp.game_server.registration_time #=> Time
|
@@ -3909,10 +3937,14 @@ module Aws::GameLift
|
|
3909
3937
|
req.send_request(options)
|
3910
3938
|
end
|
3911
3939
|
|
3912
|
-
# **This
|
3913
|
-
#
|
3940
|
+
# **This operation is used with the Amazon GameLift FleetIQ solution and
|
3941
|
+
# game server groups.**
|
3914
3942
|
#
|
3915
|
-
# Retrieves information on a game server group.
|
3943
|
+
# Retrieves information on a game server group. This operation returns
|
3944
|
+
# only properties related to GameLift FleetIQ. To view or update
|
3945
|
+
# properties for the corresponding Auto Scaling group, such as launch
|
3946
|
+
# template, auto scaling policies, and maximum/minimum group size,
|
3947
|
+
# access the Auto Scaling group directly.
|
3916
3948
|
#
|
3917
3949
|
# To get attributes for a game server group, provide a group name or ARN
|
3918
3950
|
# value. If successful, a GameServerGroup object is returned.
|
@@ -3937,13 +3969,15 @@ module Aws::GameLift
|
|
3937
3969
|
#
|
3938
3970
|
# * SuspendGameServerGroup
|
3939
3971
|
#
|
3972
|
+
# * DescribeGameServerInstances
|
3940
3973
|
#
|
3941
3974
|
#
|
3942
|
-
#
|
3975
|
+
#
|
3976
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
3943
3977
|
#
|
3944
3978
|
# @option params [required, String] :game_server_group_name
|
3945
|
-
#
|
3946
|
-
#
|
3979
|
+
# A unique identifier for the game server group. Use either the
|
3980
|
+
# GameServerGroup name or ARN value.
|
3947
3981
|
#
|
3948
3982
|
# @return [Types::DescribeGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3949
3983
|
#
|
@@ -3963,7 +3997,7 @@ module Aws::GameLift
|
|
3963
3997
|
# resp.game_server_group.instance_definitions #=> Array
|
3964
3998
|
# resp.game_server_group.instance_definitions[0].instance_type #=> String, one of "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge"
|
3965
3999
|
# resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
|
3966
|
-
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED"
|
4000
|
+
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED", "ON_DEMAND_ONLY"
|
3967
4001
|
# resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
|
3968
4002
|
# resp.game_server_group.auto_scaling_group_arn #=> String
|
3969
4003
|
# resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
|
@@ -3982,8 +4016,109 @@ module Aws::GameLift
|
|
3982
4016
|
req.send_request(options)
|
3983
4017
|
end
|
3984
4018
|
|
4019
|
+
# **This operation is used with the Amazon GameLift FleetIQ solution and
|
4020
|
+
# game server groups.**
|
4021
|
+
#
|
4022
|
+
# Retrieves status information about the Amazon EC2 instances associated
|
4023
|
+
# with a GameLift FleetIQ game server group. Use this operation to
|
4024
|
+
# detect when instances are active or not available to host new game
|
4025
|
+
# servers. If you are looking for instance configuration information,
|
4026
|
+
# call DescribeGameServerGroup or access the corresponding Auto Scaling
|
4027
|
+
# group properties.
|
4028
|
+
#
|
4029
|
+
# To request status for all instances in the game server group, provide
|
4030
|
+
# a game server group ID only. To request status for specific instances,
|
4031
|
+
# provide the game server group ID and one or more instance IDs. Use the
|
4032
|
+
# pagination parameters to retrieve results in sequential segments. If
|
4033
|
+
# successful, a collection of `GameServerInstance` objects is returned.
|
4034
|
+
#
|
4035
|
+
# This operation is not designed to be called with every game server
|
4036
|
+
# claim request; this practice can cause you to exceed your API limit,
|
4037
|
+
# which results in errors. Instead, as a best practice, cache the
|
4038
|
+
# results and refresh your cache no more than once every 10 seconds.
|
4039
|
+
#
|
4040
|
+
# **Learn more**
|
4041
|
+
#
|
4042
|
+
# [GameLift FleetIQ Guide][1]
|
4043
|
+
#
|
4044
|
+
# **Related operations**
|
4045
|
+
#
|
4046
|
+
# * CreateGameServerGroup
|
4047
|
+
#
|
4048
|
+
# * ListGameServerGroups
|
4049
|
+
#
|
4050
|
+
# * DescribeGameServerGroup
|
4051
|
+
#
|
4052
|
+
# * UpdateGameServerGroup
|
4053
|
+
#
|
4054
|
+
# * DeleteGameServerGroup
|
4055
|
+
#
|
4056
|
+
# * ResumeGameServerGroup
|
4057
|
+
#
|
4058
|
+
# * SuspendGameServerGroup
|
4059
|
+
#
|
4060
|
+
# * DescribeGameServerInstances
|
4061
|
+
#
|
4062
|
+
#
|
4063
|
+
#
|
4064
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
4065
|
+
#
|
4066
|
+
# @option params [required, String] :game_server_group_name
|
4067
|
+
# A unique identifier for the game server group. Use either the
|
4068
|
+
# GameServerGroup name or ARN value.
|
4069
|
+
#
|
4070
|
+
# @option params [Array<String>] :instance_ids
|
4071
|
+
# The EC2 instance IDs that you want to retrieve status on. EC2 instance
|
4072
|
+
# IDs use a 17-character format, for example: `i-1234567890abcdef0`. To
|
4073
|
+
# retrieve all instances in the game server group, leave this parameter
|
4074
|
+
# empty.
|
4075
|
+
#
|
4076
|
+
# @option params [Integer] :limit
|
4077
|
+
# The maximum number of results to return. Use this parameter with
|
4078
|
+
# `NextToken` to get results as a set of sequential segments.
|
4079
|
+
#
|
4080
|
+
# @option params [String] :next_token
|
4081
|
+
# A token that indicates the start of the next sequential segment of
|
4082
|
+
# results. Use the token returned with the previous call to this
|
4083
|
+
# operation. To start at the beginning of the result set, do not specify
|
4084
|
+
# a value.
|
4085
|
+
#
|
4086
|
+
# @return [Types::DescribeGameServerInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4087
|
+
#
|
4088
|
+
# * {Types::DescribeGameServerInstancesOutput#game_server_instances #game_server_instances} => Array<Types::GameServerInstance>
|
4089
|
+
# * {Types::DescribeGameServerInstancesOutput#next_token #next_token} => String
|
4090
|
+
#
|
4091
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4092
|
+
#
|
4093
|
+
# @example Request syntax with placeholder values
|
4094
|
+
#
|
4095
|
+
# resp = client.describe_game_server_instances({
|
4096
|
+
# game_server_group_name: "GameServerGroupNameOrArn", # required
|
4097
|
+
# instance_ids: ["GameServerInstanceId"],
|
4098
|
+
# limit: 1,
|
4099
|
+
# next_token: "NonZeroAndMaxString",
|
4100
|
+
# })
|
4101
|
+
#
|
4102
|
+
# @example Response structure
|
4103
|
+
#
|
4104
|
+
# resp.game_server_instances #=> Array
|
4105
|
+
# resp.game_server_instances[0].game_server_group_name #=> String
|
4106
|
+
# resp.game_server_instances[0].game_server_group_arn #=> String
|
4107
|
+
# resp.game_server_instances[0].instance_id #=> String
|
4108
|
+
# resp.game_server_instances[0].instance_status #=> String, one of "ACTIVE", "DRAINING", "SPOT_TERMINATING"
|
4109
|
+
# resp.next_token #=> String
|
4110
|
+
#
|
4111
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeGameServerInstances AWS API Documentation
|
4112
|
+
#
|
4113
|
+
# @overload describe_game_server_instances(params = {})
|
4114
|
+
# @param [Hash] params ({})
|
4115
|
+
def describe_game_server_instances(params = {}, options = {})
|
4116
|
+
req = build_request(:describe_game_server_instances, params)
|
4117
|
+
req.send_request(options)
|
4118
|
+
end
|
4119
|
+
|
3985
4120
|
# Retrieves properties, including the protection policy in force, for
|
3986
|
-
# one or more game sessions. This
|
4121
|
+
# one or more game sessions. This operation can be used in several ways:
|
3987
4122
|
# (1) provide a `GameSessionId` or `GameSessionArn` to request details
|
3988
4123
|
# for a specific game session; (2) provide either a `FleetId` or an
|
3989
4124
|
# `AliasId` to request properties for all game sessions running on a
|
@@ -4037,14 +4172,16 @@ module Aws::GameLift
|
|
4037
4172
|
#
|
4038
4173
|
# @option params [String] :next_token
|
4039
4174
|
# Token that indicates the start of the next sequential page of results.
|
4040
|
-
# Use the token that is returned with a previous call to this
|
4041
|
-
# start at the beginning of the result set, do not specify a value.
|
4175
|
+
# Use the token that is returned with a previous call to this operation.
|
4176
|
+
# To start at the beginning of the result set, do not specify a value.
|
4042
4177
|
#
|
4043
4178
|
# @return [Types::DescribeGameSessionDetailsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4044
4179
|
#
|
4045
4180
|
# * {Types::DescribeGameSessionDetailsOutput#game_session_details #game_session_details} => Array<Types::GameSessionDetail>
|
4046
4181
|
# * {Types::DescribeGameSessionDetailsOutput#next_token #next_token} => String
|
4047
4182
|
#
|
4183
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4184
|
+
#
|
4048
4185
|
# @example Request syntax with placeholder values
|
4049
4186
|
#
|
4050
4187
|
# resp = client.describe_game_session_details({
|
@@ -4197,19 +4334,22 @@ module Aws::GameLift
|
|
4197
4334
|
#
|
4198
4335
|
# @option params [Integer] :limit
|
4199
4336
|
# The maximum number of results to return. Use this parameter with
|
4200
|
-
# `NextToken` to get results as a set of sequential pages.
|
4337
|
+
# `NextToken` to get results as a set of sequential pages. You can
|
4338
|
+
# request up to 50 results.
|
4201
4339
|
#
|
4202
4340
|
# @option params [String] :next_token
|
4203
4341
|
# A token that indicates the start of the next sequential page of
|
4204
4342
|
# results. Use the token that is returned with a previous call to this
|
4205
|
-
#
|
4206
|
-
# value.
|
4343
|
+
# operation. To start at the beginning of the result set, do not specify
|
4344
|
+
# a value.
|
4207
4345
|
#
|
4208
4346
|
# @return [Types::DescribeGameSessionQueuesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4209
4347
|
#
|
4210
4348
|
# * {Types::DescribeGameSessionQueuesOutput#game_session_queues #game_session_queues} => Array<Types::GameSessionQueue>
|
4211
4349
|
# * {Types::DescribeGameSessionQueuesOutput#next_token #next_token} => String
|
4212
4350
|
#
|
4351
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4352
|
+
#
|
4213
4353
|
# @example Request syntax with placeholder values
|
4214
4354
|
#
|
4215
4355
|
# resp = client.describe_game_session_queues({
|
@@ -4296,14 +4436,16 @@ module Aws::GameLift
|
|
4296
4436
|
#
|
4297
4437
|
# @option params [String] :next_token
|
4298
4438
|
# Token that indicates the start of the next sequential page of results.
|
4299
|
-
# Use the token that is returned with a previous call to this
|
4300
|
-
# start at the beginning of the result set, do not specify a value.
|
4439
|
+
# Use the token that is returned with a previous call to this operation.
|
4440
|
+
# To start at the beginning of the result set, do not specify a value.
|
4301
4441
|
#
|
4302
4442
|
# @return [Types::DescribeGameSessionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4303
4443
|
#
|
4304
4444
|
# * {Types::DescribeGameSessionsOutput#game_sessions #game_sessions} => Array<Types::GameSession>
|
4305
4445
|
# * {Types::DescribeGameSessionsOutput#next_token #next_token} => String
|
4306
4446
|
#
|
4447
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4448
|
+
#
|
4307
4449
|
# @example Request syntax with placeholder values
|
4308
4450
|
#
|
4309
4451
|
# resp = client.describe_game_sessions({
|
@@ -4350,8 +4492,8 @@ module Aws::GameLift
|
|
4350
4492
|
end
|
4351
4493
|
|
4352
4494
|
# Retrieves information about a fleet's instances, including instance
|
4353
|
-
# IDs. Use this
|
4354
|
-
# get details on one specific instance.
|
4495
|
+
# IDs. Use this operation to get details on all instances in the fleet
|
4496
|
+
# or get details on one specific instance.
|
4355
4497
|
#
|
4356
4498
|
# To get a specific instance, specify fleet ID and instance ID. To get
|
4357
4499
|
# all instances in a fleet, specify a fleet ID only. Use the pagination
|
@@ -4389,14 +4531,16 @@ module Aws::GameLift
|
|
4389
4531
|
#
|
4390
4532
|
# @option params [String] :next_token
|
4391
4533
|
# Token that indicates the start of the next sequential page of results.
|
4392
|
-
# Use the token that is returned with a previous call to this
|
4393
|
-
# start at the beginning of the result set, do not specify a value.
|
4534
|
+
# Use the token that is returned with a previous call to this operation.
|
4535
|
+
# To start at the beginning of the result set, do not specify a value.
|
4394
4536
|
#
|
4395
4537
|
# @return [Types::DescribeInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4396
4538
|
#
|
4397
4539
|
# * {Types::DescribeInstancesOutput#instances #instances} => Array<Types::Instance>
|
4398
4540
|
# * {Types::DescribeInstancesOutput#next_token #next_token} => String
|
4399
4541
|
#
|
4542
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4543
|
+
#
|
4400
4544
|
# @example Request syntax with placeholder values
|
4401
4545
|
#
|
4402
4546
|
# resp = client.describe_instances({
|
@@ -4429,19 +4573,24 @@ module Aws::GameLift
|
|
4429
4573
|
end
|
4430
4574
|
|
4431
4575
|
# Retrieves one or more matchmaking tickets. Use this operation to
|
4432
|
-
# retrieve ticket information, including
|
4433
|
-
#
|
4434
|
-
# game session.
|
4435
|
-
#
|
4436
|
-
# You can use this operation to track the progress of matchmaking
|
4437
|
-
# requests (through polling) as an alternative to using event
|
4438
|
-
# notifications. See more details on tracking matchmaking requests
|
4439
|
-
# through polling or notifications in StartMatchmaking.
|
4576
|
+
# retrieve ticket information, including--after a successful match is
|
4577
|
+
# made--connection information for the resulting new game session.
|
4440
4578
|
#
|
4441
4579
|
# To request matchmaking tickets, provide a list of up to 10 ticket IDs.
|
4442
4580
|
# If the request is successful, a ticket object is returned for each
|
4443
4581
|
# requested ID that currently exists.
|
4444
4582
|
#
|
4583
|
+
# This operation is not designed to be continually called to track
|
4584
|
+
# matchmaking ticket status. This practice can cause you to exceed your
|
4585
|
+
# API limit, which results in errors. Instead, as a best practice, set
|
4586
|
+
# up an Amazon Simple Notification Service (SNS) to receive
|
4587
|
+
# notifications, and provide the topic ARN in the matchmaking
|
4588
|
+
# configuration. Continuously poling ticket status with
|
4589
|
+
# DescribeMatchmaking should only be used for games in development with
|
4590
|
+
# low matchmaking usage.
|
4591
|
+
#
|
4592
|
+
#
|
4593
|
+
#
|
4445
4594
|
# **Learn more**
|
4446
4595
|
#
|
4447
4596
|
# [ Add FlexMatch to a Game Client][1]
|
@@ -4515,15 +4664,18 @@ module Aws::GameLift
|
|
4515
4664
|
req.send_request(options)
|
4516
4665
|
end
|
4517
4666
|
|
4518
|
-
# Retrieves the details of FlexMatch matchmaking configurations.
|
4519
|
-
#
|
4520
|
-
#
|
4521
|
-
# configurations
|
4522
|
-
#
|
4667
|
+
# Retrieves the details of FlexMatch matchmaking configurations.
|
4668
|
+
#
|
4669
|
+
# This operation offers the following options: (1) retrieve all
|
4670
|
+
# matchmaking configurations, (2) retrieve configurations for a
|
4671
|
+
# specified list, or (3) retrieve all configurations that use a
|
4672
|
+
# specified rule set name. When requesting multiple items, use the
|
4523
4673
|
# pagination parameters to retrieve results as a set of sequential
|
4524
|
-
# pages.
|
4525
|
-
#
|
4526
|
-
#
|
4674
|
+
# pages.
|
4675
|
+
#
|
4676
|
+
# If successful, a configuration is returned for each requested name.
|
4677
|
+
# When specifying a list of names, only configurations that currently
|
4678
|
+
# exist are returned.
|
4527
4679
|
#
|
4528
4680
|
# **Learn more**
|
4529
4681
|
#
|
@@ -4569,14 +4721,16 @@ module Aws::GameLift
|
|
4569
4721
|
# @option params [String] :next_token
|
4570
4722
|
# A token that indicates the start of the next sequential page of
|
4571
4723
|
# results. Use the token that is returned with a previous call to this
|
4572
|
-
#
|
4573
|
-
# value.
|
4724
|
+
# operation. To start at the beginning of the result set, do not specify
|
4725
|
+
# a value.
|
4574
4726
|
#
|
4575
4727
|
# @return [Types::DescribeMatchmakingConfigurationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4576
4728
|
#
|
4577
4729
|
# * {Types::DescribeMatchmakingConfigurationsOutput#configurations #configurations} => Array<Types::MatchmakingConfiguration>
|
4578
4730
|
# * {Types::DescribeMatchmakingConfigurationsOutput#next_token #next_token} => String
|
4579
4731
|
#
|
4732
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4733
|
+
#
|
4580
4734
|
# @example Request syntax with placeholder values
|
4581
4735
|
#
|
4582
4736
|
# resp = client.describe_matchmaking_configurations({
|
@@ -4666,14 +4820,16 @@ module Aws::GameLift
|
|
4666
4820
|
# @option params [String] :next_token
|
4667
4821
|
# A token that indicates the start of the next sequential page of
|
4668
4822
|
# results. Use the token that is returned with a previous call to this
|
4669
|
-
#
|
4670
|
-
# value.
|
4823
|
+
# operation. To start at the beginning of the result set, do not specify
|
4824
|
+
# a value.
|
4671
4825
|
#
|
4672
4826
|
# @return [Types::DescribeMatchmakingRuleSetsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4673
4827
|
#
|
4674
4828
|
# * {Types::DescribeMatchmakingRuleSetsOutput#rule_sets #rule_sets} => Array<Types::MatchmakingRuleSet>
|
4675
4829
|
# * {Types::DescribeMatchmakingRuleSetsOutput#next_token #next_token} => String
|
4676
4830
|
#
|
4831
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4832
|
+
#
|
4677
4833
|
# @example Request syntax with placeholder values
|
4678
4834
|
#
|
4679
4835
|
# resp = client.describe_matchmaking_rule_sets({
|
@@ -4700,9 +4856,9 @@ module Aws::GameLift
|
|
4700
4856
|
req.send_request(options)
|
4701
4857
|
end
|
4702
4858
|
|
4703
|
-
# Retrieves properties for one or more player sessions. This
|
4704
|
-
# be used in several ways: (1) provide a `PlayerSessionId` to
|
4705
|
-
# properties for a specific player session; (2) provide a
|
4859
|
+
# Retrieves properties for one or more player sessions. This operation
|
4860
|
+
# can be used in several ways: (1) provide a `PlayerSessionId` to
|
4861
|
+
# request properties for a specific player session; (2) provide a
|
4706
4862
|
# `GameSessionId` to request properties for all player sessions in the
|
4707
4863
|
# specified game session; (3) provide a `PlayerId` to request properties
|
4708
4864
|
# for all player sessions of a specified player.
|
@@ -4765,15 +4921,17 @@ module Aws::GameLift
|
|
4765
4921
|
#
|
4766
4922
|
# @option params [String] :next_token
|
4767
4923
|
# Token that indicates the start of the next sequential page of results.
|
4768
|
-
# Use the token that is returned with a previous call to this
|
4769
|
-
# start at the beginning of the result set, do not specify a value.
|
4770
|
-
# player session ID is specified, this parameter is ignored.
|
4924
|
+
# Use the token that is returned with a previous call to this operation.
|
4925
|
+
# To start at the beginning of the result set, do not specify a value.
|
4926
|
+
# If a player session ID is specified, this parameter is ignored.
|
4771
4927
|
#
|
4772
4928
|
# @return [Types::DescribePlayerSessionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4773
4929
|
#
|
4774
4930
|
# * {Types::DescribePlayerSessionsOutput#player_sessions #player_sessions} => Array<Types::PlayerSession>
|
4775
4931
|
# * {Types::DescribePlayerSessionsOutput#next_token #next_token} => String
|
4776
4932
|
#
|
4933
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4934
|
+
#
|
4777
4935
|
# @example Request syntax with placeholder values
|
4778
4936
|
#
|
4779
4937
|
# resp = client.describe_player_sessions({
|
@@ -4900,7 +5058,7 @@ module Aws::GameLift
|
|
4900
5058
|
# is returned for the fleet.
|
4901
5059
|
#
|
4902
5060
|
# A fleet may have all of its scaling policies suspended
|
4903
|
-
# (StopFleetActions). This
|
5061
|
+
# (StopFleetActions). This operation does not affect the status of the
|
4904
5062
|
# scaling policies, which remains ACTIVE. To see whether a fleet's
|
4905
5063
|
# scaling policies are in force or suspended, call
|
4906
5064
|
# DescribeFleetAttributes and check the stopped actions.
|
@@ -4956,14 +5114,16 @@ module Aws::GameLift
|
|
4956
5114
|
#
|
4957
5115
|
# @option params [String] :next_token
|
4958
5116
|
# Token that indicates the start of the next sequential page of results.
|
4959
|
-
# Use the token that is returned with a previous call to this
|
4960
|
-
# start at the beginning of the result set, do not specify a value.
|
5117
|
+
# Use the token that is returned with a previous call to this operation.
|
5118
|
+
# To start at the beginning of the result set, do not specify a value.
|
4961
5119
|
#
|
4962
5120
|
# @return [Types::DescribeScalingPoliciesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4963
5121
|
#
|
4964
5122
|
# * {Types::DescribeScalingPoliciesOutput#scaling_policies #scaling_policies} => Array<Types::ScalingPolicy>
|
4965
5123
|
# * {Types::DescribeScalingPoliciesOutput#next_token #next_token} => String
|
4966
5124
|
#
|
5125
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5126
|
+
#
|
4967
5127
|
# @example Request syntax with placeholder values
|
4968
5128
|
#
|
4969
5129
|
# resp = client.describe_scaling_policies({
|
@@ -5228,7 +5388,7 @@ module Aws::GameLift
|
|
5228
5388
|
# an SSH client. The private key must be saved in the proper format to a
|
5229
5389
|
# `.pem` file before using. If you're making this request using the AWS
|
5230
5390
|
# CLI, saving the secret can be handled as part of the GetInstanceAccess
|
5231
|
-
# request, as shown in one of the examples for this
|
5391
|
+
# request, as shown in one of the examples for this operation.
|
5232
5392
|
#
|
5233
5393
|
# To request access to a specific instance, specify the IDs of both the
|
5234
5394
|
# instance and the fleet it belongs to. You can retrieve a fleet's
|
@@ -5339,14 +5499,16 @@ module Aws::GameLift
|
|
5339
5499
|
# @option params [String] :next_token
|
5340
5500
|
# A token that indicates the start of the next sequential page of
|
5341
5501
|
# results. Use the token that is returned with a previous call to this
|
5342
|
-
#
|
5343
|
-
# value.
|
5502
|
+
# operation. To start at the beginning of the result set, do not specify
|
5503
|
+
# a value.
|
5344
5504
|
#
|
5345
5505
|
# @return [Types::ListAliasesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5346
5506
|
#
|
5347
5507
|
# * {Types::ListAliasesOutput#aliases #aliases} => Array<Types::Alias>
|
5348
5508
|
# * {Types::ListAliasesOutput#next_token #next_token} => String
|
5349
5509
|
#
|
5510
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5511
|
+
#
|
5350
5512
|
# @example Request syntax with placeholder values
|
5351
5513
|
#
|
5352
5514
|
# resp = client.list_aliases({
|
@@ -5431,14 +5593,16 @@ module Aws::GameLift
|
|
5431
5593
|
#
|
5432
5594
|
# @option params [String] :next_token
|
5433
5595
|
# Token that indicates the start of the next sequential page of results.
|
5434
|
-
# Use the token that is returned with a previous call to this
|
5435
|
-
# start at the beginning of the result set, do not specify a value.
|
5596
|
+
# Use the token that is returned with a previous call to this operation.
|
5597
|
+
# To start at the beginning of the result set, do not specify a value.
|
5436
5598
|
#
|
5437
5599
|
# @return [Types::ListBuildsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5438
5600
|
#
|
5439
5601
|
# * {Types::ListBuildsOutput#builds #builds} => Array<Types::Build>
|
5440
5602
|
# * {Types::ListBuildsOutput#next_token #next_token} => String
|
5441
5603
|
#
|
5604
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5605
|
+
#
|
5442
5606
|
# @example Request syntax with placeholder values
|
5443
5607
|
#
|
5444
5608
|
# resp = client.list_builds({
|
@@ -5518,14 +5682,16 @@ module Aws::GameLift
|
|
5518
5682
|
#
|
5519
5683
|
# @option params [String] :next_token
|
5520
5684
|
# Token that indicates the start of the next sequential page of results.
|
5521
|
-
# Use the token that is returned with a previous call to this
|
5522
|
-
# start at the beginning of the result set, do not specify a value.
|
5685
|
+
# Use the token that is returned with a previous call to this operation.
|
5686
|
+
# To start at the beginning of the result set, do not specify a value.
|
5523
5687
|
#
|
5524
5688
|
# @return [Types::ListFleetsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5525
5689
|
#
|
5526
5690
|
# * {Types::ListFleetsOutput#fleet_ids #fleet_ids} => Array<String>
|
5527
5691
|
# * {Types::ListFleetsOutput#next_token #next_token} => String
|
5528
5692
|
#
|
5693
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5694
|
+
#
|
5529
5695
|
# @example Request syntax with placeholder values
|
5530
5696
|
#
|
5531
5697
|
# resp = client.list_fleets({
|
@@ -5550,12 +5716,12 @@ module Aws::GameLift
|
|
5550
5716
|
req.send_request(options)
|
5551
5717
|
end
|
5552
5718
|
|
5553
|
-
# **This
|
5554
|
-
#
|
5719
|
+
# **This operation is used with the Amazon GameLift FleetIQ solution and
|
5720
|
+
# game server groups.**
|
5555
5721
|
#
|
5556
5722
|
# Retrieves information on all game servers groups that exist in the
|
5557
|
-
# current AWS account for the selected
|
5558
|
-
# parameters to retrieve results in a set of sequential
|
5723
|
+
# current AWS account for the selected Region. Use the pagination
|
5724
|
+
# parameters to retrieve results in a set of sequential segments.
|
5559
5725
|
#
|
5560
5726
|
# **Learn more**
|
5561
5727
|
#
|
@@ -5577,25 +5743,29 @@ module Aws::GameLift
|
|
5577
5743
|
#
|
5578
5744
|
# * SuspendGameServerGroup
|
5579
5745
|
#
|
5746
|
+
# * DescribeGameServerInstances
|
5747
|
+
#
|
5580
5748
|
#
|
5581
5749
|
#
|
5582
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
5750
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
5583
5751
|
#
|
5584
5752
|
# @option params [Integer] :limit
|
5585
5753
|
# The maximum number of results to return. Use this parameter with
|
5586
|
-
# `NextToken` to get results as a set of sequential
|
5754
|
+
# `NextToken` to get results as a set of sequential segments.
|
5587
5755
|
#
|
5588
5756
|
# @option params [String] :next_token
|
5589
|
-
# A token that indicates the start of the next sequential
|
5590
|
-
# results. Use the token
|
5591
|
-
#
|
5592
|
-
# value.
|
5757
|
+
# A token that indicates the start of the next sequential segment of
|
5758
|
+
# results. Use the token returned with the previous call to this
|
5759
|
+
# operation. To start at the beginning of the result set, do not specify
|
5760
|
+
# a value.
|
5593
5761
|
#
|
5594
5762
|
# @return [Types::ListGameServerGroupsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5595
5763
|
#
|
5596
5764
|
# * {Types::ListGameServerGroupsOutput#game_server_groups #game_server_groups} => Array<Types::GameServerGroup>
|
5597
5765
|
# * {Types::ListGameServerGroupsOutput#next_token #next_token} => String
|
5598
5766
|
#
|
5767
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5768
|
+
#
|
5599
5769
|
# @example Request syntax with placeholder values
|
5600
5770
|
#
|
5601
5771
|
# resp = client.list_game_server_groups({
|
@@ -5612,7 +5782,7 @@ module Aws::GameLift
|
|
5612
5782
|
# resp.game_server_groups[0].instance_definitions #=> Array
|
5613
5783
|
# resp.game_server_groups[0].instance_definitions[0].instance_type #=> String, one of "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge"
|
5614
5784
|
# resp.game_server_groups[0].instance_definitions[0].weighted_capacity #=> String
|
5615
|
-
# resp.game_server_groups[0].balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED"
|
5785
|
+
# resp.game_server_groups[0].balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED", "ON_DEMAND_ONLY"
|
5616
5786
|
# resp.game_server_groups[0].game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
|
5617
5787
|
# resp.game_server_groups[0].auto_scaling_group_arn #=> String
|
5618
5788
|
# resp.game_server_groups[0].status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
|
@@ -5632,14 +5802,13 @@ module Aws::GameLift
|
|
5632
5802
|
req.send_request(options)
|
5633
5803
|
end
|
5634
5804
|
|
5635
|
-
# **This
|
5636
|
-
#
|
5805
|
+
# **This operation is used with the Amazon GameLift FleetIQ solution and
|
5806
|
+
# game server groups.**
|
5637
5807
|
#
|
5638
|
-
# Retrieves information on all game servers that are currently
|
5639
|
-
#
|
5640
|
-
#
|
5641
|
-
#
|
5642
|
-
# results in a set of sequential pages.
|
5808
|
+
# Retrieves information on all game servers that are currently active in
|
5809
|
+
# a specified game server group. You can opt to sort the list by game
|
5810
|
+
# server age. Use the pagination parameters to retrieve results in a set
|
5811
|
+
# of sequential segments.
|
5643
5812
|
#
|
5644
5813
|
# **Learn more**
|
5645
5814
|
#
|
@@ -5661,32 +5830,36 @@ module Aws::GameLift
|
|
5661
5830
|
#
|
5662
5831
|
#
|
5663
5832
|
#
|
5664
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
5833
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
5665
5834
|
#
|
5666
5835
|
# @option params [required, String] :game_server_group_name
|
5667
|
-
# An identifier for the game server group
|
5668
|
-
#
|
5836
|
+
# An identifier for the game server group to retrieve a list of game
|
5837
|
+
# servers from. Use either the GameServerGroup name or ARN value.
|
5669
5838
|
#
|
5670
5839
|
# @option params [String] :sort_order
|
5671
|
-
# Indicates how to sort the returned data based on
|
5672
|
-
#
|
5673
|
-
#
|
5840
|
+
# Indicates how to sort the returned data based on game server
|
5841
|
+
# registration timestamp. Use ASCENDING to retrieve oldest game servers
|
5842
|
+
# first, or use DESCENDING to retrieve newest game servers first. If
|
5843
|
+
# this parameter is left empty, game servers are returned in no
|
5844
|
+
# particular order.
|
5674
5845
|
#
|
5675
5846
|
# @option params [Integer] :limit
|
5676
5847
|
# The maximum number of results to return. Use this parameter with
|
5677
|
-
# `NextToken` to get results as a set of sequential
|
5848
|
+
# `NextToken` to get results as a set of sequential segments.
|
5678
5849
|
#
|
5679
5850
|
# @option params [String] :next_token
|
5680
|
-
# A token that indicates the start of the next sequential
|
5681
|
-
# results. Use the token
|
5682
|
-
#
|
5683
|
-
# value.
|
5851
|
+
# A token that indicates the start of the next sequential segment of
|
5852
|
+
# results. Use the token returned with the previous call to this
|
5853
|
+
# operation. To start at the beginning of the result set, do not specify
|
5854
|
+
# a value.
|
5684
5855
|
#
|
5685
5856
|
# @return [Types::ListGameServersOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5686
5857
|
#
|
5687
5858
|
# * {Types::ListGameServersOutput#game_servers #game_servers} => Array<Types::GameServer>
|
5688
5859
|
# * {Types::ListGameServersOutput#next_token #next_token} => String
|
5689
5860
|
#
|
5861
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5862
|
+
#
|
5690
5863
|
# @example Request syntax with placeholder values
|
5691
5864
|
#
|
5692
5865
|
# resp = client.list_game_servers({
|
@@ -5705,7 +5878,6 @@ module Aws::GameLift
|
|
5705
5878
|
# resp.game_servers[0].instance_id #=> String
|
5706
5879
|
# resp.game_servers[0].connection_info #=> String
|
5707
5880
|
# resp.game_servers[0].game_server_data #=> String
|
5708
|
-
# resp.game_servers[0].custom_sort_key #=> String
|
5709
5881
|
# resp.game_servers[0].claim_status #=> String, one of "CLAIMED"
|
5710
5882
|
# resp.game_servers[0].utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
|
5711
5883
|
# resp.game_servers[0].registration_time #=> Time
|
@@ -5752,14 +5924,16 @@ module Aws::GameLift
|
|
5752
5924
|
# @option params [String] :next_token
|
5753
5925
|
# A token that indicates the start of the next sequential page of
|
5754
5926
|
# results. Use the token that is returned with a previous call to this
|
5755
|
-
#
|
5756
|
-
# value.
|
5927
|
+
# operation. To start at the beginning of the result set, do not specify
|
5928
|
+
# a value.
|
5757
5929
|
#
|
5758
5930
|
# @return [Types::ListScriptsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5759
5931
|
#
|
5760
5932
|
# * {Types::ListScriptsOutput#scripts #scripts} => Array<Types::Script>
|
5761
5933
|
# * {Types::ListScriptsOutput#next_token #next_token} => String
|
5762
5934
|
#
|
5935
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5936
|
+
#
|
5763
5937
|
# @example Request syntax with placeholder values
|
5764
5938
|
#
|
5765
5939
|
# resp = client.list_scripts({
|
@@ -5793,7 +5967,7 @@ module Aws::GameLift
|
|
5793
5967
|
|
5794
5968
|
# Retrieves all tags that are assigned to a GameLift resource. Resource
|
5795
5969
|
# tags are used to organize AWS resources for a range of purposes. This
|
5796
|
-
#
|
5970
|
+
# operation handles the permissions necessary to manage tags for the
|
5797
5971
|
# following GameLift resource types:
|
5798
5972
|
#
|
5799
5973
|
# * Build
|
@@ -5836,8 +6010,8 @@ module Aws::GameLift
|
|
5836
6010
|
# The Amazon Resource Name ([ARN][1]) that is assigned to and uniquely
|
5837
6011
|
# identifies the GameLift resource that you want to retrieve tags for.
|
5838
6012
|
# GameLift resource ARNs are included in the data object for the
|
5839
|
-
# resource, which can be retrieved by calling a List or Describe
|
5840
|
-
# for the resource type.
|
6013
|
+
# resource, which can be retrieved by calling a List or Describe
|
6014
|
+
# operation for the resource type.
|
5841
6015
|
#
|
5842
6016
|
#
|
5843
6017
|
#
|
@@ -6105,26 +6279,26 @@ module Aws::GameLift
|
|
6105
6279
|
req.send_request(options)
|
6106
6280
|
end
|
6107
6281
|
|
6108
|
-
# **This
|
6109
|
-
#
|
6282
|
+
# **This operation is used with the Amazon GameLift FleetIQ solution and
|
6283
|
+
# game server groups.**
|
6110
6284
|
#
|
6111
6285
|
# Creates a new game server resource and notifies GameLift FleetIQ that
|
6112
|
-
# the game server is ready to host gameplay and players. This
|
6113
|
-
# called by a game server process that is running on an instance in a
|
6286
|
+
# the game server is ready to host gameplay and players. This operation
|
6287
|
+
# is called by a game server process that is running on an instance in a
|
6114
6288
|
# game server group. Registering game servers enables GameLift FleetIQ
|
6115
6289
|
# to track available game servers and enables game clients and services
|
6116
6290
|
# to claim a game server for a new game session.
|
6117
6291
|
#
|
6118
6292
|
# To register a game server, identify the game server group and instance
|
6119
6293
|
# where the game server is running, and provide a unique identifier for
|
6120
|
-
# the game server. You can also include connection and game server data
|
6121
|
-
#
|
6122
|
-
# ClaimGameServer, this information is returned in response.
|
6294
|
+
# the game server. You can also include connection and game server data.
|
6295
|
+
# When a game client or service requests a game server by calling
|
6296
|
+
# ClaimGameServer, this information is returned in the response.
|
6123
6297
|
#
|
6124
6298
|
# Once a game server is successfully registered, it is put in status
|
6125
|
-
# AVAILABLE
|
6126
|
-
# instance it is in the process of shutting down as part
|
6127
|
-
#
|
6299
|
+
# `AVAILABLE`. A request to register a game server may fail if the
|
6300
|
+
# instance it is running on is in the process of shutting down as part
|
6301
|
+
# of instance balancing or scale-down activity.
|
6128
6302
|
#
|
6129
6303
|
# **Learn more**
|
6130
6304
|
#
|
@@ -6146,51 +6320,33 @@ module Aws::GameLift
|
|
6146
6320
|
#
|
6147
6321
|
#
|
6148
6322
|
#
|
6149
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
6323
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
6150
6324
|
#
|
6151
6325
|
# @option params [required, String] :game_server_group_name
|
6152
|
-
#
|
6153
|
-
# running.
|
6326
|
+
# A unique identifier for the game server group where the game server is
|
6327
|
+
# running. Use either the GameServerGroup name or ARN value.
|
6154
6328
|
#
|
6155
6329
|
# @option params [required, String] :game_server_id
|
6156
|
-
# A custom string that uniquely identifies the
|
6157
|
-
# server IDs are developer-defined and must be unique across all
|
6158
|
-
# server groups in your AWS account.
|
6330
|
+
# A custom string that uniquely identifies the game server to register.
|
6331
|
+
# Game server IDs are developer-defined and must be unique across all
|
6332
|
+
# game server groups in your AWS account.
|
6159
6333
|
#
|
6160
6334
|
# @option params [required, String] :instance_id
|
6161
6335
|
# The unique identifier for the instance where the game server is
|
6162
|
-
# running. This ID is available in the instance metadata.
|
6336
|
+
# running. This ID is available in the instance metadata. EC2 instance
|
6337
|
+
# IDs use a 17-character format, for example: `i-1234567890abcdef0`.
|
6163
6338
|
#
|
6164
6339
|
# @option params [String] :connection_info
|
6165
|
-
# Information needed to make inbound client connections to the
|
6166
|
-
# server. This might include IP address and port, DNS name,
|
6340
|
+
# Information that is needed to make inbound client connections to the
|
6341
|
+
# game server. This might include the IP address and port, DNS name, and
|
6342
|
+
# other information.
|
6167
6343
|
#
|
6168
6344
|
# @option params [String] :game_server_data
|
6169
6345
|
# A set of custom game server properties, formatted as a single string
|
6170
6346
|
# value. This data is passed to a game client or service when it
|
6171
|
-
# requests information on
|
6347
|
+
# requests information on game servers using ListGameServers or
|
6172
6348
|
# ClaimGameServer.
|
6173
6349
|
#
|
6174
|
-
# @option params [String] :custom_sort_key
|
6175
|
-
# A game server tag that can be used to request sorted lists of game
|
6176
|
-
# servers using ListGameServers. Custom sort keys are developer-defined
|
6177
|
-
# based on how you want to organize the retrieved game server
|
6178
|
-
# information.
|
6179
|
-
#
|
6180
|
-
# @option params [Array<Types::Tag>] :tags
|
6181
|
-
# A list of labels to assign to the new game server resource. Tags are
|
6182
|
-
# developer-defined key-value pairs. Tagging AWS resources are useful
|
6183
|
-
# for resource management, access management, and cost allocation. For
|
6184
|
-
# more information, see [ Tagging AWS Resources][1] in the *AWS General
|
6185
|
-
# Reference*. Once the resource is created, you can use TagResource,
|
6186
|
-
# UntagResource, and ListTagsForResource to add, remove, and view tags.
|
6187
|
-
# The maximum tag limit may be lower than stated. See the AWS General
|
6188
|
-
# Reference for actual tagging limits.
|
6189
|
-
#
|
6190
|
-
#
|
6191
|
-
#
|
6192
|
-
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
6193
|
-
#
|
6194
6350
|
# @return [Types::RegisterGameServerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6195
6351
|
#
|
6196
6352
|
# * {Types::RegisterGameServerOutput#game_server #game_server} => Types::GameServer
|
@@ -6203,13 +6359,6 @@ module Aws::GameLift
|
|
6203
6359
|
# instance_id: "GameServerInstanceId", # required
|
6204
6360
|
# connection_info: "GameServerConnectionInfo",
|
6205
6361
|
# game_server_data: "GameServerData",
|
6206
|
-
# custom_sort_key: "GameServerSortKey",
|
6207
|
-
# tags: [
|
6208
|
-
# {
|
6209
|
-
# key: "TagKey", # required
|
6210
|
-
# value: "TagValue", # required
|
6211
|
-
# },
|
6212
|
-
# ],
|
6213
6362
|
# })
|
6214
6363
|
#
|
6215
6364
|
# @example Response structure
|
@@ -6220,7 +6369,6 @@ module Aws::GameLift
|
|
6220
6369
|
# resp.game_server.instance_id #=> String
|
6221
6370
|
# resp.game_server.connection_info #=> String
|
6222
6371
|
# resp.game_server.game_server_data #=> String
|
6223
|
-
# resp.game_server.custom_sort_key #=> String
|
6224
6372
|
# resp.game_server.claim_status #=> String, one of "CLAIMED"
|
6225
6373
|
# resp.game_server.utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
|
6226
6374
|
# resp.game_server.registration_time #=> Time
|
@@ -6342,19 +6490,21 @@ module Aws::GameLift
|
|
6342
6490
|
req.send_request(options)
|
6343
6491
|
end
|
6344
6492
|
|
6345
|
-
# **This
|
6346
|
-
#
|
6493
|
+
# **This operation is used with the Amazon GameLift FleetIQ solution and
|
6494
|
+
# game server groups.**
|
6347
6495
|
#
|
6348
6496
|
# Reinstates activity on a game server group after it has been
|
6349
|
-
# suspended. A game server group
|
6350
|
-
#
|
6351
|
-
# due to a configuration problem.
|
6352
|
-
# the group once the configuration
|
6353
|
-
# the game server group status and
|
6354
|
-
# why group activity is suspended.
|
6497
|
+
# suspended. A game server group might be suspended by
|
6498
|
+
# theSuspendGameServerGroup operation, or it might be suspended
|
6499
|
+
# involuntarily due to a configuration problem. In the second case, you
|
6500
|
+
# can manually resume activity on the group once the configuration
|
6501
|
+
# problem has been resolved. Refer to the game server group status and
|
6502
|
+
# status reason for more information on why group activity is suspended.
|
6355
6503
|
#
|
6356
6504
|
# To resume activity, specify a game server group ARN and the type of
|
6357
|
-
# activity to be resumed.
|
6505
|
+
# activity to be resumed. If successful, a GameServerGroup object is
|
6506
|
+
# returned showing that the resumed activity is no longer listed in
|
6507
|
+
# `SuspendedActions`.
|
6358
6508
|
#
|
6359
6509
|
# **Learn more**
|
6360
6510
|
#
|
@@ -6376,16 +6526,18 @@ module Aws::GameLift
|
|
6376
6526
|
#
|
6377
6527
|
# * SuspendGameServerGroup
|
6378
6528
|
#
|
6529
|
+
# * DescribeGameServerInstances
|
6530
|
+
#
|
6379
6531
|
#
|
6380
6532
|
#
|
6381
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
6533
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
6382
6534
|
#
|
6383
6535
|
# @option params [required, String] :game_server_group_name
|
6384
|
-
#
|
6385
|
-
#
|
6536
|
+
# A unique identifier for the game server group. Use either the
|
6537
|
+
# GameServerGroup name or ARN value.
|
6386
6538
|
#
|
6387
6539
|
# @option params [required, Array<String>] :resume_actions
|
6388
|
-
# The
|
6540
|
+
# The activity to resume for this game server group.
|
6389
6541
|
#
|
6390
6542
|
# @return [Types::ResumeGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6391
6543
|
#
|
@@ -6406,7 +6558,7 @@ module Aws::GameLift
|
|
6406
6558
|
# resp.game_server_group.instance_definitions #=> Array
|
6407
6559
|
# resp.game_server_group.instance_definitions[0].instance_type #=> String, one of "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge"
|
6408
6560
|
# resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
|
6409
|
-
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED"
|
6561
|
+
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED", "ON_DEMAND_ONLY"
|
6410
6562
|
# resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
|
6411
6563
|
# resp.game_server_group.auto_scaling_group_arn #=> String
|
6412
6564
|
# resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
|
@@ -6585,14 +6737,16 @@ module Aws::GameLift
|
|
6585
6737
|
#
|
6586
6738
|
# @option params [String] :next_token
|
6587
6739
|
# Token that indicates the start of the next sequential page of results.
|
6588
|
-
# Use the token that is returned with a previous call to this
|
6589
|
-
# start at the beginning of the result set, do not specify a value.
|
6740
|
+
# Use the token that is returned with a previous call to this operation.
|
6741
|
+
# To start at the beginning of the result set, do not specify a value.
|
6590
6742
|
#
|
6591
6743
|
# @return [Types::SearchGameSessionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6592
6744
|
#
|
6593
6745
|
# * {Types::SearchGameSessionsOutput#game_sessions #game_sessions} => Array<Types::GameSession>
|
6594
6746
|
# * {Types::SearchGameSessionsOutput#next_token #next_token} => String
|
6595
6747
|
#
|
6748
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6749
|
+
#
|
6596
6750
|
# @example Request syntax with placeholder values
|
6597
6751
|
#
|
6598
6752
|
# resp = client.search_game_sessions({
|
@@ -7041,26 +7195,13 @@ module Aws::GameLift
|
|
7041
7195
|
# matchmaking configuration, and include the players to be matched. You
|
7042
7196
|
# must also include a set of player attributes relevant for the
|
7043
7197
|
# matchmaking configuration. If successful, a matchmaking ticket is
|
7044
|
-
# returned with status set to `QUEUED`.
|
7045
|
-
#
|
7046
|
-
#
|
7047
|
-
#
|
7048
|
-
#
|
7049
|
-
#
|
7050
|
-
#
|
7051
|
-
# * Polling -- Call `DescribeMatchmaking`. This operation returns the
|
7052
|
-
# full ticket object, including current status and (for completed
|
7053
|
-
# tickets) game session connection info. We recommend polling no more
|
7054
|
-
# than once every 10 seconds.
|
7055
|
-
#
|
7056
|
-
# * Notifications -- Get event notifications for changes in ticket
|
7057
|
-
# status using Amazon Simple Notification Service (SNS). Notifications
|
7058
|
-
# are easy to set up (see CreateMatchmakingConfiguration) and
|
7059
|
-
# typically deliver match status changes faster and more efficiently
|
7060
|
-
# than polling. We recommend that you use polling to back up to
|
7061
|
-
# notifications (since delivery is not guaranteed) and call
|
7062
|
-
# `DescribeMatchmaking` only when notifications are not received
|
7063
|
-
# within 30 seconds.
|
7198
|
+
# returned with status set to `QUEUED`.
|
7199
|
+
#
|
7200
|
+
# Track the status of the ticket to respond as needed and acquire game
|
7201
|
+
# session connection information for successfully completed matches.
|
7202
|
+
# Ticket status updates are tracked using event notification through
|
7203
|
+
# Amazon Simple Notification Service (SNS), which is defined in the
|
7204
|
+
# matchmaking configuration.
|
7064
7205
|
#
|
7065
7206
|
# **Processing a matchmaking request** -- FlexMatch handles a
|
7066
7207
|
# matchmaking request as follows:
|
@@ -7341,7 +7482,7 @@ module Aws::GameLift
|
|
7341
7482
|
# The ticket ID is included in the `MatchmakerData` of an updated game
|
7342
7483
|
# session object, which is provided to the game server.
|
7343
7484
|
#
|
7344
|
-
# <note markdown="1"> If the
|
7485
|
+
# <note markdown="1"> If the operation is successful, the service sends back an empty JSON
|
7345
7486
|
# struct with the HTTP 200 response (not an empty HTTP body).
|
7346
7487
|
#
|
7347
7488
|
# </note>
|
@@ -7386,27 +7527,28 @@ module Aws::GameLift
|
|
7386
7527
|
req.send_request(options)
|
7387
7528
|
end
|
7388
7529
|
|
7389
|
-
# **This
|
7390
|
-
#
|
7530
|
+
# **This operation is used with the Amazon GameLift FleetIQ solution and
|
7531
|
+
# game server groups.**
|
7391
7532
|
#
|
7392
7533
|
# Temporarily stops activity on a game server group without terminating
|
7393
|
-
# instances or the game server group.
|
7394
|
-
# calling ResumeGameServerGroup.
|
7395
|
-
#
|
7396
|
-
# * Instance type replacement
|
7397
|
-
# viability of all instance types that are defined
|
7398
|
-
# group. It updates the Auto Scaling group to
|
7399
|
-
#
|
7400
|
-
# interruptions
|
7401
|
-
# Spot
|
7402
|
-
# Scaling group continues with its current
|
7403
|
-
# viability. Instance protection, utilization
|
7404
|
-
#
|
7534
|
+
# instances or the game server group. You can restart activity by
|
7535
|
+
# calling ResumeGameServerGroup. You can suspend the following activity:
|
7536
|
+
#
|
7537
|
+
# * **Instance type replacement** - This activity evaluates the current
|
7538
|
+
# game hosting viability of all Spot instance types that are defined
|
7539
|
+
# for the game server group. It updates the Auto Scaling group to
|
7540
|
+
# remove nonviable Spot Instance types, which have a higher chance of
|
7541
|
+
# game server interruptions. It then balances capacity across the
|
7542
|
+
# remaining viable Spot Instance types. When this activity is
|
7543
|
+
# suspended, the Auto Scaling group continues with its current
|
7544
|
+
# balance, regardless of viability. Instance protection, utilization
|
7545
|
+
# metrics, and capacity scaling activities continue to be active.
|
7405
7546
|
#
|
7406
7547
|
# ^
|
7407
7548
|
#
|
7408
7549
|
# To suspend activity, specify a game server group ARN and the type of
|
7409
|
-
# activity to be suspended.
|
7550
|
+
# activity to be suspended. If successful, a GameServerGroup object is
|
7551
|
+
# returned showing that the activity is listed in `SuspendedActions`.
|
7410
7552
|
#
|
7411
7553
|
# **Learn more**
|
7412
7554
|
#
|
@@ -7428,16 +7570,18 @@ module Aws::GameLift
|
|
7428
7570
|
#
|
7429
7571
|
# * SuspendGameServerGroup
|
7430
7572
|
#
|
7573
|
+
# * DescribeGameServerInstances
|
7431
7574
|
#
|
7432
7575
|
#
|
7433
|
-
#
|
7576
|
+
#
|
7577
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
7434
7578
|
#
|
7435
7579
|
# @option params [required, String] :game_server_group_name
|
7436
|
-
#
|
7437
|
-
#
|
7580
|
+
# A unique identifier for the game server group. Use either the
|
7581
|
+
# GameServerGroup name or ARN value.
|
7438
7582
|
#
|
7439
7583
|
# @option params [required, Array<String>] :suspend_actions
|
7440
|
-
# The
|
7584
|
+
# The activity to suspend for this game server group.
|
7441
7585
|
#
|
7442
7586
|
# @return [Types::SuspendGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7443
7587
|
#
|
@@ -7458,7 +7602,7 @@ module Aws::GameLift
|
|
7458
7602
|
# resp.game_server_group.instance_definitions #=> Array
|
7459
7603
|
# resp.game_server_group.instance_definitions[0].instance_type #=> String, one of "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge"
|
7460
7604
|
# resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
|
7461
|
-
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED"
|
7605
|
+
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED", "ON_DEMAND_ONLY"
|
7462
7606
|
# resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
|
7463
7607
|
# resp.game_server_group.auto_scaling_group_arn #=> String
|
7464
7608
|
# resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
|
@@ -7480,9 +7624,9 @@ module Aws::GameLift
|
|
7480
7624
|
# Assigns a tag to a GameLift resource. AWS resource tags provide an
|
7481
7625
|
# additional management tool set. You can use tags to organize
|
7482
7626
|
# resources, create IAM permissions policies to manage access to groups
|
7483
|
-
# of resources, customize AWS cost breakdowns, etc. This
|
7484
|
-
# the permissions necessary to manage tags for the following
|
7485
|
-
# resource types:
|
7627
|
+
# of resources, customize AWS cost breakdowns, etc. This operation
|
7628
|
+
# handles the permissions necessary to manage tags for the following
|
7629
|
+
# GameLift resource types:
|
7486
7630
|
#
|
7487
7631
|
# * Build
|
7488
7632
|
#
|
@@ -7526,8 +7670,8 @@ module Aws::GameLift
|
|
7526
7670
|
# The Amazon Resource Name ([ARN][1]) that is assigned to and uniquely
|
7527
7671
|
# identifies the GameLift resource that you want to assign tags to.
|
7528
7672
|
# GameLift resource ARNs are included in the data object for the
|
7529
|
-
# resource, which can be retrieved by calling a List or Describe
|
7530
|
-
# for the resource type.
|
7673
|
+
# resource, which can be retrieved by calling a List or Describe
|
7674
|
+
# operation for the resource type.
|
7531
7675
|
#
|
7532
7676
|
#
|
7533
7677
|
#
|
@@ -7568,7 +7712,7 @@ module Aws::GameLift
|
|
7568
7712
|
|
7569
7713
|
# Removes a tag that is assigned to a GameLift resource. Resource tags
|
7570
7714
|
# are used to organize AWS resources for a range of purposes. This
|
7571
|
-
#
|
7715
|
+
# operation handles the permissions necessary to manage tags for the
|
7572
7716
|
# following GameLift resource types:
|
7573
7717
|
#
|
7574
7718
|
# * Build
|
@@ -7587,8 +7731,8 @@ module Aws::GameLift
|
|
7587
7731
|
#
|
7588
7732
|
# To remove a tag from a resource, specify the unique ARN value for the
|
7589
7733
|
# resource and provide a string list containing one or more tags to be
|
7590
|
-
# removed. This
|
7591
|
-
# not currently assigned to the specified resource.
|
7734
|
+
# removed. This operation succeeds even if the list includes tags that
|
7735
|
+
# are not currently assigned to the specified resource.
|
7592
7736
|
#
|
7593
7737
|
# **Learn more**
|
7594
7738
|
#
|
@@ -7613,8 +7757,8 @@ module Aws::GameLift
|
|
7613
7757
|
# The Amazon Resource Name ([ARN][1]) that is assigned to and uniquely
|
7614
7758
|
# identifies the GameLift resource that you want to remove tags from.
|
7615
7759
|
# GameLift resource ARNs are included in the data object for the
|
7616
|
-
# resource, which can be retrieved by calling a List or Describe
|
7617
|
-
# for the resource type.
|
7760
|
+
# resource, which can be retrieved by calling a List or Describe
|
7761
|
+
# operation for the resource type.
|
7618
7762
|
#
|
7619
7763
|
#
|
7620
7764
|
#
|
@@ -7881,9 +8025,9 @@ module Aws::GameLift
|
|
7881
8025
|
req.send_request(options)
|
7882
8026
|
end
|
7883
8027
|
|
7884
|
-
# Updates capacity settings for a fleet. Use this
|
7885
|
-
# number of EC2 instances (hosts) that you want this fleet to
|
7886
|
-
# Before calling this
|
8028
|
+
# Updates capacity settings for a fleet. Use this operation to specify
|
8029
|
+
# the number of EC2 instances (hosts) that you want this fleet to
|
8030
|
+
# contain. Before calling this operation, you may want to call
|
7887
8031
|
# DescribeEC2InstanceLimits to get the maximum capacity based on the
|
7888
8032
|
# fleet's EC2 instance type.
|
7889
8033
|
#
|
@@ -8059,18 +8203,17 @@ module Aws::GameLift
|
|
8059
8203
|
req.send_request(options)
|
8060
8204
|
end
|
8061
8205
|
|
8062
|
-
# **This
|
8063
|
-
#
|
8064
|
-
#
|
8065
|
-
# Updates information about a registered game server
|
8066
|
-
#
|
8067
|
-
# game server
|
8068
|
-
#
|
8069
|
-
#
|
8070
|
-
#
|
8071
|
-
#
|
8072
|
-
#
|
8073
|
-
# You can make all three types of updates in the same request.
|
8206
|
+
# **This operation is used with the Amazon GameLift FleetIQ solution and
|
8207
|
+
# game server groups.**
|
8208
|
+
#
|
8209
|
+
# Updates information about a registered game server to help GameLift
|
8210
|
+
# FleetIQ to track game server availability. This operation is called by
|
8211
|
+
# a game server process that is running on an instance in a game server
|
8212
|
+
# group.
|
8213
|
+
#
|
8214
|
+
# Use this operation to update the following types of game server
|
8215
|
+
# information. You can make all three types of updates in the same
|
8216
|
+
# request:
|
8074
8217
|
#
|
8075
8218
|
# * To update the game server's utilization status, identify the game
|
8076
8219
|
# server and game server group and specify the current utilization
|
@@ -8078,14 +8221,14 @@ module Aws::GameLift
|
|
8078
8221
|
# hosting games and when they are available to be claimed.
|
8079
8222
|
#
|
8080
8223
|
# * To report health status, identify the game server and game server
|
8081
|
-
# group and set health check to HEALTHY
|
8224
|
+
# group and set health check to `HEALTHY`. If a game server does not
|
8082
8225
|
# report health status for a certain length of time, the game server
|
8083
|
-
# is no longer considered healthy
|
8084
|
-
# from the game server group to avoid affecting
|
8085
|
-
# The best practice is to report health every 60
|
8226
|
+
# is no longer considered healthy. As a result, it will be eventually
|
8227
|
+
# deregistered from the game server group to avoid affecting
|
8228
|
+
# utilization metrics. The best practice is to report health every 60
|
8229
|
+
# seconds.
|
8086
8230
|
#
|
8087
|
-
# * To change game server metadata, provide updated game server data
|
8088
|
-
# custom sort key values.
|
8231
|
+
# * To change game server metadata, provide updated game server data.
|
8089
8232
|
#
|
8090
8233
|
# Once a game server is successfully updated, the relevant statuses and
|
8091
8234
|
# timestamps are updated.
|
@@ -8110,35 +8253,29 @@ module Aws::GameLift
|
|
8110
8253
|
#
|
8111
8254
|
#
|
8112
8255
|
#
|
8113
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
8256
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
8114
8257
|
#
|
8115
8258
|
# @option params [required, String] :game_server_group_name
|
8116
|
-
#
|
8259
|
+
# A unique identifier for the game server group where the game server is
|
8117
8260
|
# running. Use either the GameServerGroup name or ARN value.
|
8118
8261
|
#
|
8119
8262
|
# @option params [required, String] :game_server_id
|
8120
|
-
#
|
8263
|
+
# A custom string that uniquely identifies the game server to update.
|
8121
8264
|
#
|
8122
8265
|
# @option params [String] :game_server_data
|
8123
8266
|
# A set of custom game server properties, formatted as a single string
|
8124
8267
|
# value. This data is passed to a game client or service when it
|
8125
|
-
# requests information on
|
8268
|
+
# requests information on game servers using ListGameServers or
|
8126
8269
|
# ClaimGameServer.
|
8127
8270
|
#
|
8128
|
-
# @option params [String] :custom_sort_key
|
8129
|
-
# A game server tag that can be used to request sorted lists of game
|
8130
|
-
# servers using ListGameServers. Custom sort keys are developer-defined
|
8131
|
-
# based on how you want to organize the retrieved game server
|
8132
|
-
# information.
|
8133
|
-
#
|
8134
8271
|
# @option params [String] :utilization_status
|
8135
8272
|
# Indicates whether the game server is available or is currently hosting
|
8136
8273
|
# gameplay.
|
8137
8274
|
#
|
8138
8275
|
# @option params [String] :health_check
|
8139
|
-
# Indicates health status of the game server.
|
8140
|
-
#
|
8141
|
-
#
|
8276
|
+
# Indicates health status of the game server. A request that includes
|
8277
|
+
# this parameter updates the game server's *LastHealthCheckTime*
|
8278
|
+
# timestamp.
|
8142
8279
|
#
|
8143
8280
|
# @return [Types::UpdateGameServerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8144
8281
|
#
|
@@ -8150,7 +8287,6 @@ module Aws::GameLift
|
|
8150
8287
|
# game_server_group_name: "GameServerGroupNameOrArn", # required
|
8151
8288
|
# game_server_id: "GameServerId", # required
|
8152
8289
|
# game_server_data: "GameServerData",
|
8153
|
-
# custom_sort_key: "GameServerSortKey",
|
8154
8290
|
# utilization_status: "AVAILABLE", # accepts AVAILABLE, UTILIZED
|
8155
8291
|
# health_check: "HEALTHY", # accepts HEALTHY
|
8156
8292
|
# })
|
@@ -8163,7 +8299,6 @@ module Aws::GameLift
|
|
8163
8299
|
# resp.game_server.instance_id #=> String
|
8164
8300
|
# resp.game_server.connection_info #=> String
|
8165
8301
|
# resp.game_server.game_server_data #=> String
|
8166
|
-
# resp.game_server.custom_sort_key #=> String
|
8167
8302
|
# resp.game_server.claim_status #=> String, one of "CLAIMED"
|
8168
8303
|
# resp.game_server.utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
|
8169
8304
|
# resp.game_server.registration_time #=> Time
|
@@ -8179,29 +8314,24 @@ module Aws::GameLift
|
|
8179
8314
|
req.send_request(options)
|
8180
8315
|
end
|
8181
8316
|
|
8182
|
-
# **This
|
8183
|
-
#
|
8317
|
+
# **This operation is used with the Amazon GameLift FleetIQ solution and
|
8318
|
+
# game server groups.**
|
8184
8319
|
#
|
8185
8320
|
# Updates GameLift FleetIQ-specific properties for a game server group.
|
8186
|
-
#
|
8187
|
-
#
|
8188
|
-
#
|
8189
|
-
# counts, and launch template.
|
8321
|
+
# Many Auto Scaling group properties are updated on the Auto Scaling
|
8322
|
+
# group directly, including the launch template, Auto Scaling policies,
|
8323
|
+
# and maximum/minimum/desired instance counts.
|
8190
8324
|
#
|
8191
8325
|
# To update the game server group, specify the game server group ID and
|
8192
|
-
# provide the updated values.
|
8193
|
-
#
|
8194
|
-
#
|
8195
|
-
#
|
8196
|
-
# change Auto Scaling group properties directly and the changes cause
|
8197
|
-
# errors with GameLift FleetIQ activities, an alert is sent.
|
8326
|
+
# provide the updated values. Before applying the updates, the new
|
8327
|
+
# values are validated to ensure that GameLift FleetIQ can continue to
|
8328
|
+
# perform instance balancing activity. If successful, a GameServerGroup
|
8329
|
+
# object is returned.
|
8198
8330
|
#
|
8199
8331
|
# **Learn more**
|
8200
8332
|
#
|
8201
8333
|
# [GameLift FleetIQ Guide][1]
|
8202
8334
|
#
|
8203
|
-
# [Updating a GameLift FleetIQ-Linked Auto Scaling Group][2]
|
8204
|
-
#
|
8205
8335
|
# **Related operations**
|
8206
8336
|
#
|
8207
8337
|
# * CreateGameServerGroup
|
@@ -8218,64 +8348,75 @@ module Aws::GameLift
|
|
8218
8348
|
#
|
8219
8349
|
# * SuspendGameServerGroup
|
8220
8350
|
#
|
8351
|
+
# * DescribeGameServerInstances
|
8221
8352
|
#
|
8222
8353
|
#
|
8223
|
-
#
|
8224
|
-
# [
|
8354
|
+
#
|
8355
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
8225
8356
|
#
|
8226
8357
|
# @option params [required, String] :game_server_group_name
|
8227
|
-
#
|
8228
|
-
#
|
8358
|
+
# A unique identifier for the game server group. Use either the
|
8359
|
+
# GameServerGroup name or ARN value.
|
8229
8360
|
#
|
8230
8361
|
# @option params [String] :role_arn
|
8231
8362
|
# The Amazon Resource Name ([ARN][1]) for an IAM role that allows Amazon
|
8232
|
-
# GameLift to access your EC2 Auto Scaling groups.
|
8233
|
-
# validated to ensure that it contains the necessary permissions for
|
8234
|
-
# game server groups.
|
8363
|
+
# GameLift to access your EC2 Auto Scaling groups.
|
8235
8364
|
#
|
8236
8365
|
#
|
8237
8366
|
#
|
8238
8367
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
|
8239
8368
|
#
|
8240
8369
|
# @option params [Array<Types::InstanceDefinition>] :instance_definitions
|
8241
|
-
# An updated list of EC2 instance types to use
|
8242
|
-
#
|
8243
|
-
# are supported by GameLift FleetIQ
|
8244
|
-
#
|
8245
|
-
#
|
8246
|
-
#
|
8247
|
-
#
|
8370
|
+
# An updated list of EC2 instance types to use in the Auto Scaling
|
8371
|
+
# group. The instance definitions must specify at least two different
|
8372
|
+
# instance types that are supported by GameLift FleetIQ. This updated
|
8373
|
+
# list replaces the entire current list of instance definitions for the
|
8374
|
+
# game server group. For more information on instance types, see [EC2
|
8375
|
+
# Instance Types][1] in the *Amazon EC2 User Guide*. You can optionally
|
8376
|
+
# specify capacity weighting for each instance type. If no weight value
|
8377
|
+
# is specified for an instance type, it is set to the default value
|
8378
|
+
# "1". For more information about capacity weighting, see [ Instance
|
8379
|
+
# Weighting for Amazon EC2 Auto Scaling][2] in the Amazon EC2 Auto
|
8380
|
+
# Scaling User Guide.
|
8248
8381
|
#
|
8249
8382
|
#
|
8250
8383
|
#
|
8251
8384
|
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html
|
8385
|
+
# [2]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html
|
8252
8386
|
#
|
8253
8387
|
# @option params [String] :game_server_protection_policy
|
8254
8388
|
# A flag that indicates whether instances in the game server group are
|
8255
8389
|
# protected from early termination. Unprotected instances that have
|
8256
|
-
# active game servers running
|
8390
|
+
# active game servers running might be terminated during a scale-down
|
8257
8391
|
# event, causing players to be dropped from the game. Protected
|
8258
8392
|
# instances cannot be terminated while there are active game servers
|
8259
|
-
# running
|
8393
|
+
# running except in the event of a forced game server group deletion
|
8394
|
+
# (see ). An exception to this is with Spot Instances, which can be
|
8260
8395
|
# terminated by AWS regardless of protection status. This property is
|
8261
|
-
# set to
|
8396
|
+
# set to `NO_PROTECTION` by default.
|
8262
8397
|
#
|
8263
8398
|
# @option params [String] :balancing_strategy
|
8264
|
-
#
|
8265
|
-
#
|
8266
|
-
#
|
8267
|
-
#
|
8268
|
-
#
|
8269
|
-
#
|
8270
|
-
# group provides no hosting capacity
|
8271
|
-
#
|
8272
|
-
#
|
8273
|
-
#
|
8274
|
-
#
|
8275
|
-
#
|
8276
|
-
#
|
8277
|
-
#
|
8278
|
-
# On-Demand
|
8399
|
+
# Indicates how GameLift FleetIQ balances the use of Spot Instances and
|
8400
|
+
# On-Demand Instances in the game server group. Method options include
|
8401
|
+
# the following:
|
8402
|
+
#
|
8403
|
+
# * `SPOT_ONLY` - Only Spot Instances are used in the game server group.
|
8404
|
+
# If Spot Instances are unavailable or not viable for game hosting,
|
8405
|
+
# the game server group provides no hosting capacity until Spot
|
8406
|
+
# Instances can again be used. Until then, no new instances are
|
8407
|
+
# started, and the existing nonviable Spot Instances are terminated
|
8408
|
+
# (after current gameplay ends) and are not replaced.
|
8409
|
+
#
|
8410
|
+
# * `SPOT_PREFERRED` - (default value) Spot Instances are used whenever
|
8411
|
+
# available in the game server group. If Spot Instances are
|
8412
|
+
# unavailable, the game server group continues to provide hosting
|
8413
|
+
# capacity by falling back to On-Demand Instances. Existing nonviable
|
8414
|
+
# Spot Instances are terminated (after current gameplay ends) and are
|
8415
|
+
# replaced with new On-Demand Instances.
|
8416
|
+
#
|
8417
|
+
# * `ON_DEMAND_ONLY` - Only On-Demand Instances are used in the game
|
8418
|
+
# server group. No Spot Instances are used, even when available, while
|
8419
|
+
# this balancing strategy is in force.
|
8279
8420
|
#
|
8280
8421
|
# @return [Types::UpdateGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8281
8422
|
#
|
@@ -8293,7 +8434,7 @@ module Aws::GameLift
|
|
8293
8434
|
# },
|
8294
8435
|
# ],
|
8295
8436
|
# game_server_protection_policy: "NO_PROTECTION", # accepts NO_PROTECTION, FULL_PROTECTION
|
8296
|
-
# balancing_strategy: "SPOT_ONLY", # accepts SPOT_ONLY, SPOT_PREFERRED
|
8437
|
+
# balancing_strategy: "SPOT_ONLY", # accepts SPOT_ONLY, SPOT_PREFERRED, ON_DEMAND_ONLY
|
8297
8438
|
# })
|
8298
8439
|
#
|
8299
8440
|
# @example Response structure
|
@@ -8304,7 +8445,7 @@ module Aws::GameLift
|
|
8304
8445
|
# resp.game_server_group.instance_definitions #=> Array
|
8305
8446
|
# resp.game_server_group.instance_definitions[0].instance_type #=> String, one of "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge"
|
8306
8447
|
# resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
|
8307
|
-
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED"
|
8448
|
+
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED", "ON_DEMAND_ONLY"
|
8308
8449
|
# resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
|
8309
8450
|
# resp.game_server_group.auto_scaling_group_arn #=> String
|
8310
8451
|
# resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
|
@@ -8980,7 +9121,7 @@ module Aws::GameLift
|
|
8980
9121
|
params: params,
|
8981
9122
|
config: config)
|
8982
9123
|
context[:gem_name] = 'aws-sdk-gamelift'
|
8983
|
-
context[:gem_version] = '1.
|
9124
|
+
context[:gem_version] = '1.36.0'
|
8984
9125
|
Seahorse::Client::Request.new(handlers, context)
|
8985
9126
|
end
|
8986
9127
|
|