aws-sdk-gamelift 1.27.0 → 1.32.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/lib/aws-sdk-gamelift.rb +7 -4
- data/lib/aws-sdk-gamelift/client.rb +1818 -390
- data/lib/aws-sdk-gamelift/client_api.rb +456 -54
- data/lib/aws-sdk-gamelift/errors.rb +51 -13
- data/lib/aws-sdk-gamelift/resource.rb +1 -0
- data/lib/aws-sdk-gamelift/types.rb +1368 -150
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 61b45f81b1dc47300f8ad1b7e5eb9303dcf6ed1ed3e2fe58839b42c72d9e2923
|
4
|
+
data.tar.gz: 7ce7f68844772afa503caaaad65dae6d35176d9b1c285df3399b9be32fa748e8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: eb3c926be3e44a82d78bfb7ed16e006bc9dd784371a077bd80ee6f66987ea8af9e79f573fbd9d49f444271024ecf2b85e683026881986c8eb52847c19e8f3cd6
|
7
|
+
data.tar.gz: 797bf813186a2d4ba4130ce5c14a2151e90d2f13bbb016b2c1280bf568d22fb2af55347c72d6da1c4c07d9ef0aba2b6bd2d9dd7ac6392ae4c48d02aa9e694bc7
|
data/lib/aws-sdk-gamelift.rb
CHANGED
@@ -24,17 +24,20 @@ require_relative 'aws-sdk-gamelift/customizations'
|
|
24
24
|
# methods each accept a hash of request parameters and return a response
|
25
25
|
# structure.
|
26
26
|
#
|
27
|
+
# game_lift = Aws::GameLift::Client.new
|
28
|
+
# resp = game_lift.accept_match(params)
|
29
|
+
#
|
27
30
|
# See {Client} for more information.
|
28
31
|
#
|
29
32
|
# # Errors
|
30
33
|
#
|
31
|
-
# Errors returned from Amazon GameLift
|
32
|
-
# extend {Errors::ServiceError}.
|
34
|
+
# Errors returned from Amazon GameLift are defined in the
|
35
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
33
36
|
#
|
34
37
|
# begin
|
35
38
|
# # do stuff
|
36
39
|
# rescue Aws::GameLift::Errors::ServiceError
|
37
|
-
# # rescues all
|
40
|
+
# # rescues all Amazon GameLift API errors
|
38
41
|
# end
|
39
42
|
#
|
40
43
|
# See {Errors} for more information.
|
@@ -42,6 +45,6 @@ require_relative 'aws-sdk-gamelift/customizations'
|
|
42
45
|
# @service
|
43
46
|
module Aws::GameLift
|
44
47
|
|
45
|
-
GEM_VERSION = '1.
|
48
|
+
GEM_VERSION = '1.32.1'
|
46
49
|
|
47
50
|
end
|
@@ -24,12 +24,25 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
|
24
24
|
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
25
25
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
26
26
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
27
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
27
28
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
28
29
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
29
30
|
|
30
31
|
Aws::Plugins::GlobalConfiguration.add_identifier(:gamelift)
|
31
32
|
|
32
33
|
module Aws::GameLift
|
34
|
+
# An API client for GameLift. To construct a client, you need to configure a `:region` and `:credentials`.
|
35
|
+
#
|
36
|
+
# client = Aws::GameLift::Client.new(
|
37
|
+
# region: region_name,
|
38
|
+
# credentials: credentials,
|
39
|
+
# # ...
|
40
|
+
# )
|
41
|
+
#
|
42
|
+
# For details on configuring region and credentials see
|
43
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
44
|
+
#
|
45
|
+
# See {#initialize} for a full list of supported configuration options.
|
33
46
|
class Client < Seahorse::Client::Base
|
34
47
|
|
35
48
|
include Aws::ClientStubs
|
@@ -57,6 +70,7 @@ module Aws::GameLift
|
|
57
70
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
58
71
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
59
72
|
add_plugin(Aws::Plugins::TransferEncoding)
|
73
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
60
74
|
add_plugin(Aws::Plugins::SignatureV4)
|
61
75
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
62
76
|
|
@@ -93,7 +107,7 @@ module Aws::GameLift
|
|
93
107
|
# @option options [required, String] :region
|
94
108
|
# The AWS region to connect to. The configured `:region` is
|
95
109
|
# used to determine the service `:endpoint`. When not passed,
|
96
|
-
# a default `:region` is
|
110
|
+
# a default `:region` is searched for in the following locations:
|
97
111
|
#
|
98
112
|
# * `Aws.config[:region]`
|
99
113
|
# * `ENV['AWS_REGION']`
|
@@ -108,6 +122,12 @@ module Aws::GameLift
|
|
108
122
|
# When set to `true`, a thread polling for endpoints will be running in
|
109
123
|
# the background every 60 secs (default). Defaults to `false`.
|
110
124
|
#
|
125
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
126
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
127
|
+
# until there is sufficent client side capacity to retry the request.
|
128
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
129
|
+
# not retry instead of sleeping.
|
130
|
+
#
|
111
131
|
# @option options [Boolean] :client_side_monitoring (false)
|
112
132
|
# When `true`, client-side metrics will be collected for all API requests from
|
113
133
|
# this client.
|
@@ -132,6 +152,10 @@ module Aws::GameLift
|
|
132
152
|
# When `true`, an attempt is made to coerce request parameters into
|
133
153
|
# the required types.
|
134
154
|
#
|
155
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
156
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
157
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
158
|
+
#
|
135
159
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
136
160
|
# Set to true to disable SDK automatically adding host prefix
|
137
161
|
# to default service endpoint when available.
|
@@ -139,7 +163,7 @@ module Aws::GameLift
|
|
139
163
|
# @option options [String] :endpoint
|
140
164
|
# The client endpoint is normally constructed from the `:region`
|
141
165
|
# option. You should only configure an `:endpoint` when connecting
|
142
|
-
# to test endpoints. This should be
|
166
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
143
167
|
#
|
144
168
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
145
169
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -154,7 +178,7 @@ module Aws::GameLift
|
|
154
178
|
# requests fetching endpoints information. Defaults to 60 sec.
|
155
179
|
#
|
156
180
|
# @option options [Boolean] :endpoint_discovery (false)
|
157
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
181
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
158
182
|
#
|
159
183
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
160
184
|
# The log formatter.
|
@@ -166,15 +190,29 @@ module Aws::GameLift
|
|
166
190
|
# The Logger instance to send log messages to. If this option
|
167
191
|
# is not set, logging will be disabled.
|
168
192
|
#
|
193
|
+
# @option options [Integer] :max_attempts (3)
|
194
|
+
# An integer representing the maximum number attempts that will be made for
|
195
|
+
# a single request, including the initial attempt. For example,
|
196
|
+
# setting this value to 5 will result in a request being retried up to
|
197
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
198
|
+
#
|
169
199
|
# @option options [String] :profile ("default")
|
170
200
|
# Used when loading credentials from the shared credentials file
|
171
201
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
172
202
|
#
|
203
|
+
# @option options [Proc] :retry_backoff
|
204
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
205
|
+
# This option is only used in the `legacy` retry mode.
|
206
|
+
#
|
173
207
|
# @option options [Float] :retry_base_delay (0.3)
|
174
|
-
# The base delay in seconds used by the default backoff function.
|
208
|
+
# The base delay in seconds used by the default backoff function. This option
|
209
|
+
# is only used in the `legacy` retry mode.
|
175
210
|
#
|
176
211
|
# @option options [Symbol] :retry_jitter (:none)
|
177
|
-
# A delay randomiser function used by the default backoff function.
|
212
|
+
# A delay randomiser function used by the default backoff function.
|
213
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
214
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
215
|
+
# in the `legacy` retry mode.
|
178
216
|
#
|
179
217
|
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
180
218
|
#
|
@@ -182,11 +220,30 @@ module Aws::GameLift
|
|
182
220
|
# The maximum number of times to retry failed requests. Only
|
183
221
|
# ~ 500 level server errors and certain ~ 400 level client errors
|
184
222
|
# are retried. Generally, these are throttling errors, data
|
185
|
-
# checksum errors, networking errors, timeout errors
|
186
|
-
# errors from expired credentials.
|
223
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
224
|
+
# endpoint discovery, and errors from expired credentials.
|
225
|
+
# This option is only used in the `legacy` retry mode.
|
187
226
|
#
|
188
227
|
# @option options [Integer] :retry_max_delay (0)
|
189
|
-
# The maximum number of seconds to delay between retries (0 for no limit)
|
228
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
229
|
+
# used by the default backoff function. This option is only used in the
|
230
|
+
# `legacy` retry mode.
|
231
|
+
#
|
232
|
+
# @option options [String] :retry_mode ("legacy")
|
233
|
+
# Specifies which retry algorithm to use. Values are:
|
234
|
+
#
|
235
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
236
|
+
# no retry mode is provided.
|
237
|
+
#
|
238
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
239
|
+
# This includes support for retry quotas, which limit the number of
|
240
|
+
# unsuccessful retries a client can make.
|
241
|
+
#
|
242
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
243
|
+
# functionality of `standard` mode along with automatic client side
|
244
|
+
# throttling. This is a provisional mode that may change behavior
|
245
|
+
# in the future.
|
246
|
+
#
|
190
247
|
#
|
191
248
|
# @option options [String] :secret_access_key
|
192
249
|
#
|
@@ -219,16 +276,15 @@ module Aws::GameLift
|
|
219
276
|
# requests through. Formatted like 'http://proxy.com:123'.
|
220
277
|
#
|
221
278
|
# @option options [Float] :http_open_timeout (15) The number of
|
222
|
-
# seconds to wait when opening a HTTP session before
|
279
|
+
# seconds to wait when opening a HTTP session before raising a
|
223
280
|
# `Timeout::Error`.
|
224
281
|
#
|
225
282
|
# @option options [Integer] :http_read_timeout (60) The default
|
226
283
|
# number of seconds to wait for response data. This value can
|
227
|
-
# safely be set
|
228
|
-
# per-request on the session yeidled by {#session_for}.
|
284
|
+
# safely be set per-request on the session.
|
229
285
|
#
|
230
286
|
# @option options [Float] :http_idle_timeout (5) The number of
|
231
|
-
# seconds a connection is allowed to sit
|
287
|
+
# seconds a connection is allowed to sit idle before it is
|
232
288
|
# considered stale. Stale connections are closed and removed
|
233
289
|
# from the pool before making a request.
|
234
290
|
#
|
@@ -237,7 +293,7 @@ module Aws::GameLift
|
|
237
293
|
# request body. This option has no effect unless the request has
|
238
294
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
239
295
|
# disables this behaviour. This value can safely be set per
|
240
|
-
# request on the session
|
296
|
+
# request on the session.
|
241
297
|
#
|
242
298
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
243
299
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -343,6 +399,122 @@ module Aws::GameLift
|
|
343
399
|
req.send_request(options)
|
344
400
|
end
|
345
401
|
|
402
|
+
# **This action is part of Amazon GameLift FleetIQ with game server
|
403
|
+
# groups, which is in preview release and is subject to change.**
|
404
|
+
#
|
405
|
+
# Locates an available game server and temporarily reserves it to host
|
406
|
+
# gameplay and players. This action is called by a game client or client
|
407
|
+
# service (such as a matchmaker) to request hosting resources for a new
|
408
|
+
# game session. In response, GameLift FleetIQ searches for an available
|
409
|
+
# game server in the specified game server group, places the game server
|
410
|
+
# in "claimed" status for 60 seconds, and returns connection
|
411
|
+
# information back to the requester so that players can connect to the
|
412
|
+
# game server.
|
413
|
+
#
|
414
|
+
# There are two ways you can claim a game server. For the first option,
|
415
|
+
# you provide a game server group ID only, which prompts GameLift
|
416
|
+
# FleetIQ to search for an available game server in the specified group
|
417
|
+
# and claim it. With this option, GameLift FleetIQ attempts to
|
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.
|
428
|
+
#
|
429
|
+
# When a game server is successfully claimed, connection information is
|
430
|
+
# returned. A claimed game server's utilization status remains
|
431
|
+
# AVAILABLE, while the claim status is set to CLAIMED for up to 60
|
432
|
+
# seconds. This time period allows the game server to be prompted to
|
433
|
+
# update its status to UTILIZED (using UpdateGameServer). If the game
|
434
|
+
# server's status is not updated within 60 seconds, the game server
|
435
|
+
# reverts to unclaimed status and is available to be claimed by another
|
436
|
+
# request.
|
437
|
+
#
|
438
|
+
# If you try to claim a specific game server, this request will fail in
|
439
|
+
# the following cases: (1) if the game server utilization status is
|
440
|
+
# UTILIZED, (2) if the game server claim status is CLAIMED, or (3) if
|
441
|
+
# the instance that the game server is running on is flagged as
|
442
|
+
# draining.
|
443
|
+
#
|
444
|
+
# **Learn more**
|
445
|
+
#
|
446
|
+
# [GameLift FleetIQ Guide][1]
|
447
|
+
#
|
448
|
+
# **Related operations**
|
449
|
+
#
|
450
|
+
# * RegisterGameServer
|
451
|
+
#
|
452
|
+
# * ListGameServers
|
453
|
+
#
|
454
|
+
# * ClaimGameServer
|
455
|
+
#
|
456
|
+
# * DescribeGameServer
|
457
|
+
#
|
458
|
+
# * UpdateGameServer
|
459
|
+
#
|
460
|
+
# * DeregisterGameServer
|
461
|
+
#
|
462
|
+
#
|
463
|
+
#
|
464
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
|
465
|
+
#
|
466
|
+
# @option params [required, String] :game_server_group_name
|
467
|
+
# An identifier for the game server group. When claiming a specific game
|
468
|
+
# server, this is the game server group whether the game server is
|
469
|
+
# located. When requesting that GameLift FleetIQ locate an available
|
470
|
+
# game server, this is the game server group to search on. You can use
|
471
|
+
# either the GameServerGroup name or ARN value.
|
472
|
+
#
|
473
|
+
# @option params [String] :game_server_id
|
474
|
+
# A custom string that uniquely identifies the game server to claim. If
|
475
|
+
# this parameter is left empty, GameLift FleetIQ searches for an
|
476
|
+
# available game server in the specified game server group.
|
477
|
+
#
|
478
|
+
# @option params [String] :game_server_data
|
479
|
+
# A set of custom game server properties, formatted as a single string
|
480
|
+
# value, to be passed to the claimed game server.
|
481
|
+
#
|
482
|
+
# @return [Types::ClaimGameServerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
483
|
+
#
|
484
|
+
# * {Types::ClaimGameServerOutput#game_server #game_server} => Types::GameServer
|
485
|
+
#
|
486
|
+
# @example Request syntax with placeholder values
|
487
|
+
#
|
488
|
+
# resp = client.claim_game_server({
|
489
|
+
# game_server_group_name: "GameServerGroupNameOrArn", # required
|
490
|
+
# game_server_id: "GameServerId",
|
491
|
+
# game_server_data: "GameServerData",
|
492
|
+
# })
|
493
|
+
#
|
494
|
+
# @example Response structure
|
495
|
+
#
|
496
|
+
# resp.game_server.game_server_group_name #=> String
|
497
|
+
# resp.game_server.game_server_group_arn #=> String
|
498
|
+
# resp.game_server.game_server_id #=> String
|
499
|
+
# resp.game_server.instance_id #=> String
|
500
|
+
# resp.game_server.connection_info #=> String
|
501
|
+
# resp.game_server.game_server_data #=> String
|
502
|
+
# resp.game_server.custom_sort_key #=> String
|
503
|
+
# resp.game_server.claim_status #=> String, one of "CLAIMED"
|
504
|
+
# resp.game_server.utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
|
505
|
+
# resp.game_server.registration_time #=> Time
|
506
|
+
# resp.game_server.last_claim_time #=> Time
|
507
|
+
# resp.game_server.last_health_check_time #=> Time
|
508
|
+
#
|
509
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ClaimGameServer AWS API Documentation
|
510
|
+
#
|
511
|
+
# @overload claim_game_server(params = {})
|
512
|
+
# @param [Hash] params ({})
|
513
|
+
def claim_game_server(params = {}, options = {})
|
514
|
+
req = build_request(:claim_game_server, params)
|
515
|
+
req.send_request(options)
|
516
|
+
end
|
517
|
+
|
346
518
|
# Creates an alias for a fleet. In most situations, you can use an alias
|
347
519
|
# ID in place of a fleet ID. An alias provides a level of abstraction
|
348
520
|
# for a fleet that is useful when redirecting player traffic from one
|
@@ -441,49 +613,43 @@ module Aws::GameLift
|
|
441
613
|
req.send_request(options)
|
442
614
|
end
|
443
615
|
|
444
|
-
# Creates a new Amazon GameLift build
|
445
|
-
# files
|
446
|
-
#
|
447
|
-
#
|
448
|
-
# Game server binaries must be combined into a zip file for use with
|
449
|
-
# Amazon GameLift.
|
616
|
+
# Creates a new Amazon GameLift build resource for your game server
|
617
|
+
# binary files. Game server binaries must be combined into a zip file
|
618
|
+
# for use with Amazon GameLift.
|
450
619
|
#
|
451
|
-
#
|
452
|
-
# command <b> <a
|
620
|
+
# When setting up a new game build for GameLift, we recommend using the
|
621
|
+
# AWS CLI command <b> <a
|
453
622
|
# href="https://docs.aws.amazon.com/cli/latest/reference/gamelift/upload-build.html">upload-build</a>
|
454
|
-
# </b>. This helper command
|
455
|
-
#
|
456
|
-
#
|
457
|
-
#
|
458
|
-
# The `CreateBuild` operation
|
459
|
-
#
|
460
|
-
#
|
461
|
-
#
|
462
|
-
#
|
463
|
-
#
|
464
|
-
#
|
465
|
-
#
|
466
|
-
#
|
467
|
-
#
|
468
|
-
#
|
469
|
-
#
|
470
|
-
#
|
471
|
-
#
|
472
|
-
#
|
473
|
-
#
|
474
|
-
#
|
475
|
-
#
|
476
|
-
#
|
477
|
-
#
|
478
|
-
# DescribeBuild to check the status of your build. A build must be in
|
479
|
-
# `READY` status before it can be used to create fleets.
|
623
|
+
# </b>. This helper command combines two tasks: (1) it uploads your
|
624
|
+
# build files from a file directory to a GameLift Amazon S3 location,
|
625
|
+
# and (2) it creates a new build resource.
|
626
|
+
#
|
627
|
+
# The `CreateBuild` operation can used in the following scenarios:
|
628
|
+
#
|
629
|
+
# * To create a new game build with build files that are in an S3
|
630
|
+
# location under an AWS account that you control. To use this option,
|
631
|
+
# you must first give Amazon GameLift access to the S3 bucket. With
|
632
|
+
# permissions in place, call `CreateBuild` and specify a build name,
|
633
|
+
# operating system, and the S3 storage location of your game build.
|
634
|
+
#
|
635
|
+
# * To directly upload your build files to a GameLift S3 location. To
|
636
|
+
# use this option, first call `CreateBuild` and specify a build name
|
637
|
+
# and operating system. This action creates a new build resource and
|
638
|
+
# also returns an S3 location with temporary access credentials. Use
|
639
|
+
# the credentials to manually upload your build files to the specified
|
640
|
+
# S3 location. For more information, see [Uploading Objects][1] in the
|
641
|
+
# *Amazon S3 Developer Guide*. Build files can be uploaded to the
|
642
|
+
# GameLift S3 location once only; that can't be updated.
|
643
|
+
#
|
644
|
+
# If successful, this operation creates a new build resource with a
|
645
|
+
# unique build ID and places it in `INITIALIZED` status. A build must be
|
646
|
+
# in `READY` status before you can create fleets with it.
|
480
647
|
#
|
481
648
|
# **Learn more**
|
482
649
|
#
|
483
650
|
# [Uploading Your Game][2]
|
484
|
-
# [https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html][3]
|
485
651
|
#
|
486
|
-
# [ Create a Build with Files in Amazon S3][
|
652
|
+
# [ Create a Build with Files in Amazon S3][3]
|
487
653
|
#
|
488
654
|
# **Related operations**
|
489
655
|
#
|
@@ -501,8 +667,7 @@ module Aws::GameLift
|
|
501
667
|
#
|
502
668
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UploadingObjects.html
|
503
669
|
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html
|
504
|
-
# [3]: https://docs.aws.amazon.com/
|
505
|
-
# [4]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html#gamelift-build-cli-uploading-create-build
|
670
|
+
# [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html#gamelift-build-cli-uploading-create-build
|
506
671
|
#
|
507
672
|
# @option params [String] :name
|
508
673
|
# A descriptive label that is associated with a build. Build names do
|
@@ -516,11 +681,11 @@ module Aws::GameLift
|
|
516
681
|
#
|
517
682
|
# @option params [Types::S3Location] :storage_location
|
518
683
|
# Information indicating where your game build files are stored. Use
|
519
|
-
# this parameter only when creating a build with files stored in an
|
520
|
-
#
|
521
|
-
#
|
522
|
-
#
|
523
|
-
#
|
684
|
+
# this parameter only when creating a build with files stored in an S3
|
685
|
+
# bucket that you own. The storage location must specify an S3 bucket
|
686
|
+
# name and key. The location must also specify a role ARN that you set
|
687
|
+
# up to allow Amazon GameLift to access your S3 bucket. The S3 bucket
|
688
|
+
# and your new build must be in the same Region.
|
524
689
|
#
|
525
690
|
# @option params [String] :operating_system
|
526
691
|
# The operating system that the game server binaries are built to run
|
@@ -604,17 +769,17 @@ module Aws::GameLift
|
|
604
769
|
# choose the hardware specifications, set some configuration options,
|
605
770
|
# and specify the game server to deploy on the new fleet.
|
606
771
|
#
|
607
|
-
# To create a new fleet,
|
608
|
-
#
|
609
|
-
#
|
610
|
-
#
|
611
|
-
#
|
772
|
+
# To create a new fleet, provide the following: (1) a fleet name, (2) an
|
773
|
+
# EC2 instance type and fleet type (spot or on-demand), (3) the build ID
|
774
|
+
# for your game build or script ID if using Realtime Servers, and (4) a
|
775
|
+
# runtime configuration, which determines how game servers will run on
|
776
|
+
# each instance in the fleet.
|
612
777
|
#
|
613
778
|
# If the `CreateFleet` call is successful, Amazon GameLift performs the
|
614
779
|
# following tasks. You can track the process of a fleet by checking the
|
615
780
|
# fleet status or by monitoring fleet creation events:
|
616
781
|
#
|
617
|
-
# * Creates a fleet
|
782
|
+
# * Creates a fleet resource. Status: `NEW`.
|
618
783
|
#
|
619
784
|
# * Begins writing events to the fleet event log, which can be accessed
|
620
785
|
# in the Amazon GameLift console.
|
@@ -635,9 +800,9 @@ module Aws::GameLift
|
|
635
800
|
#
|
636
801
|
# **Learn more**
|
637
802
|
#
|
638
|
-
# [
|
803
|
+
# [Setting Up Fleets][1]
|
639
804
|
#
|
640
|
-
# [
|
805
|
+
# [Debug Fleet Creation Issues][2]
|
641
806
|
#
|
642
807
|
# **Related operations**
|
643
808
|
#
|
@@ -651,11 +816,7 @@ module Aws::GameLift
|
|
651
816
|
#
|
652
817
|
# * UpdateFleetAttributes
|
653
818
|
#
|
654
|
-
# *
|
655
|
-
#
|
656
|
-
# * StartFleetActions
|
657
|
-
#
|
658
|
-
# * StopFleetActions
|
819
|
+
# * StartFleetActions or StopFleetActions
|
659
820
|
#
|
660
821
|
#
|
661
822
|
#
|
@@ -856,8 +1017,8 @@ module Aws::GameLift
|
|
856
1017
|
# resp = client.create_fleet({
|
857
1018
|
# name: "NonZeroAndMaxString", # required
|
858
1019
|
# description: "NonZeroAndMaxString",
|
859
|
-
# build_id: "
|
860
|
-
# script_id: "
|
1020
|
+
# build_id: "BuildIdOrArn",
|
1021
|
+
# script_id: "ScriptIdOrArn",
|
861
1022
|
# server_launch_path: "NonZeroAndMaxString",
|
862
1023
|
# server_launch_parameters: "NonZeroAndMaxString",
|
863
1024
|
# log_paths: ["NonZeroAndMaxString"],
|
@@ -941,6 +1102,248 @@ module Aws::GameLift
|
|
941
1102
|
req.send_request(options)
|
942
1103
|
end
|
943
1104
|
|
1105
|
+
# **This action is part of Amazon GameLift FleetIQ with game server
|
1106
|
+
# groups, which is in preview release and is subject to change.**
|
1107
|
+
#
|
1108
|
+
# Creates a GameLift FleetIQ game server group to manage a collection of
|
1109
|
+
# EC2 instances for game hosting. In addition to creating the game
|
1110
|
+
# server group, this action also creates an Auto Scaling group in your
|
1111
|
+
# AWS account and establishes a link between the two groups. You have
|
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.
|
1115
|
+
# You can view the status of your game server groups in the GameLift
|
1116
|
+
# Console. Game server group metrics and events are emitted to Amazon
|
1117
|
+
# CloudWatch.
|
1118
|
+
#
|
1119
|
+
# Prior creating a new game server group, you must set up the following:
|
1120
|
+
#
|
1121
|
+
# * An EC2 launch template. The template provides configuration settings
|
1122
|
+
# for a set of EC2 instances and includes the game server build that
|
1123
|
+
# you want to deploy and run on each instance. For more information on
|
1124
|
+
# creating a launch template, see [ Launching an Instance from a
|
1125
|
+
# Launch Template][1] in the *Amazon EC2 User Guide*.
|
1126
|
+
#
|
1127
|
+
# * An IAM role. The role sets up limited access to your AWS account,
|
1128
|
+
# allowing GameLift FleetIQ to create and manage the EC2 Auto Scaling
|
1129
|
+
# group, get instance data, and emit metrics and events to CloudWatch.
|
1130
|
+
# For more information on setting up an IAM permissions policy with
|
1131
|
+
# principal access for GameLift, see [ Specifying a Principal in a
|
1132
|
+
# Policy][2] in the *Amazon S3 Developer Guide*.
|
1133
|
+
#
|
1134
|
+
# To create a new game server group, provide a name and specify the IAM
|
1135
|
+
# role and EC2 launch template. You also need to provide a list of
|
1136
|
+
# instance types to be used in the group and set initial maximum and
|
1137
|
+
# minimum limits on the group's instance count. You can optionally set
|
1138
|
+
# an autoscaling policy with target tracking based on a GameLift FleetIQ
|
1139
|
+
# metric.
|
1140
|
+
#
|
1141
|
+
# Once the game server group and corresponding Auto Scaling group are
|
1142
|
+
# created, you have full access to change the Auto Scaling group's
|
1143
|
+
# configuration as needed. Keep in mind, however, that some properties
|
1144
|
+
# are periodically updated by GameLift FleetIQ as it balances the
|
1145
|
+
# group's instances based on availability and cost.
|
1146
|
+
#
|
1147
|
+
# **Learn more**
|
1148
|
+
#
|
1149
|
+
# [GameLift FleetIQ Guide][3]
|
1150
|
+
#
|
1151
|
+
# [Updating a GameLift FleetIQ-Linked Auto Scaling Group][4]
|
1152
|
+
#
|
1153
|
+
# **Related operations**
|
1154
|
+
#
|
1155
|
+
# * CreateGameServerGroup
|
1156
|
+
#
|
1157
|
+
# * ListGameServerGroups
|
1158
|
+
#
|
1159
|
+
# * DescribeGameServerGroup
|
1160
|
+
#
|
1161
|
+
# * UpdateGameServerGroup
|
1162
|
+
#
|
1163
|
+
# * DeleteGameServerGroup
|
1164
|
+
#
|
1165
|
+
# * ResumeGameServerGroup
|
1166
|
+
#
|
1167
|
+
# * SuspendGameServerGroup
|
1168
|
+
#
|
1169
|
+
#
|
1170
|
+
#
|
1171
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html
|
1172
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-bucket-user-policy-specifying-principal-intro.html
|
1173
|
+
# [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
|
1174
|
+
# [4]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-asgroups.html
|
1175
|
+
#
|
1176
|
+
# @option params [required, String] :game_server_group_name
|
1177
|
+
# An identifier for the new game server group. This value is used to
|
1178
|
+
# generate unique ARN identifiers for the EC2 Auto Scaling group and the
|
1179
|
+
# GameLift FleetIQ game server group. The name must be unique per Region
|
1180
|
+
# per AWS account.
|
1181
|
+
#
|
1182
|
+
# @option params [required, String] :role_arn
|
1183
|
+
# The Amazon Resource Name ([ARN][1]) for an IAM role that allows Amazon
|
1184
|
+
# GameLift to access your EC2 Auto Scaling groups. The submitted role is
|
1185
|
+
# validated to ensure that it contains the necessary permissions for
|
1186
|
+
# game server groups.
|
1187
|
+
#
|
1188
|
+
#
|
1189
|
+
#
|
1190
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
|
1191
|
+
#
|
1192
|
+
# @option params [required, Integer] :min_size
|
1193
|
+
# The minimum number of instances allowed in the EC2 Auto Scaling group.
|
1194
|
+
# During autoscaling events, GameLift FleetIQ and EC2 do not scale down
|
1195
|
+
# the group below this minimum. In production, this value should be set
|
1196
|
+
# to at least 1.
|
1197
|
+
#
|
1198
|
+
# @option params [required, Integer] :max_size
|
1199
|
+
# The maximum number of instances allowed in the EC2 Auto Scaling group.
|
1200
|
+
# During autoscaling events, GameLift FleetIQ and EC2 do not scale up
|
1201
|
+
# the group above this maximum.
|
1202
|
+
#
|
1203
|
+
# @option params [required, Types::LaunchTemplateSpecification] :launch_template
|
1204
|
+
# The EC2 launch template that contains configuration settings and game
|
1205
|
+
# server code to be deployed to all instances in the game server group.
|
1206
|
+
# You can specify the template using either the template name or ID. For
|
1207
|
+
# help with creating a launch template, see [Creating a Launch Template
|
1208
|
+
# for an Auto Scaling Group][1] in the *Amazon EC2 Auto Scaling User
|
1209
|
+
# Guide*.
|
1210
|
+
#
|
1211
|
+
#
|
1212
|
+
#
|
1213
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html
|
1214
|
+
#
|
1215
|
+
# @option params [required, Array<Types::InstanceDefinition>] :instance_definitions
|
1216
|
+
# A set of EC2 instance types to use when creating instances in the
|
1217
|
+
# group. The instance definitions must specify at least two different
|
1218
|
+
# instance types that are supported by GameLift FleetIQ. For more
|
1219
|
+
# information on instance types, see [EC2 Instance Types][1] in the
|
1220
|
+
# *Amazon EC2 User Guide*.
|
1221
|
+
#
|
1222
|
+
#
|
1223
|
+
#
|
1224
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html
|
1225
|
+
#
|
1226
|
+
# @option params [Types::GameServerGroupAutoScalingPolicy] :auto_scaling_policy
|
1227
|
+
# Configuration settings to define a scaling policy for the Auto Scaling
|
1228
|
+
# group that is optimized for game hosting. The scaling policy uses the
|
1229
|
+
# metric "PercentUtilizedGameServers" to maintain a buffer of idle
|
1230
|
+
# game servers that can immediately accommodate new games and players.
|
1231
|
+
# Once the game server and Auto Scaling groups are created, you can
|
1232
|
+
# update the scaling policy settings directly in Auto Scaling Groups.
|
1233
|
+
#
|
1234
|
+
# @option params [String] :balancing_strategy
|
1235
|
+
# The fallback balancing method to use for the game server group when
|
1236
|
+
# Spot instances in a Region become unavailable or are not viable for
|
1237
|
+
# game hosting. Once triggered, this method remains active until Spot
|
1238
|
+
# instances can once again be used. Method options include:
|
1239
|
+
#
|
1240
|
+
# * SPOT\_ONLY -- If Spot instances are unavailable, the game server
|
1241
|
+
# group provides no hosting capacity. No new instances are started,
|
1242
|
+
# and the existing nonviable Spot instances are terminated (once
|
1243
|
+
# current gameplay ends) and not replaced.
|
1244
|
+
#
|
1245
|
+
# * SPOT\_PREFERRED -- If Spot instances are unavailable, the game
|
1246
|
+
# server group continues to provide hosting capacity by using
|
1247
|
+
# On-Demand instances. Existing nonviable Spot instances are
|
1248
|
+
# terminated (once current gameplay ends) and replaced with new
|
1249
|
+
# On-Demand instances.
|
1250
|
+
#
|
1251
|
+
# @option params [String] :game_server_protection_policy
|
1252
|
+
# A flag that indicates whether instances in the game server group are
|
1253
|
+
# protected from early termination. Unprotected instances that have
|
1254
|
+
# active game servers running may by terminated during a scale-down
|
1255
|
+
# event, causing players to be dropped from the game. Protected
|
1256
|
+
# instances cannot be terminated while there are active game servers
|
1257
|
+
# running. An exception to this is Spot Instances, which may be
|
1258
|
+
# terminated by AWS regardless of protection status. This property is
|
1259
|
+
# set to NO\_PROTECTION by default.
|
1260
|
+
#
|
1261
|
+
# @option params [Array<String>] :vpc_subnets
|
1262
|
+
# A list of virtual private cloud (VPC) subnets to use with instances in
|
1263
|
+
# the game server group. By default, all GameLift FleetIQ-supported
|
1264
|
+
# availability zones are used; this parameter allows you to specify VPCs
|
1265
|
+
# that you've set up.
|
1266
|
+
#
|
1267
|
+
# @option params [Array<Types::Tag>] :tags
|
1268
|
+
# A list of labels to assign to the new game server group resource. Tags
|
1269
|
+
# are developer-defined key-value pairs. Tagging AWS resources are
|
1270
|
+
# useful for resource management, access management, and cost
|
1271
|
+
# allocation. For more information, see [ Tagging AWS Resources][1] in
|
1272
|
+
# the *AWS General Reference*. Once the resource is created, you can use
|
1273
|
+
# TagResource, UntagResource, and ListTagsForResource to add, remove,
|
1274
|
+
# and view tags. The maximum tag limit may be lower than stated. See the
|
1275
|
+
# AWS General Reference for actual tagging limits.
|
1276
|
+
#
|
1277
|
+
#
|
1278
|
+
#
|
1279
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
1280
|
+
#
|
1281
|
+
# @return [Types::CreateGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1282
|
+
#
|
1283
|
+
# * {Types::CreateGameServerGroupOutput#game_server_group #game_server_group} => Types::GameServerGroup
|
1284
|
+
#
|
1285
|
+
# @example Request syntax with placeholder values
|
1286
|
+
#
|
1287
|
+
# resp = client.create_game_server_group({
|
1288
|
+
# game_server_group_name: "GameServerGroupName", # required
|
1289
|
+
# role_arn: "IamRoleArn", # required
|
1290
|
+
# min_size: 1, # required
|
1291
|
+
# max_size: 1, # required
|
1292
|
+
# launch_template: { # required
|
1293
|
+
# launch_template_id: "LaunchTemplateId",
|
1294
|
+
# launch_template_name: "LaunchTemplateName",
|
1295
|
+
# version: "LaunchTemplateVersion",
|
1296
|
+
# },
|
1297
|
+
# instance_definitions: [ # required
|
1298
|
+
# {
|
1299
|
+
# instance_type: "c4.large", # required, accepts 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
|
1300
|
+
# weighted_capacity: "WeightedCapacity",
|
1301
|
+
# },
|
1302
|
+
# ],
|
1303
|
+
# auto_scaling_policy: {
|
1304
|
+
# estimated_instance_warmup: 1,
|
1305
|
+
# target_tracking_configuration: { # required
|
1306
|
+
# target_value: 1.0, # required
|
1307
|
+
# },
|
1308
|
+
# },
|
1309
|
+
# balancing_strategy: "SPOT_ONLY", # accepts SPOT_ONLY, SPOT_PREFERRED
|
1310
|
+
# game_server_protection_policy: "NO_PROTECTION", # accepts NO_PROTECTION, FULL_PROTECTION
|
1311
|
+
# vpc_subnets: ["VpcSubnet"],
|
1312
|
+
# tags: [
|
1313
|
+
# {
|
1314
|
+
# key: "TagKey", # required
|
1315
|
+
# value: "TagValue", # required
|
1316
|
+
# },
|
1317
|
+
# ],
|
1318
|
+
# })
|
1319
|
+
#
|
1320
|
+
# @example Response structure
|
1321
|
+
#
|
1322
|
+
# resp.game_server_group.game_server_group_name #=> String
|
1323
|
+
# resp.game_server_group.game_server_group_arn #=> String
|
1324
|
+
# resp.game_server_group.role_arn #=> String
|
1325
|
+
# resp.game_server_group.instance_definitions #=> Array
|
1326
|
+
# 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
|
+
# resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
|
1328
|
+
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED"
|
1329
|
+
# resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
|
1330
|
+
# resp.game_server_group.auto_scaling_group_arn #=> String
|
1331
|
+
# resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
|
1332
|
+
# resp.game_server_group.status_reason #=> String
|
1333
|
+
# resp.game_server_group.suspended_actions #=> Array
|
1334
|
+
# resp.game_server_group.suspended_actions[0] #=> String, one of "REPLACE_INSTANCE_TYPES"
|
1335
|
+
# resp.game_server_group.creation_time #=> Time
|
1336
|
+
# resp.game_server_group.last_updated_time #=> Time
|
1337
|
+
#
|
1338
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateGameServerGroup AWS API Documentation
|
1339
|
+
#
|
1340
|
+
# @overload create_game_server_group(params = {})
|
1341
|
+
# @param [Hash] params ({})
|
1342
|
+
def create_game_server_group(params = {}, options = {})
|
1343
|
+
req = build_request(:create_game_server_group, params)
|
1344
|
+
req.send_request(options)
|
1345
|
+
end
|
1346
|
+
|
944
1347
|
# Creates a multiplayer game session for players. This action creates a
|
945
1348
|
# game session record and assigns an available server process in the
|
946
1349
|
# specified fleet to host the game session. A fleet must have an
|
@@ -1065,8 +1468,8 @@ module Aws::GameLift
|
|
1065
1468
|
# @example Request syntax with placeholder values
|
1066
1469
|
#
|
1067
1470
|
# resp = client.create_game_session({
|
1068
|
-
# fleet_id: "
|
1069
|
-
# alias_id: "
|
1471
|
+
# fleet_id: "FleetIdOrArn",
|
1472
|
+
# alias_id: "AliasIdOrArn",
|
1070
1473
|
# maximum_player_session_count: 1, # required
|
1071
1474
|
# name: "NonZeroAndMaxString",
|
1072
1475
|
# game_properties: [
|
@@ -1148,6 +1551,14 @@ module Aws::GameLift
|
|
1148
1551
|
# destinations and, if desired, a set of latency policies. If
|
1149
1552
|
# successful, a new queue object is returned.
|
1150
1553
|
#
|
1554
|
+
# **Learn more**
|
1555
|
+
#
|
1556
|
+
# [ Design a Game Session Queue][1]
|
1557
|
+
#
|
1558
|
+
# [ Create a Game Session Queue][2]
|
1559
|
+
#
|
1560
|
+
# **Related operations**
|
1561
|
+
#
|
1151
1562
|
# * CreateGameSessionQueue
|
1152
1563
|
#
|
1153
1564
|
# * DescribeGameSessionQueues
|
@@ -1156,6 +1567,11 @@ module Aws::GameLift
|
|
1156
1567
|
#
|
1157
1568
|
# * DeleteGameSessionQueue
|
1158
1569
|
#
|
1570
|
+
#
|
1571
|
+
#
|
1572
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-design.html
|
1573
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-creating.html
|
1574
|
+
#
|
1159
1575
|
# @option params [required, String] :name
|
1160
1576
|
# A descriptive label that is associated with game session queue. Queue
|
1161
1577
|
# names must be unique within each Region.
|
@@ -2067,7 +2483,7 @@ module Aws::GameLift
|
|
2067
2483
|
# @example Request syntax with placeholder values
|
2068
2484
|
#
|
2069
2485
|
# resp = client.delete_alias({
|
2070
|
-
# alias_id: "
|
2486
|
+
# alias_id: "AliasIdOrArn", # required
|
2071
2487
|
# })
|
2072
2488
|
#
|
2073
2489
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteAlias AWS API Documentation
|
@@ -2079,16 +2495,16 @@ module Aws::GameLift
|
|
2079
2495
|
req.send_request(options)
|
2080
2496
|
end
|
2081
2497
|
|
2082
|
-
# Deletes a build. This action permanently deletes the build
|
2083
|
-
# any uploaded build files.
|
2084
|
-
#
|
2085
|
-
# To delete a build, specify its ID. Deleting a build does not affect
|
2086
|
-
# the status of any active fleets using the build, but you can no longer
|
2498
|
+
# Deletes a build. This action permanently deletes the build resource
|
2499
|
+
# and any uploaded build files. Deleting a build does not affect the
|
2500
|
+
# status of any active fleets using the build, but you can no longer
|
2087
2501
|
# create new fleets with the deleted build.
|
2088
2502
|
#
|
2503
|
+
# To delete a build, specify the build ID.
|
2504
|
+
#
|
2089
2505
|
# **Learn more**
|
2090
2506
|
#
|
2091
|
-
# [
|
2507
|
+
# [ Upload a Custom Server Build][1]
|
2092
2508
|
#
|
2093
2509
|
# **Related operations**
|
2094
2510
|
#
|
@@ -2104,7 +2520,7 @@ module Aws::GameLift
|
|
2104
2520
|
#
|
2105
2521
|
#
|
2106
2522
|
#
|
2107
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/build-intro.html
|
2523
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html
|
2108
2524
|
#
|
2109
2525
|
# @option params [required, String] :build_id
|
2110
2526
|
# A unique identifier for a build to delete. You can use either the
|
@@ -2115,7 +2531,7 @@ module Aws::GameLift
|
|
2115
2531
|
# @example Request syntax with placeholder values
|
2116
2532
|
#
|
2117
2533
|
# resp = client.delete_build({
|
2118
|
-
# build_id: "
|
2534
|
+
# build_id: "BuildIdOrArn", # required
|
2119
2535
|
# })
|
2120
2536
|
#
|
2121
2537
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteBuild AWS API Documentation
|
@@ -2137,12 +2553,12 @@ module Aws::GameLift
|
|
2137
2553
|
# the VPC peering connection--this is done as part of the delete fleet
|
2138
2554
|
# process.
|
2139
2555
|
#
|
2140
|
-
# This action removes the fleet
|
2141
|
-
#
|
2556
|
+
# This action removes the fleet and its resources. Once a fleet is
|
2557
|
+
# deleted, you can no longer use any of the resource in that fleet.
|
2142
2558
|
#
|
2143
2559
|
# **Learn more**
|
2144
2560
|
#
|
2145
|
-
# [
|
2561
|
+
# [Setting up GameLift Fleets][1]
|
2146
2562
|
#
|
2147
2563
|
# **Related operations**
|
2148
2564
|
#
|
@@ -2156,11 +2572,7 @@ module Aws::GameLift
|
|
2156
2572
|
#
|
2157
2573
|
# * UpdateFleetAttributes
|
2158
2574
|
#
|
2159
|
-
# *
|
2160
|
-
#
|
2161
|
-
# * StartFleetActions
|
2162
|
-
#
|
2163
|
-
# * StopFleetActions
|
2575
|
+
# * StartFleetActions or StopFleetActions
|
2164
2576
|
#
|
2165
2577
|
#
|
2166
2578
|
#
|
@@ -2175,7 +2587,7 @@ module Aws::GameLift
|
|
2175
2587
|
# @example Request syntax with placeholder values
|
2176
2588
|
#
|
2177
2589
|
# resp = client.delete_fleet({
|
2178
|
-
# fleet_id: "
|
2590
|
+
# fleet_id: "FleetIdOrArn", # required
|
2179
2591
|
# })
|
2180
2592
|
#
|
2181
2593
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteFleet AWS API Documentation
|
@@ -2187,10 +2599,119 @@ module Aws::GameLift
|
|
2187
2599
|
req.send_request(options)
|
2188
2600
|
end
|
2189
2601
|
|
2602
|
+
# **This action is part of Amazon GameLift FleetIQ with game server
|
2603
|
+
# groups, which is in preview release and is subject to change.**
|
2604
|
+
#
|
2605
|
+
# Terminates a game server group and permanently deletes the game server
|
2606
|
+
# group record. You have several options for how these resources are
|
2607
|
+
# impacted when deleting the game server group. Depending on the type of
|
2608
|
+
# delete action selected, this action may affect three types of
|
2609
|
+
# resources: the game server group, the corresponding Auto Scaling
|
2610
|
+
# group, and all game servers currently running in the group.
|
2611
|
+
#
|
2612
|
+
# To delete a game server group, identify the game server group to
|
2613
|
+
# delete and specify the type of delete action to initiate. Game server
|
2614
|
+
# groups can only be deleted if they are in ACTIVE or ERROR status.
|
2615
|
+
#
|
2616
|
+
# If the delete request is successful, a series of actions are kicked
|
2617
|
+
# off. The game server group status is changed to DELETE\_SCHEDULED,
|
2618
|
+
# which prevents new game servers from being registered and stops
|
2619
|
+
# autoscaling activity. Once all game servers in the game server group
|
2620
|
+
# are de-registered, GameLift FleetIQ can begin deleting resources. If
|
2621
|
+
# any of the delete actions fail, the game server group is placed in
|
2622
|
+
# ERROR status.
|
2623
|
+
#
|
2624
|
+
# GameLift FleetIQ emits delete events to Amazon CloudWatch.
|
2625
|
+
#
|
2626
|
+
# **Learn more**
|
2627
|
+
#
|
2628
|
+
# [GameLift FleetIQ Guide][1]
|
2629
|
+
#
|
2630
|
+
# **Related operations**
|
2631
|
+
#
|
2632
|
+
# * CreateGameServerGroup
|
2633
|
+
#
|
2634
|
+
# * ListGameServerGroups
|
2635
|
+
#
|
2636
|
+
# * DescribeGameServerGroup
|
2637
|
+
#
|
2638
|
+
# * UpdateGameServerGroup
|
2639
|
+
#
|
2640
|
+
# * DeleteGameServerGroup
|
2641
|
+
#
|
2642
|
+
# * ResumeGameServerGroup
|
2643
|
+
#
|
2644
|
+
# * SuspendGameServerGroup
|
2645
|
+
#
|
2646
|
+
#
|
2647
|
+
#
|
2648
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
|
2649
|
+
#
|
2650
|
+
# @option params [required, String] :game_server_group_name
|
2651
|
+
# The unique identifier of the game server group to delete. Use either
|
2652
|
+
# the GameServerGroup name or ARN value.
|
2653
|
+
#
|
2654
|
+
# @option params [String] :delete_option
|
2655
|
+
# The type of delete to perform. Options include:
|
2656
|
+
#
|
2657
|
+
# * SAFE\_DELETE – Terminates the game server group and EC2 Auto Scaling
|
2658
|
+
# group only when it has no game servers that are in IN\_USE status.
|
2659
|
+
#
|
2660
|
+
# * FORCE\_DELETE – Terminates the game server group, including all
|
2661
|
+
# active game servers regardless of their utilization status, and the
|
2662
|
+
# EC2 Auto Scaling group.
|
2663
|
+
#
|
2664
|
+
# * RETAIN – Does a safe delete of the game server group but retains the
|
2665
|
+
# EC2 Auto Scaling group as is.
|
2666
|
+
#
|
2667
|
+
# @return [Types::DeleteGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2668
|
+
#
|
2669
|
+
# * {Types::DeleteGameServerGroupOutput#game_server_group #game_server_group} => Types::GameServerGroup
|
2670
|
+
#
|
2671
|
+
# @example Request syntax with placeholder values
|
2672
|
+
#
|
2673
|
+
# resp = client.delete_game_server_group({
|
2674
|
+
# game_server_group_name: "GameServerGroupNameOrArn", # required
|
2675
|
+
# delete_option: "SAFE_DELETE", # accepts SAFE_DELETE, FORCE_DELETE, RETAIN
|
2676
|
+
# })
|
2677
|
+
#
|
2678
|
+
# @example Response structure
|
2679
|
+
#
|
2680
|
+
# resp.game_server_group.game_server_group_name #=> String
|
2681
|
+
# resp.game_server_group.game_server_group_arn #=> String
|
2682
|
+
# resp.game_server_group.role_arn #=> String
|
2683
|
+
# resp.game_server_group.instance_definitions #=> Array
|
2684
|
+
# 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
|
+
# resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
|
2686
|
+
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED"
|
2687
|
+
# resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
|
2688
|
+
# resp.game_server_group.auto_scaling_group_arn #=> String
|
2689
|
+
# resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
|
2690
|
+
# resp.game_server_group.status_reason #=> String
|
2691
|
+
# resp.game_server_group.suspended_actions #=> Array
|
2692
|
+
# resp.game_server_group.suspended_actions[0] #=> String, one of "REPLACE_INSTANCE_TYPES"
|
2693
|
+
# resp.game_server_group.creation_time #=> Time
|
2694
|
+
# resp.game_server_group.last_updated_time #=> Time
|
2695
|
+
#
|
2696
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteGameServerGroup AWS API Documentation
|
2697
|
+
#
|
2698
|
+
# @overload delete_game_server_group(params = {})
|
2699
|
+
# @param [Hash] params ({})
|
2700
|
+
def delete_game_server_group(params = {}, options = {})
|
2701
|
+
req = build_request(:delete_game_server_group, params)
|
2702
|
+
req.send_request(options)
|
2703
|
+
end
|
2704
|
+
|
2190
2705
|
# Deletes a game session queue. This action means that any
|
2191
2706
|
# StartGameSessionPlacement requests that reference this queue will
|
2192
2707
|
# fail. To delete a queue, specify the queue name.
|
2193
2708
|
#
|
2709
|
+
# **Learn more**
|
2710
|
+
#
|
2711
|
+
# [ Using Multi-Region Queues][1]
|
2712
|
+
#
|
2713
|
+
# **Related operations**
|
2714
|
+
#
|
2194
2715
|
# * CreateGameSessionQueue
|
2195
2716
|
#
|
2196
2717
|
# * DescribeGameSessionQueues
|
@@ -2199,6 +2720,10 @@ module Aws::GameLift
|
|
2199
2720
|
#
|
2200
2721
|
# * DeleteGameSessionQueue
|
2201
2722
|
#
|
2723
|
+
#
|
2724
|
+
#
|
2725
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html
|
2726
|
+
#
|
2202
2727
|
# @option params [required, String] :name
|
2203
2728
|
# A descriptive label that is associated with game session queue. Queue
|
2204
2729
|
# names must be unique within each Region. You can use either the queue
|
@@ -2209,7 +2734,7 @@ module Aws::GameLift
|
|
2209
2734
|
# @example Request syntax with placeholder values
|
2210
2735
|
#
|
2211
2736
|
# resp = client.delete_game_session_queue({
|
2212
|
-
# name: "
|
2737
|
+
# name: "GameSessionQueueNameOrArn", # required
|
2213
2738
|
# })
|
2214
2739
|
#
|
2215
2740
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteGameSessionQueue AWS API Documentation
|
@@ -2360,7 +2885,7 @@ module Aws::GameLift
|
|
2360
2885
|
#
|
2361
2886
|
# resp = client.delete_scaling_policy({
|
2362
2887
|
# name: "NonZeroAndMaxString", # required
|
2363
|
-
# fleet_id: "
|
2888
|
+
# fleet_id: "FleetIdOrArn", # required
|
2364
2889
|
# })
|
2365
2890
|
#
|
2366
2891
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteScalingPolicy AWS API Documentation
|
@@ -2411,7 +2936,7 @@ module Aws::GameLift
|
|
2411
2936
|
# @example Request syntax with placeholder values
|
2412
2937
|
#
|
2413
2938
|
# resp = client.delete_script({
|
2414
|
-
# script_id: "
|
2939
|
+
# script_id: "ScriptIdOrArn", # required
|
2415
2940
|
# })
|
2416
2941
|
#
|
2417
2942
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteScript AWS API Documentation
|
@@ -2525,6 +3050,65 @@ module Aws::GameLift
|
|
2525
3050
|
req.send_request(options)
|
2526
3051
|
end
|
2527
3052
|
|
3053
|
+
# **This action is part of Amazon GameLift FleetIQ with game server
|
3054
|
+
# groups, which is in preview release and is subject to change.**
|
3055
|
+
#
|
3056
|
+
# Removes the game server resource from the game server group. As a
|
3057
|
+
# result of this action, the de-registered game server can no longer be
|
3058
|
+
# claimed and will not returned in a list of active game servers.
|
3059
|
+
#
|
3060
|
+
# To de-register a game server, specify the game server group and game
|
3061
|
+
# server ID. If successful, this action emits a CloudWatch event with
|
3062
|
+
# termination time stamp and reason.
|
3063
|
+
#
|
3064
|
+
# **Learn more**
|
3065
|
+
#
|
3066
|
+
# [GameLift FleetIQ Guide][1]
|
3067
|
+
#
|
3068
|
+
# **Related operations**
|
3069
|
+
#
|
3070
|
+
# * RegisterGameServer
|
3071
|
+
#
|
3072
|
+
# * ListGameServers
|
3073
|
+
#
|
3074
|
+
# * ClaimGameServer
|
3075
|
+
#
|
3076
|
+
# * DescribeGameServer
|
3077
|
+
#
|
3078
|
+
# * UpdateGameServer
|
3079
|
+
#
|
3080
|
+
# * DeregisterGameServer
|
3081
|
+
#
|
3082
|
+
#
|
3083
|
+
#
|
3084
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
|
3085
|
+
#
|
3086
|
+
# @option params [required, String] :game_server_group_name
|
3087
|
+
# An identifier for the game server group where the game server to be
|
3088
|
+
# de-registered is running. Use either the GameServerGroup name or ARN
|
3089
|
+
# value.
|
3090
|
+
#
|
3091
|
+
# @option params [required, String] :game_server_id
|
3092
|
+
# The identifier for the game server to be de-registered.
|
3093
|
+
#
|
3094
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3095
|
+
#
|
3096
|
+
# @example Request syntax with placeholder values
|
3097
|
+
#
|
3098
|
+
# resp = client.deregister_game_server({
|
3099
|
+
# game_server_group_name: "GameServerGroupNameOrArn", # required
|
3100
|
+
# game_server_id: "GameServerId", # required
|
3101
|
+
# })
|
3102
|
+
#
|
3103
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeregisterGameServer AWS API Documentation
|
3104
|
+
#
|
3105
|
+
# @overload deregister_game_server(params = {})
|
3106
|
+
# @param [Hash] params ({})
|
3107
|
+
def deregister_game_server(params = {}, options = {})
|
3108
|
+
req = build_request(:deregister_game_server, params)
|
3109
|
+
req.send_request(options)
|
3110
|
+
end
|
3111
|
+
|
2528
3112
|
# Retrieves properties for an alias. This operation returns all alias
|
2529
3113
|
# metadata and settings. To get an alias's target fleet ID only, use
|
2530
3114
|
# `ResolveAlias`.
|
@@ -2555,7 +3139,7 @@ module Aws::GameLift
|
|
2555
3139
|
# @example Request syntax with placeholder values
|
2556
3140
|
#
|
2557
3141
|
# resp = client.describe_alias({
|
2558
|
-
# alias_id: "
|
3142
|
+
# alias_id: "AliasIdOrArn", # required
|
2559
3143
|
# })
|
2560
3144
|
#
|
2561
3145
|
# @example Response structure
|
@@ -2579,13 +3163,13 @@ module Aws::GameLift
|
|
2579
3163
|
req.send_request(options)
|
2580
3164
|
end
|
2581
3165
|
|
2582
|
-
# Retrieves properties for a build. To request a build
|
2583
|
-
# build ID. If successful, an object containing the
|
2584
|
-
# returned.
|
3166
|
+
# Retrieves properties for a custom game build. To request a build
|
3167
|
+
# resource, specify a build ID. If successful, an object containing the
|
3168
|
+
# build properties is returned.
|
2585
3169
|
#
|
2586
3170
|
# **Learn more**
|
2587
3171
|
#
|
2588
|
-
# [
|
3172
|
+
# [ Upload a Custom Server Build][1]
|
2589
3173
|
#
|
2590
3174
|
# **Related operations**
|
2591
3175
|
#
|
@@ -2601,7 +3185,7 @@ module Aws::GameLift
|
|
2601
3185
|
#
|
2602
3186
|
#
|
2603
3187
|
#
|
2604
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/build-intro.html
|
3188
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html
|
2605
3189
|
#
|
2606
3190
|
# @option params [required, String] :build_id
|
2607
3191
|
# A unique identifier for a build to retrieve properties for. You can
|
@@ -2614,7 +3198,7 @@ module Aws::GameLift
|
|
2614
3198
|
# @example Request syntax with placeholder values
|
2615
3199
|
#
|
2616
3200
|
# resp = client.describe_build({
|
2617
|
-
# build_id: "
|
3201
|
+
# build_id: "BuildIdOrArn", # required
|
2618
3202
|
# })
|
2619
3203
|
#
|
2620
3204
|
# @example Response structure
|
@@ -2640,17 +3224,17 @@ module Aws::GameLift
|
|
2640
3224
|
# Retrieves the following information for the specified EC2 instance
|
2641
3225
|
# type:
|
2642
3226
|
#
|
2643
|
-
# *
|
3227
|
+
# * Maximum number of instances allowed per AWS account (service limit).
|
2644
3228
|
#
|
2645
|
-
# *
|
3229
|
+
# * Current usage for the AWS account.
|
2646
3230
|
#
|
2647
|
-
#
|
2648
|
-
#
|
2649
|
-
#
|
3231
|
+
# To learn more about the capabilities of each instance type, see
|
3232
|
+
# [Amazon EC2 Instance Types][1]. Note that the instance types offered
|
3233
|
+
# may vary depending on the region.
|
2650
3234
|
#
|
2651
3235
|
# **Learn more**
|
2652
3236
|
#
|
2653
|
-
# [
|
3237
|
+
# [Setting up GameLift Fleets][2]
|
2654
3238
|
#
|
2655
3239
|
# **Related operations**
|
2656
3240
|
#
|
@@ -2660,41 +3244,16 @@ module Aws::GameLift
|
|
2660
3244
|
#
|
2661
3245
|
# * DeleteFleet
|
2662
3246
|
#
|
2663
|
-
# *
|
2664
|
-
#
|
2665
|
-
# * DescribeFleetAttributes
|
2666
|
-
#
|
2667
|
-
# * DescribeFleetCapacity
|
2668
|
-
#
|
2669
|
-
# * DescribeFleetPortSettings
|
2670
|
-
#
|
2671
|
-
# * DescribeFleetUtilization
|
2672
|
-
#
|
2673
|
-
# * DescribeRuntimeConfiguration
|
2674
|
-
#
|
2675
|
-
# * DescribeEC2InstanceLimits
|
2676
|
-
#
|
2677
|
-
# * DescribeFleetEvents
|
2678
|
-
#
|
2679
|
-
# * Update fleets:
|
2680
|
-
#
|
2681
|
-
# * UpdateFleetAttributes
|
2682
|
-
#
|
2683
|
-
# * UpdateFleetCapacity
|
2684
|
-
#
|
2685
|
-
# * UpdateFleetPortSettings
|
2686
|
-
#
|
2687
|
-
# * UpdateRuntimeConfiguration
|
2688
|
-
#
|
2689
|
-
# * Manage fleet actions:
|
3247
|
+
# * DescribeFleetAttributes
|
2690
3248
|
#
|
2691
|
-
#
|
3249
|
+
# * UpdateFleetAttributes
|
2692
3250
|
#
|
2693
|
-
#
|
3251
|
+
# * StartFleetActions or StopFleetActions
|
2694
3252
|
#
|
2695
3253
|
#
|
2696
3254
|
#
|
2697
|
-
# [1]:
|
3255
|
+
# [1]: http://aws.amazon.com/ec2/instance-types/
|
3256
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
2698
3257
|
#
|
2699
3258
|
# @option params [String] :ec2_instance_type
|
2700
3259
|
# Name of an EC2 instance type that is supported in Amazon GameLift. A
|
@@ -2734,24 +3293,25 @@ module Aws::GameLift
|
|
2734
3293
|
req.send_request(options)
|
2735
3294
|
end
|
2736
3295
|
|
2737
|
-
# Retrieves
|
2738
|
-
#
|
2739
|
-
#
|
2740
|
-
#
|
2741
|
-
#
|
2742
|
-
#
|
2743
|
-
#
|
2744
|
-
#
|
3296
|
+
# Retrieves core properties, including configuration, status, and
|
3297
|
+
# metadata, for a fleet.
|
3298
|
+
#
|
3299
|
+
# To get attributes for one or more fleets, provide a list of fleet IDs
|
3300
|
+
# or fleet ARNs. To get attributes for all fleets, do not specify a
|
3301
|
+
# fleet identifier. When requesting attributes for multiple fleets, use
|
3302
|
+
# the pagination parameters to retrieve results as a set of sequential
|
3303
|
+
# pages. If successful, a FleetAttributes object is returned for each
|
3304
|
+
# fleet requested, unless the fleet identifier is not found.
|
2745
3305
|
#
|
2746
3306
|
# <note markdown="1"> Some API actions may limit the number of fleet IDs allowed in one
|
2747
3307
|
# request. If a request exceeds this limit, the request fails and the
|
2748
|
-
# error message includes the maximum allowed.
|
3308
|
+
# error message includes the maximum allowed number.
|
2749
3309
|
#
|
2750
3310
|
# </note>
|
2751
3311
|
#
|
2752
3312
|
# **Learn more**
|
2753
3313
|
#
|
2754
|
-
# [
|
3314
|
+
# [Setting up GameLift Fleets][1]
|
2755
3315
|
#
|
2756
3316
|
# **Related operations**
|
2757
3317
|
#
|
@@ -2779,19 +3339,18 @@ module Aws::GameLift
|
|
2779
3339
|
#
|
2780
3340
|
# * UpdateFleetAttributes
|
2781
3341
|
#
|
2782
|
-
# *
|
2783
|
-
#
|
2784
|
-
# * StartFleetActions
|
2785
|
-
#
|
2786
|
-
# * StopFleetActions
|
3342
|
+
# * StartFleetActions or StopFleetActions
|
2787
3343
|
#
|
2788
3344
|
#
|
2789
3345
|
#
|
2790
3346
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
2791
3347
|
#
|
2792
3348
|
# @option params [Array<String>] :fleet_ids
|
2793
|
-
# A
|
2794
|
-
# use either the fleet ID or ARN value.
|
3349
|
+
# A list of unique fleet identifiers to retrieve attributes for. You can
|
3350
|
+
# use either the fleet ID or ARN value. To retrieve attributes for all
|
3351
|
+
# current fleets, do not include this parameter. If the list of fleet
|
3352
|
+
# identifiers includes fleets that don't currently exist, the request
|
3353
|
+
# succeeds but no attributes for that fleet are returned.
|
2795
3354
|
#
|
2796
3355
|
# @option params [Integer] :limit
|
2797
3356
|
# The maximum number of results to return. Use this parameter with
|
@@ -2814,7 +3373,7 @@ module Aws::GameLift
|
|
2814
3373
|
# @example Request syntax with placeholder values
|
2815
3374
|
#
|
2816
3375
|
# resp = client.describe_fleet_attributes({
|
2817
|
-
# fleet_ids: ["
|
3376
|
+
# fleet_ids: ["FleetIdOrArn"],
|
2818
3377
|
# limit: 1,
|
2819
3378
|
# next_token: "NonZeroAndMaxString",
|
2820
3379
|
# })
|
@@ -2860,15 +3419,18 @@ module Aws::GameLift
|
|
2860
3419
|
req.send_request(options)
|
2861
3420
|
end
|
2862
3421
|
|
2863
|
-
# Retrieves the current
|
2864
|
-
#
|
2865
|
-
#
|
2866
|
-
#
|
2867
|
-
#
|
2868
|
-
#
|
2869
|
-
#
|
2870
|
-
# fleet
|
2871
|
-
#
|
3422
|
+
# Retrieves the current capacity statistics for one or more fleets.
|
3423
|
+
# These statistics present a snapshot of the fleet's instances and
|
3424
|
+
# provide insight on current or imminent scaling activity. To get
|
3425
|
+
# statistics on game hosting activity in the fleet, see
|
3426
|
+
# DescribeFleetUtilization.
|
3427
|
+
#
|
3428
|
+
# You can request capacity for all fleets or specify a list of one or
|
3429
|
+
# more fleet identifiers. When requesting multiple fleets, use the
|
3430
|
+
# pagination parameters to retrieve results as a set of sequential
|
3431
|
+
# pages. If successful, a FleetCapacity object is returned for each
|
3432
|
+
# requested fleet ID. When a list of fleet IDs is provided, attribute
|
3433
|
+
# objects are returned only for fleets that currently exist.
|
2872
3434
|
#
|
2873
3435
|
# <note markdown="1"> Some API actions may limit the number of fleet IDs allowed in one
|
2874
3436
|
# request. If a request exceeds this limit, the request fails and the
|
@@ -2878,7 +3440,9 @@ module Aws::GameLift
|
|
2878
3440
|
#
|
2879
3441
|
# **Learn more**
|
2880
3442
|
#
|
2881
|
-
# [
|
3443
|
+
# [Setting up GameLift Fleets][1]
|
3444
|
+
#
|
3445
|
+
# [GameLift Metrics for Fleets][2]
|
2882
3446
|
#
|
2883
3447
|
# **Related operations**
|
2884
3448
|
#
|
@@ -2906,15 +3470,12 @@ module Aws::GameLift
|
|
2906
3470
|
#
|
2907
3471
|
# * UpdateFleetAttributes
|
2908
3472
|
#
|
2909
|
-
# *
|
2910
|
-
#
|
2911
|
-
# * StartFleetActions
|
2912
|
-
#
|
2913
|
-
# * StopFleetActions
|
3473
|
+
# * StartFleetActions or StopFleetActions
|
2914
3474
|
#
|
2915
3475
|
#
|
2916
3476
|
#
|
2917
3477
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
3478
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet
|
2918
3479
|
#
|
2919
3480
|
# @option params [Array<String>] :fleet_ids
|
2920
3481
|
# A unique identifier for a fleet(s) to retrieve capacity information
|
@@ -2941,7 +3502,7 @@ module Aws::GameLift
|
|
2941
3502
|
# @example Request syntax with placeholder values
|
2942
3503
|
#
|
2943
3504
|
# resp = client.describe_fleet_capacity({
|
2944
|
-
# fleet_ids: ["
|
3505
|
+
# fleet_ids: ["FleetIdOrArn"],
|
2945
3506
|
# limit: 1,
|
2946
3507
|
# next_token: "NonZeroAndMaxString",
|
2947
3508
|
# })
|
@@ -2977,7 +3538,7 @@ module Aws::GameLift
|
|
2977
3538
|
#
|
2978
3539
|
# **Learn more**
|
2979
3540
|
#
|
2980
|
-
# [
|
3541
|
+
# [Setting up GameLift Fleets][1]
|
2981
3542
|
#
|
2982
3543
|
# **Related operations**
|
2983
3544
|
#
|
@@ -3005,11 +3566,7 @@ module Aws::GameLift
|
|
3005
3566
|
#
|
3006
3567
|
# * UpdateFleetAttributes
|
3007
3568
|
#
|
3008
|
-
# *
|
3009
|
-
#
|
3010
|
-
# * StartFleetActions
|
3011
|
-
#
|
3012
|
-
# * StopFleetActions
|
3569
|
+
# * StartFleetActions or StopFleetActions
|
3013
3570
|
#
|
3014
3571
|
#
|
3015
3572
|
#
|
@@ -3048,7 +3605,7 @@ module Aws::GameLift
|
|
3048
3605
|
# @example Request syntax with placeholder values
|
3049
3606
|
#
|
3050
3607
|
# resp = client.describe_fleet_events({
|
3051
|
-
# fleet_id: "
|
3608
|
+
# fleet_id: "FleetIdOrArn", # required
|
3052
3609
|
# start_time: Time.now,
|
3053
3610
|
# end_time: Time.now,
|
3054
3611
|
# limit: 1,
|
@@ -3075,17 +3632,20 @@ module Aws::GameLift
|
|
3075
3632
|
req.send_request(options)
|
3076
3633
|
end
|
3077
3634
|
|
3078
|
-
# Retrieves
|
3079
|
-
# permissions
|
3080
|
-
# incoming traffic can use to access server processes in the fleet.
|
3081
|
-
#
|
3082
|
-
#
|
3083
|
-
#
|
3084
|
-
#
|
3635
|
+
# Retrieves a fleet's inbound connection permissions. Connection
|
3636
|
+
# permissions specify the range of IP addresses and port settings that
|
3637
|
+
# incoming traffic can use to access server processes in the fleet. Game
|
3638
|
+
# sessions that are running on instances in the fleet use connections
|
3639
|
+
# that fall in this range.
|
3640
|
+
#
|
3641
|
+
# To get a fleet's inbound connection permissions, specify the fleet's
|
3642
|
+
# unique identifier. If successful, a collection of IpPermission objects
|
3643
|
+
# is returned for the requested fleet ID. If the requested fleet has
|
3644
|
+
# been deleted, the result set is empty.
|
3085
3645
|
#
|
3086
3646
|
# **Learn more**
|
3087
3647
|
#
|
3088
|
-
# [
|
3648
|
+
# [Setting up GameLift Fleets][1]
|
3089
3649
|
#
|
3090
3650
|
# **Related operations**
|
3091
3651
|
#
|
@@ -3113,11 +3673,7 @@ module Aws::GameLift
|
|
3113
3673
|
#
|
3114
3674
|
# * UpdateFleetAttributes
|
3115
3675
|
#
|
3116
|
-
# *
|
3117
|
-
#
|
3118
|
-
# * StartFleetActions
|
3119
|
-
#
|
3120
|
-
# * StopFleetActions
|
3676
|
+
# * StartFleetActions or StopFleetActions
|
3121
3677
|
#
|
3122
3678
|
#
|
3123
3679
|
#
|
@@ -3134,7 +3690,7 @@ module Aws::GameLift
|
|
3134
3690
|
# @example Request syntax with placeholder values
|
3135
3691
|
#
|
3136
3692
|
# resp = client.describe_fleet_port_settings({
|
3137
|
-
# fleet_id: "
|
3693
|
+
# fleet_id: "FleetIdOrArn", # required
|
3138
3694
|
# })
|
3139
3695
|
#
|
3140
3696
|
# @example Response structure
|
@@ -3154,13 +3710,16 @@ module Aws::GameLift
|
|
3154
3710
|
req.send_request(options)
|
3155
3711
|
end
|
3156
3712
|
|
3157
|
-
# Retrieves utilization statistics for one or more fleets.
|
3158
|
-
#
|
3159
|
-
#
|
3160
|
-
#
|
3161
|
-
#
|
3162
|
-
#
|
3163
|
-
#
|
3713
|
+
# Retrieves utilization statistics for one or more fleets. These
|
3714
|
+
# statistics provide insight into how available hosting resources are
|
3715
|
+
# currently being used. To get statistics on available hosting
|
3716
|
+
# resources, see DescribeFleetCapacity.
|
3717
|
+
#
|
3718
|
+
# You can request utilization data for all fleets, or specify a list of
|
3719
|
+
# one or more fleet IDs. When requesting multiple fleets, use the
|
3720
|
+
# pagination parameters to retrieve results as a set of sequential
|
3721
|
+
# pages. If successful, a FleetUtilization object is returned for each
|
3722
|
+
# requested fleet ID, unless the fleet identifier is not found.
|
3164
3723
|
#
|
3165
3724
|
# <note markdown="1"> Some API actions may limit the number of fleet IDs allowed in one
|
3166
3725
|
# request. If a request exceeds this limit, the request fails and the
|
@@ -3170,7 +3729,9 @@ module Aws::GameLift
|
|
3170
3729
|
#
|
3171
3730
|
# **Learn more**
|
3172
3731
|
#
|
3173
|
-
# [
|
3732
|
+
# [Setting up GameLift Fleets][1]
|
3733
|
+
#
|
3734
|
+
# [GameLift Metrics for Fleets][2]
|
3174
3735
|
#
|
3175
3736
|
# **Related operations**
|
3176
3737
|
#
|
@@ -3198,19 +3759,19 @@ module Aws::GameLift
|
|
3198
3759
|
#
|
3199
3760
|
# * UpdateFleetAttributes
|
3200
3761
|
#
|
3201
|
-
# *
|
3202
|
-
#
|
3203
|
-
# * StartFleetActions
|
3204
|
-
#
|
3205
|
-
# * StopFleetActions
|
3762
|
+
# * StartFleetActions or StopFleetActions
|
3206
3763
|
#
|
3207
3764
|
#
|
3208
3765
|
#
|
3209
3766
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
3767
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet
|
3210
3768
|
#
|
3211
3769
|
# @option params [Array<String>] :fleet_ids
|
3212
3770
|
# A unique identifier for a fleet(s) to retrieve utilization data for.
|
3213
|
-
# You can use either the fleet ID or ARN value.
|
3771
|
+
# You can use either the fleet ID or ARN value. To retrieve attributes
|
3772
|
+
# for all current fleets, do not include this parameter. If the list of
|
3773
|
+
# fleet identifiers includes fleets that don't currently exist, the
|
3774
|
+
# request succeeds but no attributes for that fleet are returned.
|
3214
3775
|
#
|
3215
3776
|
# @option params [Integer] :limit
|
3216
3777
|
# The maximum number of results to return. Use this parameter with
|
@@ -3233,7 +3794,7 @@ module Aws::GameLift
|
|
3233
3794
|
# @example Request syntax with placeholder values
|
3234
3795
|
#
|
3235
3796
|
# resp = client.describe_fleet_utilization({
|
3236
|
-
# fleet_ids: ["
|
3797
|
+
# fleet_ids: ["FleetIdOrArn"],
|
3237
3798
|
# limit: 1,
|
3238
3799
|
# next_token: "NonZeroAndMaxString",
|
3239
3800
|
# })
|
@@ -3257,6 +3818,153 @@ module Aws::GameLift
|
|
3257
3818
|
req.send_request(options)
|
3258
3819
|
end
|
3259
3820
|
|
3821
|
+
# **This action is part of Amazon GameLift FleetIQ with game server
|
3822
|
+
# groups, which is in preview release and is subject to change.**
|
3823
|
+
#
|
3824
|
+
# Retrieves information for a game server resource. Information includes
|
3825
|
+
# the game server statuses, health check info, and the instance the game
|
3826
|
+
# server is running on.
|
3827
|
+
#
|
3828
|
+
# To retrieve game server information, specify the game server ID. If
|
3829
|
+
# successful, the requested game server object is returned.
|
3830
|
+
#
|
3831
|
+
# **Learn more**
|
3832
|
+
#
|
3833
|
+
# [GameLift FleetIQ Guide][1]
|
3834
|
+
#
|
3835
|
+
# **Related operations**
|
3836
|
+
#
|
3837
|
+
# * RegisterGameServer
|
3838
|
+
#
|
3839
|
+
# * ListGameServers
|
3840
|
+
#
|
3841
|
+
# * ClaimGameServer
|
3842
|
+
#
|
3843
|
+
# * DescribeGameServer
|
3844
|
+
#
|
3845
|
+
# * UpdateGameServer
|
3846
|
+
#
|
3847
|
+
# * DeregisterGameServer
|
3848
|
+
#
|
3849
|
+
#
|
3850
|
+
#
|
3851
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
|
3852
|
+
#
|
3853
|
+
# @option params [required, String] :game_server_group_name
|
3854
|
+
# An identifier for the game server group where the game server is
|
3855
|
+
# running. Use either the GameServerGroup name or ARN value.
|
3856
|
+
#
|
3857
|
+
# @option params [required, String] :game_server_id
|
3858
|
+
# The identifier for the game server to be retrieved.
|
3859
|
+
#
|
3860
|
+
# @return [Types::DescribeGameServerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3861
|
+
#
|
3862
|
+
# * {Types::DescribeGameServerOutput#game_server #game_server} => Types::GameServer
|
3863
|
+
#
|
3864
|
+
# @example Request syntax with placeholder values
|
3865
|
+
#
|
3866
|
+
# resp = client.describe_game_server({
|
3867
|
+
# game_server_group_name: "GameServerGroupNameOrArn", # required
|
3868
|
+
# game_server_id: "GameServerId", # required
|
3869
|
+
# })
|
3870
|
+
#
|
3871
|
+
# @example Response structure
|
3872
|
+
#
|
3873
|
+
# resp.game_server.game_server_group_name #=> String
|
3874
|
+
# resp.game_server.game_server_group_arn #=> String
|
3875
|
+
# resp.game_server.game_server_id #=> String
|
3876
|
+
# resp.game_server.instance_id #=> String
|
3877
|
+
# resp.game_server.connection_info #=> String
|
3878
|
+
# resp.game_server.game_server_data #=> String
|
3879
|
+
# resp.game_server.custom_sort_key #=> String
|
3880
|
+
# resp.game_server.claim_status #=> String, one of "CLAIMED"
|
3881
|
+
# resp.game_server.utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
|
3882
|
+
# resp.game_server.registration_time #=> Time
|
3883
|
+
# resp.game_server.last_claim_time #=> Time
|
3884
|
+
# resp.game_server.last_health_check_time #=> Time
|
3885
|
+
#
|
3886
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeGameServer AWS API Documentation
|
3887
|
+
#
|
3888
|
+
# @overload describe_game_server(params = {})
|
3889
|
+
# @param [Hash] params ({})
|
3890
|
+
def describe_game_server(params = {}, options = {})
|
3891
|
+
req = build_request(:describe_game_server, params)
|
3892
|
+
req.send_request(options)
|
3893
|
+
end
|
3894
|
+
|
3895
|
+
# **This action is part of Amazon GameLift FleetIQ with game server
|
3896
|
+
# groups, which is in preview release and is subject to change.**
|
3897
|
+
#
|
3898
|
+
# Retrieves information on a game server group.
|
3899
|
+
#
|
3900
|
+
# To get attributes for a game server group, provide a group name or ARN
|
3901
|
+
# value. If successful, a GameServerGroup object is returned.
|
3902
|
+
#
|
3903
|
+
# **Learn more**
|
3904
|
+
#
|
3905
|
+
# [GameLift FleetIQ Guide][1]
|
3906
|
+
#
|
3907
|
+
# **Related operations**
|
3908
|
+
#
|
3909
|
+
# * CreateGameServerGroup
|
3910
|
+
#
|
3911
|
+
# * ListGameServerGroups
|
3912
|
+
#
|
3913
|
+
# * DescribeGameServerGroup
|
3914
|
+
#
|
3915
|
+
# * UpdateGameServerGroup
|
3916
|
+
#
|
3917
|
+
# * DeleteGameServerGroup
|
3918
|
+
#
|
3919
|
+
# * ResumeGameServerGroup
|
3920
|
+
#
|
3921
|
+
# * SuspendGameServerGroup
|
3922
|
+
#
|
3923
|
+
#
|
3924
|
+
#
|
3925
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
|
3926
|
+
#
|
3927
|
+
# @option params [required, String] :game_server_group_name
|
3928
|
+
# The unique identifier for the game server group being requested. Use
|
3929
|
+
# either the GameServerGroup name or ARN value.
|
3930
|
+
#
|
3931
|
+
# @return [Types::DescribeGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3932
|
+
#
|
3933
|
+
# * {Types::DescribeGameServerGroupOutput#game_server_group #game_server_group} => Types::GameServerGroup
|
3934
|
+
#
|
3935
|
+
# @example Request syntax with placeholder values
|
3936
|
+
#
|
3937
|
+
# resp = client.describe_game_server_group({
|
3938
|
+
# game_server_group_name: "GameServerGroupNameOrArn", # required
|
3939
|
+
# })
|
3940
|
+
#
|
3941
|
+
# @example Response structure
|
3942
|
+
#
|
3943
|
+
# resp.game_server_group.game_server_group_name #=> String
|
3944
|
+
# resp.game_server_group.game_server_group_arn #=> String
|
3945
|
+
# resp.game_server_group.role_arn #=> String
|
3946
|
+
# resp.game_server_group.instance_definitions #=> Array
|
3947
|
+
# 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
|
+
# resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
|
3949
|
+
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED"
|
3950
|
+
# resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
|
3951
|
+
# resp.game_server_group.auto_scaling_group_arn #=> String
|
3952
|
+
# resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
|
3953
|
+
# resp.game_server_group.status_reason #=> String
|
3954
|
+
# resp.game_server_group.suspended_actions #=> Array
|
3955
|
+
# resp.game_server_group.suspended_actions[0] #=> String, one of "REPLACE_INSTANCE_TYPES"
|
3956
|
+
# resp.game_server_group.creation_time #=> Time
|
3957
|
+
# resp.game_server_group.last_updated_time #=> Time
|
3958
|
+
#
|
3959
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeGameServerGroup AWS API Documentation
|
3960
|
+
#
|
3961
|
+
# @overload describe_game_server_group(params = {})
|
3962
|
+
# @param [Hash] params ({})
|
3963
|
+
def describe_game_server_group(params = {}, options = {})
|
3964
|
+
req = build_request(:describe_game_server_group, params)
|
3965
|
+
req.send_request(options)
|
3966
|
+
end
|
3967
|
+
|
3260
3968
|
# Retrieves properties, including the protection policy in force, for
|
3261
3969
|
# one or more game sessions. This action can be used in several ways:
|
3262
3970
|
# (1) provide a `GameSessionId` or `GameSessionArn` to request details
|
@@ -3323,9 +4031,9 @@ module Aws::GameLift
|
|
3323
4031
|
# @example Request syntax with placeholder values
|
3324
4032
|
#
|
3325
4033
|
# resp = client.describe_game_session_details({
|
3326
|
-
# fleet_id: "
|
4034
|
+
# fleet_id: "FleetIdOrArn",
|
3327
4035
|
# game_session_id: "ArnStringModel",
|
3328
|
-
# alias_id: "
|
4036
|
+
# alias_id: "AliasIdOrArn",
|
3329
4037
|
# status_filter: "NonZeroAndMaxString",
|
3330
4038
|
# limit: 1,
|
3331
4039
|
# next_token: "NonZeroAndMaxString",
|
@@ -3447,6 +4155,12 @@ module Aws::GameLift
|
|
3447
4155
|
# specifying a list of queues, objects are returned only for queues that
|
3448
4156
|
# currently exist in the Region.
|
3449
4157
|
#
|
4158
|
+
# **Learn more**
|
4159
|
+
#
|
4160
|
+
# [ View Your Queues][1]
|
4161
|
+
#
|
4162
|
+
# **Related operations**
|
4163
|
+
#
|
3450
4164
|
# * CreateGameSessionQueue
|
3451
4165
|
#
|
3452
4166
|
# * DescribeGameSessionQueues
|
@@ -3455,6 +4169,10 @@ module Aws::GameLift
|
|
3455
4169
|
#
|
3456
4170
|
# * DeleteGameSessionQueue
|
3457
4171
|
#
|
4172
|
+
#
|
4173
|
+
#
|
4174
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-console.html
|
4175
|
+
#
|
3458
4176
|
# @option params [Array<String>] :names
|
3459
4177
|
# A list of queue names to retrieve information for. You can use either
|
3460
4178
|
# the queue ID or ARN value. To request settings for all queues, leave
|
@@ -3478,7 +4196,7 @@ module Aws::GameLift
|
|
3478
4196
|
# @example Request syntax with placeholder values
|
3479
4197
|
#
|
3480
4198
|
# resp = client.describe_game_session_queues({
|
3481
|
-
# names: ["
|
4199
|
+
# names: ["GameSessionQueueNameOrArn"],
|
3482
4200
|
# limit: 1,
|
3483
4201
|
# next_token: "NonZeroAndMaxString",
|
3484
4202
|
# })
|
@@ -3572,9 +4290,9 @@ module Aws::GameLift
|
|
3572
4290
|
# @example Request syntax with placeholder values
|
3573
4291
|
#
|
3574
4292
|
# resp = client.describe_game_sessions({
|
3575
|
-
# fleet_id: "
|
4293
|
+
# fleet_id: "FleetIdOrArn",
|
3576
4294
|
# game_session_id: "ArnStringModel",
|
3577
|
-
# alias_id: "
|
4295
|
+
# alias_id: "AliasIdOrArn",
|
3578
4296
|
# status_filter: "NonZeroAndMaxString",
|
3579
4297
|
# limit: 1,
|
3580
4298
|
# next_token: "NonZeroAndMaxString",
|
@@ -3623,6 +4341,23 @@ module Aws::GameLift
|
|
3623
4341
|
# parameters to retrieve results as a set of sequential pages. If
|
3624
4342
|
# successful, an Instance object is returned for each result.
|
3625
4343
|
#
|
4344
|
+
# **Learn more**
|
4345
|
+
#
|
4346
|
+
# [Remotely Access Fleet Instances][1]
|
4347
|
+
#
|
4348
|
+
# [Debug Fleet Issues][2]
|
4349
|
+
#
|
4350
|
+
# **Related operations**
|
4351
|
+
#
|
4352
|
+
# * DescribeInstances
|
4353
|
+
#
|
4354
|
+
# * GetInstanceAccess
|
4355
|
+
#
|
4356
|
+
#
|
4357
|
+
#
|
4358
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html
|
4359
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html
|
4360
|
+
#
|
3626
4361
|
# @option params [required, String] :fleet_id
|
3627
4362
|
# A unique identifier for a fleet to retrieve instance information for.
|
3628
4363
|
# You can use either the fleet ID or ARN value.
|
@@ -3648,7 +4383,7 @@ module Aws::GameLift
|
|
3648
4383
|
# @example Request syntax with placeholder values
|
3649
4384
|
#
|
3650
4385
|
# resp = client.describe_instances({
|
3651
|
-
# fleet_id: "
|
4386
|
+
# fleet_id: "FleetIdOrArn", # required
|
3652
4387
|
# instance_id: "InstanceId",
|
3653
4388
|
# limit: 1,
|
3654
4389
|
# next_token: "NonZeroAndMaxString",
|
@@ -4059,13 +4794,20 @@ module Aws::GameLift
|
|
4059
4794
|
req.send_request(options)
|
4060
4795
|
end
|
4061
4796
|
|
4062
|
-
# Retrieves
|
4063
|
-
#
|
4064
|
-
#
|
4797
|
+
# Retrieves a fleet's runtime configuration settings. The runtime
|
4798
|
+
# configuration tells Amazon GameLift which server processes to run (and
|
4799
|
+
# how) on each instance in the fleet.
|
4800
|
+
#
|
4801
|
+
# To get a runtime configuration, specify the fleet's unique
|
4802
|
+
# identifier. If successful, a RuntimeConfiguration object is returned
|
4803
|
+
# for the requested fleet. If the requested fleet has been deleted, the
|
4804
|
+
# result set is empty.
|
4065
4805
|
#
|
4066
4806
|
# **Learn more**
|
4067
4807
|
#
|
4068
|
-
# [
|
4808
|
+
# [Setting up GameLift Fleets][1]
|
4809
|
+
#
|
4810
|
+
# [Running Multiple Processes on a Fleet][2]
|
4069
4811
|
#
|
4070
4812
|
# **Related operations**
|
4071
4813
|
#
|
@@ -4093,15 +4835,12 @@ module Aws::GameLift
|
|
4093
4835
|
#
|
4094
4836
|
# * UpdateFleetAttributes
|
4095
4837
|
#
|
4096
|
-
# *
|
4097
|
-
#
|
4098
|
-
# * StartFleetActions
|
4099
|
-
#
|
4100
|
-
# * StopFleetActions
|
4838
|
+
# * StartFleetActions or StopFleetActions
|
4101
4839
|
#
|
4102
4840
|
#
|
4103
4841
|
#
|
4104
4842
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
4843
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html
|
4105
4844
|
#
|
4106
4845
|
# @option params [required, String] :fleet_id
|
4107
4846
|
# A unique identifier for a fleet to get the runtime configuration for.
|
@@ -4114,7 +4853,7 @@ module Aws::GameLift
|
|
4114
4853
|
# @example Request syntax with placeholder values
|
4115
4854
|
#
|
4116
4855
|
# resp = client.describe_runtime_configuration({
|
4117
|
-
# fleet_id: "
|
4856
|
+
# fleet_id: "FleetIdOrArn", # required
|
4118
4857
|
# })
|
4119
4858
|
#
|
4120
4859
|
# @example Response structure
|
@@ -4211,7 +4950,7 @@ module Aws::GameLift
|
|
4211
4950
|
# @example Request syntax with placeholder values
|
4212
4951
|
#
|
4213
4952
|
# resp = client.describe_scaling_policies({
|
4214
|
-
# fleet_id: "
|
4953
|
+
# fleet_id: "FleetIdOrArn", # required
|
4215
4954
|
# status_filter: "ACTIVE", # accepts ACTIVE, UPDATE_REQUESTED, UPDATING, DELETE_REQUESTED, DELETING, DELETED, ERROR
|
4216
4955
|
# limit: 1,
|
4217
4956
|
# next_token: "NonZeroAndMaxString",
|
@@ -4278,7 +5017,7 @@ module Aws::GameLift
|
|
4278
5017
|
# @example Request syntax with placeholder values
|
4279
5018
|
#
|
4280
5019
|
# resp = client.describe_script({
|
4281
|
-
# script_id: "
|
5020
|
+
# script_id: "ScriptIdOrArn", # required
|
4282
5021
|
# })
|
4283
5022
|
#
|
4284
5023
|
# @example Response structure
|
@@ -4461,29 +5200,41 @@ module Aws::GameLift
|
|
4461
5200
|
end
|
4462
5201
|
|
4463
5202
|
# Requests remote access to a fleet instance. Remote access is useful
|
4464
|
-
# for debugging, gathering benchmarking data, or
|
5203
|
+
# for debugging, gathering benchmarking data, or observing activity in
|
4465
5204
|
# real time.
|
4466
5205
|
#
|
4467
|
-
#
|
4468
|
-
# instance. For a Windows instance, Amazon
|
4469
|
-
# and password as strings for use with a
|
4470
|
-
# For a Linux instance, Amazon GameLift
|
4471
|
-
# private key, also as strings, for use with
|
4472
|
-
# key must be saved in the proper format to a
|
4473
|
-
# If you're making this request using the AWS
|
4474
|
-
# can be handled as part of the GetInstanceAccess
|
4475
|
-
#
|
4476
|
-
# see [Remotely Accessing an Instance][1].
|
5206
|
+
# To remotely access an instance, you need credentials that match the
|
5207
|
+
# operating system of the instance. For a Windows instance, Amazon
|
5208
|
+
# GameLift returns a user name and password as strings for use with a
|
5209
|
+
# Windows Remote Desktop client. For a Linux instance, Amazon GameLift
|
5210
|
+
# returns a user name and RSA private key, also as strings, for use with
|
5211
|
+
# an SSH client. The private key must be saved in the proper format to a
|
5212
|
+
# `.pem` file before using. If you're making this request using the AWS
|
5213
|
+
# CLI, saving the secret can be handled as part of the GetInstanceAccess
|
5214
|
+
# request, as shown in one of the examples for this action.
|
4477
5215
|
#
|
4478
5216
|
# To request access to a specific instance, specify the IDs of both the
|
4479
5217
|
# instance and the fleet it belongs to. You can retrieve a fleet's
|
4480
5218
|
# instance IDs by calling DescribeInstances. If successful, an
|
4481
|
-
# InstanceAccess object is returned
|
5219
|
+
# InstanceAccess object is returned that contains the instance's IP
|
4482
5220
|
# address and a set of credentials.
|
4483
5221
|
#
|
5222
|
+
# **Learn more**
|
5223
|
+
#
|
5224
|
+
# [Remotely Access Fleet Instances][1]
|
5225
|
+
#
|
5226
|
+
# [Debug Fleet Issues][2]
|
5227
|
+
#
|
5228
|
+
# **Related operations**
|
5229
|
+
#
|
5230
|
+
# * DescribeInstances
|
5231
|
+
#
|
5232
|
+
# * GetInstanceAccess
|
5233
|
+
#
|
4484
5234
|
#
|
4485
5235
|
#
|
4486
5236
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html
|
5237
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html
|
4487
5238
|
#
|
4488
5239
|
# @option params [required, String] :fleet_id
|
4489
5240
|
# A unique identifier for a fleet that contains the instance you want
|
@@ -4503,7 +5254,7 @@ module Aws::GameLift
|
|
4503
5254
|
# @example Request syntax with placeholder values
|
4504
5255
|
#
|
4505
5256
|
# resp = client.get_instance_access({
|
4506
|
-
# fleet_id: "
|
5257
|
+
# fleet_id: "FleetIdOrArn", # required
|
4507
5258
|
# instance_id: "InstanceId", # required
|
4508
5259
|
# })
|
4509
5260
|
#
|
@@ -4611,18 +5362,18 @@ module Aws::GameLift
|
|
4611
5362
|
req.send_request(options)
|
4612
5363
|
end
|
4613
5364
|
|
4614
|
-
# Retrieves build
|
4615
|
-
# in use. You can limit results to builds that are in a specific
|
4616
|
-
# by using the `Status` parameter. Use the pagination parameters
|
4617
|
-
# retrieve results in a set of sequential pages.
|
5365
|
+
# Retrieves build resources for all builds associated with the AWS
|
5366
|
+
# account in use. You can limit results to builds that are in a specific
|
5367
|
+
# status by using the `Status` parameter. Use the pagination parameters
|
5368
|
+
# to retrieve results in a set of sequential pages.
|
4618
5369
|
#
|
4619
|
-
# <note markdown="1"> Build
|
5370
|
+
# <note markdown="1"> Build resources are not listed in any particular order.
|
4620
5371
|
#
|
4621
5372
|
# </note>
|
4622
5373
|
#
|
4623
5374
|
# **Learn more**
|
4624
5375
|
#
|
4625
|
-
# [
|
5376
|
+
# [ Upload a Custom Server Build][1]
|
4626
5377
|
#
|
4627
5378
|
# **Related operations**
|
4628
5379
|
#
|
@@ -4638,7 +5389,7 @@ module Aws::GameLift
|
|
4638
5389
|
#
|
4639
5390
|
#
|
4640
5391
|
#
|
4641
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/build-intro.html
|
5392
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html
|
4642
5393
|
#
|
4643
5394
|
# @option params [String] :status
|
4644
5395
|
# Build status to filter results by. To retrieve all builds, leave this
|
@@ -4701,18 +5452,18 @@ module Aws::GameLift
|
|
4701
5452
|
req.send_request(options)
|
4702
5453
|
end
|
4703
5454
|
|
4704
|
-
# Retrieves a collection of fleet
|
4705
|
-
# filter the result set to find only those fleets that are deployed
|
4706
|
-
# a specific build or script. Use the pagination parameters to
|
4707
|
-
# results in sequential pages.
|
5455
|
+
# Retrieves a collection of fleet resources for this AWS account. You
|
5456
|
+
# can filter the result set to find only those fleets that are deployed
|
5457
|
+
# with a specific build or script. Use the pagination parameters to
|
5458
|
+
# retrieve results in sequential pages.
|
4708
5459
|
#
|
4709
|
-
# <note markdown="1"> Fleet
|
5460
|
+
# <note markdown="1"> Fleet resources are not listed in a particular order.
|
4710
5461
|
#
|
4711
5462
|
# </note>
|
4712
5463
|
#
|
4713
5464
|
# **Learn more**
|
4714
5465
|
#
|
4715
|
-
# [
|
5466
|
+
# [Setting up GameLift Fleets][1]
|
4716
5467
|
#
|
4717
5468
|
# **Related operations**
|
4718
5469
|
#
|
@@ -4726,11 +5477,7 @@ module Aws::GameLift
|
|
4726
5477
|
#
|
4727
5478
|
# * UpdateFleetAttributes
|
4728
5479
|
#
|
4729
|
-
# *
|
4730
|
-
#
|
4731
|
-
# * StartFleetActions
|
4732
|
-
#
|
4733
|
-
# * StopFleetActions
|
5480
|
+
# * StartFleetActions or StopFleetActions
|
4734
5481
|
#
|
4735
5482
|
#
|
4736
5483
|
#
|
@@ -4738,14 +5485,14 @@ module Aws::GameLift
|
|
4738
5485
|
#
|
4739
5486
|
# @option params [String] :build_id
|
4740
5487
|
# A unique identifier for a build to return fleets for. Use this
|
4741
|
-
# parameter to return only fleets using
|
4742
|
-
# the build ID or ARN value.To retrieve all fleets,
|
4743
|
-
#
|
5488
|
+
# parameter to return only fleets using a specified build. Use either
|
5489
|
+
# the build ID or ARN value. To retrieve all fleets, do not include
|
5490
|
+
# either a BuildId and ScriptID parameter.
|
4744
5491
|
#
|
4745
5492
|
# @option params [String] :script_id
|
4746
5493
|
# A unique identifier for a Realtime script to return fleets for. Use
|
4747
|
-
# this parameter to return only fleets using
|
4748
|
-
# either the script ID or ARN value.To retrieve all fleets, leave this
|
5494
|
+
# this parameter to return only fleets using a specified script. Use
|
5495
|
+
# either the script ID or ARN value. To retrieve all fleets, leave this
|
4749
5496
|
# parameter empty.
|
4750
5497
|
#
|
4751
5498
|
# @option params [Integer] :limit
|
@@ -4765,8 +5512,8 @@ module Aws::GameLift
|
|
4765
5512
|
# @example Request syntax with placeholder values
|
4766
5513
|
#
|
4767
5514
|
# resp = client.list_fleets({
|
4768
|
-
# build_id: "
|
4769
|
-
# script_id: "
|
5515
|
+
# build_id: "BuildIdOrArn",
|
5516
|
+
# script_id: "ScriptIdOrArn",
|
4770
5517
|
# limit: 1,
|
4771
5518
|
# next_token: "NonZeroAndMaxString",
|
4772
5519
|
# })
|
@@ -4786,6 +5533,178 @@ module Aws::GameLift
|
|
4786
5533
|
req.send_request(options)
|
4787
5534
|
end
|
4788
5535
|
|
5536
|
+
# **This action is part of Amazon GameLift FleetIQ with game server
|
5537
|
+
# groups, which is in preview release and is subject to change.**
|
5538
|
+
#
|
5539
|
+
# Retrieves information on all game servers groups that exist in the
|
5540
|
+
# current AWS account for the selected region. Use the pagination
|
5541
|
+
# parameters to retrieve results in a set of sequential pages.
|
5542
|
+
#
|
5543
|
+
# **Learn more**
|
5544
|
+
#
|
5545
|
+
# [GameLift FleetIQ Guide][1]
|
5546
|
+
#
|
5547
|
+
# **Related operations**
|
5548
|
+
#
|
5549
|
+
# * CreateGameServerGroup
|
5550
|
+
#
|
5551
|
+
# * ListGameServerGroups
|
5552
|
+
#
|
5553
|
+
# * DescribeGameServerGroup
|
5554
|
+
#
|
5555
|
+
# * UpdateGameServerGroup
|
5556
|
+
#
|
5557
|
+
# * DeleteGameServerGroup
|
5558
|
+
#
|
5559
|
+
# * ResumeGameServerGroup
|
5560
|
+
#
|
5561
|
+
# * SuspendGameServerGroup
|
5562
|
+
#
|
5563
|
+
#
|
5564
|
+
#
|
5565
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
|
5566
|
+
#
|
5567
|
+
# @option params [Integer] :limit
|
5568
|
+
# The maximum number of results to return. Use this parameter with
|
5569
|
+
# `NextToken` to get results as a set of sequential pages.
|
5570
|
+
#
|
5571
|
+
# @option params [String] :next_token
|
5572
|
+
# A token that indicates the start of the next sequential page of
|
5573
|
+
# results. Use the token that is returned with a previous call to this
|
5574
|
+
# action. To start at the beginning of the result set, do not specify a
|
5575
|
+
# value.
|
5576
|
+
#
|
5577
|
+
# @return [Types::ListGameServerGroupsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5578
|
+
#
|
5579
|
+
# * {Types::ListGameServerGroupsOutput#game_server_groups #game_server_groups} => Array<Types::GameServerGroup>
|
5580
|
+
# * {Types::ListGameServerGroupsOutput#next_token #next_token} => String
|
5581
|
+
#
|
5582
|
+
# @example Request syntax with placeholder values
|
5583
|
+
#
|
5584
|
+
# resp = client.list_game_server_groups({
|
5585
|
+
# limit: 1,
|
5586
|
+
# next_token: "NonZeroAndMaxString",
|
5587
|
+
# })
|
5588
|
+
#
|
5589
|
+
# @example Response structure
|
5590
|
+
#
|
5591
|
+
# resp.game_server_groups #=> Array
|
5592
|
+
# resp.game_server_groups[0].game_server_group_name #=> String
|
5593
|
+
# resp.game_server_groups[0].game_server_group_arn #=> String
|
5594
|
+
# resp.game_server_groups[0].role_arn #=> String
|
5595
|
+
# resp.game_server_groups[0].instance_definitions #=> Array
|
5596
|
+
# 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
|
+
# 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"
|
5599
|
+
# resp.game_server_groups[0].game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
|
5600
|
+
# resp.game_server_groups[0].auto_scaling_group_arn #=> String
|
5601
|
+
# resp.game_server_groups[0].status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
|
5602
|
+
# resp.game_server_groups[0].status_reason #=> String
|
5603
|
+
# resp.game_server_groups[0].suspended_actions #=> Array
|
5604
|
+
# resp.game_server_groups[0].suspended_actions[0] #=> String, one of "REPLACE_INSTANCE_TYPES"
|
5605
|
+
# resp.game_server_groups[0].creation_time #=> Time
|
5606
|
+
# resp.game_server_groups[0].last_updated_time #=> Time
|
5607
|
+
# resp.next_token #=> String
|
5608
|
+
#
|
5609
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListGameServerGroups AWS API Documentation
|
5610
|
+
#
|
5611
|
+
# @overload list_game_server_groups(params = {})
|
5612
|
+
# @param [Hash] params ({})
|
5613
|
+
def list_game_server_groups(params = {}, options = {})
|
5614
|
+
req = build_request(:list_game_server_groups, params)
|
5615
|
+
req.send_request(options)
|
5616
|
+
end
|
5617
|
+
|
5618
|
+
# **This action is part of Amazon GameLift FleetIQ with game server
|
5619
|
+
# groups, which is in preview release and is subject to change.**
|
5620
|
+
#
|
5621
|
+
# Retrieves information on all game servers that are currently running
|
5622
|
+
# in a specified game server group. If there are custom key sort values
|
5623
|
+
# for your game servers, you can opt to have the returned list sorted
|
5624
|
+
# based on these values. Use the pagination parameters to retrieve
|
5625
|
+
# results in a set of sequential pages.
|
5626
|
+
#
|
5627
|
+
# **Learn more**
|
5628
|
+
#
|
5629
|
+
# [GameLift FleetIQ Guide][1]
|
5630
|
+
#
|
5631
|
+
# **Related operations**
|
5632
|
+
#
|
5633
|
+
# * RegisterGameServer
|
5634
|
+
#
|
5635
|
+
# * ListGameServers
|
5636
|
+
#
|
5637
|
+
# * ClaimGameServer
|
5638
|
+
#
|
5639
|
+
# * DescribeGameServer
|
5640
|
+
#
|
5641
|
+
# * UpdateGameServer
|
5642
|
+
#
|
5643
|
+
# * DeregisterGameServer
|
5644
|
+
#
|
5645
|
+
#
|
5646
|
+
#
|
5647
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
|
5648
|
+
#
|
5649
|
+
# @option params [required, String] :game_server_group_name
|
5650
|
+
# An identifier for the game server group for the game server you want
|
5651
|
+
# to list. Use either the GameServerGroup name or ARN value.
|
5652
|
+
#
|
5653
|
+
# @option params [String] :sort_order
|
5654
|
+
# Indicates how to sort the returned data based on the game servers'
|
5655
|
+
# custom key sort value. If this parameter is left empty, the list of
|
5656
|
+
# game servers is returned in no particular order.
|
5657
|
+
#
|
5658
|
+
# @option params [Integer] :limit
|
5659
|
+
# The maximum number of results to return. Use this parameter with
|
5660
|
+
# `NextToken` to get results as a set of sequential pages.
|
5661
|
+
#
|
5662
|
+
# @option params [String] :next_token
|
5663
|
+
# A token that indicates the start of the next sequential page of
|
5664
|
+
# results. Use the token that is returned with a previous call to this
|
5665
|
+
# action. To start at the beginning of the result set, do not specify a
|
5666
|
+
# value.
|
5667
|
+
#
|
5668
|
+
# @return [Types::ListGameServersOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5669
|
+
#
|
5670
|
+
# * {Types::ListGameServersOutput#game_servers #game_servers} => Array<Types::GameServer>
|
5671
|
+
# * {Types::ListGameServersOutput#next_token #next_token} => String
|
5672
|
+
#
|
5673
|
+
# @example Request syntax with placeholder values
|
5674
|
+
#
|
5675
|
+
# resp = client.list_game_servers({
|
5676
|
+
# game_server_group_name: "GameServerGroupNameOrArn", # required
|
5677
|
+
# sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
5678
|
+
# limit: 1,
|
5679
|
+
# next_token: "NonZeroAndMaxString",
|
5680
|
+
# })
|
5681
|
+
#
|
5682
|
+
# @example Response structure
|
5683
|
+
#
|
5684
|
+
# resp.game_servers #=> Array
|
5685
|
+
# resp.game_servers[0].game_server_group_name #=> String
|
5686
|
+
# resp.game_servers[0].game_server_group_arn #=> String
|
5687
|
+
# resp.game_servers[0].game_server_id #=> String
|
5688
|
+
# resp.game_servers[0].instance_id #=> String
|
5689
|
+
# resp.game_servers[0].connection_info #=> String
|
5690
|
+
# resp.game_servers[0].game_server_data #=> String
|
5691
|
+
# resp.game_servers[0].custom_sort_key #=> String
|
5692
|
+
# resp.game_servers[0].claim_status #=> String, one of "CLAIMED"
|
5693
|
+
# resp.game_servers[0].utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
|
5694
|
+
# resp.game_servers[0].registration_time #=> Time
|
5695
|
+
# resp.game_servers[0].last_claim_time #=> Time
|
5696
|
+
# resp.game_servers[0].last_health_check_time #=> Time
|
5697
|
+
# resp.next_token #=> String
|
5698
|
+
#
|
5699
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListGameServers AWS API Documentation
|
5700
|
+
#
|
5701
|
+
# @overload list_game_servers(params = {})
|
5702
|
+
# @param [Hash] params ({})
|
5703
|
+
def list_game_servers(params = {}, options = {})
|
5704
|
+
req = build_request(:list_game_servers, params)
|
5705
|
+
req.send_request(options)
|
5706
|
+
end
|
5707
|
+
|
4789
5708
|
# Retrieves script records for all Realtime scripts that are associated
|
4790
5709
|
# with the AWS account in use.
|
4791
5710
|
#
|
@@ -5143,7 +6062,7 @@ module Aws::GameLift
|
|
5143
6062
|
#
|
5144
6063
|
# resp = client.put_scaling_policy({
|
5145
6064
|
# name: "NonZeroAndMaxString", # required
|
5146
|
-
# fleet_id: "
|
6065
|
+
# fleet_id: "FleetIdOrArn", # required
|
5147
6066
|
# scaling_adjustment: 1,
|
5148
6067
|
# scaling_adjustment_type: "ChangeInCapacity", # accepts ChangeInCapacity, ExactCapacity, PercentChangeInCapacity
|
5149
6068
|
# threshold: 1.0,
|
@@ -5158,14 +6077,145 @@ module Aws::GameLift
|
|
5158
6077
|
#
|
5159
6078
|
# @example Response structure
|
5160
6079
|
#
|
5161
|
-
# resp.name #=> String
|
5162
|
-
#
|
5163
|
-
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/PutScalingPolicy AWS API Documentation
|
5164
|
-
#
|
5165
|
-
# @overload put_scaling_policy(params = {})
|
6080
|
+
# resp.name #=> String
|
6081
|
+
#
|
6082
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/PutScalingPolicy AWS API Documentation
|
6083
|
+
#
|
6084
|
+
# @overload put_scaling_policy(params = {})
|
6085
|
+
# @param [Hash] params ({})
|
6086
|
+
def put_scaling_policy(params = {}, options = {})
|
6087
|
+
req = build_request(:put_scaling_policy, params)
|
6088
|
+
req.send_request(options)
|
6089
|
+
end
|
6090
|
+
|
6091
|
+
# **This action is part of Amazon GameLift FleetIQ with game server
|
6092
|
+
# groups, which is in preview release and is subject to change.**
|
6093
|
+
#
|
6094
|
+
# Creates a new game server resource and notifies GameLift FleetIQ that
|
6095
|
+
# the game server is ready to host gameplay and players. This action is
|
6096
|
+
# called by a game server process that is running on an instance in a
|
6097
|
+
# game server group. Registering game servers enables GameLift FleetIQ
|
6098
|
+
# to track available game servers and enables game clients and services
|
6099
|
+
# to claim a game server for a new game session.
|
6100
|
+
#
|
6101
|
+
# To register a game server, identify the game server group and instance
|
6102
|
+
# 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
|
+
# when a game client or service requests a game server by calling
|
6105
|
+
# ClaimGameServer, this information is returned in response.
|
6106
|
+
#
|
6107
|
+
# Once a game server is successfully registered, it is put in status
|
6108
|
+
# AVAILABLE. A request to register a game server may fail if the
|
6109
|
+
# instance it is in the process of shutting down as part of instance
|
6110
|
+
# rebalancing or scale-down activity.
|
6111
|
+
#
|
6112
|
+
# **Learn more**
|
6113
|
+
#
|
6114
|
+
# [GameLift FleetIQ Guide][1]
|
6115
|
+
#
|
6116
|
+
# **Related operations**
|
6117
|
+
#
|
6118
|
+
# * RegisterGameServer
|
6119
|
+
#
|
6120
|
+
# * ListGameServers
|
6121
|
+
#
|
6122
|
+
# * ClaimGameServer
|
6123
|
+
#
|
6124
|
+
# * DescribeGameServer
|
6125
|
+
#
|
6126
|
+
# * UpdateGameServer
|
6127
|
+
#
|
6128
|
+
# * DeregisterGameServer
|
6129
|
+
#
|
6130
|
+
#
|
6131
|
+
#
|
6132
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
|
6133
|
+
#
|
6134
|
+
# @option params [required, String] :game_server_group_name
|
6135
|
+
# An identifier for the game server group where the game server is
|
6136
|
+
# running. You can use either the GameServerGroup name or ARN value.
|
6137
|
+
#
|
6138
|
+
# @option params [required, String] :game_server_id
|
6139
|
+
# A custom string that uniquely identifies the new game server. Game
|
6140
|
+
# server IDs are developer-defined and must be unique across all game
|
6141
|
+
# server groups in your AWS account.
|
6142
|
+
#
|
6143
|
+
# @option params [required, String] :instance_id
|
6144
|
+
# The unique identifier for the instance where the game server is
|
6145
|
+
# running. This ID is available in the instance metadata.
|
6146
|
+
#
|
6147
|
+
# @option params [String] :connection_info
|
6148
|
+
# Information needed to make inbound client connections to the game
|
6149
|
+
# server. This might include IP address and port, DNS name, etc.
|
6150
|
+
#
|
6151
|
+
# @option params [String] :game_server_data
|
6152
|
+
# A set of custom game server properties, formatted as a single string
|
6153
|
+
# value. This data is passed to a game client or service when it
|
6154
|
+
# requests information on a game servers using ListGameServers or
|
6155
|
+
# ClaimGameServer.
|
6156
|
+
#
|
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
|
+
# @return [Types::RegisterGameServerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6178
|
+
#
|
6179
|
+
# * {Types::RegisterGameServerOutput#game_server #game_server} => Types::GameServer
|
6180
|
+
#
|
6181
|
+
# @example Request syntax with placeholder values
|
6182
|
+
#
|
6183
|
+
# resp = client.register_game_server({
|
6184
|
+
# game_server_group_name: "GameServerGroupNameOrArn", # required
|
6185
|
+
# game_server_id: "GameServerId", # required
|
6186
|
+
# instance_id: "GameServerInstanceId", # required
|
6187
|
+
# connection_info: "GameServerConnectionInfo",
|
6188
|
+
# game_server_data: "GameServerData",
|
6189
|
+
# custom_sort_key: "GameServerSortKey",
|
6190
|
+
# tags: [
|
6191
|
+
# {
|
6192
|
+
# key: "TagKey", # required
|
6193
|
+
# value: "TagValue", # required
|
6194
|
+
# },
|
6195
|
+
# ],
|
6196
|
+
# })
|
6197
|
+
#
|
6198
|
+
# @example Response structure
|
6199
|
+
#
|
6200
|
+
# resp.game_server.game_server_group_name #=> String
|
6201
|
+
# resp.game_server.game_server_group_arn #=> String
|
6202
|
+
# resp.game_server.game_server_id #=> String
|
6203
|
+
# resp.game_server.instance_id #=> String
|
6204
|
+
# resp.game_server.connection_info #=> String
|
6205
|
+
# resp.game_server.game_server_data #=> String
|
6206
|
+
# resp.game_server.custom_sort_key #=> String
|
6207
|
+
# resp.game_server.claim_status #=> String, one of "CLAIMED"
|
6208
|
+
# resp.game_server.utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
|
6209
|
+
# resp.game_server.registration_time #=> Time
|
6210
|
+
# resp.game_server.last_claim_time #=> Time
|
6211
|
+
# resp.game_server.last_health_check_time #=> Time
|
6212
|
+
#
|
6213
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/RegisterGameServer AWS API Documentation
|
6214
|
+
#
|
6215
|
+
# @overload register_game_server(params = {})
|
5166
6216
|
# @param [Hash] params ({})
|
5167
|
-
def
|
5168
|
-
req = build_request(:
|
6217
|
+
def register_game_server(params = {}, options = {})
|
6218
|
+
req = build_request(:register_game_server, params)
|
5169
6219
|
req.send_request(options)
|
5170
6220
|
end
|
5171
6221
|
|
@@ -5180,7 +6230,7 @@ module Aws::GameLift
|
|
5180
6230
|
#
|
5181
6231
|
# **Learn more**
|
5182
6232
|
#
|
5183
|
-
# [
|
6233
|
+
# [ Create a Build with Files in S3][1]
|
5184
6234
|
#
|
5185
6235
|
# **Related operations**
|
5186
6236
|
#
|
@@ -5196,7 +6246,7 @@ module Aws::GameLift
|
|
5196
6246
|
#
|
5197
6247
|
#
|
5198
6248
|
#
|
5199
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-
|
6249
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html#gamelift-build-cli-uploading-create-build
|
5200
6250
|
#
|
5201
6251
|
# @option params [required, String] :build_id
|
5202
6252
|
# A unique identifier for a build to get credentials for. You can use
|
@@ -5210,7 +6260,7 @@ module Aws::GameLift
|
|
5210
6260
|
# @example Request syntax with placeholder values
|
5211
6261
|
#
|
5212
6262
|
# resp = client.request_upload_credentials({
|
5213
|
-
# build_id: "
|
6263
|
+
# build_id: "BuildIdOrArn", # required
|
5214
6264
|
# })
|
5215
6265
|
#
|
5216
6266
|
# @example Response structure
|
@@ -5258,7 +6308,7 @@ module Aws::GameLift
|
|
5258
6308
|
# @example Request syntax with placeholder values
|
5259
6309
|
#
|
5260
6310
|
# resp = client.resolve_alias({
|
5261
|
-
# alias_id: "
|
6311
|
+
# alias_id: "AliasIdOrArn", # required
|
5262
6312
|
# })
|
5263
6313
|
#
|
5264
6314
|
# @example Response structure
|
@@ -5275,6 +6325,89 @@ module Aws::GameLift
|
|
5275
6325
|
req.send_request(options)
|
5276
6326
|
end
|
5277
6327
|
|
6328
|
+
# **This action is part of Amazon GameLift FleetIQ with game server
|
6329
|
+
# groups, which is in preview release and is subject to change.**
|
6330
|
+
#
|
6331
|
+
# Reinstates activity on a game server group after it has been
|
6332
|
+
# suspended. A game server group may be suspended by calling
|
6333
|
+
# SuspendGameServerGroup, or it may have been involuntarily suspended
|
6334
|
+
# due to a configuration problem. You can manually resume activity on
|
6335
|
+
# the group once the configuration problem has been resolved. Refer to
|
6336
|
+
# the game server group status and status reason for more information on
|
6337
|
+
# why group activity is suspended.
|
6338
|
+
#
|
6339
|
+
# To resume activity, specify a game server group ARN and the type of
|
6340
|
+
# activity to be resumed.
|
6341
|
+
#
|
6342
|
+
# **Learn more**
|
6343
|
+
#
|
6344
|
+
# [GameLift FleetIQ Guide][1]
|
6345
|
+
#
|
6346
|
+
# **Related operations**
|
6347
|
+
#
|
6348
|
+
# * CreateGameServerGroup
|
6349
|
+
#
|
6350
|
+
# * ListGameServerGroups
|
6351
|
+
#
|
6352
|
+
# * DescribeGameServerGroup
|
6353
|
+
#
|
6354
|
+
# * UpdateGameServerGroup
|
6355
|
+
#
|
6356
|
+
# * DeleteGameServerGroup
|
6357
|
+
#
|
6358
|
+
# * ResumeGameServerGroup
|
6359
|
+
#
|
6360
|
+
# * SuspendGameServerGroup
|
6361
|
+
#
|
6362
|
+
#
|
6363
|
+
#
|
6364
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
|
6365
|
+
#
|
6366
|
+
# @option params [required, String] :game_server_group_name
|
6367
|
+
# The unique identifier of the game server group to resume activity on.
|
6368
|
+
# Use either the GameServerGroup name or ARN value.
|
6369
|
+
#
|
6370
|
+
# @option params [required, Array<String>] :resume_actions
|
6371
|
+
# The action to resume for this game server group.
|
6372
|
+
#
|
6373
|
+
# @return [Types::ResumeGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6374
|
+
#
|
6375
|
+
# * {Types::ResumeGameServerGroupOutput#game_server_group #game_server_group} => Types::GameServerGroup
|
6376
|
+
#
|
6377
|
+
# @example Request syntax with placeholder values
|
6378
|
+
#
|
6379
|
+
# resp = client.resume_game_server_group({
|
6380
|
+
# game_server_group_name: "GameServerGroupNameOrArn", # required
|
6381
|
+
# resume_actions: ["REPLACE_INSTANCE_TYPES"], # required, accepts REPLACE_INSTANCE_TYPES
|
6382
|
+
# })
|
6383
|
+
#
|
6384
|
+
# @example Response structure
|
6385
|
+
#
|
6386
|
+
# resp.game_server_group.game_server_group_name #=> String
|
6387
|
+
# resp.game_server_group.game_server_group_arn #=> String
|
6388
|
+
# resp.game_server_group.role_arn #=> String
|
6389
|
+
# resp.game_server_group.instance_definitions #=> Array
|
6390
|
+
# 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
|
+
# resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
|
6392
|
+
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED"
|
6393
|
+
# resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
|
6394
|
+
# resp.game_server_group.auto_scaling_group_arn #=> String
|
6395
|
+
# resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
|
6396
|
+
# resp.game_server_group.status_reason #=> String
|
6397
|
+
# resp.game_server_group.suspended_actions #=> Array
|
6398
|
+
# resp.game_server_group.suspended_actions[0] #=> String, one of "REPLACE_INSTANCE_TYPES"
|
6399
|
+
# resp.game_server_group.creation_time #=> Time
|
6400
|
+
# resp.game_server_group.last_updated_time #=> Time
|
6401
|
+
#
|
6402
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ResumeGameServerGroup AWS API Documentation
|
6403
|
+
#
|
6404
|
+
# @overload resume_game_server_group(params = {})
|
6405
|
+
# @param [Hash] params ({})
|
6406
|
+
def resume_game_server_group(params = {}, options = {})
|
6407
|
+
req = build_request(:resume_game_server_group, params)
|
6408
|
+
req.send_request(options)
|
6409
|
+
end
|
6410
|
+
|
5278
6411
|
# Retrieves all active game sessions that match a set of search criteria
|
5279
6412
|
# and sorts them in a specified order. You can search or sort by the
|
5280
6413
|
# following game session attributes:
|
@@ -5446,8 +6579,8 @@ module Aws::GameLift
|
|
5446
6579
|
# @example Request syntax with placeholder values
|
5447
6580
|
#
|
5448
6581
|
# resp = client.search_game_sessions({
|
5449
|
-
# fleet_id: "
|
5450
|
-
# alias_id: "
|
6582
|
+
# fleet_id: "FleetIdOrArn",
|
6583
|
+
# alias_id: "AliasIdOrArn",
|
5451
6584
|
# filter_expression: "NonZeroAndMaxString",
|
5452
6585
|
# sort_expression: "NonZeroAndMaxString",
|
5453
6586
|
# limit: 1,
|
@@ -5501,7 +6634,7 @@ module Aws::GameLift
|
|
5501
6634
|
#
|
5502
6635
|
# **Learn more**
|
5503
6636
|
#
|
5504
|
-
# [
|
6637
|
+
# [Setting up GameLift Fleets][1]
|
5505
6638
|
#
|
5506
6639
|
# **Related operations**
|
5507
6640
|
#
|
@@ -5511,37 +6644,11 @@ module Aws::GameLift
|
|
5511
6644
|
#
|
5512
6645
|
# * DeleteFleet
|
5513
6646
|
#
|
5514
|
-
# *
|
5515
|
-
#
|
5516
|
-
# * DescribeFleetAttributes
|
5517
|
-
#
|
5518
|
-
# * DescribeFleetCapacity
|
5519
|
-
#
|
5520
|
-
# * DescribeFleetPortSettings
|
5521
|
-
#
|
5522
|
-
# * DescribeFleetUtilization
|
5523
|
-
#
|
5524
|
-
# * DescribeRuntimeConfiguration
|
5525
|
-
#
|
5526
|
-
# * DescribeEC2InstanceLimits
|
5527
|
-
#
|
5528
|
-
# * DescribeFleetEvents
|
5529
|
-
#
|
5530
|
-
# * Update fleets:
|
5531
|
-
#
|
5532
|
-
# * UpdateFleetAttributes
|
5533
|
-
#
|
5534
|
-
# * UpdateFleetCapacity
|
5535
|
-
#
|
5536
|
-
# * UpdateFleetPortSettings
|
5537
|
-
#
|
5538
|
-
# * UpdateRuntimeConfiguration
|
5539
|
-
#
|
5540
|
-
# * Manage fleet actions:
|
6647
|
+
# * DescribeFleetAttributes
|
5541
6648
|
#
|
5542
|
-
#
|
6649
|
+
# * UpdateFleetAttributes
|
5543
6650
|
#
|
5544
|
-
#
|
6651
|
+
# * StartFleetActions or StopFleetActions
|
5545
6652
|
#
|
5546
6653
|
#
|
5547
6654
|
#
|
@@ -5559,7 +6666,7 @@ module Aws::GameLift
|
|
5559
6666
|
# @example Request syntax with placeholder values
|
5560
6667
|
#
|
5561
6668
|
# resp = client.start_fleet_actions({
|
5562
|
-
# fleet_id: "
|
6669
|
+
# fleet_id: "FleetIdOrArn", # required
|
5563
6670
|
# actions: ["AUTO_SCALING"], # required, accepts AUTO_SCALING
|
5564
6671
|
# })
|
5565
6672
|
#
|
@@ -5646,7 +6753,7 @@ module Aws::GameLift
|
|
5646
6753
|
#
|
5647
6754
|
# @option params [required, String] :game_session_queue_name
|
5648
6755
|
# Name of the queue to use to place the new game session. You can use
|
5649
|
-
# either the
|
6756
|
+
# either the queue name or ARN value.
|
5650
6757
|
#
|
5651
6758
|
# @option params [Array<Types::GameProperty>] :game_properties
|
5652
6759
|
# Set of custom properties for a game session, formatted as key:value
|
@@ -5693,7 +6800,7 @@ module Aws::GameLift
|
|
5693
6800
|
#
|
5694
6801
|
# resp = client.start_game_session_placement({
|
5695
6802
|
# placement_id: "IdStringModel", # required
|
5696
|
-
# game_session_queue_name: "
|
6803
|
+
# game_session_queue_name: "GameSessionQueueNameOrArn", # required
|
5697
6804
|
# game_properties: [
|
5698
6805
|
# {
|
5699
6806
|
# key: "GamePropertyKey", # required
|
@@ -6076,20 +7183,18 @@ module Aws::GameLift
|
|
6076
7183
|
|
6077
7184
|
# Suspends activity on a fleet. Currently, this operation is used to
|
6078
7185
|
# stop a fleet's auto-scaling activity. It is used to temporarily stop
|
6079
|
-
# scaling events
|
6080
|
-
#
|
6081
|
-
#
|
6082
|
-
# DescribeFleetAttributes.
|
7186
|
+
# triggering scaling events. The policies can be retained and
|
7187
|
+
# auto-scaling activity can be restarted using StartFleetActions. You
|
7188
|
+
# can view a fleet's stopped actions using DescribeFleetAttributes.
|
6083
7189
|
#
|
6084
7190
|
# To stop fleet actions, specify the fleet ID and the type of actions to
|
6085
7191
|
# suspend. When auto-scaling fleet actions are stopped, Amazon GameLift
|
6086
|
-
# no longer initiates scaling events except
|
6087
|
-
#
|
6088
|
-
# capacity must be done manually using UpdateFleetCapacity.
|
7192
|
+
# no longer initiates scaling events except in response to manual
|
7193
|
+
# changes using UpdateFleetCapacity.
|
6089
7194
|
#
|
6090
7195
|
# **Learn more**
|
6091
7196
|
#
|
6092
|
-
# [
|
7197
|
+
# [Setting up GameLift Fleets][1]
|
6093
7198
|
#
|
6094
7199
|
# **Related operations**
|
6095
7200
|
#
|
@@ -6099,37 +7204,11 @@ module Aws::GameLift
|
|
6099
7204
|
#
|
6100
7205
|
# * DeleteFleet
|
6101
7206
|
#
|
6102
|
-
# *
|
6103
|
-
#
|
6104
|
-
# * DescribeFleetAttributes
|
6105
|
-
#
|
6106
|
-
# * DescribeFleetCapacity
|
6107
|
-
#
|
6108
|
-
# * DescribeFleetPortSettings
|
6109
|
-
#
|
6110
|
-
# * DescribeFleetUtilization
|
6111
|
-
#
|
6112
|
-
# * DescribeRuntimeConfiguration
|
6113
|
-
#
|
6114
|
-
# * DescribeEC2InstanceLimits
|
6115
|
-
#
|
6116
|
-
# * DescribeFleetEvents
|
6117
|
-
#
|
6118
|
-
# * Update fleets:
|
6119
|
-
#
|
6120
|
-
# * UpdateFleetAttributes
|
6121
|
-
#
|
6122
|
-
# * UpdateFleetCapacity
|
6123
|
-
#
|
6124
|
-
# * UpdateFleetPortSettings
|
6125
|
-
#
|
6126
|
-
# * UpdateRuntimeConfiguration
|
6127
|
-
#
|
6128
|
-
# * Manage fleet actions:
|
7207
|
+
# * DescribeFleetAttributes
|
6129
7208
|
#
|
6130
|
-
#
|
7209
|
+
# * UpdateFleetAttributes
|
6131
7210
|
#
|
6132
|
-
#
|
7211
|
+
# * StartFleetActions or StopFleetActions
|
6133
7212
|
#
|
6134
7213
|
#
|
6135
7214
|
#
|
@@ -6147,7 +7226,7 @@ module Aws::GameLift
|
|
6147
7226
|
# @example Request syntax with placeholder values
|
6148
7227
|
#
|
6149
7228
|
# resp = client.stop_fleet_actions({
|
6150
|
-
# fleet_id: "
|
7229
|
+
# fleet_id: "FleetIdOrArn", # required
|
6151
7230
|
# actions: ["AUTO_SCALING"], # required, accepts AUTO_SCALING
|
6152
7231
|
# })
|
6153
7232
|
#
|
@@ -6290,6 +7369,97 @@ module Aws::GameLift
|
|
6290
7369
|
req.send_request(options)
|
6291
7370
|
end
|
6292
7371
|
|
7372
|
+
# **This action is part of Amazon GameLift FleetIQ with game server
|
7373
|
+
# groups, which is in preview release and is subject to change.**
|
7374
|
+
#
|
7375
|
+
# Temporarily stops activity on a game server group without terminating
|
7376
|
+
# instances or the game server group. Activity can be restarted by
|
7377
|
+
# calling ResumeGameServerGroup. Activities that can suspended are:
|
7378
|
+
#
|
7379
|
+
# * Instance type replacement. This activity evaluates the current Spot
|
7380
|
+
# viability of all instance types that are defined for the game server
|
7381
|
+
# group. It updates the Auto Scaling group to remove nonviable Spot
|
7382
|
+
# instance types (which have a higher chance of game server
|
7383
|
+
# interruptions) and rebalances capacity across the remaining viable
|
7384
|
+
# Spot instance types. When this activity is suspended, the Auto
|
7385
|
+
# Scaling group continues with its current balance, regardless of
|
7386
|
+
# viability. Instance protection, utilization metrics, and capacity
|
7387
|
+
# autoscaling activities continue to be active.
|
7388
|
+
#
|
7389
|
+
# ^
|
7390
|
+
#
|
7391
|
+
# To suspend activity, specify a game server group ARN and the type of
|
7392
|
+
# activity to be suspended.
|
7393
|
+
#
|
7394
|
+
# **Learn more**
|
7395
|
+
#
|
7396
|
+
# [GameLift FleetIQ Guide][1]
|
7397
|
+
#
|
7398
|
+
# **Related operations**
|
7399
|
+
#
|
7400
|
+
# * CreateGameServerGroup
|
7401
|
+
#
|
7402
|
+
# * ListGameServerGroups
|
7403
|
+
#
|
7404
|
+
# * DescribeGameServerGroup
|
7405
|
+
#
|
7406
|
+
# * UpdateGameServerGroup
|
7407
|
+
#
|
7408
|
+
# * DeleteGameServerGroup
|
7409
|
+
#
|
7410
|
+
# * ResumeGameServerGroup
|
7411
|
+
#
|
7412
|
+
# * SuspendGameServerGroup
|
7413
|
+
#
|
7414
|
+
#
|
7415
|
+
#
|
7416
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
|
7417
|
+
#
|
7418
|
+
# @option params [required, String] :game_server_group_name
|
7419
|
+
# The unique identifier of the game server group to stop activity on.
|
7420
|
+
# Use either the GameServerGroup name or ARN value.
|
7421
|
+
#
|
7422
|
+
# @option params [required, Array<String>] :suspend_actions
|
7423
|
+
# The action to suspend for this game server group.
|
7424
|
+
#
|
7425
|
+
# @return [Types::SuspendGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7426
|
+
#
|
7427
|
+
# * {Types::SuspendGameServerGroupOutput#game_server_group #game_server_group} => Types::GameServerGroup
|
7428
|
+
#
|
7429
|
+
# @example Request syntax with placeholder values
|
7430
|
+
#
|
7431
|
+
# resp = client.suspend_game_server_group({
|
7432
|
+
# game_server_group_name: "GameServerGroupNameOrArn", # required
|
7433
|
+
# suspend_actions: ["REPLACE_INSTANCE_TYPES"], # required, accepts REPLACE_INSTANCE_TYPES
|
7434
|
+
# })
|
7435
|
+
#
|
7436
|
+
# @example Response structure
|
7437
|
+
#
|
7438
|
+
# resp.game_server_group.game_server_group_name #=> String
|
7439
|
+
# resp.game_server_group.game_server_group_arn #=> String
|
7440
|
+
# resp.game_server_group.role_arn #=> String
|
7441
|
+
# resp.game_server_group.instance_definitions #=> Array
|
7442
|
+
# 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
|
+
# resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
|
7444
|
+
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED"
|
7445
|
+
# resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
|
7446
|
+
# resp.game_server_group.auto_scaling_group_arn #=> String
|
7447
|
+
# resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
|
7448
|
+
# resp.game_server_group.status_reason #=> String
|
7449
|
+
# resp.game_server_group.suspended_actions #=> Array
|
7450
|
+
# resp.game_server_group.suspended_actions[0] #=> String, one of "REPLACE_INSTANCE_TYPES"
|
7451
|
+
# resp.game_server_group.creation_time #=> Time
|
7452
|
+
# resp.game_server_group.last_updated_time #=> Time
|
7453
|
+
#
|
7454
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/SuspendGameServerGroup AWS API Documentation
|
7455
|
+
#
|
7456
|
+
# @overload suspend_game_server_group(params = {})
|
7457
|
+
# @param [Hash] params ({})
|
7458
|
+
def suspend_game_server_group(params = {}, options = {})
|
7459
|
+
req = build_request(:suspend_game_server_group, params)
|
7460
|
+
req.send_request(options)
|
7461
|
+
end
|
7462
|
+
|
6293
7463
|
# Assigns a tag to a GameLift resource. AWS resource tags provide an
|
6294
7464
|
# additional management tool set. You can use tags to organize
|
6295
7465
|
# resources, create IAM permissions policies to manage access to groups
|
@@ -6312,7 +7482,7 @@ module Aws::GameLift
|
|
6312
7482
|
# * MatchmakingRuleSet
|
6313
7483
|
#
|
6314
7484
|
# To add a tag to a resource, specify the unique ARN value for the
|
6315
|
-
# resource and provide a
|
7485
|
+
# resource and provide a tag list containing one or more tags. The
|
6316
7486
|
# operation succeeds even if the list includes tags that are already
|
6317
7487
|
# assigned to the specified resource.
|
6318
7488
|
#
|
@@ -6434,9 +7604,9 @@ module Aws::GameLift
|
|
6434
7604
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
|
6435
7605
|
#
|
6436
7606
|
# @option params [required, Array<String>] :tag_keys
|
6437
|
-
# A list of one or more
|
6438
|
-
# resource.
|
6439
|
-
#
|
7607
|
+
# A list of one or more tag keys to remove from the specified GameLift
|
7608
|
+
# resource. An AWS resource can have only one tag with a specific tag
|
7609
|
+
# key, so specifying the tag key identifies which tag to remove.
|
6440
7610
|
#
|
6441
7611
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
6442
7612
|
#
|
@@ -6495,7 +7665,7 @@ module Aws::GameLift
|
|
6495
7665
|
# @example Request syntax with placeholder values
|
6496
7666
|
#
|
6497
7667
|
# resp = client.update_alias({
|
6498
|
-
# alias_id: "
|
7668
|
+
# alias_id: "AliasIdOrArn", # required
|
6499
7669
|
# name: "NonBlankAndLengthConstraintString",
|
6500
7670
|
# description: "NonZeroAndMaxString",
|
6501
7671
|
# routing_strategy: {
|
@@ -6526,14 +7696,14 @@ module Aws::GameLift
|
|
6526
7696
|
req.send_request(options)
|
6527
7697
|
end
|
6528
7698
|
|
6529
|
-
# Updates metadata in a build
|
7699
|
+
# Updates metadata in a build resource, including the build name and
|
6530
7700
|
# version. To update the metadata, specify the build ID to update and
|
6531
7701
|
# provide the new values. If successful, a build object containing the
|
6532
7702
|
# updated metadata is returned.
|
6533
7703
|
#
|
6534
7704
|
# **Learn more**
|
6535
7705
|
#
|
6536
|
-
# [
|
7706
|
+
# [ Upload a Custom Server Build][1]
|
6537
7707
|
#
|
6538
7708
|
# **Related operations**
|
6539
7709
|
#
|
@@ -6549,7 +7719,7 @@ module Aws::GameLift
|
|
6549
7719
|
#
|
6550
7720
|
#
|
6551
7721
|
#
|
6552
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/build-intro.html
|
7722
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html
|
6553
7723
|
#
|
6554
7724
|
# @option params [required, String] :build_id
|
6555
7725
|
# A unique identifier for a build to update. You can use either the
|
@@ -6570,7 +7740,7 @@ module Aws::GameLift
|
|
6570
7740
|
# @example Request syntax with placeholder values
|
6571
7741
|
#
|
6572
7742
|
# resp = client.update_build({
|
6573
|
-
# build_id: "
|
7743
|
+
# build_id: "BuildIdOrArn", # required
|
6574
7744
|
# name: "NonZeroAndMaxString",
|
6575
7745
|
# version: "NonZeroAndMaxString",
|
6576
7746
|
# })
|
@@ -6602,7 +7772,7 @@ module Aws::GameLift
|
|
6602
7772
|
#
|
6603
7773
|
# **Learn more**
|
6604
7774
|
#
|
6605
|
-
# [
|
7775
|
+
# [Setting up GameLift Fleets][1]
|
6606
7776
|
#
|
6607
7777
|
# **Related operations**
|
6608
7778
|
#
|
@@ -6624,11 +7794,7 @@ module Aws::GameLift
|
|
6624
7794
|
#
|
6625
7795
|
# * UpdateRuntimeConfiguration
|
6626
7796
|
#
|
6627
|
-
# *
|
6628
|
-
#
|
6629
|
-
# * StartFleetActions
|
6630
|
-
#
|
6631
|
-
# * StopFleetActions
|
7797
|
+
# * StartFleetActions or StopFleetActions
|
6632
7798
|
#
|
6633
7799
|
#
|
6634
7800
|
#
|
@@ -6674,7 +7840,7 @@ module Aws::GameLift
|
|
6674
7840
|
# @example Request syntax with placeholder values
|
6675
7841
|
#
|
6676
7842
|
# resp = client.update_fleet_attributes({
|
6677
|
-
# fleet_id: "
|
7843
|
+
# fleet_id: "FleetIdOrArn", # required
|
6678
7844
|
# name: "NonZeroAndMaxString",
|
6679
7845
|
# description: "NonZeroAndMaxString",
|
6680
7846
|
# new_game_session_protection_policy: "NoProtection", # accepts NoProtection, FullProtection
|
@@ -6720,7 +7886,7 @@ module Aws::GameLift
|
|
6720
7886
|
#
|
6721
7887
|
# **Learn more**
|
6722
7888
|
#
|
6723
|
-
# [
|
7889
|
+
# [Setting up GameLift Fleets][1]
|
6724
7890
|
#
|
6725
7891
|
# **Related operations**
|
6726
7892
|
#
|
@@ -6742,11 +7908,7 @@ module Aws::GameLift
|
|
6742
7908
|
#
|
6743
7909
|
# * UpdateRuntimeConfiguration
|
6744
7910
|
#
|
6745
|
-
# *
|
6746
|
-
#
|
6747
|
-
# * StartFleetActions
|
6748
|
-
#
|
6749
|
-
# * StopFleetActions
|
7911
|
+
# * StartFleetActions or StopFleetActions
|
6750
7912
|
#
|
6751
7913
|
#
|
6752
7914
|
#
|
@@ -6774,7 +7936,7 @@ module Aws::GameLift
|
|
6774
7936
|
# @example Request syntax with placeholder values
|
6775
7937
|
#
|
6776
7938
|
# resp = client.update_fleet_capacity({
|
6777
|
-
# fleet_id: "
|
7939
|
+
# fleet_id: "FleetIdOrArn", # required
|
6778
7940
|
# desired_instances: 1,
|
6779
7941
|
# min_size: 1,
|
6780
7942
|
# max_size: 1,
|
@@ -6803,7 +7965,7 @@ module Aws::GameLift
|
|
6803
7965
|
#
|
6804
7966
|
# **Learn more**
|
6805
7967
|
#
|
6806
|
-
# [
|
7968
|
+
# [Setting up GameLift Fleets][1]
|
6807
7969
|
#
|
6808
7970
|
# **Related operations**
|
6809
7971
|
#
|
@@ -6825,11 +7987,7 @@ module Aws::GameLift
|
|
6825
7987
|
#
|
6826
7988
|
# * UpdateRuntimeConfiguration
|
6827
7989
|
#
|
6828
|
-
# *
|
6829
|
-
#
|
6830
|
-
# * StartFleetActions
|
6831
|
-
#
|
6832
|
-
# * StopFleetActions
|
7990
|
+
# * StartFleetActions or StopFleetActions
|
6833
7991
|
#
|
6834
7992
|
#
|
6835
7993
|
#
|
@@ -6840,10 +7998,10 @@ module Aws::GameLift
|
|
6840
7998
|
# use either the fleet ID or ARN value.
|
6841
7999
|
#
|
6842
8000
|
# @option params [Array<Types::IpPermission>] :inbound_permission_authorizations
|
6843
|
-
# A collection of port settings to be added to the fleet
|
8001
|
+
# A collection of port settings to be added to the fleet resource.
|
6844
8002
|
#
|
6845
8003
|
# @option params [Array<Types::IpPermission>] :inbound_permission_revocations
|
6846
|
-
# A collection of port settings to be removed from the fleet
|
8004
|
+
# A collection of port settings to be removed from the fleet resource.
|
6847
8005
|
#
|
6848
8006
|
# @return [Types::UpdateFleetPortSettingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6849
8007
|
#
|
@@ -6852,7 +8010,7 @@ module Aws::GameLift
|
|
6852
8010
|
# @example Request syntax with placeholder values
|
6853
8011
|
#
|
6854
8012
|
# resp = client.update_fleet_port_settings({
|
6855
|
-
# fleet_id: "
|
8013
|
+
# fleet_id: "FleetIdOrArn", # required
|
6856
8014
|
# inbound_permission_authorizations: [
|
6857
8015
|
# {
|
6858
8016
|
# from_port: 1, # required
|
@@ -6884,6 +8042,270 @@ module Aws::GameLift
|
|
6884
8042
|
req.send_request(options)
|
6885
8043
|
end
|
6886
8044
|
|
8045
|
+
# **This action is part of Amazon GameLift FleetIQ with game server
|
8046
|
+
# groups, which is in preview release and is subject to change.**
|
8047
|
+
#
|
8048
|
+
# Updates information about a registered game server. This action is
|
8049
|
+
# called by a game server process that is running on an instance in a
|
8050
|
+
# game server group. There are three reasons to update game server
|
8051
|
+
# information: (1) to change the utilization status of the game server,
|
8052
|
+
# (2) to report game server health status, and (3) to change game server
|
8053
|
+
# metadata. A registered game server should regularly report health and
|
8054
|
+
# should update utilization status when it is supporting gameplay so
|
8055
|
+
# that GameLift FleetIQ can accurately track game server availability.
|
8056
|
+
# You can make all three types of updates in the same request.
|
8057
|
+
#
|
8058
|
+
# * To update the game server's utilization status, identify the game
|
8059
|
+
# server and game server group and specify the current utilization
|
8060
|
+
# status. Use this status to identify when game servers are currently
|
8061
|
+
# hosting games and when they are available to be claimed.
|
8062
|
+
#
|
8063
|
+
# * To report health status, identify the game server and game server
|
8064
|
+
# group and set health check to HEALTHY. If a game server does not
|
8065
|
+
# report health status for a certain length of time, the game server
|
8066
|
+
# is no longer considered healthy and will be eventually de-registered
|
8067
|
+
# from the game server group to avoid affecting utilization metrics.
|
8068
|
+
# The best practice is to report health every 60 seconds.
|
8069
|
+
#
|
8070
|
+
# * To change game server metadata, provide updated game server data and
|
8071
|
+
# custom sort key values.
|
8072
|
+
#
|
8073
|
+
# Once a game server is successfully updated, the relevant statuses and
|
8074
|
+
# timestamps are updated.
|
8075
|
+
#
|
8076
|
+
# **Learn more**
|
8077
|
+
#
|
8078
|
+
# [GameLift FleetIQ Guide][1]
|
8079
|
+
#
|
8080
|
+
# **Related operations**
|
8081
|
+
#
|
8082
|
+
# * RegisterGameServer
|
8083
|
+
#
|
8084
|
+
# * ListGameServers
|
8085
|
+
#
|
8086
|
+
# * ClaimGameServer
|
8087
|
+
#
|
8088
|
+
# * DescribeGameServer
|
8089
|
+
#
|
8090
|
+
# * UpdateGameServer
|
8091
|
+
#
|
8092
|
+
# * DeregisterGameServer
|
8093
|
+
#
|
8094
|
+
#
|
8095
|
+
#
|
8096
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
|
8097
|
+
#
|
8098
|
+
# @option params [required, String] :game_server_group_name
|
8099
|
+
# An identifier for the game server group where the game server is
|
8100
|
+
# running. Use either the GameServerGroup name or ARN value.
|
8101
|
+
#
|
8102
|
+
# @option params [required, String] :game_server_id
|
8103
|
+
# The identifier for the game server to be updated.
|
8104
|
+
#
|
8105
|
+
# @option params [String] :game_server_data
|
8106
|
+
# A set of custom game server properties, formatted as a single string
|
8107
|
+
# value. This data is passed to a game client or service when it
|
8108
|
+
# requests information on a game servers using DescribeGameServer or
|
8109
|
+
# ClaimGameServer.
|
8110
|
+
#
|
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
|
+
# @option params [String] :utilization_status
|
8118
|
+
# Indicates whether the game server is available or is currently hosting
|
8119
|
+
# gameplay.
|
8120
|
+
#
|
8121
|
+
# @option params [String] :health_check
|
8122
|
+
# Indicates health status of the game server. An update that explicitly
|
8123
|
+
# includes this parameter updates the game server's
|
8124
|
+
# *LastHealthCheckTime* time stamp.
|
8125
|
+
#
|
8126
|
+
# @return [Types::UpdateGameServerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8127
|
+
#
|
8128
|
+
# * {Types::UpdateGameServerOutput#game_server #game_server} => Types::GameServer
|
8129
|
+
#
|
8130
|
+
# @example Request syntax with placeholder values
|
8131
|
+
#
|
8132
|
+
# resp = client.update_game_server({
|
8133
|
+
# game_server_group_name: "GameServerGroupNameOrArn", # required
|
8134
|
+
# game_server_id: "GameServerId", # required
|
8135
|
+
# game_server_data: "GameServerData",
|
8136
|
+
# custom_sort_key: "GameServerSortKey",
|
8137
|
+
# utilization_status: "AVAILABLE", # accepts AVAILABLE, UTILIZED
|
8138
|
+
# health_check: "HEALTHY", # accepts HEALTHY
|
8139
|
+
# })
|
8140
|
+
#
|
8141
|
+
# @example Response structure
|
8142
|
+
#
|
8143
|
+
# resp.game_server.game_server_group_name #=> String
|
8144
|
+
# resp.game_server.game_server_group_arn #=> String
|
8145
|
+
# resp.game_server.game_server_id #=> String
|
8146
|
+
# resp.game_server.instance_id #=> String
|
8147
|
+
# resp.game_server.connection_info #=> String
|
8148
|
+
# resp.game_server.game_server_data #=> String
|
8149
|
+
# resp.game_server.custom_sort_key #=> String
|
8150
|
+
# resp.game_server.claim_status #=> String, one of "CLAIMED"
|
8151
|
+
# resp.game_server.utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
|
8152
|
+
# resp.game_server.registration_time #=> Time
|
8153
|
+
# resp.game_server.last_claim_time #=> Time
|
8154
|
+
# resp.game_server.last_health_check_time #=> Time
|
8155
|
+
#
|
8156
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateGameServer AWS API Documentation
|
8157
|
+
#
|
8158
|
+
# @overload update_game_server(params = {})
|
8159
|
+
# @param [Hash] params ({})
|
8160
|
+
def update_game_server(params = {}, options = {})
|
8161
|
+
req = build_request(:update_game_server, params)
|
8162
|
+
req.send_request(options)
|
8163
|
+
end
|
8164
|
+
|
8165
|
+
# **This action is part of Amazon GameLift FleetIQ with game server
|
8166
|
+
# groups, which is in preview release and is subject to change.**
|
8167
|
+
#
|
8168
|
+
# Updates GameLift FleetIQ-specific properties for a game server group.
|
8169
|
+
# These properties include instance rebalancing and game server
|
8170
|
+
# protection. Many Auto Scaling group properties are updated directly.
|
8171
|
+
# These include autoscaling policies, minimum/maximum/desired instance
|
8172
|
+
# counts, and launch template.
|
8173
|
+
#
|
8174
|
+
# To update the game server group, specify the game server group ID and
|
8175
|
+
# provide the updated values.
|
8176
|
+
#
|
8177
|
+
# Updated properties are validated to ensure that GameLift FleetIQ can
|
8178
|
+
# continue to perform its core instance rebalancing activity. When you
|
8179
|
+
# change Auto Scaling group properties directly and the changes cause
|
8180
|
+
# errors with GameLift FleetIQ activities, an alert is sent.
|
8181
|
+
#
|
8182
|
+
# **Learn more**
|
8183
|
+
#
|
8184
|
+
# [GameLift FleetIQ Guide][1]
|
8185
|
+
#
|
8186
|
+
# [Updating a GameLift FleetIQ-Linked Auto Scaling Group][2]
|
8187
|
+
#
|
8188
|
+
# **Related operations**
|
8189
|
+
#
|
8190
|
+
# * CreateGameServerGroup
|
8191
|
+
#
|
8192
|
+
# * ListGameServerGroups
|
8193
|
+
#
|
8194
|
+
# * DescribeGameServerGroup
|
8195
|
+
#
|
8196
|
+
# * UpdateGameServerGroup
|
8197
|
+
#
|
8198
|
+
# * DeleteGameServerGroup
|
8199
|
+
#
|
8200
|
+
# * ResumeGameServerGroup
|
8201
|
+
#
|
8202
|
+
# * SuspendGameServerGroup
|
8203
|
+
#
|
8204
|
+
#
|
8205
|
+
#
|
8206
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
|
8207
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-asgroups.html
|
8208
|
+
#
|
8209
|
+
# @option params [required, String] :game_server_group_name
|
8210
|
+
# The unique identifier of the game server group to update. Use either
|
8211
|
+
# the GameServerGroup name or ARN value.
|
8212
|
+
#
|
8213
|
+
# @option params [String] :role_arn
|
8214
|
+
# The Amazon Resource Name ([ARN][1]) for an IAM role that allows Amazon
|
8215
|
+
# GameLift to access your EC2 Auto Scaling groups. The submitted role is
|
8216
|
+
# validated to ensure that it contains the necessary permissions for
|
8217
|
+
# game server groups.
|
8218
|
+
#
|
8219
|
+
#
|
8220
|
+
#
|
8221
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
|
8222
|
+
#
|
8223
|
+
# @option params [Array<Types::InstanceDefinition>] :instance_definitions
|
8224
|
+
# An updated list of EC2 instance types to use when creating instances
|
8225
|
+
# in the group. The instance definition must specify instance types that
|
8226
|
+
# are supported by GameLift FleetIQ, and must include at least two
|
8227
|
+
# instance types. This updated list replaces the entire current list of
|
8228
|
+
# instance definitions for the game server group. For more information
|
8229
|
+
# on instance types, see [EC2 Instance Types][1] in the *Amazon EC2 User
|
8230
|
+
# Guide*..
|
8231
|
+
#
|
8232
|
+
#
|
8233
|
+
#
|
8234
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html
|
8235
|
+
#
|
8236
|
+
# @option params [String] :game_server_protection_policy
|
8237
|
+
# A flag that indicates whether instances in the game server group are
|
8238
|
+
# protected from early termination. Unprotected instances that have
|
8239
|
+
# active game servers running may by terminated during a scale-down
|
8240
|
+
# event, causing players to be dropped from the game. Protected
|
8241
|
+
# instances cannot be terminated while there are active game servers
|
8242
|
+
# running. An exception to this is Spot Instances, which may be
|
8243
|
+
# terminated by AWS regardless of protection status. This property is
|
8244
|
+
# set to NO\_PROTECTION by default.
|
8245
|
+
#
|
8246
|
+
# @option params [String] :balancing_strategy
|
8247
|
+
# The fallback balancing method to use for the game server group when
|
8248
|
+
# Spot instances in a Region become unavailable or are not viable for
|
8249
|
+
# game hosting. Once triggered, this method remains active until Spot
|
8250
|
+
# instances can once again be used. Method options include:
|
8251
|
+
#
|
8252
|
+
# * SPOT\_ONLY -- If Spot instances are unavailable, the game server
|
8253
|
+
# group provides no hosting capacity. No new instances are started,
|
8254
|
+
# and the existing nonviable Spot instances are terminated (once
|
8255
|
+
# current gameplay ends) and not replaced.
|
8256
|
+
#
|
8257
|
+
# * SPOT\_PREFERRED -- If Spot instances are unavailable, the game
|
8258
|
+
# server group continues to provide hosting capacity by using
|
8259
|
+
# On-Demand instances. Existing nonviable Spot instances are
|
8260
|
+
# terminated (once current gameplay ends) and replaced with new
|
8261
|
+
# On-Demand instances.
|
8262
|
+
#
|
8263
|
+
# @return [Types::UpdateGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8264
|
+
#
|
8265
|
+
# * {Types::UpdateGameServerGroupOutput#game_server_group #game_server_group} => Types::GameServerGroup
|
8266
|
+
#
|
8267
|
+
# @example Request syntax with placeholder values
|
8268
|
+
#
|
8269
|
+
# resp = client.update_game_server_group({
|
8270
|
+
# game_server_group_name: "GameServerGroupNameOrArn", # required
|
8271
|
+
# role_arn: "IamRoleArn",
|
8272
|
+
# instance_definitions: [
|
8273
|
+
# {
|
8274
|
+
# instance_type: "c4.large", # required, accepts 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
|
8275
|
+
# weighted_capacity: "WeightedCapacity",
|
8276
|
+
# },
|
8277
|
+
# ],
|
8278
|
+
# game_server_protection_policy: "NO_PROTECTION", # accepts NO_PROTECTION, FULL_PROTECTION
|
8279
|
+
# balancing_strategy: "SPOT_ONLY", # accepts SPOT_ONLY, SPOT_PREFERRED
|
8280
|
+
# })
|
8281
|
+
#
|
8282
|
+
# @example Response structure
|
8283
|
+
#
|
8284
|
+
# resp.game_server_group.game_server_group_name #=> String
|
8285
|
+
# resp.game_server_group.game_server_group_arn #=> String
|
8286
|
+
# resp.game_server_group.role_arn #=> String
|
8287
|
+
# resp.game_server_group.instance_definitions #=> Array
|
8288
|
+
# 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
|
+
# resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
|
8290
|
+
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED"
|
8291
|
+
# resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
|
8292
|
+
# resp.game_server_group.auto_scaling_group_arn #=> String
|
8293
|
+
# resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
|
8294
|
+
# resp.game_server_group.status_reason #=> String
|
8295
|
+
# resp.game_server_group.suspended_actions #=> Array
|
8296
|
+
# resp.game_server_group.suspended_actions[0] #=> String, one of "REPLACE_INSTANCE_TYPES"
|
8297
|
+
# resp.game_server_group.creation_time #=> Time
|
8298
|
+
# resp.game_server_group.last_updated_time #=> Time
|
8299
|
+
#
|
8300
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateGameServerGroup AWS API Documentation
|
8301
|
+
#
|
8302
|
+
# @overload update_game_server_group(params = {})
|
8303
|
+
# @param [Hash] params ({})
|
8304
|
+
def update_game_server_group(params = {}, options = {})
|
8305
|
+
req = build_request(:update_game_server_group, params)
|
8306
|
+
req.send_request(options)
|
8307
|
+
end
|
8308
|
+
|
6887
8309
|
# Updates game session properties. This includes the session name,
|
6888
8310
|
# maximum player count, protection policy, which controls whether or not
|
6889
8311
|
# an active game session can be terminated during a scale-down event,
|
@@ -6987,6 +8409,12 @@ module Aws::GameLift
|
|
6987
8409
|
# specify the queue name to be updated and provide the new settings.
|
6988
8410
|
# When updating destinations, provide a complete list of destinations.
|
6989
8411
|
#
|
8412
|
+
# **Learn more**
|
8413
|
+
#
|
8414
|
+
# [ Using Multi-Region Queues][1]
|
8415
|
+
#
|
8416
|
+
# **Related operations**
|
8417
|
+
#
|
6990
8418
|
# * CreateGameSessionQueue
|
6991
8419
|
#
|
6992
8420
|
# * DescribeGameSessionQueues
|
@@ -6995,6 +8423,10 @@ module Aws::GameLift
|
|
6995
8423
|
#
|
6996
8424
|
# * DeleteGameSessionQueue
|
6997
8425
|
#
|
8426
|
+
#
|
8427
|
+
#
|
8428
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html
|
8429
|
+
#
|
6998
8430
|
# @option params [required, String] :name
|
6999
8431
|
# A descriptive label that is associated with game session queue. Queue
|
7000
8432
|
# names must be unique within each Region. You can use either the queue
|
@@ -7031,7 +8463,7 @@ module Aws::GameLift
|
|
7031
8463
|
# @example Request syntax with placeholder values
|
7032
8464
|
#
|
7033
8465
|
# resp = client.update_game_session_queue({
|
7034
|
-
# name: "
|
8466
|
+
# name: "GameSessionQueueNameOrArn", # required
|
7035
8467
|
# timeout_in_seconds: 1,
|
7036
8468
|
# player_latency_policies: [
|
7037
8469
|
# {
|
@@ -7269,7 +8701,7 @@ module Aws::GameLift
|
|
7269
8701
|
#
|
7270
8702
|
# **Learn more**
|
7271
8703
|
#
|
7272
|
-
# [
|
8704
|
+
# [Setting up GameLift Fleets][1]
|
7273
8705
|
#
|
7274
8706
|
# **Related operations**
|
7275
8707
|
#
|
@@ -7291,11 +8723,7 @@ module Aws::GameLift
|
|
7291
8723
|
#
|
7292
8724
|
# * UpdateRuntimeConfiguration
|
7293
8725
|
#
|
7294
|
-
# *
|
7295
|
-
#
|
7296
|
-
# * StartFleetActions
|
7297
|
-
#
|
7298
|
-
# * StopFleetActions
|
8726
|
+
# * StartFleetActions or StopFleetActions
|
7299
8727
|
#
|
7300
8728
|
#
|
7301
8729
|
#
|
@@ -7322,7 +8750,7 @@ module Aws::GameLift
|
|
7322
8750
|
# @example Request syntax with placeholder values
|
7323
8751
|
#
|
7324
8752
|
# resp = client.update_runtime_configuration({
|
7325
|
-
# fleet_id: "
|
8753
|
+
# fleet_id: "FleetIdOrArn", # required
|
7326
8754
|
# runtime_configuration: { # required
|
7327
8755
|
# server_processes: [
|
7328
8756
|
# {
|
@@ -7428,7 +8856,7 @@ module Aws::GameLift
|
|
7428
8856
|
# @example Request syntax with placeholder values
|
7429
8857
|
#
|
7430
8858
|
# resp = client.update_script({
|
7431
|
-
# script_id: "
|
8859
|
+
# script_id: "ScriptIdOrArn", # required
|
7432
8860
|
# name: "NonZeroAndMaxString",
|
7433
8861
|
# version: "NonZeroAndMaxString",
|
7434
8862
|
# storage_location: {
|
@@ -7535,7 +8963,7 @@ module Aws::GameLift
|
|
7535
8963
|
params: params,
|
7536
8964
|
config: config)
|
7537
8965
|
context[:gem_name] = 'aws-sdk-gamelift'
|
7538
|
-
context[:gem_version] = '1.
|
8966
|
+
context[:gem_version] = '1.32.1'
|
7539
8967
|
Seahorse::Client::Request.new(handlers, context)
|
7540
8968
|
end
|
7541
8969
|
|