aws-sdk-gamelift 1.31.0 → 1.36.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: 716ae6dcfe092cbdc810d7eeec5a3c8d70e7aecee8920506d35b5de23b5e4911
4
- data.tar.gz: 45e7d46de8ba1e3962b7901306332c541cde538c267e7a1f299f1f9887153cb5
3
+ metadata.gz: 643faf0fb7357b1685bc6baff8b979a8f99d417ffc070415dd705a15fc67b727
4
+ data.tar.gz: 789736af3e9d8a1079e777a371987d73f2dc6ccd501f4432ef4eb178ab3fa949
5
5
  SHA512:
6
- metadata.gz: 00effc8d4cc90fc18e2f04322a65a223ac72995ece142363d35edf3deb0f1d5caaa161a6ad1e5cbe3086a54c3fdd05999472b1ec6ddf8e30b3d2761db48d0228
7
- data.tar.gz: f78563a63d2660f3642db4990c84873cd6c5e22a135beaca0f6eed9c2448bb21b0eb656d318affb4bf7380f0b05c07cfc7f45408e45e8406ebdb5deaebd8ce5a
6
+ metadata.gz: 3a339c92f286893711c325282e2d2e82e9aeb7886be3e09aabae47dbb9a80fd00ddda2171930fbdc87877ad6925740c85ca65465311baa375cf74823c6618105
7
+ data.tar.gz: e94aa48acd4b152ba7f289b06716e25e37fb66b60000494b452122e115d8bdb3195815ae861394a72d2f6f1e28a9fef1f445f88e7ca0e8a35125f84926fb43b8
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -42,9 +44,9 @@ require_relative 'aws-sdk-gamelift/customizations'
42
44
  #
43
45
  # See {Errors} for more information.
44
46
  #
45
- # @service
47
+ # @!group service
46
48
  module Aws::GameLift
47
49
 
48
- GEM_VERSION = '1.31.0'
50
+ GEM_VERSION = '1.36.0'
49
51
 
50
52
  end
@@ -1,3 +1,5 @@
1
+ # frozen_string_literal: true
2
+
1
3
  # WARNING ABOUT GENERATED CODE
2
4
  #
3
5
  # This file is generated. See the contributing guide for more information:
@@ -24,6 +26,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
24
26
  require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
25
27
  require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
26
28
  require 'aws-sdk-core/plugins/transfer_encoding.rb'
29
+ require 'aws-sdk-core/plugins/http_checksum.rb'
27
30
  require 'aws-sdk-core/plugins/signature_v4.rb'
28
31
  require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
29
32
 
@@ -69,6 +72,7 @@ module Aws::GameLift
69
72
  add_plugin(Aws::Plugins::ClientMetricsPlugin)
70
73
  add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
71
74
  add_plugin(Aws::Plugins::TransferEncoding)
75
+ add_plugin(Aws::Plugins::HttpChecksum)
72
76
  add_plugin(Aws::Plugins::SignatureV4)
73
77
  add_plugin(Aws::Plugins::Protocols::JsonRpc)
74
78
 
@@ -81,13 +85,28 @@ module Aws::GameLift
81
85
  # * `Aws::Credentials` - Used for configuring static, non-refreshing
82
86
  # credentials.
83
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
+ #
84
102
  # * `Aws::InstanceProfileCredentials` - Used for loading credentials
85
103
  # from an EC2 IMDS on an EC2 instance.
86
104
  #
87
- # * `Aws::SharedCredentials` - Used for loading credentials from a
88
- # shared file, such as `~/.aws/config`.
105
+ # * `Aws::ECSCredentials` - Used for loading credentials from
106
+ # instances running in ECS.
89
107
  #
90
- # * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
108
+ # * `Aws::CognitoIdentityCredentials` - Used for loading credentials
109
+ # from the Cognito Identity service.
91
110
  #
92
111
  # When `:credentials` are not configured directly, the following
93
112
  # locations will be searched for credentials:
@@ -97,10 +116,10 @@ module Aws::GameLift
97
116
  # * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
98
117
  # * `~/.aws/credentials`
99
118
  # * `~/.aws/config`
100
- # * EC2 IMDS instance profile - When used by default, the timeouts are
101
- # very aggressive. Construct and pass an instance of
102
- # `Aws::InstanceProfileCredentails` to enable retries and extended
103
- # 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.
104
123
  #
105
124
  # @option options [required, String] :region
106
125
  # The AWS region to connect to. The configured `:region` is
@@ -161,7 +180,7 @@ module Aws::GameLift
161
180
  # @option options [String] :endpoint
162
181
  # The client endpoint is normally constructed from the `:region`
163
182
  # option. You should only configure an `:endpoint` when connecting
164
- # to test endpoints. This should be a valid HTTP(S) URI.
183
+ # to test or custom endpoints. This should be a valid HTTP(S) URI.
165
184
  #
166
185
  # @option options [Integer] :endpoint_cache_max_entries (1000)
167
186
  # Used for the maximum size limit of the LRU cache storing endpoints data
@@ -397,47 +416,46 @@ module Aws::GameLift
397
416
  req.send_request(options)
398
417
  end
399
418
 
400
- # **This action is part of Amazon GameLift FleetIQ with game server
401
- # 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.**
402
421
  #
403
422
  # Locates an available game server and temporarily reserves it to host
404
- # gameplay and players. This action is called by a game client or client
405
- # service (such as a matchmaker) to request hosting resources for a new
406
- # game session. In response, GameLift FleetIQ searches for an available
407
- # game server in the specified game server group, places the game server
408
- # in "claimed" status for 60 seconds, and returns connection
409
- # information back to the requester so that players can connect to the
410
- # game server.
411
- #
412
- # There are two ways you can claim a game server. For the first option,
413
- # you provide a game server group ID only, which prompts GameLift
414
- # FleetIQ to search for an available game server in the specified group
415
- # and claim it. With this option, GameLift FleetIQ attempts to
416
- # consolidate gameplay on as few instances as possible to minimize
417
- # hosting costs. For the second option, you request a specific game
418
- # server by its ID. This option results in a less efficient claiming
419
- # process because it does not take advantage of consolidation and may
420
- # fail if the requested game server is unavailable.
421
- #
422
- # To claim a game server, identify a game server group and (optionally)
423
- # a game server ID. If your game requires that game data be provided to
424
- # the game server at the start of a game, such as a game map or player
425
- # 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.
426
435
  #
427
436
  # When a game server is successfully claimed, connection information is
428
437
  # returned. A claimed game server's utilization status remains
429
- # AVAILABLE, while the claim status is set to CLAIMED for up to 60
430
- # seconds. This time period allows the game server to be prompted to
431
- # update its status to UTILIZED (using UpdateGameServer). If the game
432
- # server's status is not updated within 60 seconds, the game server
433
- # reverts to unclaimed status and is available to be claimed by another
434
- # 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.
435
445
  #
436
446
  # If you try to claim a specific game server, this request will fail in
437
- # the following cases: (1) if the game server utilization status is
438
- # UTILIZED, (2) if the game server claim status is CLAIMED, or (3) if
439
- # the instance that the game server is running on is flagged as
440
- # 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>
441
459
  #
442
460
  # **Learn more**
443
461
  #
@@ -459,14 +477,13 @@ module Aws::GameLift
459
477
  #
460
478
  #
461
479
  #
462
- # [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
463
481
  #
464
482
  # @option params [required, String] :game_server_group_name
465
- # An identifier for the game server group. When claiming a specific game
466
- # server, this is the game server group whether the game server is
467
- # located. When requesting that GameLift FleetIQ locate an available
468
- # game server, this is the game server group to search on. You can use
469
- # 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.
470
487
  #
471
488
  # @option params [String] :game_server_id
472
489
  # A custom string that uniquely identifies the game server to claim. If
@@ -475,7 +492,9 @@ module Aws::GameLift
475
492
  #
476
493
  # @option params [String] :game_server_data
477
494
  # A set of custom game server properties, formatted as a single string
478
- # 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.
479
498
  #
480
499
  # @return [Types::ClaimGameServerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
481
500
  #
@@ -497,7 +516,6 @@ module Aws::GameLift
497
516
  # resp.game_server.instance_id #=> String
498
517
  # resp.game_server.connection_info #=> String
499
518
  # resp.game_server.game_server_data #=> String
500
- # resp.game_server.custom_sort_key #=> String
501
519
  # resp.game_server.claim_status #=> String, one of "CLAIMED"
502
520
  # resp.game_server.utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
503
521
  # resp.game_server.registration_time #=> Time
@@ -632,12 +650,13 @@ module Aws::GameLift
632
650
  #
633
651
  # * To directly upload your build files to a GameLift S3 location. To
634
652
  # use this option, first call `CreateBuild` and specify a build name
635
- # and operating system. This action creates a new build resource and
636
- # also returns an S3 location with temporary access credentials. Use
637
- # the credentials to manually upload your build files to the specified
638
- # S3 location. For more information, see [Uploading Objects][1] in the
639
- # *Amazon S3 Developer Guide*. Build files can be uploaded to the
640
- # 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.
641
660
  #
642
661
  # If successful, this operation creates a new build resource with a
643
662
  # unique build ID and places it in `INITIALIZED` status. A build must be
@@ -1100,54 +1119,49 @@ module Aws::GameLift
1100
1119
  req.send_request(options)
1101
1120
  end
1102
1121
 
1103
- # **This action is part of Amazon GameLift FleetIQ with game server
1104
- # groups, which is in preview release and is subject to change.**
1105
- #
1106
- # Creates a GameLift FleetIQ game server group to manage a collection of
1107
- # EC2 instances for game hosting. In addition to creating the game
1108
- # server group, this action also creates an Auto Scaling group in your
1109
- # AWS account and establishes a link between the two groups. You have
1110
- # full control over configuration of the Auto Scaling group, but
1111
- # GameLift FleetIQ routinely certain Auto Scaling group properties in
1112
- # 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.
1113
1129
  # You can view the status of your game server groups in the GameLift
1114
- # Console. Game server group metrics and events are emitted to Amazon
1130
+ # console. Game server group metrics and events are emitted to Amazon
1115
1131
  # CloudWatch.
1116
1132
  #
1117
- # 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:
1118
1134
  #
1119
- # * An EC2 launch template. The template provides configuration settings
1120
- # for a set of EC2 instances and includes the game server build that
1121
- # you want to deploy and run on each instance. For more information on
1122
- # creating a launch template, see [ Launching an Instance from a
1123
- # 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*.
1124
1139
  #
1125
- # * An IAM role. The role sets up limited access to your AWS account,
1126
- # allowing GameLift FleetIQ to create and manage the EC2 Auto Scaling
1127
- # group, get instance data, and emit metrics and events to CloudWatch.
1128
- # For more information on setting up an IAM permissions policy with
1129
- # principal access for GameLift, see [ Specifying a Principal in a
1130
- # 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*.
1131
1144
  #
1132
- # To create a new game server group, provide a name and specify the IAM
1133
- # role and EC2 launch template. You also need to provide a list of
1134
- # instance types to be used in the group and set initial maximum and
1135
- # minimum limits on the group's instance count. You can optionally set
1136
- # an autoscaling policy with target tracking based on a GameLift FleetIQ
1137
- # 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.
1138
1151
  #
1139
1152
  # Once the game server group and corresponding Auto Scaling group are
1140
1153
  # created, you have full access to change the Auto Scaling group's
1141
- # configuration as needed. Keep in mind, however, that some properties
1142
- # are periodically updated by GameLift FleetIQ as it balances the
1143
- # 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.
1144
1160
  #
1145
1161
  # **Learn more**
1146
1162
  #
1147
1163
  # [GameLift FleetIQ Guide][3]
1148
1164
  #
1149
- # [Updating a GameLift FleetIQ-Linked Auto Scaling Group][4]
1150
- #
1151
1165
  # **Related operations**
1152
1166
  #
1153
1167
  # * CreateGameServerGroup
@@ -1164,12 +1178,13 @@ module Aws::GameLift
1164
1178
  #
1165
1179
  # * SuspendGameServerGroup
1166
1180
  #
1181
+ # * DescribeGameServerInstances
1182
+ #
1167
1183
  #
1168
1184
  #
1169
1185
  # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html
1170
- # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-bucket-user-policy-specifying-principal-intro.html
1171
- # [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
1172
- # [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
1173
1188
  #
1174
1189
  # @option params [required, String] :game_server_group_name
1175
1190
  # An identifier for the new game server group. This value is used to
@@ -1179,9 +1194,7 @@ module Aws::GameLift
1179
1194
  #
1180
1195
  # @option params [required, String] :role_arn
1181
1196
  # The Amazon Resource Name ([ARN][1]) for an IAM role that allows Amazon
1182
- # GameLift to access your EC2 Auto Scaling groups. The submitted role is
1183
- # validated to ensure that it contains the necessary permissions for
1184
- # game server groups.
1197
+ # GameLift to access your EC2 Auto Scaling groups.
1185
1198
  #
1186
1199
  #
1187
1200
  #
@@ -1189,14 +1202,18 @@ module Aws::GameLift
1189
1202
  #
1190
1203
  # @option params [required, Integer] :min_size
1191
1204
  # The minimum number of instances allowed in the EC2 Auto Scaling group.
1192
- # During autoscaling events, GameLift FleetIQ and EC2 do not scale down
1193
- # the group below this minimum. In production, this value should be set
1194
- # 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.
1195
1210
  #
1196
1211
  # @option params [required, Integer] :max_size
1197
1212
  # The maximum number of instances allowed in the EC2 Auto Scaling group.
1198
- # During autoscaling events, GameLift FleetIQ and EC2 do not scale up
1199
- # 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.
1200
1217
  #
1201
1218
  # @option params [required, Types::LaunchTemplateSpecification] :launch_template
1202
1219
  # The EC2 launch template that contains configuration settings and game
@@ -1204,72 +1221,88 @@ module Aws::GameLift
1204
1221
  # You can specify the template using either the template name or ID. For
1205
1222
  # help with creating a launch template, see [Creating a Launch Template
1206
1223
  # for an Auto Scaling Group][1] in the *Amazon EC2 Auto Scaling User
1207
- # 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.
1208
1226
  #
1209
1227
  #
1210
1228
  #
1211
1229
  # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html
1212
1230
  #
1213
1231
  # @option params [required, Array<Types::InstanceDefinition>] :instance_definitions
1214
- # A set of EC2 instance types to use when creating instances in the
1215
- # group. The instance definitions must specify at least two different
1216
- # instance types that are supported by GameLift FleetIQ. For more
1217
- # information on instance types, see [EC2 Instance Types][1] in the
1218
- # *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.
1219
1241
  #
1220
1242
  #
1221
1243
  #
1222
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
1223
1246
  #
1224
1247
  # @option params [Types::GameServerGroupAutoScalingPolicy] :auto_scaling_policy
1225
1248
  # Configuration settings to define a scaling policy for the Auto Scaling
1226
1249
  # group that is optimized for game hosting. The scaling policy uses the
1227
- # metric "PercentUtilizedGameServers" to maintain a buffer of idle
1250
+ # metric `"PercentUtilizedGameServers"` to maintain a buffer of idle
1228
1251
  # game servers that can immediately accommodate new games and players.
1229
- # Once the game server and Auto Scaling groups are created, you can
1230
- # 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.
1231
1254
  #
1232
1255
  # @option params [String] :balancing_strategy
1233
- # The fallback balancing method to use for the game server group when
1234
- # Spot instances in a Region become unavailable or are not viable for
1235
- # game hosting. Once triggered, this method remains active until Spot
1236
- # instances can once again be used. Method options include:
1237
- #
1238
- # * SPOT\_ONLY -- If Spot instances are unavailable, the game server
1239
- # group provides no hosting capacity. No new instances are started,
1240
- # and the existing nonviable Spot instances are terminated (once
1241
- # current gameplay ends) and not replaced.
1242
- #
1243
- # * SPOT\_PREFERRED -- If Spot instances are unavailable, the game
1244
- # server group continues to provide hosting capacity by using
1245
- # On-Demand instances. Existing nonviable Spot instances are
1246
- # terminated (once current gameplay ends) and replaced with new
1247
- # 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.
1248
1277
  #
1249
1278
  # @option params [String] :game_server_protection_policy
1250
1279
  # A flag that indicates whether instances in the game server group are
1251
1280
  # protected from early termination. Unprotected instances that have
1252
- # active game servers running may by terminated during a scale-down
1281
+ # active game servers running might be terminated during a scale-down
1253
1282
  # event, causing players to be dropped from the game. Protected
1254
1283
  # instances cannot be terminated while there are active game servers
1255
- # 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
1256
1286
  # terminated by AWS regardless of protection status. This property is
1257
- # set to NO\_PROTECTION by default.
1287
+ # set to `NO_PROTECTION` by default.
1258
1288
  #
1259
1289
  # @option params [Array<String>] :vpc_subnets
1260
1290
  # A list of virtual private cloud (VPC) subnets to use with instances in
1261
1291
  # the game server group. By default, all GameLift FleetIQ-supported
1262
- # availability zones are used; this parameter allows you to specify VPCs
1263
- # 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
1264
1297
  #
1265
1298
  # @option params [Array<Types::Tag>] :tags
1266
1299
  # A list of labels to assign to the new game server group resource. Tags
1267
- # are developer-defined key-value pairs. Tagging AWS resources are
1268
- # useful for resource management, access management, and cost
1269
- # allocation. For more information, see [ Tagging AWS Resources][1] in
1270
- # the *AWS General Reference*. Once the resource is created, you can use
1271
- # TagResource, UntagResource, and ListTagsForResource to add, remove,
1272
- # 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
1273
1306
  # AWS General Reference for actual tagging limits.
1274
1307
  #
1275
1308
  #
@@ -1304,7 +1337,7 @@ module Aws::GameLift
1304
1337
  # target_value: 1.0, # required
1305
1338
  # },
1306
1339
  # },
1307
- # balancing_strategy: "SPOT_ONLY", # accepts SPOT_ONLY, SPOT_PREFERRED
1340
+ # balancing_strategy: "SPOT_ONLY", # accepts SPOT_ONLY, SPOT_PREFERRED, ON_DEMAND_ONLY
1308
1341
  # game_server_protection_policy: "NO_PROTECTION", # accepts NO_PROTECTION, FULL_PROTECTION
1309
1342
  # vpc_subnets: ["VpcSubnet"],
1310
1343
  # tags: [
@@ -1323,7 +1356,7 @@ module Aws::GameLift
1323
1356
  # resp.game_server_group.instance_definitions #=> Array
1324
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"
1325
1358
  # resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
1326
- # 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"
1327
1360
  # resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
1328
1361
  # resp.game_server_group.auto_scaling_group_arn #=> String
1329
1362
  # resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
@@ -1342,8 +1375,8 @@ module Aws::GameLift
1342
1375
  req.send_request(options)
1343
1376
  end
1344
1377
 
1345
- # Creates a multiplayer game session for players. This action creates a
1346
- # 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
1347
1380
  # specified fleet to host the game session. A fleet must have an
1348
1381
  # `ACTIVE` status before a game session can be created in it.
1349
1382
  #
@@ -1674,20 +1707,17 @@ module Aws::GameLift
1674
1707
  # use when placing a new game session for the match; and the maximum
1675
1708
  # time allowed for a matchmaking attempt.
1676
1709
  #
1677
- # There are two ways to track the progress of matchmaking tickets: (1)
1678
- # polling ticket status with DescribeMatchmaking; or (2) receiving
1679
- # notifications with Amazon Simple Notification Service (SNS). To use
1680
- # notifications, you first need to set up an SNS topic to receive the
1681
- # notifications, and provide the topic ARN in the matchmaking
1682
- # configuration. Since notifications promise only "best effort"
1683
- # delivery, we recommend calling `DescribeMatchmaking` if no
1684
- # 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.
1685
1715
  #
1686
1716
  # **Learn more**
1687
1717
  #
1688
1718
  # [ Design a FlexMatch Matchmaker][1]
1689
1719
  #
1690
- # [ Setting up Notifications for Matchmaking][2]
1720
+ # [ Set Up FlexMatch Event Notification][2]
1691
1721
  #
1692
1722
  # **Related operations**
1693
1723
  #
@@ -2209,7 +2239,7 @@ module Aws::GameLift
2209
2239
  # the zip file; if you have S3 object versioning turned on, you can use
2210
2240
  # the `ObjectVersion` parameter to specify an earlier version.
2211
2241
  #
2212
- # @option params [String, IO] :zip_file
2242
+ # @option params [String, StringIO, File] :zip_file
2213
2243
  # A data object containing your Realtime scripts and dependencies as a
2214
2244
  # zip file. The zip file can have one or multiple files. Maximum size of
2215
2245
  # a zip file is 5 MB.
@@ -2455,7 +2485,7 @@ module Aws::GameLift
2455
2485
  req.send_request(options)
2456
2486
  end
2457
2487
 
2458
- # 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
2459
2489
  # clients attempting to access a server process using the deleted alias
2460
2490
  # receive an error. To delete an alias, specify the alias ID to be
2461
2491
  # deleted.
@@ -2493,7 +2523,7 @@ module Aws::GameLift
2493
2523
  req.send_request(options)
2494
2524
  end
2495
2525
 
2496
- # Deletes a build. This action permanently deletes the build resource
2526
+ # Deletes a build. This operation permanently deletes the build resource
2497
2527
  # and any uploaded build files. Deleting a build does not affect the
2498
2528
  # status of any active fleets using the build, but you can no longer
2499
2529
  # create new fleets with the deleted build.
@@ -2551,7 +2581,7 @@ module Aws::GameLift
2551
2581
  # the VPC peering connection--this is done as part of the delete fleet
2552
2582
  # process.
2553
2583
  #
2554
- # 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
2555
2585
  # deleted, you can no longer use any of the resource in that fleet.
2556
2586
  #
2557
2587
  # **Learn more**
@@ -2597,27 +2627,33 @@ module Aws::GameLift
2597
2627
  req.send_request(options)
2598
2628
  end
2599
2629
 
2600
- # **This action is part of Amazon GameLift FleetIQ with game server
2601
- # 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.**
2602
2632
  #
2603
2633
  # Terminates a game server group and permanently deletes the game server
2604
2634
  # group record. You have several options for how these resources are
2605
2635
  # impacted when deleting the game server group. Depending on the type of
2606
- # delete action selected, this action may affect three types of
2607
- # resources: the game server group, the corresponding Auto Scaling
2608
- # 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
2609
2644
  #
2610
2645
  # To delete a game server group, identify the game server group to
2611
- # delete and specify the type of delete action to initiate. Game server
2612
- # 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.
2613
2649
  #
2614
- # If the delete request is successful, a series of actions are kicked
2615
- # 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`,
2616
2652
  # which prevents new game servers from being registered and stops
2617
- # autoscaling activity. Once all game servers in the game server group
2618
- # are de-registered, GameLift FleetIQ can begin deleting resources. If
2619
- # any of the delete actions fail, the game server group is placed in
2620
- # 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.
2621
2657
  #
2622
2658
  # GameLift FleetIQ emits delete events to Amazon CloudWatch.
2623
2659
  #
@@ -2641,26 +2677,29 @@ module Aws::GameLift
2641
2677
  #
2642
2678
  # * SuspendGameServerGroup
2643
2679
  #
2680
+ # * DescribeGameServerInstances
2681
+ #
2644
2682
  #
2645
2683
  #
2646
- # [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
2647
2685
  #
2648
2686
  # @option params [required, String] :game_server_group_name
2649
- # The unique identifier of the game server group to delete. Use either
2650
- # the GameServerGroup name or ARN value.
2687
+ # A unique identifier for the game server group. Use either the
2688
+ # GameServerGroup name or ARN value.
2651
2689
  #
2652
2690
  # @option params [String] :delete_option
2653
- # The type of delete to perform. Options include:
2691
+ # The type of delete to perform. Options include the following:
2654
2692
  #
2655
- # * SAFE\_DELETE – Terminates the game server group and EC2 Auto Scaling
2656
- # 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.
2657
2696
  #
2658
- # * FORCE\_DELETE – Terminates the game server group, including all
2697
+ # * `FORCE_DELETE` – Terminates the game server group, including all
2659
2698
  # active game servers regardless of their utilization status, and the
2660
2699
  # EC2 Auto Scaling group.
2661
2700
  #
2662
- # * RETAIN – Does a safe delete of the game server group but retains the
2663
- # 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.
2664
2703
  #
2665
2704
  # @return [Types::DeleteGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2666
2705
  #
@@ -2681,7 +2720,7 @@ module Aws::GameLift
2681
2720
  # resp.game_server_group.instance_definitions #=> Array
2682
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"
2683
2722
  # resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
2684
- # 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"
2685
2724
  # resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
2686
2725
  # resp.game_server_group.auto_scaling_group_arn #=> String
2687
2726
  # resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
@@ -2700,9 +2739,9 @@ module Aws::GameLift
2700
2739
  req.send_request(options)
2701
2740
  end
2702
2741
 
2703
- # Deletes a game session queue. This action means that any
2704
- # StartGameSessionPlacement requests that reference this queue will
2705
- # 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.
2706
2745
  #
2707
2746
  # **Learn more**
2708
2747
  #
@@ -2841,8 +2880,8 @@ module Aws::GameLift
2841
2880
  req.send_request(options)
2842
2881
  end
2843
2882
 
2844
- # Deletes a fleet scaling policy. This action means that the policy is
2845
- # 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
2846
2885
  # policy, specify both the scaling policy name and the fleet ID it is
2847
2886
  # associated with.
2848
2887
  #
@@ -2895,9 +2934,9 @@ module Aws::GameLift
2895
2934
  req.send_request(options)
2896
2935
  end
2897
2936
 
2898
- # Deletes a Realtime script. This action permanently deletes the script
2899
- # record. If script files were uploaded, they are also deleted (files
2900
- # 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).
2901
2940
  #
2902
2941
  # To delete a script, specify the script ID. Before deleting a script,
2903
2942
  # be sure to terminate all fleets that are deployed with the script
@@ -3048,16 +3087,16 @@ module Aws::GameLift
3048
3087
  req.send_request(options)
3049
3088
  end
3050
3089
 
3051
- # **This action is part of Amazon GameLift FleetIQ with game server
3052
- # 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.**
3053
3092
  #
3054
- # Removes the game server resource from the game server group. As a
3055
- # result of this action, the de-registered game server can no longer be
3056
- # 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.
3057
3096
  #
3058
- # To de-register a game server, specify the game server group and game
3059
- # server ID. If successful, this action emits a CloudWatch event with
3060
- # 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.
3061
3100
  #
3062
3101
  # **Learn more**
3063
3102
  #
@@ -3079,15 +3118,15 @@ module Aws::GameLift
3079
3118
  #
3080
3119
  #
3081
3120
  #
3082
- # [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
3083
3122
  #
3084
3123
  # @option params [required, String] :game_server_group_name
3085
- # An identifier for the game server group where the game server to be
3086
- # de-registered is running. Use either the GameServerGroup name or ARN
3087
- # 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.
3088
3126
  #
3089
3127
  # @option params [required, String] :game_server_id
3090
- # The identifier for the game server to be de-registered.
3128
+ # A custom string that uniquely identifies the game server to
3129
+ # deregister.
3091
3130
  #
3092
3131
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3093
3132
  #
@@ -3301,7 +3340,7 @@ module Aws::GameLift
3301
3340
  # pages. If successful, a FleetAttributes object is returned for each
3302
3341
  # fleet requested, unless the fleet identifier is not found.
3303
3342
  #
3304
- # <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
3305
3344
  # request. If a request exceeds this limit, the request fails and the
3306
3345
  # error message includes the maximum allowed number.
3307
3346
  #
@@ -3358,16 +3397,18 @@ module Aws::GameLift
3358
3397
  #
3359
3398
  # @option params [String] :next_token
3360
3399
  # Token that indicates the start of the next sequential page of results.
3361
- # Use the token that is returned with a previous call to this action. To
3362
- # start at the beginning of the result set, do not specify a value. This
3363
- # parameter is ignored when the request specifies one or a list of fleet
3364
- # 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.
3365
3404
  #
3366
3405
  # @return [Types::DescribeFleetAttributesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3367
3406
  #
3368
3407
  # * {Types::DescribeFleetAttributesOutput#fleet_attributes #fleet_attributes} => Array&lt;Types::FleetAttributes&gt;
3369
3408
  # * {Types::DescribeFleetAttributesOutput#next_token #next_token} => String
3370
3409
  #
3410
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3411
+ #
3371
3412
  # @example Request syntax with placeholder values
3372
3413
  #
3373
3414
  # resp = client.describe_fleet_attributes({
@@ -3430,7 +3471,7 @@ module Aws::GameLift
3430
3471
  # requested fleet ID. When a list of fleet IDs is provided, attribute
3431
3472
  # objects are returned only for fleets that currently exist.
3432
3473
  #
3433
- # <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
3434
3475
  # request. If a request exceeds this limit, the request fails and the
3435
3476
  # error message includes the maximum allowed.
3436
3477
  #
@@ -3487,16 +3528,18 @@ module Aws::GameLift
3487
3528
  #
3488
3529
  # @option params [String] :next_token
3489
3530
  # Token that indicates the start of the next sequential page of results.
3490
- # Use the token that is returned with a previous call to this action. To
3491
- # start at the beginning of the result set, do not specify a value. This
3492
- # parameter is ignored when the request specifies one or a list of fleet
3493
- # 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.
3494
3535
  #
3495
3536
  # @return [Types::DescribeFleetCapacityOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3496
3537
  #
3497
3538
  # * {Types::DescribeFleetCapacityOutput#fleet_capacity #fleet_capacity} => Array&lt;Types::FleetCapacity&gt;
3498
3539
  # * {Types::DescribeFleetCapacityOutput#next_token #next_token} => String
3499
3540
  #
3541
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3542
+ #
3500
3543
  # @example Request syntax with placeholder values
3501
3544
  #
3502
3545
  # resp = client.describe_fleet_capacity({
@@ -3592,14 +3635,16 @@ module Aws::GameLift
3592
3635
  #
3593
3636
  # @option params [String] :next_token
3594
3637
  # Token that indicates the start of the next sequential page of results.
3595
- # Use the token that is returned with a previous call to this action. To
3596
- # 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.
3597
3640
  #
3598
3641
  # @return [Types::DescribeFleetEventsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3599
3642
  #
3600
3643
  # * {Types::DescribeFleetEventsOutput#events #events} => Array&lt;Types::Event&gt;
3601
3644
  # * {Types::DescribeFleetEventsOutput#next_token #next_token} => String
3602
3645
  #
3646
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3647
+ #
3603
3648
  # @example Request syntax with placeholder values
3604
3649
  #
3605
3650
  # resp = client.describe_fleet_events({
@@ -3719,7 +3764,7 @@ module Aws::GameLift
3719
3764
  # pages. If successful, a FleetUtilization object is returned for each
3720
3765
  # requested fleet ID, unless the fleet identifier is not found.
3721
3766
  #
3722
- # <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
3723
3768
  # request. If a request exceeds this limit, the request fails and the
3724
3769
  # error message includes the maximum allowed.
3725
3770
  #
@@ -3779,16 +3824,18 @@ module Aws::GameLift
3779
3824
  #
3780
3825
  # @option params [String] :next_token
3781
3826
  # Token that indicates the start of the next sequential page of results.
3782
- # Use the token that is returned with a previous call to this action. To
3783
- # start at the beginning of the result set, do not specify a value. This
3784
- # parameter is ignored when the request specifies one or a list of fleet
3785
- # 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.
3786
3831
  #
3787
3832
  # @return [Types::DescribeFleetUtilizationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3788
3833
  #
3789
3834
  # * {Types::DescribeFleetUtilizationOutput#fleet_utilization #fleet_utilization} => Array&lt;Types::FleetUtilization&gt;
3790
3835
  # * {Types::DescribeFleetUtilizationOutput#next_token #next_token} => String
3791
3836
  #
3837
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3838
+ #
3792
3839
  # @example Request syntax with placeholder values
3793
3840
  #
3794
3841
  # resp = client.describe_fleet_utilization({
@@ -3816,12 +3863,12 @@ module Aws::GameLift
3816
3863
  req.send_request(options)
3817
3864
  end
3818
3865
 
3819
- # **This action is part of Amazon GameLift FleetIQ with game server
3820
- # 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.**
3821
3868
  #
3822
- # Retrieves information for a game server resource. Information includes
3823
- # the game server statuses, health check info, and the instance the game
3824
- # 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.
3825
3872
  #
3826
3873
  # To retrieve game server information, specify the game server ID. If
3827
3874
  # successful, the requested game server object is returned.
@@ -3846,14 +3893,15 @@ module Aws::GameLift
3846
3893
  #
3847
3894
  #
3848
3895
  #
3849
- # [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
3850
3897
  #
3851
3898
  # @option params [required, String] :game_server_group_name
3852
- # 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
3853
3900
  # running. Use either the GameServerGroup name or ARN value.
3854
3901
  #
3855
3902
  # @option params [required, String] :game_server_id
3856
- # The identifier for the game server to be retrieved.
3903
+ # A custom string that uniquely identifies the game server information
3904
+ # to be retrieved.
3857
3905
  #
3858
3906
  # @return [Types::DescribeGameServerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3859
3907
  #
@@ -3874,7 +3922,6 @@ module Aws::GameLift
3874
3922
  # resp.game_server.instance_id #=> String
3875
3923
  # resp.game_server.connection_info #=> String
3876
3924
  # resp.game_server.game_server_data #=> String
3877
- # resp.game_server.custom_sort_key #=> String
3878
3925
  # resp.game_server.claim_status #=> String, one of "CLAIMED"
3879
3926
  # resp.game_server.utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
3880
3927
  # resp.game_server.registration_time #=> Time
@@ -3890,10 +3937,14 @@ module Aws::GameLift
3890
3937
  req.send_request(options)
3891
3938
  end
3892
3939
 
3893
- # **This action is part of Amazon GameLift FleetIQ with game server
3894
- # 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.**
3895
3942
  #
3896
- # 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.
3897
3948
  #
3898
3949
  # To get attributes for a game server group, provide a group name or ARN
3899
3950
  # value. If successful, a GameServerGroup object is returned.
@@ -3918,13 +3969,15 @@ module Aws::GameLift
3918
3969
  #
3919
3970
  # * SuspendGameServerGroup
3920
3971
  #
3972
+ # * DescribeGameServerInstances
3973
+ #
3921
3974
  #
3922
3975
  #
3923
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
3976
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
3924
3977
  #
3925
3978
  # @option params [required, String] :game_server_group_name
3926
- # The unique identifier for the game server group being requested. Use
3927
- # 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.
3928
3981
  #
3929
3982
  # @return [Types::DescribeGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3930
3983
  #
@@ -3944,7 +3997,7 @@ module Aws::GameLift
3944
3997
  # resp.game_server_group.instance_definitions #=> Array
3945
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"
3946
3999
  # resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
3947
- # 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"
3948
4001
  # resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
3949
4002
  # resp.game_server_group.auto_scaling_group_arn #=> String
3950
4003
  # resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
@@ -3963,8 +4016,109 @@ module Aws::GameLift
3963
4016
  req.send_request(options)
3964
4017
  end
3965
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
+
3966
4120
  # Retrieves properties, including the protection policy in force, for
3967
- # 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:
3968
4122
  # (1) provide a `GameSessionId` or `GameSessionArn` to request details
3969
4123
  # for a specific game session; (2) provide either a `FleetId` or an
3970
4124
  # `AliasId` to request properties for all game sessions running on a
@@ -4018,14 +4172,16 @@ module Aws::GameLift
4018
4172
  #
4019
4173
  # @option params [String] :next_token
4020
4174
  # Token that indicates the start of the next sequential page of results.
4021
- # Use the token that is returned with a previous call to this action. To
4022
- # 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.
4023
4177
  #
4024
4178
  # @return [Types::DescribeGameSessionDetailsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4025
4179
  #
4026
4180
  # * {Types::DescribeGameSessionDetailsOutput#game_session_details #game_session_details} => Array&lt;Types::GameSessionDetail&gt;
4027
4181
  # * {Types::DescribeGameSessionDetailsOutput#next_token #next_token} => String
4028
4182
  #
4183
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4184
+ #
4029
4185
  # @example Request syntax with placeholder values
4030
4186
  #
4031
4187
  # resp = client.describe_game_session_details({
@@ -4178,19 +4334,22 @@ module Aws::GameLift
4178
4334
  #
4179
4335
  # @option params [Integer] :limit
4180
4336
  # The maximum number of results to return. Use this parameter with
4181
- # `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.
4182
4339
  #
4183
4340
  # @option params [String] :next_token
4184
4341
  # A token that indicates the start of the next sequential page of
4185
4342
  # results. Use the token that is returned with a previous call to this
4186
- # action. To start at the beginning of the result set, do not specify a
4187
- # value.
4343
+ # operation. To start at the beginning of the result set, do not specify
4344
+ # a value.
4188
4345
  #
4189
4346
  # @return [Types::DescribeGameSessionQueuesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4190
4347
  #
4191
4348
  # * {Types::DescribeGameSessionQueuesOutput#game_session_queues #game_session_queues} => Array&lt;Types::GameSessionQueue&gt;
4192
4349
  # * {Types::DescribeGameSessionQueuesOutput#next_token #next_token} => String
4193
4350
  #
4351
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4352
+ #
4194
4353
  # @example Request syntax with placeholder values
4195
4354
  #
4196
4355
  # resp = client.describe_game_session_queues({
@@ -4277,14 +4436,16 @@ module Aws::GameLift
4277
4436
  #
4278
4437
  # @option params [String] :next_token
4279
4438
  # Token that indicates the start of the next sequential page of results.
4280
- # Use the token that is returned with a previous call to this action. To
4281
- # 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.
4282
4441
  #
4283
4442
  # @return [Types::DescribeGameSessionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4284
4443
  #
4285
4444
  # * {Types::DescribeGameSessionsOutput#game_sessions #game_sessions} => Array&lt;Types::GameSession&gt;
4286
4445
  # * {Types::DescribeGameSessionsOutput#next_token #next_token} => String
4287
4446
  #
4447
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4448
+ #
4288
4449
  # @example Request syntax with placeholder values
4289
4450
  #
4290
4451
  # resp = client.describe_game_sessions({
@@ -4331,8 +4492,8 @@ module Aws::GameLift
4331
4492
  end
4332
4493
 
4333
4494
  # Retrieves information about a fleet's instances, including instance
4334
- # IDs. Use this action to get details on all instances in the fleet or
4335
- # 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.
4336
4497
  #
4337
4498
  # To get a specific instance, specify fleet ID and instance ID. To get
4338
4499
  # all instances in a fleet, specify a fleet ID only. Use the pagination
@@ -4370,14 +4531,16 @@ module Aws::GameLift
4370
4531
  #
4371
4532
  # @option params [String] :next_token
4372
4533
  # Token that indicates the start of the next sequential page of results.
4373
- # Use the token that is returned with a previous call to this action. To
4374
- # 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.
4375
4536
  #
4376
4537
  # @return [Types::DescribeInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4377
4538
  #
4378
4539
  # * {Types::DescribeInstancesOutput#instances #instances} => Array&lt;Types::Instance&gt;
4379
4540
  # * {Types::DescribeInstancesOutput#next_token #next_token} => String
4380
4541
  #
4542
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4543
+ #
4381
4544
  # @example Request syntax with placeholder values
4382
4545
  #
4383
4546
  # resp = client.describe_instances({
@@ -4410,19 +4573,24 @@ module Aws::GameLift
4410
4573
  end
4411
4574
 
4412
4575
  # Retrieves one or more matchmaking tickets. Use this operation to
4413
- # retrieve ticket information, including status and--once a successful
4414
- # match is made--acquire connection information for the resulting new
4415
- # game session.
4416
- #
4417
- # You can use this operation to track the progress of matchmaking
4418
- # requests (through polling) as an alternative to using event
4419
- # notifications. See more details on tracking matchmaking requests
4420
- # 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.
4421
4578
  #
4422
4579
  # To request matchmaking tickets, provide a list of up to 10 ticket IDs.
4423
4580
  # If the request is successful, a ticket object is returned for each
4424
4581
  # requested ID that currently exists.
4425
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
+ #
4426
4594
  # **Learn more**
4427
4595
  #
4428
4596
  # [ Add FlexMatch to a Game Client][1]
@@ -4496,15 +4664,18 @@ module Aws::GameLift
4496
4664
  req.send_request(options)
4497
4665
  end
4498
4666
 
4499
- # Retrieves the details of FlexMatch matchmaking configurations. With
4500
- # this operation, you have the following options: (1) retrieve all
4501
- # existing configurations, (2) provide the names of one or more
4502
- # configurations to retrieve, or (3) retrieve all configurations that
4503
- # 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
4504
4673
  # pagination parameters to retrieve results as a set of sequential
4505
- # pages. If successful, a configuration is returned for each requested
4506
- # name. When specifying a list of names, only configurations that
4507
- # 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.
4508
4679
  #
4509
4680
  # **Learn more**
4510
4681
  #
@@ -4550,14 +4721,16 @@ module Aws::GameLift
4550
4721
  # @option params [String] :next_token
4551
4722
  # A token that indicates the start of the next sequential page of
4552
4723
  # results. Use the token that is returned with a previous call to this
4553
- # action. To start at the beginning of the result set, do not specify a
4554
- # value.
4724
+ # operation. To start at the beginning of the result set, do not specify
4725
+ # a value.
4555
4726
  #
4556
4727
  # @return [Types::DescribeMatchmakingConfigurationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4557
4728
  #
4558
4729
  # * {Types::DescribeMatchmakingConfigurationsOutput#configurations #configurations} => Array&lt;Types::MatchmakingConfiguration&gt;
4559
4730
  # * {Types::DescribeMatchmakingConfigurationsOutput#next_token #next_token} => String
4560
4731
  #
4732
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4733
+ #
4561
4734
  # @example Request syntax with placeholder values
4562
4735
  #
4563
4736
  # resp = client.describe_matchmaking_configurations({
@@ -4647,14 +4820,16 @@ module Aws::GameLift
4647
4820
  # @option params [String] :next_token
4648
4821
  # A token that indicates the start of the next sequential page of
4649
4822
  # results. Use the token that is returned with a previous call to this
4650
- # action. To start at the beginning of the result set, do not specify a
4651
- # value.
4823
+ # operation. To start at the beginning of the result set, do not specify
4824
+ # a value.
4652
4825
  #
4653
4826
  # @return [Types::DescribeMatchmakingRuleSetsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4654
4827
  #
4655
4828
  # * {Types::DescribeMatchmakingRuleSetsOutput#rule_sets #rule_sets} => Array&lt;Types::MatchmakingRuleSet&gt;
4656
4829
  # * {Types::DescribeMatchmakingRuleSetsOutput#next_token #next_token} => String
4657
4830
  #
4831
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4832
+ #
4658
4833
  # @example Request syntax with placeholder values
4659
4834
  #
4660
4835
  # resp = client.describe_matchmaking_rule_sets({
@@ -4681,9 +4856,9 @@ module Aws::GameLift
4681
4856
  req.send_request(options)
4682
4857
  end
4683
4858
 
4684
- # Retrieves properties for one or more player sessions. This action can
4685
- # be used in several ways: (1) provide a `PlayerSessionId` to request
4686
- # 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
4687
4862
  # `GameSessionId` to request properties for all player sessions in the
4688
4863
  # specified game session; (3) provide a `PlayerId` to request properties
4689
4864
  # for all player sessions of a specified player.
@@ -4746,15 +4921,17 @@ module Aws::GameLift
4746
4921
  #
4747
4922
  # @option params [String] :next_token
4748
4923
  # Token that indicates the start of the next sequential page of results.
4749
- # Use the token that is returned with a previous call to this action. To
4750
- # start at the beginning of the result set, do not specify a value. If a
4751
- # 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.
4752
4927
  #
4753
4928
  # @return [Types::DescribePlayerSessionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4754
4929
  #
4755
4930
  # * {Types::DescribePlayerSessionsOutput#player_sessions #player_sessions} => Array&lt;Types::PlayerSession&gt;
4756
4931
  # * {Types::DescribePlayerSessionsOutput#next_token #next_token} => String
4757
4932
  #
4933
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4934
+ #
4758
4935
  # @example Request syntax with placeholder values
4759
4936
  #
4760
4937
  # resp = client.describe_player_sessions({
@@ -4881,7 +5058,7 @@ module Aws::GameLift
4881
5058
  # is returned for the fleet.
4882
5059
  #
4883
5060
  # A fleet may have all of its scaling policies suspended
4884
- # (StopFleetActions). This action does not affect the status of the
5061
+ # (StopFleetActions). This operation does not affect the status of the
4885
5062
  # scaling policies, which remains ACTIVE. To see whether a fleet's
4886
5063
  # scaling policies are in force or suspended, call
4887
5064
  # DescribeFleetAttributes and check the stopped actions.
@@ -4937,14 +5114,16 @@ module Aws::GameLift
4937
5114
  #
4938
5115
  # @option params [String] :next_token
4939
5116
  # Token that indicates the start of the next sequential page of results.
4940
- # Use the token that is returned with a previous call to this action. To
4941
- # 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.
4942
5119
  #
4943
5120
  # @return [Types::DescribeScalingPoliciesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4944
5121
  #
4945
5122
  # * {Types::DescribeScalingPoliciesOutput#scaling_policies #scaling_policies} => Array&lt;Types::ScalingPolicy&gt;
4946
5123
  # * {Types::DescribeScalingPoliciesOutput#next_token #next_token} => String
4947
5124
  #
5125
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5126
+ #
4948
5127
  # @example Request syntax with placeholder values
4949
5128
  #
4950
5129
  # resp = client.describe_scaling_policies({
@@ -5209,7 +5388,7 @@ module Aws::GameLift
5209
5388
  # an SSH client. The private key must be saved in the proper format to a
5210
5389
  # `.pem` file before using. If you're making this request using the AWS
5211
5390
  # CLI, saving the secret can be handled as part of the GetInstanceAccess
5212
- # request, as shown in one of the examples for this action.
5391
+ # request, as shown in one of the examples for this operation.
5213
5392
  #
5214
5393
  # To request access to a specific instance, specify the IDs of both the
5215
5394
  # instance and the fleet it belongs to. You can retrieve a fleet's
@@ -5320,14 +5499,16 @@ module Aws::GameLift
5320
5499
  # @option params [String] :next_token
5321
5500
  # A token that indicates the start of the next sequential page of
5322
5501
  # results. Use the token that is returned with a previous call to this
5323
- # action. To start at the beginning of the result set, do not specify a
5324
- # value.
5502
+ # operation. To start at the beginning of the result set, do not specify
5503
+ # a value.
5325
5504
  #
5326
5505
  # @return [Types::ListAliasesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5327
5506
  #
5328
5507
  # * {Types::ListAliasesOutput#aliases #aliases} => Array&lt;Types::Alias&gt;
5329
5508
  # * {Types::ListAliasesOutput#next_token #next_token} => String
5330
5509
  #
5510
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5511
+ #
5331
5512
  # @example Request syntax with placeholder values
5332
5513
  #
5333
5514
  # resp = client.list_aliases({
@@ -5412,14 +5593,16 @@ module Aws::GameLift
5412
5593
  #
5413
5594
  # @option params [String] :next_token
5414
5595
  # Token that indicates the start of the next sequential page of results.
5415
- # Use the token that is returned with a previous call to this action. To
5416
- # 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.
5417
5598
  #
5418
5599
  # @return [Types::ListBuildsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5419
5600
  #
5420
5601
  # * {Types::ListBuildsOutput#builds #builds} => Array&lt;Types::Build&gt;
5421
5602
  # * {Types::ListBuildsOutput#next_token #next_token} => String
5422
5603
  #
5604
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5605
+ #
5423
5606
  # @example Request syntax with placeholder values
5424
5607
  #
5425
5608
  # resp = client.list_builds({
@@ -5499,14 +5682,16 @@ module Aws::GameLift
5499
5682
  #
5500
5683
  # @option params [String] :next_token
5501
5684
  # Token that indicates the start of the next sequential page of results.
5502
- # Use the token that is returned with a previous call to this action. To
5503
- # 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.
5504
5687
  #
5505
5688
  # @return [Types::ListFleetsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5506
5689
  #
5507
5690
  # * {Types::ListFleetsOutput#fleet_ids #fleet_ids} => Array&lt;String&gt;
5508
5691
  # * {Types::ListFleetsOutput#next_token #next_token} => String
5509
5692
  #
5693
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5694
+ #
5510
5695
  # @example Request syntax with placeholder values
5511
5696
  #
5512
5697
  # resp = client.list_fleets({
@@ -5531,12 +5716,12 @@ module Aws::GameLift
5531
5716
  req.send_request(options)
5532
5717
  end
5533
5718
 
5534
- # **This action is part of Amazon GameLift FleetIQ with game server
5535
- # 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.**
5536
5721
  #
5537
5722
  # Retrieves information on all game servers groups that exist in the
5538
- # current AWS account for the selected region. Use the pagination
5539
- # 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.
5540
5725
  #
5541
5726
  # **Learn more**
5542
5727
  #
@@ -5558,25 +5743,29 @@ module Aws::GameLift
5558
5743
  #
5559
5744
  # * SuspendGameServerGroup
5560
5745
  #
5746
+ # * DescribeGameServerInstances
5747
+ #
5561
5748
  #
5562
5749
  #
5563
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
5750
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
5564
5751
  #
5565
5752
  # @option params [Integer] :limit
5566
5753
  # The maximum number of results to return. Use this parameter with
5567
- # `NextToken` to get results as a set of sequential pages.
5754
+ # `NextToken` to get results as a set of sequential segments.
5568
5755
  #
5569
5756
  # @option params [String] :next_token
5570
- # A token that indicates the start of the next sequential page of
5571
- # results. Use the token that is returned with a previous call to this
5572
- # action. To start at the beginning of the result set, do not specify a
5573
- # 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.
5574
5761
  #
5575
5762
  # @return [Types::ListGameServerGroupsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5576
5763
  #
5577
5764
  # * {Types::ListGameServerGroupsOutput#game_server_groups #game_server_groups} => Array&lt;Types::GameServerGroup&gt;
5578
5765
  # * {Types::ListGameServerGroupsOutput#next_token #next_token} => String
5579
5766
  #
5767
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5768
+ #
5580
5769
  # @example Request syntax with placeholder values
5581
5770
  #
5582
5771
  # resp = client.list_game_server_groups({
@@ -5593,7 +5782,7 @@ module Aws::GameLift
5593
5782
  # resp.game_server_groups[0].instance_definitions #=> Array
5594
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"
5595
5784
  # resp.game_server_groups[0].instance_definitions[0].weighted_capacity #=> String
5596
- # 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"
5597
5786
  # resp.game_server_groups[0].game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
5598
5787
  # resp.game_server_groups[0].auto_scaling_group_arn #=> String
5599
5788
  # resp.game_server_groups[0].status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
@@ -5613,14 +5802,13 @@ module Aws::GameLift
5613
5802
  req.send_request(options)
5614
5803
  end
5615
5804
 
5616
- # **This action is part of Amazon GameLift FleetIQ with game server
5617
- # 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.**
5618
5807
  #
5619
- # Retrieves information on all game servers that are currently running
5620
- # in a specified game server group. If there are custom key sort values
5621
- # for your game servers, you can opt to have the returned list sorted
5622
- # based on these values. Use the pagination parameters to retrieve
5623
- # 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.
5624
5812
  #
5625
5813
  # **Learn more**
5626
5814
  #
@@ -5642,32 +5830,36 @@ module Aws::GameLift
5642
5830
  #
5643
5831
  #
5644
5832
  #
5645
- # [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
5646
5834
  #
5647
5835
  # @option params [required, String] :game_server_group_name
5648
- # An identifier for the game server group for the game server you want
5649
- # 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.
5650
5838
  #
5651
5839
  # @option params [String] :sort_order
5652
- # Indicates how to sort the returned data based on the game servers'
5653
- # custom key sort value. If this parameter is left empty, the list of
5654
- # 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.
5655
5845
  #
5656
5846
  # @option params [Integer] :limit
5657
5847
  # The maximum number of results to return. Use this parameter with
5658
- # `NextToken` to get results as a set of sequential pages.
5848
+ # `NextToken` to get results as a set of sequential segments.
5659
5849
  #
5660
5850
  # @option params [String] :next_token
5661
- # A token that indicates the start of the next sequential page of
5662
- # results. Use the token that is returned with a previous call to this
5663
- # action. To start at the beginning of the result set, do not specify a
5664
- # 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.
5665
5855
  #
5666
5856
  # @return [Types::ListGameServersOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5667
5857
  #
5668
5858
  # * {Types::ListGameServersOutput#game_servers #game_servers} => Array&lt;Types::GameServer&gt;
5669
5859
  # * {Types::ListGameServersOutput#next_token #next_token} => String
5670
5860
  #
5861
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5862
+ #
5671
5863
  # @example Request syntax with placeholder values
5672
5864
  #
5673
5865
  # resp = client.list_game_servers({
@@ -5686,7 +5878,6 @@ module Aws::GameLift
5686
5878
  # resp.game_servers[0].instance_id #=> String
5687
5879
  # resp.game_servers[0].connection_info #=> String
5688
5880
  # resp.game_servers[0].game_server_data #=> String
5689
- # resp.game_servers[0].custom_sort_key #=> String
5690
5881
  # resp.game_servers[0].claim_status #=> String, one of "CLAIMED"
5691
5882
  # resp.game_servers[0].utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
5692
5883
  # resp.game_servers[0].registration_time #=> Time
@@ -5733,14 +5924,16 @@ module Aws::GameLift
5733
5924
  # @option params [String] :next_token
5734
5925
  # A token that indicates the start of the next sequential page of
5735
5926
  # results. Use the token that is returned with a previous call to this
5736
- # action. To start at the beginning of the result set, do not specify a
5737
- # value.
5927
+ # operation. To start at the beginning of the result set, do not specify
5928
+ # a value.
5738
5929
  #
5739
5930
  # @return [Types::ListScriptsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5740
5931
  #
5741
5932
  # * {Types::ListScriptsOutput#scripts #scripts} => Array&lt;Types::Script&gt;
5742
5933
  # * {Types::ListScriptsOutput#next_token #next_token} => String
5743
5934
  #
5935
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5936
+ #
5744
5937
  # @example Request syntax with placeholder values
5745
5938
  #
5746
5939
  # resp = client.list_scripts({
@@ -5774,7 +5967,7 @@ module Aws::GameLift
5774
5967
 
5775
5968
  # Retrieves all tags that are assigned to a GameLift resource. Resource
5776
5969
  # tags are used to organize AWS resources for a range of purposes. This
5777
- # action handles the permissions necessary to manage tags for the
5970
+ # operation handles the permissions necessary to manage tags for the
5778
5971
  # following GameLift resource types:
5779
5972
  #
5780
5973
  # * Build
@@ -5817,8 +6010,8 @@ module Aws::GameLift
5817
6010
  # The Amazon Resource Name ([ARN][1]) that is assigned to and uniquely
5818
6011
  # identifies the GameLift resource that you want to retrieve tags for.
5819
6012
  # GameLift resource ARNs are included in the data object for the
5820
- # resource, which can be retrieved by calling a List or Describe action
5821
- # for the resource type.
6013
+ # resource, which can be retrieved by calling a List or Describe
6014
+ # operation for the resource type.
5822
6015
  #
5823
6016
  #
5824
6017
  #
@@ -6086,26 +6279,26 @@ module Aws::GameLift
6086
6279
  req.send_request(options)
6087
6280
  end
6088
6281
 
6089
- # **This action is part of Amazon GameLift FleetIQ with game server
6090
- # 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.**
6091
6284
  #
6092
6285
  # Creates a new game server resource and notifies GameLift FleetIQ that
6093
- # the game server is ready to host gameplay and players. This action is
6094
- # 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
6095
6288
  # game server group. Registering game servers enables GameLift FleetIQ
6096
6289
  # to track available game servers and enables game clients and services
6097
6290
  # to claim a game server for a new game session.
6098
6291
  #
6099
6292
  # To register a game server, identify the game server group and instance
6100
6293
  # where the game server is running, and provide a unique identifier for
6101
- # the game server. You can also include connection and game server data;
6102
- # when a game client or service requests a game server by calling
6103
- # 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.
6104
6297
  #
6105
6298
  # Once a game server is successfully registered, it is put in status
6106
- # AVAILABLE. A request to register a game server may fail if the
6107
- # instance it is in the process of shutting down as part of instance
6108
- # 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.
6109
6302
  #
6110
6303
  # **Learn more**
6111
6304
  #
@@ -6127,51 +6320,33 @@ module Aws::GameLift
6127
6320
  #
6128
6321
  #
6129
6322
  #
6130
- # [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
6131
6324
  #
6132
6325
  # @option params [required, String] :game_server_group_name
6133
- # An identifier for the game server group where the game server is
6134
- # 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.
6135
6328
  #
6136
6329
  # @option params [required, String] :game_server_id
6137
- # A custom string that uniquely identifies the new game server. Game
6138
- # server IDs are developer-defined and must be unique across all game
6139
- # 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.
6140
6333
  #
6141
6334
  # @option params [required, String] :instance_id
6142
6335
  # The unique identifier for the instance where the game server is
6143
- # 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`.
6144
6338
  #
6145
6339
  # @option params [String] :connection_info
6146
- # Information needed to make inbound client connections to the game
6147
- # 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.
6148
6343
  #
6149
6344
  # @option params [String] :game_server_data
6150
6345
  # A set of custom game server properties, formatted as a single string
6151
6346
  # value. This data is passed to a game client or service when it
6152
- # requests information on a game servers using ListGameServers or
6347
+ # requests information on game servers using ListGameServers or
6153
6348
  # ClaimGameServer.
6154
6349
  #
6155
- # @option params [String] :custom_sort_key
6156
- # A game server tag that can be used to request sorted lists of game
6157
- # servers using ListGameServers. Custom sort keys are developer-defined
6158
- # based on how you want to organize the retrieved game server
6159
- # information.
6160
- #
6161
- # @option params [Array<Types::Tag>] :tags
6162
- # A list of labels to assign to the new game server resource. Tags are
6163
- # developer-defined key-value pairs. Tagging AWS resources are useful
6164
- # for resource management, access management, and cost allocation. For
6165
- # more information, see [ Tagging AWS Resources][1] in the *AWS General
6166
- # Reference*. Once the resource is created, you can use TagResource,
6167
- # UntagResource, and ListTagsForResource to add, remove, and view tags.
6168
- # The maximum tag limit may be lower than stated. See the AWS General
6169
- # Reference for actual tagging limits.
6170
- #
6171
- #
6172
- #
6173
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
6174
- #
6175
6350
  # @return [Types::RegisterGameServerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6176
6351
  #
6177
6352
  # * {Types::RegisterGameServerOutput#game_server #game_server} => Types::GameServer
@@ -6184,13 +6359,6 @@ module Aws::GameLift
6184
6359
  # instance_id: "GameServerInstanceId", # required
6185
6360
  # connection_info: "GameServerConnectionInfo",
6186
6361
  # game_server_data: "GameServerData",
6187
- # custom_sort_key: "GameServerSortKey",
6188
- # tags: [
6189
- # {
6190
- # key: "TagKey", # required
6191
- # value: "TagValue", # required
6192
- # },
6193
- # ],
6194
6362
  # })
6195
6363
  #
6196
6364
  # @example Response structure
@@ -6201,7 +6369,6 @@ module Aws::GameLift
6201
6369
  # resp.game_server.instance_id #=> String
6202
6370
  # resp.game_server.connection_info #=> String
6203
6371
  # resp.game_server.game_server_data #=> String
6204
- # resp.game_server.custom_sort_key #=> String
6205
6372
  # resp.game_server.claim_status #=> String, one of "CLAIMED"
6206
6373
  # resp.game_server.utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
6207
6374
  # resp.game_server.registration_time #=> Time
@@ -6323,19 +6490,21 @@ module Aws::GameLift
6323
6490
  req.send_request(options)
6324
6491
  end
6325
6492
 
6326
- # **This action is part of Amazon GameLift FleetIQ with game server
6327
- # 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.**
6328
6495
  #
6329
6496
  # Reinstates activity on a game server group after it has been
6330
- # suspended. A game server group may be suspended by calling
6331
- # SuspendGameServerGroup, or it may have been involuntarily suspended
6332
- # due to a configuration problem. You can manually resume activity on
6333
- # the group once the configuration problem has been resolved. Refer to
6334
- # the game server group status and status reason for more information on
6335
- # 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.
6336
6503
  #
6337
6504
  # To resume activity, specify a game server group ARN and the type of
6338
- # 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`.
6339
6508
  #
6340
6509
  # **Learn more**
6341
6510
  #
@@ -6357,16 +6526,18 @@ module Aws::GameLift
6357
6526
  #
6358
6527
  # * SuspendGameServerGroup
6359
6528
  #
6529
+ # * DescribeGameServerInstances
6360
6530
  #
6361
6531
  #
6362
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
6532
+ #
6533
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
6363
6534
  #
6364
6535
  # @option params [required, String] :game_server_group_name
6365
- # The unique identifier of the game server group to resume activity on.
6366
- # 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.
6367
6538
  #
6368
6539
  # @option params [required, Array<String>] :resume_actions
6369
- # The action to resume for this game server group.
6540
+ # The activity to resume for this game server group.
6370
6541
  #
6371
6542
  # @return [Types::ResumeGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6372
6543
  #
@@ -6387,7 +6558,7 @@ module Aws::GameLift
6387
6558
  # resp.game_server_group.instance_definitions #=> Array
6388
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"
6389
6560
  # resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
6390
- # 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"
6391
6562
  # resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
6392
6563
  # resp.game_server_group.auto_scaling_group_arn #=> String
6393
6564
  # resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
@@ -6566,14 +6737,16 @@ module Aws::GameLift
6566
6737
  #
6567
6738
  # @option params [String] :next_token
6568
6739
  # Token that indicates the start of the next sequential page of results.
6569
- # Use the token that is returned with a previous call to this action. To
6570
- # 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.
6571
6742
  #
6572
6743
  # @return [Types::SearchGameSessionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6573
6744
  #
6574
6745
  # * {Types::SearchGameSessionsOutput#game_sessions #game_sessions} => Array&lt;Types::GameSession&gt;
6575
6746
  # * {Types::SearchGameSessionsOutput#next_token #next_token} => String
6576
6747
  #
6748
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
6749
+ #
6577
6750
  # @example Request syntax with placeholder values
6578
6751
  #
6579
6752
  # resp = client.search_game_sessions({
@@ -7022,26 +7195,13 @@ module Aws::GameLift
7022
7195
  # matchmaking configuration, and include the players to be matched. You
7023
7196
  # must also include a set of player attributes relevant for the
7024
7197
  # matchmaking configuration. If successful, a matchmaking ticket is
7025
- # returned with status set to `QUEUED`. Track the status of the ticket
7026
- # to respond as needed and acquire game session connection information
7027
- # for successfully completed matches.
7028
- #
7029
- # **Tracking ticket status** -- A couple of options are available for
7030
- # tracking the status of matchmaking requests:
7031
- #
7032
- # * Polling -- Call `DescribeMatchmaking`. This operation returns the
7033
- # full ticket object, including current status and (for completed
7034
- # tickets) game session connection info. We recommend polling no more
7035
- # than once every 10 seconds.
7036
- #
7037
- # * Notifications -- Get event notifications for changes in ticket
7038
- # status using Amazon Simple Notification Service (SNS). Notifications
7039
- # are easy to set up (see CreateMatchmakingConfiguration) and
7040
- # typically deliver match status changes faster and more efficiently
7041
- # than polling. We recommend that you use polling to back up to
7042
- # notifications (since delivery is not guaranteed) and call
7043
- # `DescribeMatchmaking` only when notifications are not received
7044
- # 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.
7045
7205
  #
7046
7206
  # **Processing a matchmaking request** -- FlexMatch handles a
7047
7207
  # matchmaking request as follows:
@@ -7322,7 +7482,7 @@ module Aws::GameLift
7322
7482
  # The ticket ID is included in the `MatchmakerData` of an updated game
7323
7483
  # session object, which is provided to the game server.
7324
7484
  #
7325
- # <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
7326
7486
  # struct with the HTTP 200 response (not an empty HTTP body).
7327
7487
  #
7328
7488
  # </note>
@@ -7367,27 +7527,28 @@ module Aws::GameLift
7367
7527
  req.send_request(options)
7368
7528
  end
7369
7529
 
7370
- # **This action is part of Amazon GameLift FleetIQ with game server
7371
- # 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.**
7372
7532
  #
7373
7533
  # Temporarily stops activity on a game server group without terminating
7374
- # instances or the game server group. Activity can be restarted by
7375
- # calling ResumeGameServerGroup. Activities that can suspended are:
7376
- #
7377
- # * Instance type replacement. This activity evaluates the current Spot
7378
- # viability of all instance types that are defined for the game server
7379
- # group. It updates the Auto Scaling group to remove nonviable Spot
7380
- # instance types (which have a higher chance of game server
7381
- # interruptions) and rebalances capacity across the remaining viable
7382
- # Spot instance types. When this activity is suspended, the Auto
7383
- # Scaling group continues with its current balance, regardless of
7384
- # viability. Instance protection, utilization metrics, and capacity
7385
- # 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.
7386
7546
  #
7387
7547
  # ^
7388
7548
  #
7389
7549
  # To suspend activity, specify a game server group ARN and the type of
7390
- # 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`.
7391
7552
  #
7392
7553
  # **Learn more**
7393
7554
  #
@@ -7409,16 +7570,18 @@ module Aws::GameLift
7409
7570
  #
7410
7571
  # * SuspendGameServerGroup
7411
7572
  #
7573
+ # * DescribeGameServerInstances
7574
+ #
7412
7575
  #
7413
7576
  #
7414
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
7577
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
7415
7578
  #
7416
7579
  # @option params [required, String] :game_server_group_name
7417
- # The unique identifier of the game server group to stop activity on.
7418
- # 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.
7419
7582
  #
7420
7583
  # @option params [required, Array<String>] :suspend_actions
7421
- # The action to suspend for this game server group.
7584
+ # The activity to suspend for this game server group.
7422
7585
  #
7423
7586
  # @return [Types::SuspendGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7424
7587
  #
@@ -7439,7 +7602,7 @@ module Aws::GameLift
7439
7602
  # resp.game_server_group.instance_definitions #=> Array
7440
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"
7441
7604
  # resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
7442
- # 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"
7443
7606
  # resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
7444
7607
  # resp.game_server_group.auto_scaling_group_arn #=> String
7445
7608
  # resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
@@ -7461,9 +7624,9 @@ module Aws::GameLift
7461
7624
  # Assigns a tag to a GameLift resource. AWS resource tags provide an
7462
7625
  # additional management tool set. You can use tags to organize
7463
7626
  # resources, create IAM permissions policies to manage access to groups
7464
- # of resources, customize AWS cost breakdowns, etc. This action handles
7465
- # the permissions necessary to manage tags for the following GameLift
7466
- # 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:
7467
7630
  #
7468
7631
  # * Build
7469
7632
  #
@@ -7507,8 +7670,8 @@ module Aws::GameLift
7507
7670
  # The Amazon Resource Name ([ARN][1]) that is assigned to and uniquely
7508
7671
  # identifies the GameLift resource that you want to assign tags to.
7509
7672
  # GameLift resource ARNs are included in the data object for the
7510
- # resource, which can be retrieved by calling a List or Describe action
7511
- # for the resource type.
7673
+ # resource, which can be retrieved by calling a List or Describe
7674
+ # operation for the resource type.
7512
7675
  #
7513
7676
  #
7514
7677
  #
@@ -7549,7 +7712,7 @@ module Aws::GameLift
7549
7712
 
7550
7713
  # Removes a tag that is assigned to a GameLift resource. Resource tags
7551
7714
  # are used to organize AWS resources for a range of purposes. This
7552
- # action handles the permissions necessary to manage tags for the
7715
+ # operation handles the permissions necessary to manage tags for the
7553
7716
  # following GameLift resource types:
7554
7717
  #
7555
7718
  # * Build
@@ -7568,8 +7731,8 @@ module Aws::GameLift
7568
7731
  #
7569
7732
  # To remove a tag from a resource, specify the unique ARN value for the
7570
7733
  # resource and provide a string list containing one or more tags to be
7571
- # removed. This action succeeds even if the list includes tags that are
7572
- # 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.
7573
7736
  #
7574
7737
  # **Learn more**
7575
7738
  #
@@ -7594,8 +7757,8 @@ module Aws::GameLift
7594
7757
  # The Amazon Resource Name ([ARN][1]) that is assigned to and uniquely
7595
7758
  # identifies the GameLift resource that you want to remove tags from.
7596
7759
  # GameLift resource ARNs are included in the data object for the
7597
- # resource, which can be retrieved by calling a List or Describe action
7598
- # for the resource type.
7760
+ # resource, which can be retrieved by calling a List or Describe
7761
+ # operation for the resource type.
7599
7762
  #
7600
7763
  #
7601
7764
  #
@@ -7862,9 +8025,9 @@ module Aws::GameLift
7862
8025
  req.send_request(options)
7863
8026
  end
7864
8027
 
7865
- # Updates capacity settings for a fleet. Use this action to specify the
7866
- # number of EC2 instances (hosts) that you want this fleet to contain.
7867
- # 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
7868
8031
  # DescribeEC2InstanceLimits to get the maximum capacity based on the
7869
8032
  # fleet's EC2 instance type.
7870
8033
  #
@@ -8040,18 +8203,17 @@ module Aws::GameLift
8040
8203
  req.send_request(options)
8041
8204
  end
8042
8205
 
8043
- # **This action is part of Amazon GameLift FleetIQ with game server
8044
- # groups, which is in preview release and is subject to change.**
8045
- #
8046
- # Updates information about a registered game server. This action is
8047
- # called by a game server process that is running on an instance in a
8048
- # game server group. There are three reasons to update game server
8049
- # information: (1) to change the utilization status of the game server,
8050
- # (2) to report game server health status, and (3) to change game server
8051
- # metadata. A registered game server should regularly report health and
8052
- # should update utilization status when it is supporting gameplay so
8053
- # that GameLift FleetIQ can accurately track game server availability.
8054
- # 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:
8055
8217
  #
8056
8218
  # * To update the game server's utilization status, identify the game
8057
8219
  # server and game server group and specify the current utilization
@@ -8059,14 +8221,14 @@ module Aws::GameLift
8059
8221
  # hosting games and when they are available to be claimed.
8060
8222
  #
8061
8223
  # * To report health status, identify the game server and game server
8062
- # 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
8063
8225
  # report health status for a certain length of time, the game server
8064
- # is no longer considered healthy and will be eventually de-registered
8065
- # from the game server group to avoid affecting utilization metrics.
8066
- # 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.
8067
8230
  #
8068
- # * To change game server metadata, provide updated game server data and
8069
- # custom sort key values.
8231
+ # * To change game server metadata, provide updated game server data.
8070
8232
  #
8071
8233
  # Once a game server is successfully updated, the relevant statuses and
8072
8234
  # timestamps are updated.
@@ -8091,35 +8253,29 @@ module Aws::GameLift
8091
8253
  #
8092
8254
  #
8093
8255
  #
8094
- # [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
8095
8257
  #
8096
8258
  # @option params [required, String] :game_server_group_name
8097
- # 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
8098
8260
  # running. Use either the GameServerGroup name or ARN value.
8099
8261
  #
8100
8262
  # @option params [required, String] :game_server_id
8101
- # The identifier for the game server to be updated.
8263
+ # A custom string that uniquely identifies the game server to update.
8102
8264
  #
8103
8265
  # @option params [String] :game_server_data
8104
8266
  # A set of custom game server properties, formatted as a single string
8105
8267
  # value. This data is passed to a game client or service when it
8106
- # requests information on a game servers using DescribeGameServer or
8268
+ # requests information on game servers using ListGameServers or
8107
8269
  # ClaimGameServer.
8108
8270
  #
8109
- # @option params [String] :custom_sort_key
8110
- # A game server tag that can be used to request sorted lists of game
8111
- # servers using ListGameServers. Custom sort keys are developer-defined
8112
- # based on how you want to organize the retrieved game server
8113
- # information.
8114
- #
8115
8271
  # @option params [String] :utilization_status
8116
8272
  # Indicates whether the game server is available or is currently hosting
8117
8273
  # gameplay.
8118
8274
  #
8119
8275
  # @option params [String] :health_check
8120
- # Indicates health status of the game server. An update that explicitly
8121
- # includes this parameter updates the game server's
8122
- # *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.
8123
8279
  #
8124
8280
  # @return [Types::UpdateGameServerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
8125
8281
  #
@@ -8131,7 +8287,6 @@ module Aws::GameLift
8131
8287
  # game_server_group_name: "GameServerGroupNameOrArn", # required
8132
8288
  # game_server_id: "GameServerId", # required
8133
8289
  # game_server_data: "GameServerData",
8134
- # custom_sort_key: "GameServerSortKey",
8135
8290
  # utilization_status: "AVAILABLE", # accepts AVAILABLE, UTILIZED
8136
8291
  # health_check: "HEALTHY", # accepts HEALTHY
8137
8292
  # })
@@ -8144,7 +8299,6 @@ module Aws::GameLift
8144
8299
  # resp.game_server.instance_id #=> String
8145
8300
  # resp.game_server.connection_info #=> String
8146
8301
  # resp.game_server.game_server_data #=> String
8147
- # resp.game_server.custom_sort_key #=> String
8148
8302
  # resp.game_server.claim_status #=> String, one of "CLAIMED"
8149
8303
  # resp.game_server.utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
8150
8304
  # resp.game_server.registration_time #=> Time
@@ -8160,29 +8314,24 @@ module Aws::GameLift
8160
8314
  req.send_request(options)
8161
8315
  end
8162
8316
 
8163
- # **This action is part of Amazon GameLift FleetIQ with game server
8164
- # 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.**
8165
8319
  #
8166
8320
  # Updates GameLift FleetIQ-specific properties for a game server group.
8167
- # These properties include instance rebalancing and game server
8168
- # protection. Many Auto Scaling group properties are updated directly.
8169
- # These include autoscaling policies, minimum/maximum/desired instance
8170
- # 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.
8171
8324
  #
8172
8325
  # To update the game server group, specify the game server group ID and
8173
- # provide the updated values.
8174
- #
8175
- # Updated properties are validated to ensure that GameLift FleetIQ can
8176
- # continue to perform its core instance rebalancing activity. When you
8177
- # change Auto Scaling group properties directly and the changes cause
8178
- # 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.
8179
8330
  #
8180
8331
  # **Learn more**
8181
8332
  #
8182
8333
  # [GameLift FleetIQ Guide][1]
8183
8334
  #
8184
- # [Updating a GameLift FleetIQ-Linked Auto Scaling Group][2]
8185
- #
8186
8335
  # **Related operations**
8187
8336
  #
8188
8337
  # * CreateGameServerGroup
@@ -8199,64 +8348,75 @@ module Aws::GameLift
8199
8348
  #
8200
8349
  # * SuspendGameServerGroup
8201
8350
  #
8351
+ # * DescribeGameServerInstances
8202
8352
  #
8203
8353
  #
8204
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
8205
- # [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
8206
8356
  #
8207
8357
  # @option params [required, String] :game_server_group_name
8208
- # The unique identifier of the game server group to update. Use either
8209
- # the GameServerGroup name or ARN value.
8358
+ # A unique identifier for the game server group. Use either the
8359
+ # GameServerGroup name or ARN value.
8210
8360
  #
8211
8361
  # @option params [String] :role_arn
8212
8362
  # The Amazon Resource Name ([ARN][1]) for an IAM role that allows Amazon
8213
- # GameLift to access your EC2 Auto Scaling groups. The submitted role is
8214
- # validated to ensure that it contains the necessary permissions for
8215
- # game server groups.
8363
+ # GameLift to access your EC2 Auto Scaling groups.
8216
8364
  #
8217
8365
  #
8218
8366
  #
8219
8367
  # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
8220
8368
  #
8221
8369
  # @option params [Array<Types::InstanceDefinition>] :instance_definitions
8222
- # An updated list of EC2 instance types to use when creating instances
8223
- # in the group. The instance definition must specify instance types that
8224
- # are supported by GameLift FleetIQ, and must include at least two
8225
- # instance types. This updated list replaces the entire current list of
8226
- # instance definitions for the game server group. For more information
8227
- # on instance types, see [EC2 Instance Types][1] in the *Amazon EC2 User
8228
- # 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.
8229
8381
  #
8230
8382
  #
8231
8383
  #
8232
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
8233
8386
  #
8234
8387
  # @option params [String] :game_server_protection_policy
8235
8388
  # A flag that indicates whether instances in the game server group are
8236
8389
  # protected from early termination. Unprotected instances that have
8237
- # active game servers running may by terminated during a scale-down
8390
+ # active game servers running might be terminated during a scale-down
8238
8391
  # event, causing players to be dropped from the game. Protected
8239
8392
  # instances cannot be terminated while there are active game servers
8240
- # 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
8241
8395
  # terminated by AWS regardless of protection status. This property is
8242
- # set to NO\_PROTECTION by default.
8396
+ # set to `NO_PROTECTION` by default.
8243
8397
  #
8244
8398
  # @option params [String] :balancing_strategy
8245
- # The fallback balancing method to use for the game server group when
8246
- # Spot instances in a Region become unavailable or are not viable for
8247
- # game hosting. Once triggered, this method remains active until Spot
8248
- # instances can once again be used. Method options include:
8249
- #
8250
- # * SPOT\_ONLY -- If Spot instances are unavailable, the game server
8251
- # group provides no hosting capacity. No new instances are started,
8252
- # and the existing nonviable Spot instances are terminated (once
8253
- # current gameplay ends) and not replaced.
8254
- #
8255
- # * SPOT\_PREFERRED -- If Spot instances are unavailable, the game
8256
- # server group continues to provide hosting capacity by using
8257
- # On-Demand instances. Existing nonviable Spot instances are
8258
- # terminated (once current gameplay ends) and replaced with new
8259
- # 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.
8260
8420
  #
8261
8421
  # @return [Types::UpdateGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
8262
8422
  #
@@ -8274,7 +8434,7 @@ module Aws::GameLift
8274
8434
  # },
8275
8435
  # ],
8276
8436
  # game_server_protection_policy: "NO_PROTECTION", # accepts NO_PROTECTION, FULL_PROTECTION
8277
- # balancing_strategy: "SPOT_ONLY", # accepts SPOT_ONLY, SPOT_PREFERRED
8437
+ # balancing_strategy: "SPOT_ONLY", # accepts SPOT_ONLY, SPOT_PREFERRED, ON_DEMAND_ONLY
8278
8438
  # })
8279
8439
  #
8280
8440
  # @example Response structure
@@ -8285,7 +8445,7 @@ module Aws::GameLift
8285
8445
  # resp.game_server_group.instance_definitions #=> Array
8286
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"
8287
8447
  # resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
8288
- # 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"
8289
8449
  # resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
8290
8450
  # resp.game_server_group.auto_scaling_group_arn #=> String
8291
8451
  # resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
@@ -8837,7 +8997,7 @@ module Aws::GameLift
8837
8997
  # the zip file; if you have S3 object versioning turned on, you can use
8838
8998
  # the `ObjectVersion` parameter to specify an earlier version.
8839
8999
  #
8840
- # @option params [String, IO] :zip_file
9000
+ # @option params [String, StringIO, File] :zip_file
8841
9001
  # A data object containing your Realtime scripts and dependencies as a
8842
9002
  # zip file. The zip file can have one or multiple files. Maximum size of
8843
9003
  # a zip file is 5 MB.
@@ -8961,7 +9121,7 @@ module Aws::GameLift
8961
9121
  params: params,
8962
9122
  config: config)
8963
9123
  context[:gem_name] = 'aws-sdk-gamelift'
8964
- context[:gem_version] = '1.31.0'
9124
+ context[:gem_version] = '1.36.0'
8965
9125
  Seahorse::Client::Request.new(handlers, context)
8966
9126
  end
8967
9127