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