aws-sdk-gamelift 1.33.0 → 1.38.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: db78a5576967de238c6c9b7af5ff49934b17a4b3b85db208208c8914b930684a
4
- data.tar.gz: e1bcc778990c6f441026c4f4055a12bc656148cc576b60ec97818515751dee25
3
+ metadata.gz: f184391dc32a2c390a0c23e476ec57911cf1cdab0f8035b622681f32f20e93af
4
+ data.tar.gz: 3e3970fc31b3427fa723e75bbdc0f22840a049baa0edfdbf41c0bcde7610eca0
5
5
  SHA512:
6
- metadata.gz: dced0a24026fb4a19cf2ec3118ad401ae4bd169b03a61cde5c0b2b9ec22eb805463dffa0a9356a35a70abf589da06c5a21994af12f3438b518a6b64e3b629e8a
7
- data.tar.gz: 7ae76b4ce25172d9cdd031ed159c8102d7be98d34a8edfcf1df77c41e51585f08c34233d12e74023ce6ad21cec13edc03014ce97ac6ba9e6ac163772c6648009
6
+ metadata.gz: 19b607c6799b18e4bd4573120b27b9da6ad453afc0bdc4a20bb2a7aa0cf8d2a841eff6cb8b2eedeac79e30be84d27105eb840c05a5602faab1cd8069e0e4930d
7
+ data.tar.gz: 0a0feba974e6e4ef024f890e66edef9f802f2e9eeadaa733b71223cdc26a89f33c7e094a952230df97793503f4fc8cba2714d2077b69c7ee8ccb80f0cd6e5c9d
@@ -7,6 +7,7 @@
7
7
  #
8
8
  # WARNING ABOUT GENERATED CODE
9
9
 
10
+
10
11
  require 'aws-sdk-core'
11
12
  require 'aws-sigv4'
12
13
 
@@ -44,9 +45,9 @@ require_relative 'aws-sdk-gamelift/customizations'
44
45
  #
45
46
  # See {Errors} for more information.
46
47
  #
47
- # @service
48
+ # @!group service
48
49
  module Aws::GameLift
49
50
 
50
- GEM_VERSION = '1.33.0'
51
+ GEM_VERSION = '1.38.0'
51
52
 
52
53
  end
@@ -85,13 +85,28 @@ module Aws::GameLift
85
85
  # * `Aws::Credentials` - Used for configuring static, non-refreshing
86
86
  # credentials.
87
87
  #
88
+ # * `Aws::SharedCredentials` - Used for loading static credentials from a
89
+ # shared file, such as `~/.aws/config`.
90
+ #
91
+ # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
92
+ #
93
+ # * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
94
+ # assume a role after providing credentials via the web.
95
+ #
96
+ # * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
97
+ # access token generated from `aws login`.
98
+ #
99
+ # * `Aws::ProcessCredentials` - Used for loading credentials from a
100
+ # process that outputs to stdout.
101
+ #
88
102
  # * `Aws::InstanceProfileCredentials` - Used for loading credentials
89
103
  # from an EC2 IMDS on an EC2 instance.
90
104
  #
91
- # * `Aws::SharedCredentials` - Used for loading credentials from a
92
- # shared file, such as `~/.aws/config`.
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
93
107
  #
94
- # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
95
110
  #
96
111
  # When `:credentials` are not configured directly, the following
97
112
  # locations will be searched for credentials:
@@ -101,10 +116,10 @@ module Aws::GameLift
101
116
  # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
102
117
  # * `~/.aws/credentials`
103
118
  # * `~/.aws/config`
104
- # * EC2 IMDS instance profile - When used by default, the timeouts are
105
- # very aggressive. Construct and pass an instance of
106
- # `Aws::InstanceProfileCredentails` to enable retries and extended
107
- # timeouts.
119
+ # * EC2/ECS IMDS instance profile - When used by default, the timeouts
120
+ # are very aggressive. Construct and pass an instance of
121
+ # `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
122
+ # enable retries and extended timeouts.
108
123
  #
109
124
  # @option options [required, String] :region
110
125
  # The AWS region to connect to. The configured `:region` is
@@ -401,47 +416,46 @@ module Aws::GameLift
401
416
  req.send_request(options)
402
417
  end
403
418
 
404
- # **This action is part of Amazon GameLift FleetIQ with game server
405
- # groups, which is in preview release and is subject to change.**
419
+ # **This operation is used with the Amazon GameLift FleetIQ solution and
420
+ # game server groups.**
406
421
  #
407
422
  # Locates an available game server and temporarily reserves it to host
408
- # gameplay and players. This action is called by a game client or client
409
- # service (such as a matchmaker) to request hosting resources for a new
410
- # game session. In response, GameLift FleetIQ searches for an available
411
- # game server in the specified game server group, places the game server
412
- # in "claimed" status for 60 seconds, and returns connection
413
- # information back to the requester so that players can connect to the
414
- # game server.
415
- #
416
- # There are two ways you can claim a game server. For the first option,
417
- # you provide a game server group ID only, which prompts GameLift
418
- # FleetIQ to search for an available game server in the specified group
419
- # and claim it. With this option, GameLift FleetIQ attempts to
420
- # consolidate gameplay on as few instances as possible to minimize
421
- # hosting costs. For the second option, you request a specific game
422
- # server by its ID. This option results in a less efficient claiming
423
- # process because it does not take advantage of consolidation and may
424
- # fail if the requested game server is unavailable.
425
- #
426
- # To claim a game server, identify a game server group and (optionally)
427
- # a game server ID. If your game requires that game data be provided to
428
- # the game server at the start of a game, such as a game map or player
429
- # 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.
430
435
  #
431
436
  # When a game server is successfully claimed, connection information is
432
437
  # returned. A claimed game server's utilization status remains
433
- # AVAILABLE, while the claim status is set to CLAIMED for up to 60
434
- # seconds. This time period allows the game server to be prompted to
435
- # update its status to UTILIZED (using UpdateGameServer). If the game
436
- # server's status is not updated within 60 seconds, the game server
437
- # reverts to unclaimed status and is available to be claimed by another
438
- # 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.
439
445
  #
440
446
  # If you try to claim a specific game server, this request will fail in
441
- # the following cases: (1) if the game server utilization status is
442
- # UTILIZED, (2) if the game server claim status is CLAIMED, or (3) if
443
- # the instance that the game server is running on is flagged as
444
- # draining.
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>
445
459
  #
446
460
  # **Learn more**
447
461
  #
@@ -463,14 +477,13 @@ module Aws::GameLift
463
477
  #
464
478
  #
465
479
  #
466
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
480
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
467
481
  #
468
482
  # @option params [required, String] :game_server_group_name
469
- # An identifier for the game server group. When claiming a specific game
470
- # server, this is the game server group whether the game server is
471
- # located. When requesting that GameLift FleetIQ locate an available
472
- # game server, this is the game server group to search on. You can use
473
- # 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.
474
487
  #
475
488
  # @option params [String] :game_server_id
476
489
  # A custom string that uniquely identifies the game server to claim. If
@@ -479,7 +492,9 @@ module Aws::GameLift
479
492
  #
480
493
  # @option params [String] :game_server_data
481
494
  # A set of custom game server properties, formatted as a single string
482
- # value, to be passed to the claimed game server.
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.
483
498
  #
484
499
  # @return [Types::ClaimGameServerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
485
500
  #
@@ -501,7 +516,6 @@ module Aws::GameLift
501
516
  # resp.game_server.instance_id #=> String
502
517
  # resp.game_server.connection_info #=> String
503
518
  # resp.game_server.game_server_data #=> String
504
- # resp.game_server.custom_sort_key #=> String
505
519
  # resp.game_server.claim_status #=> String, one of "CLAIMED"
506
520
  # resp.game_server.utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
507
521
  # resp.game_server.registration_time #=> Time
@@ -636,12 +650,13 @@ module Aws::GameLift
636
650
  #
637
651
  # * To directly upload your build files to a GameLift S3 location. To
638
652
  # use this option, first call `CreateBuild` and specify a build name
639
- # and operating system. This action creates a new build resource and
640
- # also returns an S3 location with temporary access credentials. Use
641
- # the credentials to manually upload your build files to the specified
642
- # S3 location. For more information, see [Uploading Objects][1] in the
643
- # *Amazon S3 Developer Guide*. Build files can be uploaded to the
644
- # GameLift S3 location once only; that can't be updated.
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.
645
660
  #
646
661
  # If successful, this operation creates a new build resource with a
647
662
  # unique build ID and places it in `INITIALIZED` status. A build must be
@@ -1104,54 +1119,49 @@ module Aws::GameLift
1104
1119
  req.send_request(options)
1105
1120
  end
1106
1121
 
1107
- # **This action is part of Amazon GameLift FleetIQ with game server
1108
- # groups, which is in preview release and is subject to change.**
1109
- #
1110
- # Creates a GameLift FleetIQ game server group to manage a collection of
1111
- # EC2 instances for game hosting. In addition to creating the game
1112
- # server group, this action also creates an Auto Scaling group in your
1113
- # AWS account and establishes a link between the two groups. You have
1114
- # full control over configuration of the Auto Scaling group, but
1115
- # GameLift FleetIQ routinely certain Auto Scaling group properties in
1116
- # 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.
1117
1129
  # You can view the status of your game server groups in the GameLift
1118
- # Console. Game server group metrics and events are emitted to Amazon
1130
+ # console. Game server group metrics and events are emitted to Amazon
1119
1131
  # CloudWatch.
1120
1132
  #
1121
- # Prior creating a new game server group, you must set up the following:
1133
+ # Before creating a new game server group, you must have the following:
1122
1134
  #
1123
- # * An EC2 launch template. The template provides configuration settings
1124
- # for a set of EC2 instances and includes the game server build that
1125
- # you want to deploy and run on each instance. For more information on
1126
- # creating a launch template, see [ Launching an Instance from a
1127
- # 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*.
1128
1139
  #
1129
- # * An IAM role. The role sets up limited access to your AWS account,
1130
- # allowing GameLift FleetIQ to create and manage the EC2 Auto Scaling
1131
- # group, get instance data, and emit metrics and events to CloudWatch.
1132
- # For more information on setting up an IAM permissions policy with
1133
- # principal access for GameLift, see [ Specifying a Principal in a
1134
- # 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*.
1135
1144
  #
1136
- # To create a new game server group, provide a name and specify the IAM
1137
- # role and EC2 launch template. You also need to provide a list of
1138
- # instance types to be used in the group and set initial maximum and
1139
- # minimum limits on the group's instance count. You can optionally set
1140
- # an autoscaling policy with target tracking based on a GameLift FleetIQ
1141
- # 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.
1142
1151
  #
1143
1152
  # Once the game server group and corresponding Auto Scaling group are
1144
1153
  # created, you have full access to change the Auto Scaling group's
1145
- # configuration as needed. Keep in mind, however, that some properties
1146
- # are periodically updated by GameLift FleetIQ as it balances the
1147
- # group's instances based on availability and cost.
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.
1148
1160
  #
1149
1161
  # **Learn more**
1150
1162
  #
1151
1163
  # [GameLift FleetIQ Guide][3]
1152
1164
  #
1153
- # [Updating a GameLift FleetIQ-Linked Auto Scaling Group][4]
1154
- #
1155
1165
  # **Related operations**
1156
1166
  #
1157
1167
  # * CreateGameServerGroup
@@ -1168,12 +1178,13 @@ module Aws::GameLift
1168
1178
  #
1169
1179
  # * SuspendGameServerGroup
1170
1180
  #
1181
+ # * DescribeGameServerInstances
1182
+ #
1171
1183
  #
1172
1184
  #
1173
1185
  # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html
1174
- # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-bucket-user-policy-specifying-principal-intro.html
1175
- # [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
1176
- # [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
1177
1188
  #
1178
1189
  # @option params [required, String] :game_server_group_name
1179
1190
  # An identifier for the new game server group. This value is used to
@@ -1183,9 +1194,7 @@ module Aws::GameLift
1183
1194
  #
1184
1195
  # @option params [required, String] :role_arn
1185
1196
  # The Amazon Resource Name ([ARN][1]) for an IAM role that allows Amazon
1186
- # GameLift to access your EC2 Auto Scaling groups. The submitted role is
1187
- # validated to ensure that it contains the necessary permissions for
1188
- # game server groups.
1197
+ # GameLift to access your EC2 Auto Scaling groups.
1189
1198
  #
1190
1199
  #
1191
1200
  #
@@ -1193,14 +1202,18 @@ module Aws::GameLift
1193
1202
  #
1194
1203
  # @option params [required, Integer] :min_size
1195
1204
  # The minimum number of instances allowed in the EC2 Auto Scaling group.
1196
- # During autoscaling events, GameLift FleetIQ and EC2 do not scale down
1197
- # the group below this minimum. In production, this value should be set
1198
- # 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.
1199
1210
  #
1200
1211
  # @option params [required, Integer] :max_size
1201
1212
  # The maximum number of instances allowed in the EC2 Auto Scaling group.
1202
- # During autoscaling events, GameLift FleetIQ and EC2 do not scale up
1203
- # 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.
1204
1217
  #
1205
1218
  # @option params [required, Types::LaunchTemplateSpecification] :launch_template
1206
1219
  # The EC2 launch template that contains configuration settings and game
@@ -1208,72 +1221,88 @@ module Aws::GameLift
1208
1221
  # You can specify the template using either the template name or ID. For
1209
1222
  # help with creating a launch template, see [Creating a Launch Template
1210
1223
  # for an Auto Scaling Group][1] in the *Amazon EC2 Auto Scaling User
1211
- # 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.
1212
1226
  #
1213
1227
  #
1214
1228
  #
1215
1229
  # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html
1216
1230
  #
1217
1231
  # @option params [required, Array<Types::InstanceDefinition>] :instance_definitions
1218
- # A set of EC2 instance types to use when creating instances in the
1219
- # group. The instance definitions must specify at least two different
1220
- # instance types that are supported by GameLift FleetIQ. For more
1221
- # information on instance types, see [EC2 Instance Types][1] in the
1222
- # *Amazon EC2 User Guide*.
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.
1223
1241
  #
1224
1242
  #
1225
1243
  #
1226
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
1227
1246
  #
1228
1247
  # @option params [Types::GameServerGroupAutoScalingPolicy] :auto_scaling_policy
1229
1248
  # Configuration settings to define a scaling policy for the Auto Scaling
1230
1249
  # group that is optimized for game hosting. The scaling policy uses the
1231
- # metric "PercentUtilizedGameServers" to maintain a buffer of idle
1250
+ # metric `"PercentUtilizedGameServers"` to maintain a buffer of idle
1232
1251
  # game servers that can immediately accommodate new games and players.
1233
- # Once the game server and Auto Scaling groups are created, you can
1234
- # update the scaling policy settings directly in Auto Scaling Groups.
1252
+ # After the Auto Scaling group is created, update this value directly in
1253
+ # the Auto Scaling group using the AWS console or APIs.
1235
1254
  #
1236
1255
  # @option params [String] :balancing_strategy
1237
- # The fallback balancing method to use for the game server group when
1238
- # Spot instances in a Region become unavailable or are not viable for
1239
- # game hosting. Once triggered, this method remains active until Spot
1240
- # instances can once again be used. Method options include:
1241
- #
1242
- # * SPOT\_ONLY -- If Spot instances are unavailable, the game server
1243
- # group provides no hosting capacity. No new instances are started,
1244
- # and the existing nonviable Spot instances are terminated (once
1245
- # current gameplay ends) and not replaced.
1246
- #
1247
- # * SPOT\_PREFERRED -- If Spot instances are unavailable, the game
1248
- # server group continues to provide hosting capacity by using
1249
- # On-Demand instances. Existing nonviable Spot instances are
1250
- # terminated (once current gameplay ends) and replaced with new
1251
- # On-Demand instances.
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.
1252
1277
  #
1253
1278
  # @option params [String] :game_server_protection_policy
1254
1279
  # A flag that indicates whether instances in the game server group are
1255
1280
  # protected from early termination. Unprotected instances that have
1256
- # active game servers running may by terminated during a scale-down
1281
+ # active game servers running might be terminated during a scale-down
1257
1282
  # event, causing players to be dropped from the game. Protected
1258
1283
  # instances cannot be terminated while there are active game servers
1259
- # running. An exception to this is Spot Instances, which may be
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
1260
1286
  # terminated by AWS regardless of protection status. This property is
1261
- # set to NO\_PROTECTION by default.
1287
+ # set to `NO_PROTECTION` by default.
1262
1288
  #
1263
1289
  # @option params [Array<String>] :vpc_subnets
1264
1290
  # A list of virtual private cloud (VPC) subnets to use with instances in
1265
1291
  # the game server group. By default, all GameLift FleetIQ-supported
1266
- # availability zones are used; this parameter allows you to specify VPCs
1267
- # 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
1268
1297
  #
1269
1298
  # @option params [Array<Types::Tag>] :tags
1270
1299
  # A list of labels to assign to the new game server group resource. Tags
1271
- # are developer-defined key-value pairs. Tagging AWS resources are
1272
- # useful for resource management, access management, and cost
1273
- # allocation. For more information, see [ Tagging AWS Resources][1] in
1274
- # the *AWS General Reference*. Once the resource is created, you can use
1275
- # TagResource, UntagResource, and ListTagsForResource to add, remove,
1276
- # and view tags. The maximum tag limit may be lower than stated. See the
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
1277
1306
  # AWS General Reference for actual tagging limits.
1278
1307
  #
1279
1308
  #
@@ -1308,7 +1337,7 @@ module Aws::GameLift
1308
1337
  # target_value: 1.0, # required
1309
1338
  # },
1310
1339
  # },
1311
- # balancing_strategy: "SPOT_ONLY", # accepts SPOT_ONLY, SPOT_PREFERRED
1340
+ # balancing_strategy: "SPOT_ONLY", # accepts SPOT_ONLY, SPOT_PREFERRED, ON_DEMAND_ONLY
1312
1341
  # game_server_protection_policy: "NO_PROTECTION", # accepts NO_PROTECTION, FULL_PROTECTION
1313
1342
  # vpc_subnets: ["VpcSubnet"],
1314
1343
  # tags: [
@@ -1327,7 +1356,7 @@ module Aws::GameLift
1327
1356
  # resp.game_server_group.instance_definitions #=> Array
1328
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"
1329
1358
  # resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
1330
- # 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"
1331
1360
  # resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
1332
1361
  # resp.game_server_group.auto_scaling_group_arn #=> String
1333
1362
  # resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
@@ -1346,8 +1375,8 @@ module Aws::GameLift
1346
1375
  req.send_request(options)
1347
1376
  end
1348
1377
 
1349
- # Creates a multiplayer game session for players. This action creates a
1350
- # 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
1351
1380
  # specified fleet to host the game session. A fleet must have an
1352
1381
  # `ACTIVE` status before a game session can be created in it.
1353
1382
  #
@@ -1678,20 +1707,17 @@ module Aws::GameLift
1678
1707
  # use when placing a new game session for the match; and the maximum
1679
1708
  # time allowed for a matchmaking attempt.
1680
1709
  #
1681
- # There are two ways to track the progress of matchmaking tickets: (1)
1682
- # polling ticket status with DescribeMatchmaking; or (2) receiving
1683
- # notifications with Amazon Simple Notification Service (SNS). To use
1684
- # notifications, you first need to set up an SNS topic to receive the
1685
- # notifications, and provide the topic ARN in the matchmaking
1686
- # configuration. Since notifications promise only "best effort"
1687
- # delivery, we recommend calling `DescribeMatchmaking` if no
1688
- # 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.
1689
1715
  #
1690
1716
  # **Learn more**
1691
1717
  #
1692
1718
  # [ Design a FlexMatch Matchmaker][1]
1693
1719
  #
1694
- # [ Setting up Notifications for Matchmaking][2]
1720
+ # [ Set Up FlexMatch Event Notification][2]
1695
1721
  #
1696
1722
  # **Related operations**
1697
1723
  #
@@ -2213,7 +2239,7 @@ module Aws::GameLift
2213
2239
  # the zip file; if you have S3 object versioning turned on, you can use
2214
2240
  # the `ObjectVersion` parameter to specify an earlier version.
2215
2241
  #
2216
- # @option params [String, IO] :zip_file
2242
+ # @option params [String, StringIO, File] :zip_file
2217
2243
  # A data object containing your Realtime scripts and dependencies as a
2218
2244
  # zip file. The zip file can have one or multiple files. Maximum size of
2219
2245
  # a zip file is 5 MB.
@@ -2459,7 +2485,7 @@ module Aws::GameLift
2459
2485
  req.send_request(options)
2460
2486
  end
2461
2487
 
2462
- # Deletes an alias. This action removes all record of the alias. Game
2488
+ # Deletes an alias. This operation removes all record of the alias. Game
2463
2489
  # clients attempting to access a server process using the deleted alias
2464
2490
  # receive an error. To delete an alias, specify the alias ID to be
2465
2491
  # deleted.
@@ -2497,7 +2523,7 @@ module Aws::GameLift
2497
2523
  req.send_request(options)
2498
2524
  end
2499
2525
 
2500
- # Deletes a build. This action permanently deletes the build resource
2526
+ # Deletes a build. This operation permanently deletes the build resource
2501
2527
  # and any uploaded build files. Deleting a build does not affect the
2502
2528
  # status of any active fleets using the build, but you can no longer
2503
2529
  # create new fleets with the deleted build.
@@ -2555,7 +2581,7 @@ module Aws::GameLift
2555
2581
  # the VPC peering connection--this is done as part of the delete fleet
2556
2582
  # process.
2557
2583
  #
2558
- # This action removes the fleet and its resources. Once a fleet is
2584
+ # This operation removes the fleet and its resources. Once a fleet is
2559
2585
  # deleted, you can no longer use any of the resource in that fleet.
2560
2586
  #
2561
2587
  # **Learn more**
@@ -2601,27 +2627,33 @@ module Aws::GameLift
2601
2627
  req.send_request(options)
2602
2628
  end
2603
2629
 
2604
- # **This action is part of Amazon GameLift FleetIQ with game server
2605
- # groups, which is in preview release and is subject to change.**
2630
+ # **This operation is used with the Amazon GameLift FleetIQ solution and
2631
+ # game server groups.**
2606
2632
  #
2607
2633
  # Terminates a game server group and permanently deletes the game server
2608
2634
  # group record. You have several options for how these resources are
2609
2635
  # impacted when deleting the game server group. Depending on the type of
2610
- # delete action selected, this action may affect three types of
2611
- # resources: the game server group, the corresponding Auto Scaling
2612
- # group, and all game servers currently running in the group.
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
2613
2644
  #
2614
2645
  # To delete a game server group, identify the game server group to
2615
- # delete and specify the type of delete action to initiate. Game server
2616
- # groups can only be deleted if they are in ACTIVE or ERROR status.
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.
2617
2649
  #
2618
- # If the delete request is successful, a series of actions are kicked
2619
- # off. The game server group status is changed to DELETE\_SCHEDULED,
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`,
2620
2652
  # which prevents new game servers from being registered and stops
2621
- # autoscaling activity. Once all game servers in the game server group
2622
- # are de-registered, GameLift FleetIQ can begin deleting resources. If
2623
- # any of the delete actions fail, the game server group is placed in
2624
- # 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.
2625
2657
  #
2626
2658
  # GameLift FleetIQ emits delete events to Amazon CloudWatch.
2627
2659
  #
@@ -2645,26 +2677,29 @@ module Aws::GameLift
2645
2677
  #
2646
2678
  # * SuspendGameServerGroup
2647
2679
  #
2680
+ # * DescribeGameServerInstances
2681
+ #
2648
2682
  #
2649
2683
  #
2650
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
2684
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
2651
2685
  #
2652
2686
  # @option params [required, String] :game_server_group_name
2653
- # The unique identifier of the game server group to delete. Use either
2654
- # the GameServerGroup name or ARN value.
2687
+ # A unique identifier for the game server group. Use either the
2688
+ # GameServerGroup name or ARN value.
2655
2689
  #
2656
2690
  # @option params [String] :delete_option
2657
- # The type of delete to perform. Options include:
2691
+ # The type of delete to perform. Options include the following:
2658
2692
  #
2659
- # * SAFE\_DELETE – Terminates the game server group and EC2 Auto Scaling
2660
- # group only when it has no game servers that are in IN\_USE status.
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.
2661
2696
  #
2662
- # * FORCE\_DELETE – Terminates the game server group, including all
2697
+ # * `FORCE_DELETE` – Terminates the game server group, including all
2663
2698
  # active game servers regardless of their utilization status, and the
2664
2699
  # EC2 Auto Scaling group.
2665
2700
  #
2666
- # * RETAIN – Does a safe delete of the game server group but retains the
2667
- # 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.
2668
2703
  #
2669
2704
  # @return [Types::DeleteGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2670
2705
  #
@@ -2685,7 +2720,7 @@ module Aws::GameLift
2685
2720
  # resp.game_server_group.instance_definitions #=> Array
2686
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"
2687
2722
  # resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
2688
- # 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"
2689
2724
  # resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
2690
2725
  # resp.game_server_group.auto_scaling_group_arn #=> String
2691
2726
  # resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
@@ -2704,9 +2739,9 @@ module Aws::GameLift
2704
2739
  req.send_request(options)
2705
2740
  end
2706
2741
 
2707
- # Deletes a game session queue. This action means that any
2708
- # StartGameSessionPlacement requests that reference this queue will
2709
- # 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.
2710
2745
  #
2711
2746
  # **Learn more**
2712
2747
  #
@@ -2845,8 +2880,8 @@ module Aws::GameLift
2845
2880
  req.send_request(options)
2846
2881
  end
2847
2882
 
2848
- # Deletes a fleet scaling policy. This action means that the policy is
2849
- # no longer in force and removes all record of it. To delete a scaling
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
2850
2885
  # policy, specify both the scaling policy name and the fleet ID it is
2851
2886
  # associated with.
2852
2887
  #
@@ -2899,9 +2934,9 @@ module Aws::GameLift
2899
2934
  req.send_request(options)
2900
2935
  end
2901
2936
 
2902
- # Deletes a Realtime script. This action permanently deletes the script
2903
- # record. If script files were uploaded, they are also deleted (files
2904
- # 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).
2905
2940
  #
2906
2941
  # To delete a script, specify the script ID. Before deleting a script,
2907
2942
  # be sure to terminate all fleets that are deployed with the script
@@ -3052,16 +3087,16 @@ module Aws::GameLift
3052
3087
  req.send_request(options)
3053
3088
  end
3054
3089
 
3055
- # **This action is part of Amazon GameLift FleetIQ with game server
3056
- # groups, which is in preview release and is subject to change.**
3090
+ # **This operation is used with the Amazon GameLift FleetIQ solution and
3091
+ # game server groups.**
3057
3092
  #
3058
- # Removes the game server resource from the game server group. As a
3059
- # result of this action, the de-registered game server can no longer be
3060
- # claimed and will not returned in a list of active game servers.
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.
3061
3096
  #
3062
- # To de-register a game server, specify the game server group and game
3063
- # server ID. If successful, this action emits a CloudWatch event with
3064
- # termination time stamp and reason.
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.
3065
3100
  #
3066
3101
  # **Learn more**
3067
3102
  #
@@ -3083,15 +3118,15 @@ module Aws::GameLift
3083
3118
  #
3084
3119
  #
3085
3120
  #
3086
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
3121
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
3087
3122
  #
3088
3123
  # @option params [required, String] :game_server_group_name
3089
- # An identifier for the game server group where the game server to be
3090
- # de-registered is running. Use either the GameServerGroup name or ARN
3091
- # 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.
3092
3126
  #
3093
3127
  # @option params [required, String] :game_server_id
3094
- # The identifier for the game server to be de-registered.
3128
+ # A custom string that uniquely identifies the game server to
3129
+ # deregister.
3095
3130
  #
3096
3131
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3097
3132
  #
@@ -3305,7 +3340,7 @@ module Aws::GameLift
3305
3340
  # pages. If successful, a FleetAttributes object is returned for each
3306
3341
  # fleet requested, unless the fleet identifier is not found.
3307
3342
  #
3308
- # <note markdown="1"> Some API actions may limit the number of fleet IDs allowed in one
3343
+ # <note markdown="1"> Some API operations may limit the number of fleet IDs allowed in one
3309
3344
  # request. If a request exceeds this limit, the request fails and the
3310
3345
  # error message includes the maximum allowed number.
3311
3346
  #
@@ -3362,16 +3397,18 @@ module Aws::GameLift
3362
3397
  #
3363
3398
  # @option params [String] :next_token
3364
3399
  # Token that indicates the start of the next sequential page of results.
3365
- # Use the token that is returned with a previous call to this action. To
3366
- # start at the beginning of the result set, do not specify a value. This
3367
- # parameter is ignored when the request specifies one or a list of fleet
3368
- # 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.
3369
3404
  #
3370
3405
  # @return [Types::DescribeFleetAttributesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3371
3406
  #
3372
3407
  # * {Types::DescribeFleetAttributesOutput#fleet_attributes #fleet_attributes} => Array&lt;Types::FleetAttributes&gt;
3373
3408
  # * {Types::DescribeFleetAttributesOutput#next_token #next_token} => String
3374
3409
  #
3410
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3411
+ #
3375
3412
  # @example Request syntax with placeholder values
3376
3413
  #
3377
3414
  # resp = client.describe_fleet_attributes({
@@ -3434,7 +3471,7 @@ module Aws::GameLift
3434
3471
  # requested fleet ID. When a list of fleet IDs is provided, attribute
3435
3472
  # objects are returned only for fleets that currently exist.
3436
3473
  #
3437
- # <note markdown="1"> Some API actions may limit the number of fleet IDs allowed in one
3474
+ # <note markdown="1"> Some API operations may limit the number of fleet IDs allowed in one
3438
3475
  # request. If a request exceeds this limit, the request fails and the
3439
3476
  # error message includes the maximum allowed.
3440
3477
  #
@@ -3491,16 +3528,18 @@ module Aws::GameLift
3491
3528
  #
3492
3529
  # @option params [String] :next_token
3493
3530
  # Token that indicates the start of the next sequential page of results.
3494
- # Use the token that is returned with a previous call to this action. To
3495
- # start at the beginning of the result set, do not specify a value. This
3496
- # parameter is ignored when the request specifies one or a list of fleet
3497
- # 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.
3498
3535
  #
3499
3536
  # @return [Types::DescribeFleetCapacityOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3500
3537
  #
3501
3538
  # * {Types::DescribeFleetCapacityOutput#fleet_capacity #fleet_capacity} => Array&lt;Types::FleetCapacity&gt;
3502
3539
  # * {Types::DescribeFleetCapacityOutput#next_token #next_token} => String
3503
3540
  #
3541
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3542
+ #
3504
3543
  # @example Request syntax with placeholder values
3505
3544
  #
3506
3545
  # resp = client.describe_fleet_capacity({
@@ -3596,14 +3635,16 @@ module Aws::GameLift
3596
3635
  #
3597
3636
  # @option params [String] :next_token
3598
3637
  # Token that indicates the start of the next sequential page of results.
3599
- # Use the token that is returned with a previous call to this action. To
3600
- # 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.
3601
3640
  #
3602
3641
  # @return [Types::DescribeFleetEventsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3603
3642
  #
3604
3643
  # * {Types::DescribeFleetEventsOutput#events #events} => Array&lt;Types::Event&gt;
3605
3644
  # * {Types::DescribeFleetEventsOutput#next_token #next_token} => String
3606
3645
  #
3646
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3647
+ #
3607
3648
  # @example Request syntax with placeholder values
3608
3649
  #
3609
3650
  # resp = client.describe_fleet_events({
@@ -3723,7 +3764,7 @@ module Aws::GameLift
3723
3764
  # pages. If successful, a FleetUtilization object is returned for each
3724
3765
  # requested fleet ID, unless the fleet identifier is not found.
3725
3766
  #
3726
- # <note markdown="1"> Some API actions may limit the number of fleet IDs allowed in one
3767
+ # <note markdown="1"> Some API operations may limit the number of fleet IDs allowed in one
3727
3768
  # request. If a request exceeds this limit, the request fails and the
3728
3769
  # error message includes the maximum allowed.
3729
3770
  #
@@ -3783,16 +3824,18 @@ module Aws::GameLift
3783
3824
  #
3784
3825
  # @option params [String] :next_token
3785
3826
  # Token that indicates the start of the next sequential page of results.
3786
- # Use the token that is returned with a previous call to this action. To
3787
- # start at the beginning of the result set, do not specify a value. This
3788
- # parameter is ignored when the request specifies one or a list of fleet
3789
- # 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.
3790
3831
  #
3791
3832
  # @return [Types::DescribeFleetUtilizationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3792
3833
  #
3793
3834
  # * {Types::DescribeFleetUtilizationOutput#fleet_utilization #fleet_utilization} => Array&lt;Types::FleetUtilization&gt;
3794
3835
  # * {Types::DescribeFleetUtilizationOutput#next_token #next_token} => String
3795
3836
  #
3837
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3838
+ #
3796
3839
  # @example Request syntax with placeholder values
3797
3840
  #
3798
3841
  # resp = client.describe_fleet_utilization({
@@ -3820,12 +3863,12 @@ module Aws::GameLift
3820
3863
  req.send_request(options)
3821
3864
  end
3822
3865
 
3823
- # **This action is part of Amazon GameLift FleetIQ with game server
3824
- # groups, which is in preview release and is subject to change.**
3866
+ # **This operation is used with the Amazon GameLift FleetIQ solution and
3867
+ # game server groups.**
3825
3868
  #
3826
- # Retrieves information for a game server resource. Information includes
3827
- # the game server statuses, health check info, and the instance the game
3828
- # 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.
3829
3872
  #
3830
3873
  # To retrieve game server information, specify the game server ID. If
3831
3874
  # successful, the requested game server object is returned.
@@ -3850,14 +3893,15 @@ module Aws::GameLift
3850
3893
  #
3851
3894
  #
3852
3895
  #
3853
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
3896
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
3854
3897
  #
3855
3898
  # @option params [required, String] :game_server_group_name
3856
- # An identifier for the game server group where the game server is
3899
+ # A unique identifier for the game server group where the game server is
3857
3900
  # running. Use either the GameServerGroup name or ARN value.
3858
3901
  #
3859
3902
  # @option params [required, String] :game_server_id
3860
- # The identifier for the game server to be retrieved.
3903
+ # A custom string that uniquely identifies the game server information
3904
+ # to be retrieved.
3861
3905
  #
3862
3906
  # @return [Types::DescribeGameServerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3863
3907
  #
@@ -3878,7 +3922,6 @@ module Aws::GameLift
3878
3922
  # resp.game_server.instance_id #=> String
3879
3923
  # resp.game_server.connection_info #=> String
3880
3924
  # resp.game_server.game_server_data #=> String
3881
- # resp.game_server.custom_sort_key #=> String
3882
3925
  # resp.game_server.claim_status #=> String, one of "CLAIMED"
3883
3926
  # resp.game_server.utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
3884
3927
  # resp.game_server.registration_time #=> Time
@@ -3894,10 +3937,14 @@ module Aws::GameLift
3894
3937
  req.send_request(options)
3895
3938
  end
3896
3939
 
3897
- # **This action is part of Amazon GameLift FleetIQ with game server
3898
- # groups, which is in preview release and is subject to change.**
3940
+ # **This operation is used with the Amazon GameLift FleetIQ solution and
3941
+ # game server groups.**
3899
3942
  #
3900
- # 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.
3901
3948
  #
3902
3949
  # To get attributes for a game server group, provide a group name or ARN
3903
3950
  # value. If successful, a GameServerGroup object is returned.
@@ -3922,13 +3969,15 @@ module Aws::GameLift
3922
3969
  #
3923
3970
  # * SuspendGameServerGroup
3924
3971
  #
3972
+ # * DescribeGameServerInstances
3925
3973
  #
3926
3974
  #
3927
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
3975
+ #
3976
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
3928
3977
  #
3929
3978
  # @option params [required, String] :game_server_group_name
3930
- # The unique identifier for the game server group being requested. Use
3931
- # either the GameServerGroup name or ARN value.
3979
+ # A unique identifier for the game server group. Use either the
3980
+ # GameServerGroup name or ARN value.
3932
3981
  #
3933
3982
  # @return [Types::DescribeGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3934
3983
  #
@@ -3948,7 +3997,7 @@ module Aws::GameLift
3948
3997
  # resp.game_server_group.instance_definitions #=> Array
3949
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"
3950
3999
  # resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
3951
- # 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"
3952
4001
  # resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
3953
4002
  # resp.game_server_group.auto_scaling_group_arn #=> String
3954
4003
  # resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
@@ -3967,8 +4016,109 @@ module Aws::GameLift
3967
4016
  req.send_request(options)
3968
4017
  end
3969
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&lt;Types::GameServerInstance&gt;
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
+
3970
4120
  # Retrieves properties, including the protection policy in force, for
3971
- # one or more game sessions. This action can be used in several ways:
4121
+ # one or more game sessions. This operation can be used in several ways:
3972
4122
  # (1) provide a `GameSessionId` or `GameSessionArn` to request details
3973
4123
  # for a specific game session; (2) provide either a `FleetId` or an
3974
4124
  # `AliasId` to request properties for all game sessions running on a
@@ -4022,14 +4172,16 @@ module Aws::GameLift
4022
4172
  #
4023
4173
  # @option params [String] :next_token
4024
4174
  # Token that indicates the start of the next sequential page of results.
4025
- # Use the token that is returned with a previous call to this action. To
4026
- # 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.
4027
4177
  #
4028
4178
  # @return [Types::DescribeGameSessionDetailsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4029
4179
  #
4030
4180
  # * {Types::DescribeGameSessionDetailsOutput#game_session_details #game_session_details} => Array&lt;Types::GameSessionDetail&gt;
4031
4181
  # * {Types::DescribeGameSessionDetailsOutput#next_token #next_token} => String
4032
4182
  #
4183
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4184
+ #
4033
4185
  # @example Request syntax with placeholder values
4034
4186
  #
4035
4187
  # resp = client.describe_game_session_details({
@@ -4182,19 +4334,22 @@ module Aws::GameLift
4182
4334
  #
4183
4335
  # @option params [Integer] :limit
4184
4336
  # The maximum number of results to return. Use this parameter with
4185
- # `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.
4186
4339
  #
4187
4340
  # @option params [String] :next_token
4188
4341
  # A token that indicates the start of the next sequential page of
4189
4342
  # results. Use the token that is returned with a previous call to this
4190
- # action. To start at the beginning of the result set, do not specify a
4191
- # value.
4343
+ # operation. To start at the beginning of the result set, do not specify
4344
+ # a value.
4192
4345
  #
4193
4346
  # @return [Types::DescribeGameSessionQueuesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4194
4347
  #
4195
4348
  # * {Types::DescribeGameSessionQueuesOutput#game_session_queues #game_session_queues} => Array&lt;Types::GameSessionQueue&gt;
4196
4349
  # * {Types::DescribeGameSessionQueuesOutput#next_token #next_token} => String
4197
4350
  #
4351
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4352
+ #
4198
4353
  # @example Request syntax with placeholder values
4199
4354
  #
4200
4355
  # resp = client.describe_game_session_queues({
@@ -4281,14 +4436,16 @@ module Aws::GameLift
4281
4436
  #
4282
4437
  # @option params [String] :next_token
4283
4438
  # Token that indicates the start of the next sequential page of results.
4284
- # Use the token that is returned with a previous call to this action. To
4285
- # 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.
4286
4441
  #
4287
4442
  # @return [Types::DescribeGameSessionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4288
4443
  #
4289
4444
  # * {Types::DescribeGameSessionsOutput#game_sessions #game_sessions} => Array&lt;Types::GameSession&gt;
4290
4445
  # * {Types::DescribeGameSessionsOutput#next_token #next_token} => String
4291
4446
  #
4447
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4448
+ #
4292
4449
  # @example Request syntax with placeholder values
4293
4450
  #
4294
4451
  # resp = client.describe_game_sessions({
@@ -4335,8 +4492,8 @@ module Aws::GameLift
4335
4492
  end
4336
4493
 
4337
4494
  # Retrieves information about a fleet's instances, including instance
4338
- # IDs. Use this action to get details on all instances in the fleet or
4339
- # 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.
4340
4497
  #
4341
4498
  # To get a specific instance, specify fleet ID and instance ID. To get
4342
4499
  # all instances in a fleet, specify a fleet ID only. Use the pagination
@@ -4374,14 +4531,16 @@ module Aws::GameLift
4374
4531
  #
4375
4532
  # @option params [String] :next_token
4376
4533
  # Token that indicates the start of the next sequential page of results.
4377
- # Use the token that is returned with a previous call to this action. To
4378
- # 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.
4379
4536
  #
4380
4537
  # @return [Types::DescribeInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4381
4538
  #
4382
4539
  # * {Types::DescribeInstancesOutput#instances #instances} => Array&lt;Types::Instance&gt;
4383
4540
  # * {Types::DescribeInstancesOutput#next_token #next_token} => String
4384
4541
  #
4542
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4543
+ #
4385
4544
  # @example Request syntax with placeholder values
4386
4545
  #
4387
4546
  # resp = client.describe_instances({
@@ -4414,19 +4573,24 @@ module Aws::GameLift
4414
4573
  end
4415
4574
 
4416
4575
  # Retrieves one or more matchmaking tickets. Use this operation to
4417
- # retrieve ticket information, including status and--once a successful
4418
- # match is made--acquire connection information for the resulting new
4419
- # game session.
4420
- #
4421
- # You can use this operation to track the progress of matchmaking
4422
- # requests (through polling) as an alternative to using event
4423
- # notifications. See more details on tracking matchmaking requests
4424
- # 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.
4425
4578
  #
4426
4579
  # To request matchmaking tickets, provide a list of up to 10 ticket IDs.
4427
4580
  # If the request is successful, a ticket object is returned for each
4428
4581
  # requested ID that currently exists.
4429
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
+ #
4430
4594
  # **Learn more**
4431
4595
  #
4432
4596
  # [ Add FlexMatch to a Game Client][1]
@@ -4500,15 +4664,18 @@ module Aws::GameLift
4500
4664
  req.send_request(options)
4501
4665
  end
4502
4666
 
4503
- # Retrieves the details of FlexMatch matchmaking configurations. With
4504
- # this operation, you have the following options: (1) retrieve all
4505
- # existing configurations, (2) provide the names of one or more
4506
- # configurations to retrieve, or (3) retrieve all configurations that
4507
- # use a specified rule set name. When requesting multiple items, use the
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
4508
4673
  # pagination parameters to retrieve results as a set of sequential
4509
- # pages. If successful, a configuration is returned for each requested
4510
- # name. When specifying a list of names, only configurations that
4511
- # currently exist are returned.
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.
4512
4679
  #
4513
4680
  # **Learn more**
4514
4681
  #
@@ -4554,14 +4721,16 @@ module Aws::GameLift
4554
4721
  # @option params [String] :next_token
4555
4722
  # A token that indicates the start of the next sequential page of
4556
4723
  # results. Use the token that is returned with a previous call to this
4557
- # action. To start at the beginning of the result set, do not specify a
4558
- # value.
4724
+ # operation. To start at the beginning of the result set, do not specify
4725
+ # a value.
4559
4726
  #
4560
4727
  # @return [Types::DescribeMatchmakingConfigurationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4561
4728
  #
4562
4729
  # * {Types::DescribeMatchmakingConfigurationsOutput#configurations #configurations} => Array&lt;Types::MatchmakingConfiguration&gt;
4563
4730
  # * {Types::DescribeMatchmakingConfigurationsOutput#next_token #next_token} => String
4564
4731
  #
4732
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4733
+ #
4565
4734
  # @example Request syntax with placeholder values
4566
4735
  #
4567
4736
  # resp = client.describe_matchmaking_configurations({
@@ -4651,14 +4820,16 @@ module Aws::GameLift
4651
4820
  # @option params [String] :next_token
4652
4821
  # A token that indicates the start of the next sequential page of
4653
4822
  # results. Use the token that is returned with a previous call to this
4654
- # action. To start at the beginning of the result set, do not specify a
4655
- # value.
4823
+ # operation. To start at the beginning of the result set, do not specify
4824
+ # a value.
4656
4825
  #
4657
4826
  # @return [Types::DescribeMatchmakingRuleSetsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4658
4827
  #
4659
4828
  # * {Types::DescribeMatchmakingRuleSetsOutput#rule_sets #rule_sets} => Array&lt;Types::MatchmakingRuleSet&gt;
4660
4829
  # * {Types::DescribeMatchmakingRuleSetsOutput#next_token #next_token} => String
4661
4830
  #
4831
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4832
+ #
4662
4833
  # @example Request syntax with placeholder values
4663
4834
  #
4664
4835
  # resp = client.describe_matchmaking_rule_sets({
@@ -4685,9 +4856,9 @@ module Aws::GameLift
4685
4856
  req.send_request(options)
4686
4857
  end
4687
4858
 
4688
- # Retrieves properties for one or more player sessions. This action can
4689
- # be used in several ways: (1) provide a `PlayerSessionId` to request
4690
- # 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
4691
4862
  # `GameSessionId` to request properties for all player sessions in the
4692
4863
  # specified game session; (3) provide a `PlayerId` to request properties
4693
4864
  # for all player sessions of a specified player.
@@ -4750,15 +4921,17 @@ module Aws::GameLift
4750
4921
  #
4751
4922
  # @option params [String] :next_token
4752
4923
  # Token that indicates the start of the next sequential page of results.
4753
- # Use the token that is returned with a previous call to this action. To
4754
- # start at the beginning of the result set, do not specify a value. If a
4755
- # 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.
4756
4927
  #
4757
4928
  # @return [Types::DescribePlayerSessionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4758
4929
  #
4759
4930
  # * {Types::DescribePlayerSessionsOutput#player_sessions #player_sessions} => Array&lt;Types::PlayerSession&gt;
4760
4931
  # * {Types::DescribePlayerSessionsOutput#next_token #next_token} => String
4761
4932
  #
4933
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4934
+ #
4762
4935
  # @example Request syntax with placeholder values
4763
4936
  #
4764
4937
  # resp = client.describe_player_sessions({
@@ -4885,7 +5058,7 @@ module Aws::GameLift
4885
5058
  # is returned for the fleet.
4886
5059
  #
4887
5060
  # A fleet may have all of its scaling policies suspended
4888
- # (StopFleetActions). This action does not affect the status of the
5061
+ # (StopFleetActions). This operation does not affect the status of the
4889
5062
  # scaling policies, which remains ACTIVE. To see whether a fleet's
4890
5063
  # scaling policies are in force or suspended, call
4891
5064
  # DescribeFleetAttributes and check the stopped actions.
@@ -4941,14 +5114,16 @@ module Aws::GameLift
4941
5114
  #
4942
5115
  # @option params [String] :next_token
4943
5116
  # Token that indicates the start of the next sequential page of results.
4944
- # Use the token that is returned with a previous call to this action. To
4945
- # 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.
4946
5119
  #
4947
5120
  # @return [Types::DescribeScalingPoliciesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4948
5121
  #
4949
5122
  # * {Types::DescribeScalingPoliciesOutput#scaling_policies #scaling_policies} => Array&lt;Types::ScalingPolicy&gt;
4950
5123
  # * {Types::DescribeScalingPoliciesOutput#next_token #next_token} => String
4951
5124
  #
5125
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5126
+ #
4952
5127
  # @example Request syntax with placeholder values
4953
5128
  #
4954
5129
  # resp = client.describe_scaling_policies({
@@ -5213,7 +5388,7 @@ module Aws::GameLift
5213
5388
  # an SSH client. The private key must be saved in the proper format to a
5214
5389
  # `.pem` file before using. If you're making this request using the AWS
5215
5390
  # CLI, saving the secret can be handled as part of the GetInstanceAccess
5216
- # request, as shown in one of the examples for this action.
5391
+ # request, as shown in one of the examples for this operation.
5217
5392
  #
5218
5393
  # To request access to a specific instance, specify the IDs of both the
5219
5394
  # instance and the fleet it belongs to. You can retrieve a fleet's
@@ -5324,14 +5499,16 @@ module Aws::GameLift
5324
5499
  # @option params [String] :next_token
5325
5500
  # A token that indicates the start of the next sequential page of
5326
5501
  # results. Use the token that is returned with a previous call to this
5327
- # action. To start at the beginning of the result set, do not specify a
5328
- # value.
5502
+ # operation. To start at the beginning of the result set, do not specify
5503
+ # a value.
5329
5504
  #
5330
5505
  # @return [Types::ListAliasesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5331
5506
  #
5332
5507
  # * {Types::ListAliasesOutput#aliases #aliases} => Array&lt;Types::Alias&gt;
5333
5508
  # * {Types::ListAliasesOutput#next_token #next_token} => String
5334
5509
  #
5510
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5511
+ #
5335
5512
  # @example Request syntax with placeholder values
5336
5513
  #
5337
5514
  # resp = client.list_aliases({
@@ -5416,14 +5593,16 @@ module Aws::GameLift
5416
5593
  #
5417
5594
  # @option params [String] :next_token
5418
5595
  # Token that indicates the start of the next sequential page of results.
5419
- # Use the token that is returned with a previous call to this action. To
5420
- # 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.
5421
5598
  #
5422
5599
  # @return [Types::ListBuildsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5423
5600
  #
5424
5601
  # * {Types::ListBuildsOutput#builds #builds} => Array&lt;Types::Build&gt;
5425
5602
  # * {Types::ListBuildsOutput#next_token #next_token} => String
5426
5603
  #
5604
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5605
+ #
5427
5606
  # @example Request syntax with placeholder values
5428
5607
  #
5429
5608
  # resp = client.list_builds({
@@ -5503,14 +5682,16 @@ module Aws::GameLift
5503
5682
  #
5504
5683
  # @option params [String] :next_token
5505
5684
  # Token that indicates the start of the next sequential page of results.
5506
- # Use the token that is returned with a previous call to this action. To
5507
- # 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.
5508
5687
  #
5509
5688
  # @return [Types::ListFleetsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5510
5689
  #
5511
5690
  # * {Types::ListFleetsOutput#fleet_ids #fleet_ids} => Array&lt;String&gt;
5512
5691
  # * {Types::ListFleetsOutput#next_token #next_token} => String
5513
5692
  #
5693
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5694
+ #
5514
5695
  # @example Request syntax with placeholder values
5515
5696
  #
5516
5697
  # resp = client.list_fleets({
@@ -5535,12 +5716,12 @@ module Aws::GameLift
5535
5716
  req.send_request(options)
5536
5717
  end
5537
5718
 
5538
- # **This action is part of Amazon GameLift FleetIQ with game server
5539
- # groups, which is in preview release and is subject to change.**
5719
+ # **This operation is used with the Amazon GameLift FleetIQ solution and
5720
+ # game server groups.**
5540
5721
  #
5541
5722
  # Retrieves information on all game servers groups that exist in the
5542
- # current AWS account for the selected region. Use the pagination
5543
- # parameters to retrieve results in a set of sequential pages.
5723
+ # current AWS account for the selected Region. Use the pagination
5724
+ # parameters to retrieve results in a set of sequential segments.
5544
5725
  #
5545
5726
  # **Learn more**
5546
5727
  #
@@ -5562,25 +5743,29 @@ module Aws::GameLift
5562
5743
  #
5563
5744
  # * SuspendGameServerGroup
5564
5745
  #
5746
+ # * DescribeGameServerInstances
5565
5747
  #
5566
5748
  #
5567
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
5749
+ #
5750
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
5568
5751
  #
5569
5752
  # @option params [Integer] :limit
5570
5753
  # The maximum number of results to return. Use this parameter with
5571
- # `NextToken` to get results as a set of sequential pages.
5754
+ # `NextToken` to get results as a set of sequential segments.
5572
5755
  #
5573
5756
  # @option params [String] :next_token
5574
- # A token that indicates the start of the next sequential page of
5575
- # results. Use the token that is returned with a previous call to this
5576
- # action. To start at the beginning of the result set, do not specify a
5577
- # 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.
5578
5761
  #
5579
5762
  # @return [Types::ListGameServerGroupsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5580
5763
  #
5581
5764
  # * {Types::ListGameServerGroupsOutput#game_server_groups #game_server_groups} => Array&lt;Types::GameServerGroup&gt;
5582
5765
  # * {Types::ListGameServerGroupsOutput#next_token #next_token} => String
5583
5766
  #
5767
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5768
+ #
5584
5769
  # @example Request syntax with placeholder values
5585
5770
  #
5586
5771
  # resp = client.list_game_server_groups({
@@ -5597,7 +5782,7 @@ module Aws::GameLift
5597
5782
  # resp.game_server_groups[0].instance_definitions #=> Array
5598
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"
5599
5784
  # resp.game_server_groups[0].instance_definitions[0].weighted_capacity #=> String
5600
- # 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"
5601
5786
  # resp.game_server_groups[0].game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
5602
5787
  # resp.game_server_groups[0].auto_scaling_group_arn #=> String
5603
5788
  # resp.game_server_groups[0].status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
@@ -5617,14 +5802,13 @@ module Aws::GameLift
5617
5802
  req.send_request(options)
5618
5803
  end
5619
5804
 
5620
- # **This action is part of Amazon GameLift FleetIQ with game server
5621
- # groups, which is in preview release and is subject to change.**
5805
+ # **This operation is used with the Amazon GameLift FleetIQ solution and
5806
+ # game server groups.**
5622
5807
  #
5623
- # Retrieves information on all game servers that are currently running
5624
- # in a specified game server group. If there are custom key sort values
5625
- # for your game servers, you can opt to have the returned list sorted
5626
- # based on these values. Use the pagination parameters to retrieve
5627
- # 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.
5628
5812
  #
5629
5813
  # **Learn more**
5630
5814
  #
@@ -5646,32 +5830,36 @@ module Aws::GameLift
5646
5830
  #
5647
5831
  #
5648
5832
  #
5649
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
5833
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
5650
5834
  #
5651
5835
  # @option params [required, String] :game_server_group_name
5652
- # An identifier for the game server group for the game server you want
5653
- # to list. Use either the GameServerGroup name or ARN value.
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.
5654
5838
  #
5655
5839
  # @option params [String] :sort_order
5656
- # Indicates how to sort the returned data based on the game servers'
5657
- # custom key sort value. If this parameter is left empty, the list of
5658
- # game servers is returned in no particular order.
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.
5659
5845
  #
5660
5846
  # @option params [Integer] :limit
5661
5847
  # The maximum number of results to return. Use this parameter with
5662
- # `NextToken` to get results as a set of sequential pages.
5848
+ # `NextToken` to get results as a set of sequential segments.
5663
5849
  #
5664
5850
  # @option params [String] :next_token
5665
- # A token that indicates the start of the next sequential page of
5666
- # results. Use the token that is returned with a previous call to this
5667
- # action. To start at the beginning of the result set, do not specify a
5668
- # 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.
5669
5855
  #
5670
5856
  # @return [Types::ListGameServersOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5671
5857
  #
5672
5858
  # * {Types::ListGameServersOutput#game_servers #game_servers} => Array&lt;Types::GameServer&gt;
5673
5859
  # * {Types::ListGameServersOutput#next_token #next_token} => String
5674
5860
  #
5861
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5862
+ #
5675
5863
  # @example Request syntax with placeholder values
5676
5864
  #
5677
5865
  # resp = client.list_game_servers({
@@ -5690,7 +5878,6 @@ module Aws::GameLift
5690
5878
  # resp.game_servers[0].instance_id #=> String
5691
5879
  # resp.game_servers[0].connection_info #=> String
5692
5880
  # resp.game_servers[0].game_server_data #=> String
5693
- # resp.game_servers[0].custom_sort_key #=> String
5694
5881
  # resp.game_servers[0].claim_status #=> String, one of "CLAIMED"
5695
5882
  # resp.game_servers[0].utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
5696
5883
  # resp.game_servers[0].registration_time #=> Time
@@ -5737,14 +5924,16 @@ module Aws::GameLift
5737
5924
  # @option params [String] :next_token
5738
5925
  # A token that indicates the start of the next sequential page of
5739
5926
  # results. Use the token that is returned with a previous call to this
5740
- # action. To start at the beginning of the result set, do not specify a
5741
- # value.
5927
+ # operation. To start at the beginning of the result set, do not specify
5928
+ # a value.
5742
5929
  #
5743
5930
  # @return [Types::ListScriptsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5744
5931
  #
5745
5932
  # * {Types::ListScriptsOutput#scripts #scripts} => Array&lt;Types::Script&gt;
5746
5933
  # * {Types::ListScriptsOutput#next_token #next_token} => String
5747
5934
  #
5935
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5936
+ #
5748
5937
  # @example Request syntax with placeholder values
5749
5938
  #
5750
5939
  # resp = client.list_scripts({
@@ -5778,7 +5967,7 @@ module Aws::GameLift
5778
5967
 
5779
5968
  # Retrieves all tags that are assigned to a GameLift resource. Resource
5780
5969
  # tags are used to organize AWS resources for a range of purposes. This
5781
- # action handles the permissions necessary to manage tags for the
5970
+ # operation handles the permissions necessary to manage tags for the
5782
5971
  # following GameLift resource types:
5783
5972
  #
5784
5973
  # * Build
@@ -5821,8 +6010,8 @@ module Aws::GameLift
5821
6010
  # The Amazon Resource Name ([ARN][1]) that is assigned to and uniquely
5822
6011
  # identifies the GameLift resource that you want to retrieve tags for.
5823
6012
  # GameLift resource ARNs are included in the data object for the
5824
- # resource, which can be retrieved by calling a List or Describe action
5825
- # for the resource type.
6013
+ # resource, which can be retrieved by calling a List or Describe
6014
+ # operation for the resource type.
5826
6015
  #
5827
6016
  #
5828
6017
  #
@@ -6090,26 +6279,26 @@ module Aws::GameLift
6090
6279
  req.send_request(options)
6091
6280
  end
6092
6281
 
6093
- # **This action is part of Amazon GameLift FleetIQ with game server
6094
- # groups, which is in preview release and is subject to change.**
6282
+ # **This operation is used with the Amazon GameLift FleetIQ solution and
6283
+ # game server groups.**
6095
6284
  #
6096
6285
  # Creates a new game server resource and notifies GameLift FleetIQ that
6097
- # the game server is ready to host gameplay and players. This action is
6098
- # 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
6099
6288
  # game server group. Registering game servers enables GameLift FleetIQ
6100
6289
  # to track available game servers and enables game clients and services
6101
6290
  # to claim a game server for a new game session.
6102
6291
  #
6103
6292
  # To register a game server, identify the game server group and instance
6104
6293
  # where the game server is running, and provide a unique identifier for
6105
- # the game server. You can also include connection and game server data;
6106
- # when a game client or service requests a game server by calling
6107
- # 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.
6108
6297
  #
6109
6298
  # Once a game server is successfully registered, it is put in status
6110
- # AVAILABLE. A request to register a game server may fail if the
6111
- # instance it is in the process of shutting down as part of instance
6112
- # rebalancing or scale-down activity.
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.
6113
6302
  #
6114
6303
  # **Learn more**
6115
6304
  #
@@ -6131,51 +6320,33 @@ module Aws::GameLift
6131
6320
  #
6132
6321
  #
6133
6322
  #
6134
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
6323
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
6135
6324
  #
6136
6325
  # @option params [required, String] :game_server_group_name
6137
- # An identifier for the game server group where the game server is
6138
- # running. You can use either the GameServerGroup name or ARN value.
6326
+ # A unique identifier for the game server group where the game server is
6327
+ # running. Use either the GameServerGroup name or ARN value.
6139
6328
  #
6140
6329
  # @option params [required, String] :game_server_id
6141
- # A custom string that uniquely identifies the new game server. Game
6142
- # server IDs are developer-defined and must be unique across all game
6143
- # 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.
6144
6333
  #
6145
6334
  # @option params [required, String] :instance_id
6146
6335
  # The unique identifier for the instance where the game server is
6147
- # 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`.
6148
6338
  #
6149
6339
  # @option params [String] :connection_info
6150
- # Information needed to make inbound client connections to the game
6151
- # server. This might include IP address and port, DNS name, etc.
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.
6152
6343
  #
6153
6344
  # @option params [String] :game_server_data
6154
6345
  # A set of custom game server properties, formatted as a single string
6155
6346
  # value. This data is passed to a game client or service when it
6156
- # requests information on a game servers using ListGameServers or
6347
+ # requests information on game servers using ListGameServers or
6157
6348
  # ClaimGameServer.
6158
6349
  #
6159
- # @option params [String] :custom_sort_key
6160
- # A game server tag that can be used to request sorted lists of game
6161
- # servers using ListGameServers. Custom sort keys are developer-defined
6162
- # based on how you want to organize the retrieved game server
6163
- # information.
6164
- #
6165
- # @option params [Array<Types::Tag>] :tags
6166
- # A list of labels to assign to the new game server resource. Tags are
6167
- # developer-defined key-value pairs. Tagging AWS resources are useful
6168
- # for resource management, access management, and cost allocation. For
6169
- # more information, see [ Tagging AWS Resources][1] in the *AWS General
6170
- # Reference*. Once the resource is created, you can use TagResource,
6171
- # UntagResource, and ListTagsForResource to add, remove, and view tags.
6172
- # The maximum tag limit may be lower than stated. See the AWS General
6173
- # Reference for actual tagging limits.
6174
- #
6175
- #
6176
- #
6177
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
6178
- #
6179
6350
  # @return [Types::RegisterGameServerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6180
6351
  #
6181
6352
  # * {Types::RegisterGameServerOutput#game_server #game_server} => Types::GameServer
@@ -6188,13 +6359,6 @@ module Aws::GameLift
6188
6359
  # instance_id: "GameServerInstanceId", # required
6189
6360
  # connection_info: "GameServerConnectionInfo",
6190
6361
  # game_server_data: "GameServerData",
6191
- # custom_sort_key: "GameServerSortKey",
6192
- # tags: [
6193
- # {
6194
- # key: "TagKey", # required
6195
- # value: "TagValue", # required
6196
- # },
6197
- # ],
6198
6362
  # })
6199
6363
  #
6200
6364
  # @example Response structure
@@ -6205,7 +6369,6 @@ module Aws::GameLift
6205
6369
  # resp.game_server.instance_id #=> String
6206
6370
  # resp.game_server.connection_info #=> String
6207
6371
  # resp.game_server.game_server_data #=> String
6208
- # resp.game_server.custom_sort_key #=> String
6209
6372
  # resp.game_server.claim_status #=> String, one of "CLAIMED"
6210
6373
  # resp.game_server.utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
6211
6374
  # resp.game_server.registration_time #=> Time
@@ -6327,19 +6490,21 @@ module Aws::GameLift
6327
6490
  req.send_request(options)
6328
6491
  end
6329
6492
 
6330
- # **This action is part of Amazon GameLift FleetIQ with game server
6331
- # groups, which is in preview release and is subject to change.**
6493
+ # **This operation is used with the Amazon GameLift FleetIQ solution and
6494
+ # game server groups.**
6332
6495
  #
6333
6496
  # Reinstates activity on a game server group after it has been
6334
- # suspended. A game server group may be suspended by calling
6335
- # SuspendGameServerGroup, or it may have been involuntarily suspended
6336
- # due to a configuration problem. You can manually resume activity on
6337
- # the group once the configuration problem has been resolved. Refer to
6338
- # the game server group status and status reason for more information on
6339
- # 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.
6340
6503
  #
6341
6504
  # To resume activity, specify a game server group ARN and the type of
6342
- # 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`.
6343
6508
  #
6344
6509
  # **Learn more**
6345
6510
  #
@@ -6361,16 +6526,18 @@ module Aws::GameLift
6361
6526
  #
6362
6527
  # * SuspendGameServerGroup
6363
6528
  #
6529
+ # * DescribeGameServerInstances
6530
+ #
6364
6531
  #
6365
6532
  #
6366
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
6533
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
6367
6534
  #
6368
6535
  # @option params [required, String] :game_server_group_name
6369
- # The unique identifier of the game server group to resume activity on.
6370
- # Use either the GameServerGroup name or ARN value.
6536
+ # A unique identifier for the game server group. Use either the
6537
+ # GameServerGroup name or ARN value.
6371
6538
  #
6372
6539
  # @option params [required, Array<String>] :resume_actions
6373
- # The action to resume for this game server group.
6540
+ # The activity to resume for this game server group.
6374
6541
  #
6375
6542
  # @return [Types::ResumeGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6376
6543
  #
@@ -6391,7 +6558,7 @@ module Aws::GameLift
6391
6558
  # resp.game_server_group.instance_definitions #=> Array
6392
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"
6393
6560
  # resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
6394
- # 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"
6395
6562
  # resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
6396
6563
  # resp.game_server_group.auto_scaling_group_arn #=> String
6397
6564
  # resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
@@ -6570,14 +6737,16 @@ module Aws::GameLift
6570
6737
  #
6571
6738
  # @option params [String] :next_token
6572
6739
  # Token that indicates the start of the next sequential page of results.
6573
- # Use the token that is returned with a previous call to this action. To
6574
- # 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.
6575
6742
  #
6576
6743
  # @return [Types::SearchGameSessionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6577
6744
  #
6578
6745
  # * {Types::SearchGameSessionsOutput#game_sessions #game_sessions} => Array&lt;Types::GameSession&gt;
6579
6746
  # * {Types::SearchGameSessionsOutput#next_token #next_token} => String
6580
6747
  #
6748
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
6749
+ #
6581
6750
  # @example Request syntax with placeholder values
6582
6751
  #
6583
6752
  # resp = client.search_game_sessions({
@@ -7026,26 +7195,13 @@ module Aws::GameLift
7026
7195
  # matchmaking configuration, and include the players to be matched. You
7027
7196
  # must also include a set of player attributes relevant for the
7028
7197
  # matchmaking configuration. If successful, a matchmaking ticket is
7029
- # returned with status set to `QUEUED`. Track the status of the ticket
7030
- # to respond as needed and acquire game session connection information
7031
- # for successfully completed matches.
7032
- #
7033
- # **Tracking ticket status** -- A couple of options are available for
7034
- # tracking the status of matchmaking requests:
7035
- #
7036
- # * Polling -- Call `DescribeMatchmaking`. This operation returns the
7037
- # full ticket object, including current status and (for completed
7038
- # tickets) game session connection info. We recommend polling no more
7039
- # than once every 10 seconds.
7040
- #
7041
- # * Notifications -- Get event notifications for changes in ticket
7042
- # status using Amazon Simple Notification Service (SNS). Notifications
7043
- # are easy to set up (see CreateMatchmakingConfiguration) and
7044
- # typically deliver match status changes faster and more efficiently
7045
- # than polling. We recommend that you use polling to back up to
7046
- # notifications (since delivery is not guaranteed) and call
7047
- # `DescribeMatchmaking` only when notifications are not received
7048
- # 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.
7049
7205
  #
7050
7206
  # **Processing a matchmaking request** -- FlexMatch handles a
7051
7207
  # matchmaking request as follows:
@@ -7326,7 +7482,7 @@ module Aws::GameLift
7326
7482
  # The ticket ID is included in the `MatchmakerData` of an updated game
7327
7483
  # session object, which is provided to the game server.
7328
7484
  #
7329
- # <note markdown="1"> If the action is successful, the service sends back an empty JSON
7485
+ # <note markdown="1"> If the operation is successful, the service sends back an empty JSON
7330
7486
  # struct with the HTTP 200 response (not an empty HTTP body).
7331
7487
  #
7332
7488
  # </note>
@@ -7371,27 +7527,28 @@ module Aws::GameLift
7371
7527
  req.send_request(options)
7372
7528
  end
7373
7529
 
7374
- # **This action is part of Amazon GameLift FleetIQ with game server
7375
- # groups, which is in preview release and is subject to change.**
7530
+ # **This operation is used with the Amazon GameLift FleetIQ solution and
7531
+ # game server groups.**
7376
7532
  #
7377
7533
  # Temporarily stops activity on a game server group without terminating
7378
- # instances or the game server group. Activity can be restarted by
7379
- # calling ResumeGameServerGroup. Activities that can suspended are:
7380
- #
7381
- # * Instance type replacement. This activity evaluates the current Spot
7382
- # viability of all instance types that are defined for the game server
7383
- # group. It updates the Auto Scaling group to remove nonviable Spot
7384
- # instance types (which have a higher chance of game server
7385
- # interruptions) and rebalances capacity across the remaining viable
7386
- # Spot instance types. When this activity is suspended, the Auto
7387
- # Scaling group continues with its current balance, regardless of
7388
- # viability. Instance protection, utilization metrics, and capacity
7389
- # autoscaling activities continue to be active.
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.
7390
7546
  #
7391
7547
  # ^
7392
7548
  #
7393
7549
  # To suspend activity, specify a game server group ARN and the type of
7394
- # 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`.
7395
7552
  #
7396
7553
  # **Learn more**
7397
7554
  #
@@ -7413,16 +7570,18 @@ module Aws::GameLift
7413
7570
  #
7414
7571
  # * SuspendGameServerGroup
7415
7572
  #
7573
+ # * DescribeGameServerInstances
7416
7574
  #
7417
7575
  #
7418
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
7576
+ #
7577
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
7419
7578
  #
7420
7579
  # @option params [required, String] :game_server_group_name
7421
- # The unique identifier of the game server group to stop activity on.
7422
- # Use either the GameServerGroup name or ARN value.
7580
+ # A unique identifier for the game server group. Use either the
7581
+ # GameServerGroup name or ARN value.
7423
7582
  #
7424
7583
  # @option params [required, Array<String>] :suspend_actions
7425
- # The action to suspend for this game server group.
7584
+ # The activity to suspend for this game server group.
7426
7585
  #
7427
7586
  # @return [Types::SuspendGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7428
7587
  #
@@ -7443,7 +7602,7 @@ module Aws::GameLift
7443
7602
  # resp.game_server_group.instance_definitions #=> Array
7444
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"
7445
7604
  # resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
7446
- # 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"
7447
7606
  # resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
7448
7607
  # resp.game_server_group.auto_scaling_group_arn #=> String
7449
7608
  # resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
@@ -7465,9 +7624,9 @@ module Aws::GameLift
7465
7624
  # Assigns a tag to a GameLift resource. AWS resource tags provide an
7466
7625
  # additional management tool set. You can use tags to organize
7467
7626
  # resources, create IAM permissions policies to manage access to groups
7468
- # of resources, customize AWS cost breakdowns, etc. This action handles
7469
- # the permissions necessary to manage tags for the following GameLift
7470
- # 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:
7471
7630
  #
7472
7631
  # * Build
7473
7632
  #
@@ -7511,8 +7670,8 @@ module Aws::GameLift
7511
7670
  # The Amazon Resource Name ([ARN][1]) that is assigned to and uniquely
7512
7671
  # identifies the GameLift resource that you want to assign tags to.
7513
7672
  # GameLift resource ARNs are included in the data object for the
7514
- # resource, which can be retrieved by calling a List or Describe action
7515
- # for the resource type.
7673
+ # resource, which can be retrieved by calling a List or Describe
7674
+ # operation for the resource type.
7516
7675
  #
7517
7676
  #
7518
7677
  #
@@ -7553,7 +7712,7 @@ module Aws::GameLift
7553
7712
 
7554
7713
  # Removes a tag that is assigned to a GameLift resource. Resource tags
7555
7714
  # are used to organize AWS resources for a range of purposes. This
7556
- # action handles the permissions necessary to manage tags for the
7715
+ # operation handles the permissions necessary to manage tags for the
7557
7716
  # following GameLift resource types:
7558
7717
  #
7559
7718
  # * Build
@@ -7572,8 +7731,8 @@ module Aws::GameLift
7572
7731
  #
7573
7732
  # To remove a tag from a resource, specify the unique ARN value for the
7574
7733
  # resource and provide a string list containing one or more tags to be
7575
- # removed. This action succeeds even if the list includes tags that are
7576
- # 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.
7577
7736
  #
7578
7737
  # **Learn more**
7579
7738
  #
@@ -7598,8 +7757,8 @@ module Aws::GameLift
7598
7757
  # The Amazon Resource Name ([ARN][1]) that is assigned to and uniquely
7599
7758
  # identifies the GameLift resource that you want to remove tags from.
7600
7759
  # GameLift resource ARNs are included in the data object for the
7601
- # resource, which can be retrieved by calling a List or Describe action
7602
- # for the resource type.
7760
+ # resource, which can be retrieved by calling a List or Describe
7761
+ # operation for the resource type.
7603
7762
  #
7604
7763
  #
7605
7764
  #
@@ -7866,9 +8025,9 @@ module Aws::GameLift
7866
8025
  req.send_request(options)
7867
8026
  end
7868
8027
 
7869
- # Updates capacity settings for a fleet. Use this action to specify the
7870
- # number of EC2 instances (hosts) that you want this fleet to contain.
7871
- # Before calling this action, you may want to call
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
7872
8031
  # DescribeEC2InstanceLimits to get the maximum capacity based on the
7873
8032
  # fleet's EC2 instance type.
7874
8033
  #
@@ -8044,18 +8203,17 @@ module Aws::GameLift
8044
8203
  req.send_request(options)
8045
8204
  end
8046
8205
 
8047
- # **This action is part of Amazon GameLift FleetIQ with game server
8048
- # groups, which is in preview release and is subject to change.**
8049
- #
8050
- # Updates information about a registered game server. This action is
8051
- # called by a game server process that is running on an instance in a
8052
- # game server group. There are three reasons to update game server
8053
- # information: (1) to change the utilization status of the game server,
8054
- # (2) to report game server health status, and (3) to change game server
8055
- # metadata. A registered game server should regularly report health and
8056
- # should update utilization status when it is supporting gameplay so
8057
- # that GameLift FleetIQ can accurately track game server availability.
8058
- # 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:
8059
8217
  #
8060
8218
  # * To update the game server's utilization status, identify the game
8061
8219
  # server and game server group and specify the current utilization
@@ -8063,14 +8221,14 @@ module Aws::GameLift
8063
8221
  # hosting games and when they are available to be claimed.
8064
8222
  #
8065
8223
  # * To report health status, identify the game server and game server
8066
- # group and set health check to HEALTHY. If a game server does not
8224
+ # group and set health check to `HEALTHY`. If a game server does not
8067
8225
  # report health status for a certain length of time, the game server
8068
- # is no longer considered healthy and will be eventually de-registered
8069
- # from the game server group to avoid affecting utilization metrics.
8070
- # The best practice is to report health every 60 seconds.
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.
8071
8230
  #
8072
- # * To change game server metadata, provide updated game server data and
8073
- # custom sort key values.
8231
+ # * To change game server metadata, provide updated game server data.
8074
8232
  #
8075
8233
  # Once a game server is successfully updated, the relevant statuses and
8076
8234
  # timestamps are updated.
@@ -8095,35 +8253,29 @@ module Aws::GameLift
8095
8253
  #
8096
8254
  #
8097
8255
  #
8098
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
8256
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
8099
8257
  #
8100
8258
  # @option params [required, String] :game_server_group_name
8101
- # An identifier for the game server group where the game server is
8259
+ # A unique identifier for the game server group where the game server is
8102
8260
  # running. Use either the GameServerGroup name or ARN value.
8103
8261
  #
8104
8262
  # @option params [required, String] :game_server_id
8105
- # The identifier for the game server to be updated.
8263
+ # A custom string that uniquely identifies the game server to update.
8106
8264
  #
8107
8265
  # @option params [String] :game_server_data
8108
8266
  # A set of custom game server properties, formatted as a single string
8109
8267
  # value. This data is passed to a game client or service when it
8110
- # requests information on a game servers using DescribeGameServer or
8268
+ # requests information on game servers using ListGameServers or
8111
8269
  # ClaimGameServer.
8112
8270
  #
8113
- # @option params [String] :custom_sort_key
8114
- # A game server tag that can be used to request sorted lists of game
8115
- # servers using ListGameServers. Custom sort keys are developer-defined
8116
- # based on how you want to organize the retrieved game server
8117
- # information.
8118
- #
8119
8271
  # @option params [String] :utilization_status
8120
8272
  # Indicates whether the game server is available or is currently hosting
8121
8273
  # gameplay.
8122
8274
  #
8123
8275
  # @option params [String] :health_check
8124
- # Indicates health status of the game server. An update that explicitly
8125
- # includes this parameter updates the game server's
8126
- # *LastHealthCheckTime* time stamp.
8276
+ # Indicates health status of the game server. A request that includes
8277
+ # this parameter updates the game server's *LastHealthCheckTime*
8278
+ # timestamp.
8127
8279
  #
8128
8280
  # @return [Types::UpdateGameServerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
8129
8281
  #
@@ -8135,7 +8287,6 @@ module Aws::GameLift
8135
8287
  # game_server_group_name: "GameServerGroupNameOrArn", # required
8136
8288
  # game_server_id: "GameServerId", # required
8137
8289
  # game_server_data: "GameServerData",
8138
- # custom_sort_key: "GameServerSortKey",
8139
8290
  # utilization_status: "AVAILABLE", # accepts AVAILABLE, UTILIZED
8140
8291
  # health_check: "HEALTHY", # accepts HEALTHY
8141
8292
  # })
@@ -8148,7 +8299,6 @@ module Aws::GameLift
8148
8299
  # resp.game_server.instance_id #=> String
8149
8300
  # resp.game_server.connection_info #=> String
8150
8301
  # resp.game_server.game_server_data #=> String
8151
- # resp.game_server.custom_sort_key #=> String
8152
8302
  # resp.game_server.claim_status #=> String, one of "CLAIMED"
8153
8303
  # resp.game_server.utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
8154
8304
  # resp.game_server.registration_time #=> Time
@@ -8164,29 +8314,24 @@ module Aws::GameLift
8164
8314
  req.send_request(options)
8165
8315
  end
8166
8316
 
8167
- # **This action is part of Amazon GameLift FleetIQ with game server
8168
- # groups, which is in preview release and is subject to change.**
8317
+ # **This operation is used with the Amazon GameLift FleetIQ solution and
8318
+ # game server groups.**
8169
8319
  #
8170
8320
  # Updates GameLift FleetIQ-specific properties for a game server group.
8171
- # These properties include instance rebalancing and game server
8172
- # protection. Many Auto Scaling group properties are updated directly.
8173
- # These include autoscaling policies, minimum/maximum/desired instance
8174
- # 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.
8175
8324
  #
8176
8325
  # To update the game server group, specify the game server group ID and
8177
- # provide the updated values.
8178
- #
8179
- # Updated properties are validated to ensure that GameLift FleetIQ can
8180
- # continue to perform its core instance rebalancing activity. When you
8181
- # change Auto Scaling group properties directly and the changes cause
8182
- # 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.
8183
8330
  #
8184
8331
  # **Learn more**
8185
8332
  #
8186
8333
  # [GameLift FleetIQ Guide][1]
8187
8334
  #
8188
- # [Updating a GameLift FleetIQ-Linked Auto Scaling Group][2]
8189
- #
8190
8335
  # **Related operations**
8191
8336
  #
8192
8337
  # * CreateGameServerGroup
@@ -8203,64 +8348,75 @@ module Aws::GameLift
8203
8348
  #
8204
8349
  # * SuspendGameServerGroup
8205
8350
  #
8351
+ # * DescribeGameServerInstances
8206
8352
  #
8207
8353
  #
8208
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
8209
- # [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-asgroups.html
8354
+ #
8355
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
8210
8356
  #
8211
8357
  # @option params [required, String] :game_server_group_name
8212
- # The unique identifier of the game server group to update. Use either
8213
- # the GameServerGroup name or ARN value.
8358
+ # A unique identifier for the game server group. Use either the
8359
+ # GameServerGroup name or ARN value.
8214
8360
  #
8215
8361
  # @option params [String] :role_arn
8216
8362
  # The Amazon Resource Name ([ARN][1]) for an IAM role that allows Amazon
8217
- # GameLift to access your EC2 Auto Scaling groups. The submitted role is
8218
- # validated to ensure that it contains the necessary permissions for
8219
- # game server groups.
8363
+ # GameLift to access your EC2 Auto Scaling groups.
8220
8364
  #
8221
8365
  #
8222
8366
  #
8223
8367
  # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
8224
8368
  #
8225
8369
  # @option params [Array<Types::InstanceDefinition>] :instance_definitions
8226
- # An updated list of EC2 instance types to use when creating instances
8227
- # in the group. The instance definition must specify instance types that
8228
- # are supported by GameLift FleetIQ, and must include at least two
8229
- # instance types. This updated list replaces the entire current list of
8230
- # instance definitions for the game server group. For more information
8231
- # on instance types, see [EC2 Instance Types][1] in the *Amazon EC2 User
8232
- # Guide*..
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.
8233
8381
  #
8234
8382
  #
8235
8383
  #
8236
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
8237
8386
  #
8238
8387
  # @option params [String] :game_server_protection_policy
8239
8388
  # A flag that indicates whether instances in the game server group are
8240
8389
  # protected from early termination. Unprotected instances that have
8241
- # active game servers running may by terminated during a scale-down
8390
+ # active game servers running might be terminated during a scale-down
8242
8391
  # event, causing players to be dropped from the game. Protected
8243
8392
  # instances cannot be terminated while there are active game servers
8244
- # running. An exception to this is Spot Instances, which may be
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
8245
8395
  # terminated by AWS regardless of protection status. This property is
8246
- # set to NO\_PROTECTION by default.
8396
+ # set to `NO_PROTECTION` by default.
8247
8397
  #
8248
8398
  # @option params [String] :balancing_strategy
8249
- # The fallback balancing method to use for the game server group when
8250
- # Spot instances in a Region become unavailable or are not viable for
8251
- # game hosting. Once triggered, this method remains active until Spot
8252
- # instances can once again be used. Method options include:
8253
- #
8254
- # * SPOT\_ONLY -- If Spot instances are unavailable, the game server
8255
- # group provides no hosting capacity. No new instances are started,
8256
- # and the existing nonviable Spot instances are terminated (once
8257
- # current gameplay ends) and not replaced.
8258
- #
8259
- # * SPOT\_PREFERRED -- If Spot instances are unavailable, the game
8260
- # server group continues to provide hosting capacity by using
8261
- # On-Demand instances. Existing nonviable Spot instances are
8262
- # terminated (once current gameplay ends) and replaced with new
8263
- # On-Demand instances.
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.
8264
8420
  #
8265
8421
  # @return [Types::UpdateGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
8266
8422
  #
@@ -8278,7 +8434,7 @@ module Aws::GameLift
8278
8434
  # },
8279
8435
  # ],
8280
8436
  # game_server_protection_policy: "NO_PROTECTION", # accepts NO_PROTECTION, FULL_PROTECTION
8281
- # balancing_strategy: "SPOT_ONLY", # accepts SPOT_ONLY, SPOT_PREFERRED
8437
+ # balancing_strategy: "SPOT_ONLY", # accepts SPOT_ONLY, SPOT_PREFERRED, ON_DEMAND_ONLY
8282
8438
  # })
8283
8439
  #
8284
8440
  # @example Response structure
@@ -8289,7 +8445,7 @@ module Aws::GameLift
8289
8445
  # resp.game_server_group.instance_definitions #=> Array
8290
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"
8291
8447
  # resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
8292
- # 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"
8293
8449
  # resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
8294
8450
  # resp.game_server_group.auto_scaling_group_arn #=> String
8295
8451
  # resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
@@ -8841,7 +8997,7 @@ module Aws::GameLift
8841
8997
  # the zip file; if you have S3 object versioning turned on, you can use
8842
8998
  # the `ObjectVersion` parameter to specify an earlier version.
8843
8999
  #
8844
- # @option params [String, IO] :zip_file
9000
+ # @option params [String, StringIO, File] :zip_file
8845
9001
  # A data object containing your Realtime scripts and dependencies as a
8846
9002
  # zip file. The zip file can have one or multiple files. Maximum size of
8847
9003
  # a zip file is 5 MB.
@@ -8965,7 +9121,7 @@ module Aws::GameLift
8965
9121
  params: params,
8966
9122
  config: config)
8967
9123
  context[:gem_name] = 'aws-sdk-gamelift'
8968
- context[:gem_version] = '1.33.0'
9124
+ context[:gem_version] = '1.38.0'
8969
9125
  Seahorse::Client::Request.new(handlers, context)
8970
9126
  end
8971
9127