aws-sdk-gamelift 1.28.0 → 1.33.0
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 +3 -1
- data/lib/aws-sdk-gamelift/client.rb +1769 -390
- data/lib/aws-sdk-gamelift/client_api.rb +458 -54
- data/lib/aws-sdk-gamelift/customizations.rb +1 -0
- data/lib/aws-sdk-gamelift/errors.rb +18 -0
- data/lib/aws-sdk-gamelift/resource.rb +3 -7
- data/lib/aws-sdk-gamelift/types.rb +1593 -149
- 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: db78a5576967de238c6c9b7af5ff49934b17a4b3b85db208208c8914b930684a
|
4
|
+
data.tar.gz: e1bcc778990c6f441026c4f4055a12bc656148cc576b60ec97818515751dee25
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: dced0a24026fb4a19cf2ec3118ad401ae4bd169b03a61cde5c0b2b9ec22eb805463dffa0a9356a35a70abf589da06c5a21994af12f3438b518a6b64e3b629e8a
|
7
|
+
data.tar.gz: 7ae76b4ce25172d9cdd031ed159c8102d7be98d34a8edfcf1df77c41e51585f08c34233d12e74023ce6ad21cec13edc03014ce97ac6ba9e6ac163772c6648009
|
data/lib/aws-sdk-gamelift.rb
CHANGED
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -45,6 +47,6 @@ require_relative 'aws-sdk-gamelift/customizations'
|
|
45
47
|
# @service
|
46
48
|
module Aws::GameLift
|
47
49
|
|
48
|
-
GEM_VERSION = '1.
|
50
|
+
GEM_VERSION = '1.33.0'
|
49
51
|
|
50
52
|
end
|
@@ -1,3 +1,5 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
1
3
|
# WARNING ABOUT GENERATED CODE
|
2
4
|
#
|
3
5
|
# This file is generated. See the contributing guide for more information:
|
@@ -24,6 +26,7 @@ require 'aws-sdk-core/plugins/jsonvalue_converter.rb'
|
|
24
26
|
require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
25
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
26
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
|
+
require 'aws-sdk-core/plugins/http_checksum.rb'
|
27
30
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
28
31
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
29
32
|
|
@@ -32,11 +35,11 @@ Aws::Plugins::GlobalConfiguration.add_identifier(:gamelift)
|
|
32
35
|
module Aws::GameLift
|
33
36
|
# An API client for GameLift. To construct a client, you need to configure a `:region` and `:credentials`.
|
34
37
|
#
|
35
|
-
#
|
36
|
-
#
|
37
|
-
#
|
38
|
-
#
|
39
|
-
#
|
38
|
+
# client = Aws::GameLift::Client.new(
|
39
|
+
# region: region_name,
|
40
|
+
# credentials: credentials,
|
41
|
+
# # ...
|
42
|
+
# )
|
40
43
|
#
|
41
44
|
# For details on configuring region and credentials see
|
42
45
|
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
@@ -69,6 +72,7 @@ module Aws::GameLift
|
|
69
72
|
add_plugin(Aws::Plugins::ClientMetricsPlugin)
|
70
73
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
71
74
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
|
+
add_plugin(Aws::Plugins::HttpChecksum)
|
72
76
|
add_plugin(Aws::Plugins::SignatureV4)
|
73
77
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
74
78
|
|
@@ -105,7 +109,7 @@ module Aws::GameLift
|
|
105
109
|
# @option options [required, String] :region
|
106
110
|
# The AWS region to connect to. The configured `:region` is
|
107
111
|
# used to determine the service `:endpoint`. When not passed,
|
108
|
-
# a default `:region` is
|
112
|
+
# a default `:region` is searched for in the following locations:
|
109
113
|
#
|
110
114
|
# * `Aws.config[:region]`
|
111
115
|
# * `ENV['AWS_REGION']`
|
@@ -161,7 +165,7 @@ module Aws::GameLift
|
|
161
165
|
# @option options [String] :endpoint
|
162
166
|
# The client endpoint is normally constructed from the `:region`
|
163
167
|
# option. You should only configure an `:endpoint` when connecting
|
164
|
-
# to test endpoints. This should be
|
168
|
+
# to test or custom endpoints. This should be a valid HTTP(S) URI.
|
165
169
|
#
|
166
170
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
167
171
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -176,7 +180,7 @@ module Aws::GameLift
|
|
176
180
|
# requests fetching endpoints information. Defaults to 60 sec.
|
177
181
|
#
|
178
182
|
# @option options [Boolean] :endpoint_discovery (false)
|
179
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
183
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
180
184
|
#
|
181
185
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
182
186
|
# The log formatter.
|
@@ -229,15 +233,19 @@ module Aws::GameLift
|
|
229
233
|
#
|
230
234
|
# @option options [String] :retry_mode ("legacy")
|
231
235
|
# Specifies which retry algorithm to use. Values are:
|
232
|
-
#
|
233
|
-
#
|
234
|
-
#
|
235
|
-
#
|
236
|
-
#
|
237
|
-
#
|
238
|
-
#
|
239
|
-
#
|
240
|
-
#
|
236
|
+
#
|
237
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
238
|
+
# no retry mode is provided.
|
239
|
+
#
|
240
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
241
|
+
# This includes support for retry quotas, which limit the number of
|
242
|
+
# unsuccessful retries a client can make.
|
243
|
+
#
|
244
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
245
|
+
# functionality of `standard` mode along with automatic client side
|
246
|
+
# throttling. This is a provisional mode that may change behavior
|
247
|
+
# in the future.
|
248
|
+
#
|
241
249
|
#
|
242
250
|
# @option options [String] :secret_access_key
|
243
251
|
#
|
@@ -275,8 +283,7 @@ module Aws::GameLift
|
|
275
283
|
#
|
276
284
|
# @option options [Integer] :http_read_timeout (60) The default
|
277
285
|
# number of seconds to wait for response data. This value can
|
278
|
-
# safely be set
|
279
|
-
# per-request on the session yielded by {#session_for}.
|
286
|
+
# safely be set per-request on the session.
|
280
287
|
#
|
281
288
|
# @option options [Float] :http_idle_timeout (5) The number of
|
282
289
|
# seconds a connection is allowed to sit idle before it is
|
@@ -288,7 +295,7 @@ module Aws::GameLift
|
|
288
295
|
# request body. This option has no effect unless the request has
|
289
296
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
290
297
|
# disables this behaviour. This value can safely be set per
|
291
|
-
# request on the session
|
298
|
+
# request on the session.
|
292
299
|
#
|
293
300
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
294
301
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -394,6 +401,122 @@ module Aws::GameLift
|
|
394
401
|
req.send_request(options)
|
395
402
|
end
|
396
403
|
|
404
|
+
# **This action is part of Amazon GameLift FleetIQ with game server
|
405
|
+
# groups, which is in preview release and is subject to change.**
|
406
|
+
#
|
407
|
+
# Locates an available game server and temporarily reserves it to host
|
408
|
+
# gameplay and players. This action is called by a game client or client
|
409
|
+
# service (such as a matchmaker) to request hosting resources for a new
|
410
|
+
# game session. In response, GameLift FleetIQ searches for an available
|
411
|
+
# game server in the specified game server group, places the game server
|
412
|
+
# in "claimed" status for 60 seconds, and returns connection
|
413
|
+
# information back to the requester so that players can connect to the
|
414
|
+
# game server.
|
415
|
+
#
|
416
|
+
# There are two ways you can claim a game server. For the first option,
|
417
|
+
# you provide a game server group ID only, which prompts GameLift
|
418
|
+
# FleetIQ to search for an available game server in the specified group
|
419
|
+
# and claim it. With this option, GameLift FleetIQ attempts to
|
420
|
+
# consolidate gameplay on as few instances as possible to minimize
|
421
|
+
# hosting costs. For the second option, you request a specific game
|
422
|
+
# server by its ID. This option results in a less efficient claiming
|
423
|
+
# process because it does not take advantage of consolidation and may
|
424
|
+
# fail if the requested game server is unavailable.
|
425
|
+
#
|
426
|
+
# To claim a game server, identify a game server group and (optionally)
|
427
|
+
# a game server ID. If your game requires that game data be provided to
|
428
|
+
# the game server at the start of a game, such as a game map or player
|
429
|
+
# information, you can provide it in your claim request.
|
430
|
+
#
|
431
|
+
# When a game server is successfully claimed, connection information is
|
432
|
+
# returned. A claimed game server's utilization status remains
|
433
|
+
# AVAILABLE, while the claim status is set to CLAIMED for up to 60
|
434
|
+
# seconds. This time period allows the game server to be prompted to
|
435
|
+
# update its status to UTILIZED (using UpdateGameServer). If the game
|
436
|
+
# server's status is not updated within 60 seconds, the game server
|
437
|
+
# reverts to unclaimed status and is available to be claimed by another
|
438
|
+
# request.
|
439
|
+
#
|
440
|
+
# If you try to claim a specific game server, this request will fail in
|
441
|
+
# the following cases: (1) if the game server utilization status is
|
442
|
+
# UTILIZED, (2) if the game server claim status is CLAIMED, or (3) if
|
443
|
+
# the instance that the game server is running on is flagged as
|
444
|
+
# draining.
|
445
|
+
#
|
446
|
+
# **Learn more**
|
447
|
+
#
|
448
|
+
# [GameLift FleetIQ Guide][1]
|
449
|
+
#
|
450
|
+
# **Related operations**
|
451
|
+
#
|
452
|
+
# * RegisterGameServer
|
453
|
+
#
|
454
|
+
# * ListGameServers
|
455
|
+
#
|
456
|
+
# * ClaimGameServer
|
457
|
+
#
|
458
|
+
# * DescribeGameServer
|
459
|
+
#
|
460
|
+
# * UpdateGameServer
|
461
|
+
#
|
462
|
+
# * DeregisterGameServer
|
463
|
+
#
|
464
|
+
#
|
465
|
+
#
|
466
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
|
467
|
+
#
|
468
|
+
# @option params [required, String] :game_server_group_name
|
469
|
+
# An identifier for the game server group. When claiming a specific game
|
470
|
+
# server, this is the game server group whether the game server is
|
471
|
+
# located. When requesting that GameLift FleetIQ locate an available
|
472
|
+
# game server, this is the game server group to search on. You can use
|
473
|
+
# either the GameServerGroup name or ARN value.
|
474
|
+
#
|
475
|
+
# @option params [String] :game_server_id
|
476
|
+
# A custom string that uniquely identifies the game server to claim. If
|
477
|
+
# this parameter is left empty, GameLift FleetIQ searches for an
|
478
|
+
# available game server in the specified game server group.
|
479
|
+
#
|
480
|
+
# @option params [String] :game_server_data
|
481
|
+
# A set of custom game server properties, formatted as a single string
|
482
|
+
# value, to be passed to the claimed game server.
|
483
|
+
#
|
484
|
+
# @return [Types::ClaimGameServerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
485
|
+
#
|
486
|
+
# * {Types::ClaimGameServerOutput#game_server #game_server} => Types::GameServer
|
487
|
+
#
|
488
|
+
# @example Request syntax with placeholder values
|
489
|
+
#
|
490
|
+
# resp = client.claim_game_server({
|
491
|
+
# game_server_group_name: "GameServerGroupNameOrArn", # required
|
492
|
+
# game_server_id: "GameServerId",
|
493
|
+
# game_server_data: "GameServerData",
|
494
|
+
# })
|
495
|
+
#
|
496
|
+
# @example Response structure
|
497
|
+
#
|
498
|
+
# resp.game_server.game_server_group_name #=> String
|
499
|
+
# resp.game_server.game_server_group_arn #=> String
|
500
|
+
# resp.game_server.game_server_id #=> String
|
501
|
+
# resp.game_server.instance_id #=> String
|
502
|
+
# resp.game_server.connection_info #=> String
|
503
|
+
# resp.game_server.game_server_data #=> String
|
504
|
+
# resp.game_server.custom_sort_key #=> String
|
505
|
+
# resp.game_server.claim_status #=> String, one of "CLAIMED"
|
506
|
+
# resp.game_server.utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
|
507
|
+
# resp.game_server.registration_time #=> Time
|
508
|
+
# resp.game_server.last_claim_time #=> Time
|
509
|
+
# resp.game_server.last_health_check_time #=> Time
|
510
|
+
#
|
511
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ClaimGameServer AWS API Documentation
|
512
|
+
#
|
513
|
+
# @overload claim_game_server(params = {})
|
514
|
+
# @param [Hash] params ({})
|
515
|
+
def claim_game_server(params = {}, options = {})
|
516
|
+
req = build_request(:claim_game_server, params)
|
517
|
+
req.send_request(options)
|
518
|
+
end
|
519
|
+
|
397
520
|
# Creates an alias for a fleet. In most situations, you can use an alias
|
398
521
|
# ID in place of a fleet ID. An alias provides a level of abstraction
|
399
522
|
# for a fleet that is useful when redirecting player traffic from one
|
@@ -492,49 +615,43 @@ module Aws::GameLift
|
|
492
615
|
req.send_request(options)
|
493
616
|
end
|
494
617
|
|
495
|
-
# Creates a new Amazon GameLift build
|
496
|
-
# files
|
497
|
-
#
|
498
|
-
#
|
499
|
-
# Game server binaries must be combined into a zip file for use with
|
500
|
-
# Amazon GameLift.
|
618
|
+
# Creates a new Amazon GameLift build resource for your game server
|
619
|
+
# binary files. Game server binaries must be combined into a zip file
|
620
|
+
# for use with Amazon GameLift.
|
501
621
|
#
|
502
|
-
#
|
503
|
-
# command <b> <a
|
622
|
+
# When setting up a new game build for GameLift, we recommend using the
|
623
|
+
# AWS CLI command <b> <a
|
504
624
|
# href="https://docs.aws.amazon.com/cli/latest/reference/gamelift/upload-build.html">upload-build</a>
|
505
|
-
# </b>. This helper command
|
506
|
-
#
|
507
|
-
#
|
508
|
-
#
|
509
|
-
# The `CreateBuild` operation
|
510
|
-
#
|
511
|
-
#
|
512
|
-
#
|
513
|
-
#
|
514
|
-
#
|
515
|
-
#
|
516
|
-
#
|
517
|
-
#
|
518
|
-
#
|
519
|
-
#
|
520
|
-
#
|
521
|
-
#
|
522
|
-
#
|
523
|
-
#
|
524
|
-
#
|
525
|
-
#
|
526
|
-
#
|
527
|
-
#
|
528
|
-
#
|
529
|
-
# DescribeBuild to check the status of your build. A build must be in
|
530
|
-
# `READY` status before it can be used to create fleets.
|
625
|
+
# </b>. This helper command combines two tasks: (1) it uploads your
|
626
|
+
# build files from a file directory to a GameLift Amazon S3 location,
|
627
|
+
# and (2) it creates a new build resource.
|
628
|
+
#
|
629
|
+
# The `CreateBuild` operation can used in the following scenarios:
|
630
|
+
#
|
631
|
+
# * To create a new game build with build files that are in an S3
|
632
|
+
# location under an AWS account that you control. To use this option,
|
633
|
+
# you must first give Amazon GameLift access to the S3 bucket. With
|
634
|
+
# permissions in place, call `CreateBuild` and specify a build name,
|
635
|
+
# operating system, and the S3 storage location of your game build.
|
636
|
+
#
|
637
|
+
# * To directly upload your build files to a GameLift S3 location. To
|
638
|
+
# use this option, first call `CreateBuild` and specify a build name
|
639
|
+
# and operating system. This action creates a new build resource and
|
640
|
+
# also returns an S3 location with temporary access credentials. Use
|
641
|
+
# the credentials to manually upload your build files to the specified
|
642
|
+
# S3 location. For more information, see [Uploading Objects][1] in the
|
643
|
+
# *Amazon S3 Developer Guide*. Build files can be uploaded to the
|
644
|
+
# GameLift S3 location once only; that can't be updated.
|
645
|
+
#
|
646
|
+
# If successful, this operation creates a new build resource with a
|
647
|
+
# unique build ID and places it in `INITIALIZED` status. A build must be
|
648
|
+
# in `READY` status before you can create fleets with it.
|
531
649
|
#
|
532
650
|
# **Learn more**
|
533
651
|
#
|
534
652
|
# [Uploading Your Game][2]
|
535
|
-
# [https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html][3]
|
536
653
|
#
|
537
|
-
# [ Create a Build with Files in Amazon S3][
|
654
|
+
# [ Create a Build with Files in Amazon S3][3]
|
538
655
|
#
|
539
656
|
# **Related operations**
|
540
657
|
#
|
@@ -552,8 +669,7 @@ module Aws::GameLift
|
|
552
669
|
#
|
553
670
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/UploadingObjects.html
|
554
671
|
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html
|
555
|
-
# [3]: https://docs.aws.amazon.com/
|
556
|
-
# [4]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html#gamelift-build-cli-uploading-create-build
|
672
|
+
# [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html#gamelift-build-cli-uploading-create-build
|
557
673
|
#
|
558
674
|
# @option params [String] :name
|
559
675
|
# A descriptive label that is associated with a build. Build names do
|
@@ -567,11 +683,11 @@ module Aws::GameLift
|
|
567
683
|
#
|
568
684
|
# @option params [Types::S3Location] :storage_location
|
569
685
|
# Information indicating where your game build files are stored. Use
|
570
|
-
# this parameter only when creating a build with files stored in an
|
571
|
-
#
|
572
|
-
#
|
573
|
-
#
|
574
|
-
#
|
686
|
+
# this parameter only when creating a build with files stored in an S3
|
687
|
+
# bucket that you own. The storage location must specify an S3 bucket
|
688
|
+
# name and key. The location must also specify a role ARN that you set
|
689
|
+
# up to allow Amazon GameLift to access your S3 bucket. The S3 bucket
|
690
|
+
# and your new build must be in the same Region.
|
575
691
|
#
|
576
692
|
# @option params [String] :operating_system
|
577
693
|
# The operating system that the game server binaries are built to run
|
@@ -655,17 +771,17 @@ module Aws::GameLift
|
|
655
771
|
# choose the hardware specifications, set some configuration options,
|
656
772
|
# and specify the game server to deploy on the new fleet.
|
657
773
|
#
|
658
|
-
# To create a new fleet,
|
659
|
-
#
|
660
|
-
#
|
661
|
-
#
|
662
|
-
#
|
774
|
+
# To create a new fleet, provide the following: (1) a fleet name, (2) an
|
775
|
+
# EC2 instance type and fleet type (spot or on-demand), (3) the build ID
|
776
|
+
# for your game build or script ID if using Realtime Servers, and (4) a
|
777
|
+
# runtime configuration, which determines how game servers will run on
|
778
|
+
# each instance in the fleet.
|
663
779
|
#
|
664
780
|
# If the `CreateFleet` call is successful, Amazon GameLift performs the
|
665
781
|
# following tasks. You can track the process of a fleet by checking the
|
666
782
|
# fleet status or by monitoring fleet creation events:
|
667
783
|
#
|
668
|
-
# * Creates a fleet
|
784
|
+
# * Creates a fleet resource. Status: `NEW`.
|
669
785
|
#
|
670
786
|
# * Begins writing events to the fleet event log, which can be accessed
|
671
787
|
# in the Amazon GameLift console.
|
@@ -686,9 +802,9 @@ module Aws::GameLift
|
|
686
802
|
#
|
687
803
|
# **Learn more**
|
688
804
|
#
|
689
|
-
# [
|
805
|
+
# [Setting Up Fleets][1]
|
690
806
|
#
|
691
|
-
# [
|
807
|
+
# [Debug Fleet Creation Issues][2]
|
692
808
|
#
|
693
809
|
# **Related operations**
|
694
810
|
#
|
@@ -702,11 +818,7 @@ module Aws::GameLift
|
|
702
818
|
#
|
703
819
|
# * UpdateFleetAttributes
|
704
820
|
#
|
705
|
-
# *
|
706
|
-
#
|
707
|
-
# * StartFleetActions
|
708
|
-
#
|
709
|
-
# * StopFleetActions
|
821
|
+
# * StartFleetActions or StopFleetActions
|
710
822
|
#
|
711
823
|
#
|
712
824
|
#
|
@@ -907,8 +1019,8 @@ module Aws::GameLift
|
|
907
1019
|
# resp = client.create_fleet({
|
908
1020
|
# name: "NonZeroAndMaxString", # required
|
909
1021
|
# description: "NonZeroAndMaxString",
|
910
|
-
# build_id: "
|
911
|
-
# script_id: "
|
1022
|
+
# build_id: "BuildIdOrArn",
|
1023
|
+
# script_id: "ScriptIdOrArn",
|
912
1024
|
# server_launch_path: "NonZeroAndMaxString",
|
913
1025
|
# server_launch_parameters: "NonZeroAndMaxString",
|
914
1026
|
# log_paths: ["NonZeroAndMaxString"],
|
@@ -992,6 +1104,248 @@ module Aws::GameLift
|
|
992
1104
|
req.send_request(options)
|
993
1105
|
end
|
994
1106
|
|
1107
|
+
# **This action is part of Amazon GameLift FleetIQ with game server
|
1108
|
+
# groups, which is in preview release and is subject to change.**
|
1109
|
+
#
|
1110
|
+
# Creates a GameLift FleetIQ game server group to manage a collection of
|
1111
|
+
# EC2 instances for game hosting. In addition to creating the game
|
1112
|
+
# server group, this action also creates an Auto Scaling group in your
|
1113
|
+
# AWS account and establishes a link between the two groups. You have
|
1114
|
+
# full control over configuration of the Auto Scaling group, but
|
1115
|
+
# GameLift FleetIQ routinely certain Auto Scaling group properties in
|
1116
|
+
# order to optimize the group's instances for low-cost game hosting.
|
1117
|
+
# You can view the status of your game server groups in the GameLift
|
1118
|
+
# Console. Game server group metrics and events are emitted to Amazon
|
1119
|
+
# CloudWatch.
|
1120
|
+
#
|
1121
|
+
# Prior creating a new game server group, you must set up the following:
|
1122
|
+
#
|
1123
|
+
# * An EC2 launch template. The template provides configuration settings
|
1124
|
+
# for a set of EC2 instances and includes the game server build that
|
1125
|
+
# you want to deploy and run on each instance. For more information on
|
1126
|
+
# creating a launch template, see [ Launching an Instance from a
|
1127
|
+
# Launch Template][1] in the *Amazon EC2 User Guide*.
|
1128
|
+
#
|
1129
|
+
# * An IAM role. The role sets up limited access to your AWS account,
|
1130
|
+
# allowing GameLift FleetIQ to create and manage the EC2 Auto Scaling
|
1131
|
+
# group, get instance data, and emit metrics and events to CloudWatch.
|
1132
|
+
# For more information on setting up an IAM permissions policy with
|
1133
|
+
# principal access for GameLift, see [ Specifying a Principal in a
|
1134
|
+
# Policy][2] in the *Amazon S3 Developer Guide*.
|
1135
|
+
#
|
1136
|
+
# To create a new game server group, provide a name and specify the IAM
|
1137
|
+
# role and EC2 launch template. You also need to provide a list of
|
1138
|
+
# instance types to be used in the group and set initial maximum and
|
1139
|
+
# minimum limits on the group's instance count. You can optionally set
|
1140
|
+
# an autoscaling policy with target tracking based on a GameLift FleetIQ
|
1141
|
+
# metric.
|
1142
|
+
#
|
1143
|
+
# Once the game server group and corresponding Auto Scaling group are
|
1144
|
+
# created, you have full access to change the Auto Scaling group's
|
1145
|
+
# configuration as needed. Keep in mind, however, that some properties
|
1146
|
+
# are periodically updated by GameLift FleetIQ as it balances the
|
1147
|
+
# group's instances based on availability and cost.
|
1148
|
+
#
|
1149
|
+
# **Learn more**
|
1150
|
+
#
|
1151
|
+
# [GameLift FleetIQ Guide][3]
|
1152
|
+
#
|
1153
|
+
# [Updating a GameLift FleetIQ-Linked Auto Scaling Group][4]
|
1154
|
+
#
|
1155
|
+
# **Related operations**
|
1156
|
+
#
|
1157
|
+
# * CreateGameServerGroup
|
1158
|
+
#
|
1159
|
+
# * ListGameServerGroups
|
1160
|
+
#
|
1161
|
+
# * DescribeGameServerGroup
|
1162
|
+
#
|
1163
|
+
# * UpdateGameServerGroup
|
1164
|
+
#
|
1165
|
+
# * DeleteGameServerGroup
|
1166
|
+
#
|
1167
|
+
# * ResumeGameServerGroup
|
1168
|
+
#
|
1169
|
+
# * SuspendGameServerGroup
|
1170
|
+
#
|
1171
|
+
#
|
1172
|
+
#
|
1173
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html
|
1174
|
+
# [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-bucket-user-policy-specifying-principal-intro.html
|
1175
|
+
# [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
|
1176
|
+
# [4]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-asgroups.html
|
1177
|
+
#
|
1178
|
+
# @option params [required, String] :game_server_group_name
|
1179
|
+
# An identifier for the new game server group. This value is used to
|
1180
|
+
# generate unique ARN identifiers for the EC2 Auto Scaling group and the
|
1181
|
+
# GameLift FleetIQ game server group. The name must be unique per Region
|
1182
|
+
# per AWS account.
|
1183
|
+
#
|
1184
|
+
# @option params [required, String] :role_arn
|
1185
|
+
# The Amazon Resource Name ([ARN][1]) for an IAM role that allows Amazon
|
1186
|
+
# GameLift to access your EC2 Auto Scaling groups. The submitted role is
|
1187
|
+
# validated to ensure that it contains the necessary permissions for
|
1188
|
+
# game server groups.
|
1189
|
+
#
|
1190
|
+
#
|
1191
|
+
#
|
1192
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
|
1193
|
+
#
|
1194
|
+
# @option params [required, Integer] :min_size
|
1195
|
+
# The minimum number of instances allowed in the EC2 Auto Scaling group.
|
1196
|
+
# During autoscaling events, GameLift FleetIQ and EC2 do not scale down
|
1197
|
+
# the group below this minimum. In production, this value should be set
|
1198
|
+
# to at least 1.
|
1199
|
+
#
|
1200
|
+
# @option params [required, Integer] :max_size
|
1201
|
+
# The maximum number of instances allowed in the EC2 Auto Scaling group.
|
1202
|
+
# During autoscaling events, GameLift FleetIQ and EC2 do not scale up
|
1203
|
+
# the group above this maximum.
|
1204
|
+
#
|
1205
|
+
# @option params [required, Types::LaunchTemplateSpecification] :launch_template
|
1206
|
+
# The EC2 launch template that contains configuration settings and game
|
1207
|
+
# server code to be deployed to all instances in the game server group.
|
1208
|
+
# You can specify the template using either the template name or ID. For
|
1209
|
+
# help with creating a launch template, see [Creating a Launch Template
|
1210
|
+
# for an Auto Scaling Group][1] in the *Amazon EC2 Auto Scaling User
|
1211
|
+
# Guide*.
|
1212
|
+
#
|
1213
|
+
#
|
1214
|
+
#
|
1215
|
+
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html
|
1216
|
+
#
|
1217
|
+
# @option params [required, Array<Types::InstanceDefinition>] :instance_definitions
|
1218
|
+
# A set of EC2 instance types to use when creating instances in the
|
1219
|
+
# group. The instance definitions must specify at least two different
|
1220
|
+
# instance types that are supported by GameLift FleetIQ. For more
|
1221
|
+
# information on instance types, see [EC2 Instance Types][1] in the
|
1222
|
+
# *Amazon EC2 User Guide*.
|
1223
|
+
#
|
1224
|
+
#
|
1225
|
+
#
|
1226
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html
|
1227
|
+
#
|
1228
|
+
# @option params [Types::GameServerGroupAutoScalingPolicy] :auto_scaling_policy
|
1229
|
+
# Configuration settings to define a scaling policy for the Auto Scaling
|
1230
|
+
# group that is optimized for game hosting. The scaling policy uses the
|
1231
|
+
# metric "PercentUtilizedGameServers" to maintain a buffer of idle
|
1232
|
+
# game servers that can immediately accommodate new games and players.
|
1233
|
+
# Once the game server and Auto Scaling groups are created, you can
|
1234
|
+
# update the scaling policy settings directly in Auto Scaling Groups.
|
1235
|
+
#
|
1236
|
+
# @option params [String] :balancing_strategy
|
1237
|
+
# The fallback balancing method to use for the game server group when
|
1238
|
+
# Spot instances in a Region become unavailable or are not viable for
|
1239
|
+
# game hosting. Once triggered, this method remains active until Spot
|
1240
|
+
# instances can once again be used. Method options include:
|
1241
|
+
#
|
1242
|
+
# * SPOT\_ONLY -- If Spot instances are unavailable, the game server
|
1243
|
+
# group provides no hosting capacity. No new instances are started,
|
1244
|
+
# and the existing nonviable Spot instances are terminated (once
|
1245
|
+
# current gameplay ends) and not replaced.
|
1246
|
+
#
|
1247
|
+
# * SPOT\_PREFERRED -- If Spot instances are unavailable, the game
|
1248
|
+
# server group continues to provide hosting capacity by using
|
1249
|
+
# On-Demand instances. Existing nonviable Spot instances are
|
1250
|
+
# terminated (once current gameplay ends) and replaced with new
|
1251
|
+
# On-Demand instances.
|
1252
|
+
#
|
1253
|
+
# @option params [String] :game_server_protection_policy
|
1254
|
+
# A flag that indicates whether instances in the game server group are
|
1255
|
+
# protected from early termination. Unprotected instances that have
|
1256
|
+
# active game servers running may by terminated during a scale-down
|
1257
|
+
# event, causing players to be dropped from the game. Protected
|
1258
|
+
# instances cannot be terminated while there are active game servers
|
1259
|
+
# running. An exception to this is Spot Instances, which may be
|
1260
|
+
# terminated by AWS regardless of protection status. This property is
|
1261
|
+
# set to NO\_PROTECTION by default.
|
1262
|
+
#
|
1263
|
+
# @option params [Array<String>] :vpc_subnets
|
1264
|
+
# A list of virtual private cloud (VPC) subnets to use with instances in
|
1265
|
+
# the game server group. By default, all GameLift FleetIQ-supported
|
1266
|
+
# availability zones are used; this parameter allows you to specify VPCs
|
1267
|
+
# that you've set up.
|
1268
|
+
#
|
1269
|
+
# @option params [Array<Types::Tag>] :tags
|
1270
|
+
# A list of labels to assign to the new game server group resource. Tags
|
1271
|
+
# are developer-defined key-value pairs. Tagging AWS resources are
|
1272
|
+
# useful for resource management, access management, and cost
|
1273
|
+
# allocation. For more information, see [ Tagging AWS Resources][1] in
|
1274
|
+
# the *AWS General Reference*. Once the resource is created, you can use
|
1275
|
+
# TagResource, UntagResource, and ListTagsForResource to add, remove,
|
1276
|
+
# and view tags. The maximum tag limit may be lower than stated. See the
|
1277
|
+
# AWS General Reference for actual tagging limits.
|
1278
|
+
#
|
1279
|
+
#
|
1280
|
+
#
|
1281
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
1282
|
+
#
|
1283
|
+
# @return [Types::CreateGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1284
|
+
#
|
1285
|
+
# * {Types::CreateGameServerGroupOutput#game_server_group #game_server_group} => Types::GameServerGroup
|
1286
|
+
#
|
1287
|
+
# @example Request syntax with placeholder values
|
1288
|
+
#
|
1289
|
+
# resp = client.create_game_server_group({
|
1290
|
+
# game_server_group_name: "GameServerGroupName", # required
|
1291
|
+
# role_arn: "IamRoleArn", # required
|
1292
|
+
# min_size: 1, # required
|
1293
|
+
# max_size: 1, # required
|
1294
|
+
# launch_template: { # required
|
1295
|
+
# launch_template_id: "LaunchTemplateId",
|
1296
|
+
# launch_template_name: "LaunchTemplateName",
|
1297
|
+
# version: "LaunchTemplateVersion",
|
1298
|
+
# },
|
1299
|
+
# instance_definitions: [ # required
|
1300
|
+
# {
|
1301
|
+
# 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
|
1302
|
+
# weighted_capacity: "WeightedCapacity",
|
1303
|
+
# },
|
1304
|
+
# ],
|
1305
|
+
# auto_scaling_policy: {
|
1306
|
+
# estimated_instance_warmup: 1,
|
1307
|
+
# target_tracking_configuration: { # required
|
1308
|
+
# target_value: 1.0, # required
|
1309
|
+
# },
|
1310
|
+
# },
|
1311
|
+
# balancing_strategy: "SPOT_ONLY", # accepts SPOT_ONLY, SPOT_PREFERRED
|
1312
|
+
# game_server_protection_policy: "NO_PROTECTION", # accepts NO_PROTECTION, FULL_PROTECTION
|
1313
|
+
# vpc_subnets: ["VpcSubnet"],
|
1314
|
+
# tags: [
|
1315
|
+
# {
|
1316
|
+
# key: "TagKey", # required
|
1317
|
+
# value: "TagValue", # required
|
1318
|
+
# },
|
1319
|
+
# ],
|
1320
|
+
# })
|
1321
|
+
#
|
1322
|
+
# @example Response structure
|
1323
|
+
#
|
1324
|
+
# resp.game_server_group.game_server_group_name #=> String
|
1325
|
+
# resp.game_server_group.game_server_group_arn #=> String
|
1326
|
+
# resp.game_server_group.role_arn #=> String
|
1327
|
+
# resp.game_server_group.instance_definitions #=> Array
|
1328
|
+
# resp.game_server_group.instance_definitions[0].instance_type #=> String, one of "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge"
|
1329
|
+
# resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
|
1330
|
+
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED"
|
1331
|
+
# resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
|
1332
|
+
# resp.game_server_group.auto_scaling_group_arn #=> String
|
1333
|
+
# resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
|
1334
|
+
# resp.game_server_group.status_reason #=> String
|
1335
|
+
# resp.game_server_group.suspended_actions #=> Array
|
1336
|
+
# resp.game_server_group.suspended_actions[0] #=> String, one of "REPLACE_INSTANCE_TYPES"
|
1337
|
+
# resp.game_server_group.creation_time #=> Time
|
1338
|
+
# resp.game_server_group.last_updated_time #=> Time
|
1339
|
+
#
|
1340
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateGameServerGroup AWS API Documentation
|
1341
|
+
#
|
1342
|
+
# @overload create_game_server_group(params = {})
|
1343
|
+
# @param [Hash] params ({})
|
1344
|
+
def create_game_server_group(params = {}, options = {})
|
1345
|
+
req = build_request(:create_game_server_group, params)
|
1346
|
+
req.send_request(options)
|
1347
|
+
end
|
1348
|
+
|
995
1349
|
# Creates a multiplayer game session for players. This action creates a
|
996
1350
|
# game session record and assigns an available server process in the
|
997
1351
|
# specified fleet to host the game session. A fleet must have an
|
@@ -1116,8 +1470,8 @@ module Aws::GameLift
|
|
1116
1470
|
# @example Request syntax with placeholder values
|
1117
1471
|
#
|
1118
1472
|
# resp = client.create_game_session({
|
1119
|
-
# fleet_id: "
|
1120
|
-
# alias_id: "
|
1473
|
+
# fleet_id: "FleetIdOrArn",
|
1474
|
+
# alias_id: "AliasIdOrArn",
|
1121
1475
|
# maximum_player_session_count: 1, # required
|
1122
1476
|
# name: "NonZeroAndMaxString",
|
1123
1477
|
# game_properties: [
|
@@ -1199,6 +1553,14 @@ module Aws::GameLift
|
|
1199
1553
|
# destinations and, if desired, a set of latency policies. If
|
1200
1554
|
# successful, a new queue object is returned.
|
1201
1555
|
#
|
1556
|
+
# **Learn more**
|
1557
|
+
#
|
1558
|
+
# [ Design a Game Session Queue][1]
|
1559
|
+
#
|
1560
|
+
# [ Create a Game Session Queue][2]
|
1561
|
+
#
|
1562
|
+
# **Related operations**
|
1563
|
+
#
|
1202
1564
|
# * CreateGameSessionQueue
|
1203
1565
|
#
|
1204
1566
|
# * DescribeGameSessionQueues
|
@@ -1207,6 +1569,11 @@ module Aws::GameLift
|
|
1207
1569
|
#
|
1208
1570
|
# * DeleteGameSessionQueue
|
1209
1571
|
#
|
1572
|
+
#
|
1573
|
+
#
|
1574
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-design.html
|
1575
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-creating.html
|
1576
|
+
#
|
1210
1577
|
# @option params [required, String] :name
|
1211
1578
|
# A descriptive label that is associated with game session queue. Queue
|
1212
1579
|
# names must be unique within each Region.
|
@@ -2118,7 +2485,7 @@ module Aws::GameLift
|
|
2118
2485
|
# @example Request syntax with placeholder values
|
2119
2486
|
#
|
2120
2487
|
# resp = client.delete_alias({
|
2121
|
-
# alias_id: "
|
2488
|
+
# alias_id: "AliasIdOrArn", # required
|
2122
2489
|
# })
|
2123
2490
|
#
|
2124
2491
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteAlias AWS API Documentation
|
@@ -2130,16 +2497,16 @@ module Aws::GameLift
|
|
2130
2497
|
req.send_request(options)
|
2131
2498
|
end
|
2132
2499
|
|
2133
|
-
# Deletes a build. This action permanently deletes the build
|
2134
|
-
# any uploaded build files.
|
2135
|
-
#
|
2136
|
-
# To delete a build, specify its ID. Deleting a build does not affect
|
2137
|
-
# the status of any active fleets using the build, but you can no longer
|
2500
|
+
# Deletes a build. This action permanently deletes the build resource
|
2501
|
+
# and any uploaded build files. Deleting a build does not affect the
|
2502
|
+
# status of any active fleets using the build, but you can no longer
|
2138
2503
|
# create new fleets with the deleted build.
|
2139
2504
|
#
|
2505
|
+
# To delete a build, specify the build ID.
|
2506
|
+
#
|
2140
2507
|
# **Learn more**
|
2141
2508
|
#
|
2142
|
-
# [
|
2509
|
+
# [ Upload a Custom Server Build][1]
|
2143
2510
|
#
|
2144
2511
|
# **Related operations**
|
2145
2512
|
#
|
@@ -2155,7 +2522,7 @@ module Aws::GameLift
|
|
2155
2522
|
#
|
2156
2523
|
#
|
2157
2524
|
#
|
2158
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/build-intro.html
|
2525
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html
|
2159
2526
|
#
|
2160
2527
|
# @option params [required, String] :build_id
|
2161
2528
|
# A unique identifier for a build to delete. You can use either the
|
@@ -2166,7 +2533,7 @@ module Aws::GameLift
|
|
2166
2533
|
# @example Request syntax with placeholder values
|
2167
2534
|
#
|
2168
2535
|
# resp = client.delete_build({
|
2169
|
-
# build_id: "
|
2536
|
+
# build_id: "BuildIdOrArn", # required
|
2170
2537
|
# })
|
2171
2538
|
#
|
2172
2539
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteBuild AWS API Documentation
|
@@ -2188,12 +2555,12 @@ module Aws::GameLift
|
|
2188
2555
|
# the VPC peering connection--this is done as part of the delete fleet
|
2189
2556
|
# process.
|
2190
2557
|
#
|
2191
|
-
# This action removes the fleet
|
2192
|
-
#
|
2558
|
+
# This action removes the fleet and its resources. Once a fleet is
|
2559
|
+
# deleted, you can no longer use any of the resource in that fleet.
|
2193
2560
|
#
|
2194
2561
|
# **Learn more**
|
2195
2562
|
#
|
2196
|
-
# [
|
2563
|
+
# [Setting up GameLift Fleets][1]
|
2197
2564
|
#
|
2198
2565
|
# **Related operations**
|
2199
2566
|
#
|
@@ -2207,11 +2574,7 @@ module Aws::GameLift
|
|
2207
2574
|
#
|
2208
2575
|
# * UpdateFleetAttributes
|
2209
2576
|
#
|
2210
|
-
# *
|
2211
|
-
#
|
2212
|
-
# * StartFleetActions
|
2213
|
-
#
|
2214
|
-
# * StopFleetActions
|
2577
|
+
# * StartFleetActions or StopFleetActions
|
2215
2578
|
#
|
2216
2579
|
#
|
2217
2580
|
#
|
@@ -2226,7 +2589,7 @@ module Aws::GameLift
|
|
2226
2589
|
# @example Request syntax with placeholder values
|
2227
2590
|
#
|
2228
2591
|
# resp = client.delete_fleet({
|
2229
|
-
# fleet_id: "
|
2592
|
+
# fleet_id: "FleetIdOrArn", # required
|
2230
2593
|
# })
|
2231
2594
|
#
|
2232
2595
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteFleet AWS API Documentation
|
@@ -2238,10 +2601,119 @@ module Aws::GameLift
|
|
2238
2601
|
req.send_request(options)
|
2239
2602
|
end
|
2240
2603
|
|
2604
|
+
# **This action is part of Amazon GameLift FleetIQ with game server
|
2605
|
+
# groups, which is in preview release and is subject to change.**
|
2606
|
+
#
|
2607
|
+
# Terminates a game server group and permanently deletes the game server
|
2608
|
+
# group record. You have several options for how these resources are
|
2609
|
+
# impacted when deleting the game server group. Depending on the type of
|
2610
|
+
# delete action selected, this action may affect three types of
|
2611
|
+
# resources: the game server group, the corresponding Auto Scaling
|
2612
|
+
# group, and all game servers currently running in the group.
|
2613
|
+
#
|
2614
|
+
# To delete a game server group, identify the game server group to
|
2615
|
+
# delete and specify the type of delete action to initiate. Game server
|
2616
|
+
# groups can only be deleted if they are in ACTIVE or ERROR status.
|
2617
|
+
#
|
2618
|
+
# If the delete request is successful, a series of actions are kicked
|
2619
|
+
# off. The game server group status is changed to DELETE\_SCHEDULED,
|
2620
|
+
# which prevents new game servers from being registered and stops
|
2621
|
+
# autoscaling activity. Once all game servers in the game server group
|
2622
|
+
# are de-registered, GameLift FleetIQ can begin deleting resources. If
|
2623
|
+
# any of the delete actions fail, the game server group is placed in
|
2624
|
+
# ERROR status.
|
2625
|
+
#
|
2626
|
+
# GameLift FleetIQ emits delete events to Amazon CloudWatch.
|
2627
|
+
#
|
2628
|
+
# **Learn more**
|
2629
|
+
#
|
2630
|
+
# [GameLift FleetIQ Guide][1]
|
2631
|
+
#
|
2632
|
+
# **Related operations**
|
2633
|
+
#
|
2634
|
+
# * CreateGameServerGroup
|
2635
|
+
#
|
2636
|
+
# * ListGameServerGroups
|
2637
|
+
#
|
2638
|
+
# * DescribeGameServerGroup
|
2639
|
+
#
|
2640
|
+
# * UpdateGameServerGroup
|
2641
|
+
#
|
2642
|
+
# * DeleteGameServerGroup
|
2643
|
+
#
|
2644
|
+
# * ResumeGameServerGroup
|
2645
|
+
#
|
2646
|
+
# * SuspendGameServerGroup
|
2647
|
+
#
|
2648
|
+
#
|
2649
|
+
#
|
2650
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
|
2651
|
+
#
|
2652
|
+
# @option params [required, String] :game_server_group_name
|
2653
|
+
# The unique identifier of the game server group to delete. Use either
|
2654
|
+
# the GameServerGroup name or ARN value.
|
2655
|
+
#
|
2656
|
+
# @option params [String] :delete_option
|
2657
|
+
# The type of delete to perform. Options include:
|
2658
|
+
#
|
2659
|
+
# * SAFE\_DELETE – Terminates the game server group and EC2 Auto Scaling
|
2660
|
+
# group only when it has no game servers that are in IN\_USE status.
|
2661
|
+
#
|
2662
|
+
# * FORCE\_DELETE – Terminates the game server group, including all
|
2663
|
+
# active game servers regardless of their utilization status, and the
|
2664
|
+
# EC2 Auto Scaling group.
|
2665
|
+
#
|
2666
|
+
# * RETAIN – Does a safe delete of the game server group but retains the
|
2667
|
+
# EC2 Auto Scaling group as is.
|
2668
|
+
#
|
2669
|
+
# @return [Types::DeleteGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2670
|
+
#
|
2671
|
+
# * {Types::DeleteGameServerGroupOutput#game_server_group #game_server_group} => Types::GameServerGroup
|
2672
|
+
#
|
2673
|
+
# @example Request syntax with placeholder values
|
2674
|
+
#
|
2675
|
+
# resp = client.delete_game_server_group({
|
2676
|
+
# game_server_group_name: "GameServerGroupNameOrArn", # required
|
2677
|
+
# delete_option: "SAFE_DELETE", # accepts SAFE_DELETE, FORCE_DELETE, RETAIN
|
2678
|
+
# })
|
2679
|
+
#
|
2680
|
+
# @example Response structure
|
2681
|
+
#
|
2682
|
+
# resp.game_server_group.game_server_group_name #=> String
|
2683
|
+
# resp.game_server_group.game_server_group_arn #=> String
|
2684
|
+
# resp.game_server_group.role_arn #=> String
|
2685
|
+
# resp.game_server_group.instance_definitions #=> Array
|
2686
|
+
# resp.game_server_group.instance_definitions[0].instance_type #=> String, one of "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge"
|
2687
|
+
# resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
|
2688
|
+
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED"
|
2689
|
+
# resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
|
2690
|
+
# resp.game_server_group.auto_scaling_group_arn #=> String
|
2691
|
+
# resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
|
2692
|
+
# resp.game_server_group.status_reason #=> String
|
2693
|
+
# resp.game_server_group.suspended_actions #=> Array
|
2694
|
+
# resp.game_server_group.suspended_actions[0] #=> String, one of "REPLACE_INSTANCE_TYPES"
|
2695
|
+
# resp.game_server_group.creation_time #=> Time
|
2696
|
+
# resp.game_server_group.last_updated_time #=> Time
|
2697
|
+
#
|
2698
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteGameServerGroup AWS API Documentation
|
2699
|
+
#
|
2700
|
+
# @overload delete_game_server_group(params = {})
|
2701
|
+
# @param [Hash] params ({})
|
2702
|
+
def delete_game_server_group(params = {}, options = {})
|
2703
|
+
req = build_request(:delete_game_server_group, params)
|
2704
|
+
req.send_request(options)
|
2705
|
+
end
|
2706
|
+
|
2241
2707
|
# Deletes a game session queue. This action means that any
|
2242
2708
|
# StartGameSessionPlacement requests that reference this queue will
|
2243
2709
|
# fail. To delete a queue, specify the queue name.
|
2244
2710
|
#
|
2711
|
+
# **Learn more**
|
2712
|
+
#
|
2713
|
+
# [ Using Multi-Region Queues][1]
|
2714
|
+
#
|
2715
|
+
# **Related operations**
|
2716
|
+
#
|
2245
2717
|
# * CreateGameSessionQueue
|
2246
2718
|
#
|
2247
2719
|
# * DescribeGameSessionQueues
|
@@ -2250,6 +2722,10 @@ module Aws::GameLift
|
|
2250
2722
|
#
|
2251
2723
|
# * DeleteGameSessionQueue
|
2252
2724
|
#
|
2725
|
+
#
|
2726
|
+
#
|
2727
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html
|
2728
|
+
#
|
2253
2729
|
# @option params [required, String] :name
|
2254
2730
|
# A descriptive label that is associated with game session queue. Queue
|
2255
2731
|
# names must be unique within each Region. You can use either the queue
|
@@ -2260,7 +2736,7 @@ module Aws::GameLift
|
|
2260
2736
|
# @example Request syntax with placeholder values
|
2261
2737
|
#
|
2262
2738
|
# resp = client.delete_game_session_queue({
|
2263
|
-
# name: "
|
2739
|
+
# name: "GameSessionQueueNameOrArn", # required
|
2264
2740
|
# })
|
2265
2741
|
#
|
2266
2742
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteGameSessionQueue AWS API Documentation
|
@@ -2411,7 +2887,7 @@ module Aws::GameLift
|
|
2411
2887
|
#
|
2412
2888
|
# resp = client.delete_scaling_policy({
|
2413
2889
|
# name: "NonZeroAndMaxString", # required
|
2414
|
-
# fleet_id: "
|
2890
|
+
# fleet_id: "FleetIdOrArn", # required
|
2415
2891
|
# })
|
2416
2892
|
#
|
2417
2893
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteScalingPolicy AWS API Documentation
|
@@ -2462,7 +2938,7 @@ module Aws::GameLift
|
|
2462
2938
|
# @example Request syntax with placeholder values
|
2463
2939
|
#
|
2464
2940
|
# resp = client.delete_script({
|
2465
|
-
# script_id: "
|
2941
|
+
# script_id: "ScriptIdOrArn", # required
|
2466
2942
|
# })
|
2467
2943
|
#
|
2468
2944
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeleteScript AWS API Documentation
|
@@ -2576,6 +3052,65 @@ module Aws::GameLift
|
|
2576
3052
|
req.send_request(options)
|
2577
3053
|
end
|
2578
3054
|
|
3055
|
+
# **This action is part of Amazon GameLift FleetIQ with game server
|
3056
|
+
# groups, which is in preview release and is subject to change.**
|
3057
|
+
#
|
3058
|
+
# Removes the game server resource from the game server group. As a
|
3059
|
+
# result of this action, the de-registered game server can no longer be
|
3060
|
+
# claimed and will not returned in a list of active game servers.
|
3061
|
+
#
|
3062
|
+
# To de-register a game server, specify the game server group and game
|
3063
|
+
# server ID. If successful, this action emits a CloudWatch event with
|
3064
|
+
# termination time stamp and reason.
|
3065
|
+
#
|
3066
|
+
# **Learn more**
|
3067
|
+
#
|
3068
|
+
# [GameLift FleetIQ Guide][1]
|
3069
|
+
#
|
3070
|
+
# **Related operations**
|
3071
|
+
#
|
3072
|
+
# * RegisterGameServer
|
3073
|
+
#
|
3074
|
+
# * ListGameServers
|
3075
|
+
#
|
3076
|
+
# * ClaimGameServer
|
3077
|
+
#
|
3078
|
+
# * DescribeGameServer
|
3079
|
+
#
|
3080
|
+
# * UpdateGameServer
|
3081
|
+
#
|
3082
|
+
# * DeregisterGameServer
|
3083
|
+
#
|
3084
|
+
#
|
3085
|
+
#
|
3086
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
|
3087
|
+
#
|
3088
|
+
# @option params [required, String] :game_server_group_name
|
3089
|
+
# An identifier for the game server group where the game server to be
|
3090
|
+
# de-registered is running. Use either the GameServerGroup name or ARN
|
3091
|
+
# value.
|
3092
|
+
#
|
3093
|
+
# @option params [required, String] :game_server_id
|
3094
|
+
# The identifier for the game server to be de-registered.
|
3095
|
+
#
|
3096
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3097
|
+
#
|
3098
|
+
# @example Request syntax with placeholder values
|
3099
|
+
#
|
3100
|
+
# resp = client.deregister_game_server({
|
3101
|
+
# game_server_group_name: "GameServerGroupNameOrArn", # required
|
3102
|
+
# game_server_id: "GameServerId", # required
|
3103
|
+
# })
|
3104
|
+
#
|
3105
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DeregisterGameServer AWS API Documentation
|
3106
|
+
#
|
3107
|
+
# @overload deregister_game_server(params = {})
|
3108
|
+
# @param [Hash] params ({})
|
3109
|
+
def deregister_game_server(params = {}, options = {})
|
3110
|
+
req = build_request(:deregister_game_server, params)
|
3111
|
+
req.send_request(options)
|
3112
|
+
end
|
3113
|
+
|
2579
3114
|
# Retrieves properties for an alias. This operation returns all alias
|
2580
3115
|
# metadata and settings. To get an alias's target fleet ID only, use
|
2581
3116
|
# `ResolveAlias`.
|
@@ -2606,7 +3141,7 @@ module Aws::GameLift
|
|
2606
3141
|
# @example Request syntax with placeholder values
|
2607
3142
|
#
|
2608
3143
|
# resp = client.describe_alias({
|
2609
|
-
# alias_id: "
|
3144
|
+
# alias_id: "AliasIdOrArn", # required
|
2610
3145
|
# })
|
2611
3146
|
#
|
2612
3147
|
# @example Response structure
|
@@ -2630,13 +3165,13 @@ module Aws::GameLift
|
|
2630
3165
|
req.send_request(options)
|
2631
3166
|
end
|
2632
3167
|
|
2633
|
-
# Retrieves properties for a build. To request a build
|
2634
|
-
# build ID. If successful, an object containing the
|
2635
|
-
# returned.
|
3168
|
+
# Retrieves properties for a custom game build. To request a build
|
3169
|
+
# resource, specify a build ID. If successful, an object containing the
|
3170
|
+
# build properties is returned.
|
2636
3171
|
#
|
2637
3172
|
# **Learn more**
|
2638
3173
|
#
|
2639
|
-
# [
|
3174
|
+
# [ Upload a Custom Server Build][1]
|
2640
3175
|
#
|
2641
3176
|
# **Related operations**
|
2642
3177
|
#
|
@@ -2652,7 +3187,7 @@ module Aws::GameLift
|
|
2652
3187
|
#
|
2653
3188
|
#
|
2654
3189
|
#
|
2655
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/build-intro.html
|
3190
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html
|
2656
3191
|
#
|
2657
3192
|
# @option params [required, String] :build_id
|
2658
3193
|
# A unique identifier for a build to retrieve properties for. You can
|
@@ -2665,7 +3200,7 @@ module Aws::GameLift
|
|
2665
3200
|
# @example Request syntax with placeholder values
|
2666
3201
|
#
|
2667
3202
|
# resp = client.describe_build({
|
2668
|
-
# build_id: "
|
3203
|
+
# build_id: "BuildIdOrArn", # required
|
2669
3204
|
# })
|
2670
3205
|
#
|
2671
3206
|
# @example Response structure
|
@@ -2691,17 +3226,17 @@ module Aws::GameLift
|
|
2691
3226
|
# Retrieves the following information for the specified EC2 instance
|
2692
3227
|
# type:
|
2693
3228
|
#
|
2694
|
-
# *
|
3229
|
+
# * Maximum number of instances allowed per AWS account (service limit).
|
2695
3230
|
#
|
2696
|
-
# *
|
3231
|
+
# * Current usage for the AWS account.
|
2697
3232
|
#
|
2698
|
-
#
|
2699
|
-
#
|
2700
|
-
#
|
3233
|
+
# To learn more about the capabilities of each instance type, see
|
3234
|
+
# [Amazon EC2 Instance Types][1]. Note that the instance types offered
|
3235
|
+
# may vary depending on the region.
|
2701
3236
|
#
|
2702
3237
|
# **Learn more**
|
2703
3238
|
#
|
2704
|
-
# [
|
3239
|
+
# [Setting up GameLift Fleets][2]
|
2705
3240
|
#
|
2706
3241
|
# **Related operations**
|
2707
3242
|
#
|
@@ -2711,41 +3246,16 @@ module Aws::GameLift
|
|
2711
3246
|
#
|
2712
3247
|
# * DeleteFleet
|
2713
3248
|
#
|
2714
|
-
# *
|
2715
|
-
#
|
2716
|
-
# * DescribeFleetAttributes
|
2717
|
-
#
|
2718
|
-
# * DescribeFleetCapacity
|
2719
|
-
#
|
2720
|
-
# * DescribeFleetPortSettings
|
2721
|
-
#
|
2722
|
-
# * DescribeFleetUtilization
|
2723
|
-
#
|
2724
|
-
# * DescribeRuntimeConfiguration
|
2725
|
-
#
|
2726
|
-
# * DescribeEC2InstanceLimits
|
2727
|
-
#
|
2728
|
-
# * DescribeFleetEvents
|
2729
|
-
#
|
2730
|
-
# * Update fleets:
|
2731
|
-
#
|
2732
|
-
# * UpdateFleetAttributes
|
2733
|
-
#
|
2734
|
-
# * UpdateFleetCapacity
|
2735
|
-
#
|
2736
|
-
# * UpdateFleetPortSettings
|
2737
|
-
#
|
2738
|
-
# * UpdateRuntimeConfiguration
|
2739
|
-
#
|
2740
|
-
# * Manage fleet actions:
|
3249
|
+
# * DescribeFleetAttributes
|
2741
3250
|
#
|
2742
|
-
#
|
3251
|
+
# * UpdateFleetAttributes
|
2743
3252
|
#
|
2744
|
-
#
|
3253
|
+
# * StartFleetActions or StopFleetActions
|
2745
3254
|
#
|
2746
3255
|
#
|
2747
3256
|
#
|
2748
|
-
# [1]:
|
3257
|
+
# [1]: http://aws.amazon.com/ec2/instance-types/
|
3258
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
2749
3259
|
#
|
2750
3260
|
# @option params [String] :ec2_instance_type
|
2751
3261
|
# Name of an EC2 instance type that is supported in Amazon GameLift. A
|
@@ -2785,24 +3295,25 @@ module Aws::GameLift
|
|
2785
3295
|
req.send_request(options)
|
2786
3296
|
end
|
2787
3297
|
|
2788
|
-
# Retrieves
|
2789
|
-
#
|
2790
|
-
#
|
2791
|
-
#
|
2792
|
-
#
|
2793
|
-
#
|
2794
|
-
#
|
2795
|
-
#
|
3298
|
+
# Retrieves core properties, including configuration, status, and
|
3299
|
+
# metadata, for a fleet.
|
3300
|
+
#
|
3301
|
+
# To get attributes for one or more fleets, provide a list of fleet IDs
|
3302
|
+
# or fleet ARNs. To get attributes for all fleets, do not specify a
|
3303
|
+
# fleet identifier. When requesting attributes for multiple fleets, use
|
3304
|
+
# the pagination parameters to retrieve results as a set of sequential
|
3305
|
+
# pages. If successful, a FleetAttributes object is returned for each
|
3306
|
+
# fleet requested, unless the fleet identifier is not found.
|
2796
3307
|
#
|
2797
3308
|
# <note markdown="1"> Some API actions may limit the number of fleet IDs allowed in one
|
2798
3309
|
# request. If a request exceeds this limit, the request fails and the
|
2799
|
-
# error message includes the maximum allowed.
|
3310
|
+
# error message includes the maximum allowed number.
|
2800
3311
|
#
|
2801
3312
|
# </note>
|
2802
3313
|
#
|
2803
3314
|
# **Learn more**
|
2804
3315
|
#
|
2805
|
-
# [
|
3316
|
+
# [Setting up GameLift Fleets][1]
|
2806
3317
|
#
|
2807
3318
|
# **Related operations**
|
2808
3319
|
#
|
@@ -2830,19 +3341,18 @@ module Aws::GameLift
|
|
2830
3341
|
#
|
2831
3342
|
# * UpdateFleetAttributes
|
2832
3343
|
#
|
2833
|
-
# *
|
2834
|
-
#
|
2835
|
-
# * StartFleetActions
|
2836
|
-
#
|
2837
|
-
# * StopFleetActions
|
3344
|
+
# * StartFleetActions or StopFleetActions
|
2838
3345
|
#
|
2839
3346
|
#
|
2840
3347
|
#
|
2841
3348
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
2842
3349
|
#
|
2843
3350
|
# @option params [Array<String>] :fleet_ids
|
2844
|
-
# A
|
2845
|
-
# use either the fleet ID or ARN value.
|
3351
|
+
# A list of unique fleet identifiers to retrieve attributes for. You can
|
3352
|
+
# use either the fleet ID or ARN value. To retrieve attributes for all
|
3353
|
+
# current fleets, do not include this parameter. If the list of fleet
|
3354
|
+
# identifiers includes fleets that don't currently exist, the request
|
3355
|
+
# succeeds but no attributes for that fleet are returned.
|
2846
3356
|
#
|
2847
3357
|
# @option params [Integer] :limit
|
2848
3358
|
# The maximum number of results to return. Use this parameter with
|
@@ -2865,7 +3375,7 @@ module Aws::GameLift
|
|
2865
3375
|
# @example Request syntax with placeholder values
|
2866
3376
|
#
|
2867
3377
|
# resp = client.describe_fleet_attributes({
|
2868
|
-
# fleet_ids: ["
|
3378
|
+
# fleet_ids: ["FleetIdOrArn"],
|
2869
3379
|
# limit: 1,
|
2870
3380
|
# next_token: "NonZeroAndMaxString",
|
2871
3381
|
# })
|
@@ -2911,15 +3421,18 @@ module Aws::GameLift
|
|
2911
3421
|
req.send_request(options)
|
2912
3422
|
end
|
2913
3423
|
|
2914
|
-
# Retrieves the current
|
2915
|
-
#
|
2916
|
-
#
|
2917
|
-
#
|
2918
|
-
#
|
2919
|
-
#
|
2920
|
-
#
|
2921
|
-
# fleet
|
2922
|
-
#
|
3424
|
+
# Retrieves the current capacity statistics for one or more fleets.
|
3425
|
+
# These statistics present a snapshot of the fleet's instances and
|
3426
|
+
# provide insight on current or imminent scaling activity. To get
|
3427
|
+
# statistics on game hosting activity in the fleet, see
|
3428
|
+
# DescribeFleetUtilization.
|
3429
|
+
#
|
3430
|
+
# You can request capacity for all fleets or specify a list of one or
|
3431
|
+
# more fleet identifiers. When requesting multiple fleets, use the
|
3432
|
+
# pagination parameters to retrieve results as a set of sequential
|
3433
|
+
# pages. If successful, a FleetCapacity object is returned for each
|
3434
|
+
# requested fleet ID. When a list of fleet IDs is provided, attribute
|
3435
|
+
# objects are returned only for fleets that currently exist.
|
2923
3436
|
#
|
2924
3437
|
# <note markdown="1"> Some API actions may limit the number of fleet IDs allowed in one
|
2925
3438
|
# request. If a request exceeds this limit, the request fails and the
|
@@ -2929,7 +3442,9 @@ module Aws::GameLift
|
|
2929
3442
|
#
|
2930
3443
|
# **Learn more**
|
2931
3444
|
#
|
2932
|
-
# [
|
3445
|
+
# [Setting up GameLift Fleets][1]
|
3446
|
+
#
|
3447
|
+
# [GameLift Metrics for Fleets][2]
|
2933
3448
|
#
|
2934
3449
|
# **Related operations**
|
2935
3450
|
#
|
@@ -2957,15 +3472,12 @@ module Aws::GameLift
|
|
2957
3472
|
#
|
2958
3473
|
# * UpdateFleetAttributes
|
2959
3474
|
#
|
2960
|
-
# *
|
2961
|
-
#
|
2962
|
-
# * StartFleetActions
|
2963
|
-
#
|
2964
|
-
# * StopFleetActions
|
3475
|
+
# * StartFleetActions or StopFleetActions
|
2965
3476
|
#
|
2966
3477
|
#
|
2967
3478
|
#
|
2968
3479
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
3480
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet
|
2969
3481
|
#
|
2970
3482
|
# @option params [Array<String>] :fleet_ids
|
2971
3483
|
# A unique identifier for a fleet(s) to retrieve capacity information
|
@@ -2992,7 +3504,7 @@ module Aws::GameLift
|
|
2992
3504
|
# @example Request syntax with placeholder values
|
2993
3505
|
#
|
2994
3506
|
# resp = client.describe_fleet_capacity({
|
2995
|
-
# fleet_ids: ["
|
3507
|
+
# fleet_ids: ["FleetIdOrArn"],
|
2996
3508
|
# limit: 1,
|
2997
3509
|
# next_token: "NonZeroAndMaxString",
|
2998
3510
|
# })
|
@@ -3028,7 +3540,7 @@ module Aws::GameLift
|
|
3028
3540
|
#
|
3029
3541
|
# **Learn more**
|
3030
3542
|
#
|
3031
|
-
# [
|
3543
|
+
# [Setting up GameLift Fleets][1]
|
3032
3544
|
#
|
3033
3545
|
# **Related operations**
|
3034
3546
|
#
|
@@ -3056,11 +3568,7 @@ module Aws::GameLift
|
|
3056
3568
|
#
|
3057
3569
|
# * UpdateFleetAttributes
|
3058
3570
|
#
|
3059
|
-
# *
|
3060
|
-
#
|
3061
|
-
# * StartFleetActions
|
3062
|
-
#
|
3063
|
-
# * StopFleetActions
|
3571
|
+
# * StartFleetActions or StopFleetActions
|
3064
3572
|
#
|
3065
3573
|
#
|
3066
3574
|
#
|
@@ -3099,7 +3607,7 @@ module Aws::GameLift
|
|
3099
3607
|
# @example Request syntax with placeholder values
|
3100
3608
|
#
|
3101
3609
|
# resp = client.describe_fleet_events({
|
3102
|
-
# fleet_id: "
|
3610
|
+
# fleet_id: "FleetIdOrArn", # required
|
3103
3611
|
# start_time: Time.now,
|
3104
3612
|
# end_time: Time.now,
|
3105
3613
|
# limit: 1,
|
@@ -3126,17 +3634,20 @@ module Aws::GameLift
|
|
3126
3634
|
req.send_request(options)
|
3127
3635
|
end
|
3128
3636
|
|
3129
|
-
# Retrieves
|
3130
|
-
# permissions
|
3131
|
-
# incoming traffic can use to access server processes in the fleet.
|
3132
|
-
#
|
3133
|
-
#
|
3134
|
-
#
|
3135
|
-
#
|
3637
|
+
# Retrieves a fleet's inbound connection permissions. Connection
|
3638
|
+
# permissions specify the range of IP addresses and port settings that
|
3639
|
+
# incoming traffic can use to access server processes in the fleet. Game
|
3640
|
+
# sessions that are running on instances in the fleet use connections
|
3641
|
+
# that fall in this range.
|
3642
|
+
#
|
3643
|
+
# To get a fleet's inbound connection permissions, specify the fleet's
|
3644
|
+
# unique identifier. If successful, a collection of IpPermission objects
|
3645
|
+
# is returned for the requested fleet ID. If the requested fleet has
|
3646
|
+
# been deleted, the result set is empty.
|
3136
3647
|
#
|
3137
3648
|
# **Learn more**
|
3138
3649
|
#
|
3139
|
-
# [
|
3650
|
+
# [Setting up GameLift Fleets][1]
|
3140
3651
|
#
|
3141
3652
|
# **Related operations**
|
3142
3653
|
#
|
@@ -3164,11 +3675,7 @@ module Aws::GameLift
|
|
3164
3675
|
#
|
3165
3676
|
# * UpdateFleetAttributes
|
3166
3677
|
#
|
3167
|
-
# *
|
3168
|
-
#
|
3169
|
-
# * StartFleetActions
|
3170
|
-
#
|
3171
|
-
# * StopFleetActions
|
3678
|
+
# * StartFleetActions or StopFleetActions
|
3172
3679
|
#
|
3173
3680
|
#
|
3174
3681
|
#
|
@@ -3185,7 +3692,7 @@ module Aws::GameLift
|
|
3185
3692
|
# @example Request syntax with placeholder values
|
3186
3693
|
#
|
3187
3694
|
# resp = client.describe_fleet_port_settings({
|
3188
|
-
# fleet_id: "
|
3695
|
+
# fleet_id: "FleetIdOrArn", # required
|
3189
3696
|
# })
|
3190
3697
|
#
|
3191
3698
|
# @example Response structure
|
@@ -3205,13 +3712,16 @@ module Aws::GameLift
|
|
3205
3712
|
req.send_request(options)
|
3206
3713
|
end
|
3207
3714
|
|
3208
|
-
# Retrieves utilization statistics for one or more fleets.
|
3209
|
-
#
|
3210
|
-
#
|
3211
|
-
#
|
3212
|
-
#
|
3213
|
-
#
|
3214
|
-
#
|
3715
|
+
# Retrieves utilization statistics for one or more fleets. These
|
3716
|
+
# statistics provide insight into how available hosting resources are
|
3717
|
+
# currently being used. To get statistics on available hosting
|
3718
|
+
# resources, see DescribeFleetCapacity.
|
3719
|
+
#
|
3720
|
+
# You can request utilization data for all fleets, or specify a list of
|
3721
|
+
# one or more fleet IDs. When requesting multiple fleets, use the
|
3722
|
+
# pagination parameters to retrieve results as a set of sequential
|
3723
|
+
# pages. If successful, a FleetUtilization object is returned for each
|
3724
|
+
# requested fleet ID, unless the fleet identifier is not found.
|
3215
3725
|
#
|
3216
3726
|
# <note markdown="1"> Some API actions may limit the number of fleet IDs allowed in one
|
3217
3727
|
# request. If a request exceeds this limit, the request fails and the
|
@@ -3221,7 +3731,9 @@ module Aws::GameLift
|
|
3221
3731
|
#
|
3222
3732
|
# **Learn more**
|
3223
3733
|
#
|
3224
|
-
# [
|
3734
|
+
# [Setting up GameLift Fleets][1]
|
3735
|
+
#
|
3736
|
+
# [GameLift Metrics for Fleets][2]
|
3225
3737
|
#
|
3226
3738
|
# **Related operations**
|
3227
3739
|
#
|
@@ -3249,19 +3761,19 @@ module Aws::GameLift
|
|
3249
3761
|
#
|
3250
3762
|
# * UpdateFleetAttributes
|
3251
3763
|
#
|
3252
|
-
# *
|
3253
|
-
#
|
3254
|
-
# * StartFleetActions
|
3255
|
-
#
|
3256
|
-
# * StopFleetActions
|
3764
|
+
# * StartFleetActions or StopFleetActions
|
3257
3765
|
#
|
3258
3766
|
#
|
3259
3767
|
#
|
3260
3768
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
3769
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet
|
3261
3770
|
#
|
3262
3771
|
# @option params [Array<String>] :fleet_ids
|
3263
3772
|
# A unique identifier for a fleet(s) to retrieve utilization data for.
|
3264
|
-
# You can use either the fleet ID or ARN value.
|
3773
|
+
# You can use either the fleet ID or ARN value. To retrieve attributes
|
3774
|
+
# for all current fleets, do not include this parameter. If the list of
|
3775
|
+
# fleet identifiers includes fleets that don't currently exist, the
|
3776
|
+
# request succeeds but no attributes for that fleet are returned.
|
3265
3777
|
#
|
3266
3778
|
# @option params [Integer] :limit
|
3267
3779
|
# The maximum number of results to return. Use this parameter with
|
@@ -3284,7 +3796,7 @@ module Aws::GameLift
|
|
3284
3796
|
# @example Request syntax with placeholder values
|
3285
3797
|
#
|
3286
3798
|
# resp = client.describe_fleet_utilization({
|
3287
|
-
# fleet_ids: ["
|
3799
|
+
# fleet_ids: ["FleetIdOrArn"],
|
3288
3800
|
# limit: 1,
|
3289
3801
|
# next_token: "NonZeroAndMaxString",
|
3290
3802
|
# })
|
@@ -3308,6 +3820,153 @@ module Aws::GameLift
|
|
3308
3820
|
req.send_request(options)
|
3309
3821
|
end
|
3310
3822
|
|
3823
|
+
# **This action is part of Amazon GameLift FleetIQ with game server
|
3824
|
+
# groups, which is in preview release and is subject to change.**
|
3825
|
+
#
|
3826
|
+
# Retrieves information for a game server resource. Information includes
|
3827
|
+
# the game server statuses, health check info, and the instance the game
|
3828
|
+
# server is running on.
|
3829
|
+
#
|
3830
|
+
# To retrieve game server information, specify the game server ID. If
|
3831
|
+
# successful, the requested game server object is returned.
|
3832
|
+
#
|
3833
|
+
# **Learn more**
|
3834
|
+
#
|
3835
|
+
# [GameLift FleetIQ Guide][1]
|
3836
|
+
#
|
3837
|
+
# **Related operations**
|
3838
|
+
#
|
3839
|
+
# * RegisterGameServer
|
3840
|
+
#
|
3841
|
+
# * ListGameServers
|
3842
|
+
#
|
3843
|
+
# * ClaimGameServer
|
3844
|
+
#
|
3845
|
+
# * DescribeGameServer
|
3846
|
+
#
|
3847
|
+
# * UpdateGameServer
|
3848
|
+
#
|
3849
|
+
# * DeregisterGameServer
|
3850
|
+
#
|
3851
|
+
#
|
3852
|
+
#
|
3853
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
|
3854
|
+
#
|
3855
|
+
# @option params [required, String] :game_server_group_name
|
3856
|
+
# An identifier for the game server group where the game server is
|
3857
|
+
# running. Use either the GameServerGroup name or ARN value.
|
3858
|
+
#
|
3859
|
+
# @option params [required, String] :game_server_id
|
3860
|
+
# The identifier for the game server to be retrieved.
|
3861
|
+
#
|
3862
|
+
# @return [Types::DescribeGameServerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3863
|
+
#
|
3864
|
+
# * {Types::DescribeGameServerOutput#game_server #game_server} => Types::GameServer
|
3865
|
+
#
|
3866
|
+
# @example Request syntax with placeholder values
|
3867
|
+
#
|
3868
|
+
# resp = client.describe_game_server({
|
3869
|
+
# game_server_group_name: "GameServerGroupNameOrArn", # required
|
3870
|
+
# game_server_id: "GameServerId", # required
|
3871
|
+
# })
|
3872
|
+
#
|
3873
|
+
# @example Response structure
|
3874
|
+
#
|
3875
|
+
# resp.game_server.game_server_group_name #=> String
|
3876
|
+
# resp.game_server.game_server_group_arn #=> String
|
3877
|
+
# resp.game_server.game_server_id #=> String
|
3878
|
+
# resp.game_server.instance_id #=> String
|
3879
|
+
# resp.game_server.connection_info #=> String
|
3880
|
+
# resp.game_server.game_server_data #=> String
|
3881
|
+
# resp.game_server.custom_sort_key #=> String
|
3882
|
+
# resp.game_server.claim_status #=> String, one of "CLAIMED"
|
3883
|
+
# resp.game_server.utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
|
3884
|
+
# resp.game_server.registration_time #=> Time
|
3885
|
+
# resp.game_server.last_claim_time #=> Time
|
3886
|
+
# resp.game_server.last_health_check_time #=> Time
|
3887
|
+
#
|
3888
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeGameServer AWS API Documentation
|
3889
|
+
#
|
3890
|
+
# @overload describe_game_server(params = {})
|
3891
|
+
# @param [Hash] params ({})
|
3892
|
+
def describe_game_server(params = {}, options = {})
|
3893
|
+
req = build_request(:describe_game_server, params)
|
3894
|
+
req.send_request(options)
|
3895
|
+
end
|
3896
|
+
|
3897
|
+
# **This action is part of Amazon GameLift FleetIQ with game server
|
3898
|
+
# groups, which is in preview release and is subject to change.**
|
3899
|
+
#
|
3900
|
+
# Retrieves information on a game server group.
|
3901
|
+
#
|
3902
|
+
# To get attributes for a game server group, provide a group name or ARN
|
3903
|
+
# value. If successful, a GameServerGroup object is returned.
|
3904
|
+
#
|
3905
|
+
# **Learn more**
|
3906
|
+
#
|
3907
|
+
# [GameLift FleetIQ Guide][1]
|
3908
|
+
#
|
3909
|
+
# **Related operations**
|
3910
|
+
#
|
3911
|
+
# * CreateGameServerGroup
|
3912
|
+
#
|
3913
|
+
# * ListGameServerGroups
|
3914
|
+
#
|
3915
|
+
# * DescribeGameServerGroup
|
3916
|
+
#
|
3917
|
+
# * UpdateGameServerGroup
|
3918
|
+
#
|
3919
|
+
# * DeleteGameServerGroup
|
3920
|
+
#
|
3921
|
+
# * ResumeGameServerGroup
|
3922
|
+
#
|
3923
|
+
# * SuspendGameServerGroup
|
3924
|
+
#
|
3925
|
+
#
|
3926
|
+
#
|
3927
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
|
3928
|
+
#
|
3929
|
+
# @option params [required, String] :game_server_group_name
|
3930
|
+
# The unique identifier for the game server group being requested. Use
|
3931
|
+
# either the GameServerGroup name or ARN value.
|
3932
|
+
#
|
3933
|
+
# @return [Types::DescribeGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3934
|
+
#
|
3935
|
+
# * {Types::DescribeGameServerGroupOutput#game_server_group #game_server_group} => Types::GameServerGroup
|
3936
|
+
#
|
3937
|
+
# @example Request syntax with placeholder values
|
3938
|
+
#
|
3939
|
+
# resp = client.describe_game_server_group({
|
3940
|
+
# game_server_group_name: "GameServerGroupNameOrArn", # required
|
3941
|
+
# })
|
3942
|
+
#
|
3943
|
+
# @example Response structure
|
3944
|
+
#
|
3945
|
+
# resp.game_server_group.game_server_group_name #=> String
|
3946
|
+
# resp.game_server_group.game_server_group_arn #=> String
|
3947
|
+
# resp.game_server_group.role_arn #=> String
|
3948
|
+
# resp.game_server_group.instance_definitions #=> Array
|
3949
|
+
# resp.game_server_group.instance_definitions[0].instance_type #=> String, one of "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge"
|
3950
|
+
# resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
|
3951
|
+
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED"
|
3952
|
+
# resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
|
3953
|
+
# resp.game_server_group.auto_scaling_group_arn #=> String
|
3954
|
+
# resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
|
3955
|
+
# resp.game_server_group.status_reason #=> String
|
3956
|
+
# resp.game_server_group.suspended_actions #=> Array
|
3957
|
+
# resp.game_server_group.suspended_actions[0] #=> String, one of "REPLACE_INSTANCE_TYPES"
|
3958
|
+
# resp.game_server_group.creation_time #=> Time
|
3959
|
+
# resp.game_server_group.last_updated_time #=> Time
|
3960
|
+
#
|
3961
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeGameServerGroup AWS API Documentation
|
3962
|
+
#
|
3963
|
+
# @overload describe_game_server_group(params = {})
|
3964
|
+
# @param [Hash] params ({})
|
3965
|
+
def describe_game_server_group(params = {}, options = {})
|
3966
|
+
req = build_request(:describe_game_server_group, params)
|
3967
|
+
req.send_request(options)
|
3968
|
+
end
|
3969
|
+
|
3311
3970
|
# Retrieves properties, including the protection policy in force, for
|
3312
3971
|
# one or more game sessions. This action can be used in several ways:
|
3313
3972
|
# (1) provide a `GameSessionId` or `GameSessionArn` to request details
|
@@ -3374,9 +4033,9 @@ module Aws::GameLift
|
|
3374
4033
|
# @example Request syntax with placeholder values
|
3375
4034
|
#
|
3376
4035
|
# resp = client.describe_game_session_details({
|
3377
|
-
# fleet_id: "
|
4036
|
+
# fleet_id: "FleetIdOrArn",
|
3378
4037
|
# game_session_id: "ArnStringModel",
|
3379
|
-
# alias_id: "
|
4038
|
+
# alias_id: "AliasIdOrArn",
|
3380
4039
|
# status_filter: "NonZeroAndMaxString",
|
3381
4040
|
# limit: 1,
|
3382
4041
|
# next_token: "NonZeroAndMaxString",
|
@@ -3498,6 +4157,12 @@ module Aws::GameLift
|
|
3498
4157
|
# specifying a list of queues, objects are returned only for queues that
|
3499
4158
|
# currently exist in the Region.
|
3500
4159
|
#
|
4160
|
+
# **Learn more**
|
4161
|
+
#
|
4162
|
+
# [ View Your Queues][1]
|
4163
|
+
#
|
4164
|
+
# **Related operations**
|
4165
|
+
#
|
3501
4166
|
# * CreateGameSessionQueue
|
3502
4167
|
#
|
3503
4168
|
# * DescribeGameSessionQueues
|
@@ -3506,6 +4171,10 @@ module Aws::GameLift
|
|
3506
4171
|
#
|
3507
4172
|
# * DeleteGameSessionQueue
|
3508
4173
|
#
|
4174
|
+
#
|
4175
|
+
#
|
4176
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-console.html
|
4177
|
+
#
|
3509
4178
|
# @option params [Array<String>] :names
|
3510
4179
|
# A list of queue names to retrieve information for. You can use either
|
3511
4180
|
# the queue ID or ARN value. To request settings for all queues, leave
|
@@ -3529,7 +4198,7 @@ module Aws::GameLift
|
|
3529
4198
|
# @example Request syntax with placeholder values
|
3530
4199
|
#
|
3531
4200
|
# resp = client.describe_game_session_queues({
|
3532
|
-
# names: ["
|
4201
|
+
# names: ["GameSessionQueueNameOrArn"],
|
3533
4202
|
# limit: 1,
|
3534
4203
|
# next_token: "NonZeroAndMaxString",
|
3535
4204
|
# })
|
@@ -3623,9 +4292,9 @@ module Aws::GameLift
|
|
3623
4292
|
# @example Request syntax with placeholder values
|
3624
4293
|
#
|
3625
4294
|
# resp = client.describe_game_sessions({
|
3626
|
-
# fleet_id: "
|
4295
|
+
# fleet_id: "FleetIdOrArn",
|
3627
4296
|
# game_session_id: "ArnStringModel",
|
3628
|
-
# alias_id: "
|
4297
|
+
# alias_id: "AliasIdOrArn",
|
3629
4298
|
# status_filter: "NonZeroAndMaxString",
|
3630
4299
|
# limit: 1,
|
3631
4300
|
# next_token: "NonZeroAndMaxString",
|
@@ -3674,6 +4343,23 @@ module Aws::GameLift
|
|
3674
4343
|
# parameters to retrieve results as a set of sequential pages. If
|
3675
4344
|
# successful, an Instance object is returned for each result.
|
3676
4345
|
#
|
4346
|
+
# **Learn more**
|
4347
|
+
#
|
4348
|
+
# [Remotely Access Fleet Instances][1]
|
4349
|
+
#
|
4350
|
+
# [Debug Fleet Issues][2]
|
4351
|
+
#
|
4352
|
+
# **Related operations**
|
4353
|
+
#
|
4354
|
+
# * DescribeInstances
|
4355
|
+
#
|
4356
|
+
# * GetInstanceAccess
|
4357
|
+
#
|
4358
|
+
#
|
4359
|
+
#
|
4360
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html
|
4361
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html
|
4362
|
+
#
|
3677
4363
|
# @option params [required, String] :fleet_id
|
3678
4364
|
# A unique identifier for a fleet to retrieve instance information for.
|
3679
4365
|
# You can use either the fleet ID or ARN value.
|
@@ -3699,7 +4385,7 @@ module Aws::GameLift
|
|
3699
4385
|
# @example Request syntax with placeholder values
|
3700
4386
|
#
|
3701
4387
|
# resp = client.describe_instances({
|
3702
|
-
# fleet_id: "
|
4388
|
+
# fleet_id: "FleetIdOrArn", # required
|
3703
4389
|
# instance_id: "InstanceId",
|
3704
4390
|
# limit: 1,
|
3705
4391
|
# next_token: "NonZeroAndMaxString",
|
@@ -4110,13 +4796,20 @@ module Aws::GameLift
|
|
4110
4796
|
req.send_request(options)
|
4111
4797
|
end
|
4112
4798
|
|
4113
|
-
# Retrieves
|
4114
|
-
#
|
4115
|
-
#
|
4799
|
+
# Retrieves a fleet's runtime configuration settings. The runtime
|
4800
|
+
# configuration tells Amazon GameLift which server processes to run (and
|
4801
|
+
# how) on each instance in the fleet.
|
4802
|
+
#
|
4803
|
+
# To get a runtime configuration, specify the fleet's unique
|
4804
|
+
# identifier. If successful, a RuntimeConfiguration object is returned
|
4805
|
+
# for the requested fleet. If the requested fleet has been deleted, the
|
4806
|
+
# result set is empty.
|
4116
4807
|
#
|
4117
4808
|
# **Learn more**
|
4118
4809
|
#
|
4119
|
-
# [
|
4810
|
+
# [Setting up GameLift Fleets][1]
|
4811
|
+
#
|
4812
|
+
# [Running Multiple Processes on a Fleet][2]
|
4120
4813
|
#
|
4121
4814
|
# **Related operations**
|
4122
4815
|
#
|
@@ -4144,15 +4837,12 @@ module Aws::GameLift
|
|
4144
4837
|
#
|
4145
4838
|
# * UpdateFleetAttributes
|
4146
4839
|
#
|
4147
|
-
# *
|
4148
|
-
#
|
4149
|
-
# * StartFleetActions
|
4150
|
-
#
|
4151
|
-
# * StopFleetActions
|
4840
|
+
# * StartFleetActions or StopFleetActions
|
4152
4841
|
#
|
4153
4842
|
#
|
4154
4843
|
#
|
4155
4844
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
|
4845
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html
|
4156
4846
|
#
|
4157
4847
|
# @option params [required, String] :fleet_id
|
4158
4848
|
# A unique identifier for a fleet to get the runtime configuration for.
|
@@ -4165,7 +4855,7 @@ module Aws::GameLift
|
|
4165
4855
|
# @example Request syntax with placeholder values
|
4166
4856
|
#
|
4167
4857
|
# resp = client.describe_runtime_configuration({
|
4168
|
-
# fleet_id: "
|
4858
|
+
# fleet_id: "FleetIdOrArn", # required
|
4169
4859
|
# })
|
4170
4860
|
#
|
4171
4861
|
# @example Response structure
|
@@ -4262,7 +4952,7 @@ module Aws::GameLift
|
|
4262
4952
|
# @example Request syntax with placeholder values
|
4263
4953
|
#
|
4264
4954
|
# resp = client.describe_scaling_policies({
|
4265
|
-
# fleet_id: "
|
4955
|
+
# fleet_id: "FleetIdOrArn", # required
|
4266
4956
|
# status_filter: "ACTIVE", # accepts ACTIVE, UPDATE_REQUESTED, UPDATING, DELETE_REQUESTED, DELETING, DELETED, ERROR
|
4267
4957
|
# limit: 1,
|
4268
4958
|
# next_token: "NonZeroAndMaxString",
|
@@ -4329,7 +5019,7 @@ module Aws::GameLift
|
|
4329
5019
|
# @example Request syntax with placeholder values
|
4330
5020
|
#
|
4331
5021
|
# resp = client.describe_script({
|
4332
|
-
# script_id: "
|
5022
|
+
# script_id: "ScriptIdOrArn", # required
|
4333
5023
|
# })
|
4334
5024
|
#
|
4335
5025
|
# @example Response structure
|
@@ -4512,29 +5202,41 @@ module Aws::GameLift
|
|
4512
5202
|
end
|
4513
5203
|
|
4514
5204
|
# Requests remote access to a fleet instance. Remote access is useful
|
4515
|
-
# for debugging, gathering benchmarking data, or
|
5205
|
+
# for debugging, gathering benchmarking data, or observing activity in
|
4516
5206
|
# real time.
|
4517
5207
|
#
|
4518
|
-
#
|
4519
|
-
# instance. For a Windows instance, Amazon
|
4520
|
-
# and password as strings for use with a
|
4521
|
-
# For a Linux instance, Amazon GameLift
|
4522
|
-
# private key, also as strings, for use with
|
4523
|
-
# key must be saved in the proper format to a
|
4524
|
-
# If you're making this request using the AWS
|
4525
|
-
# can be handled as part of the GetInstanceAccess
|
4526
|
-
#
|
4527
|
-
# see [Remotely Accessing an Instance][1].
|
5208
|
+
# To remotely access an instance, you need credentials that match the
|
5209
|
+
# operating system of the instance. For a Windows instance, Amazon
|
5210
|
+
# GameLift returns a user name and password as strings for use with a
|
5211
|
+
# Windows Remote Desktop client. For a Linux instance, Amazon GameLift
|
5212
|
+
# returns a user name and RSA private key, also as strings, for use with
|
5213
|
+
# an SSH client. The private key must be saved in the proper format to a
|
5214
|
+
# `.pem` file before using. If you're making this request using the AWS
|
5215
|
+
# CLI, saving the secret can be handled as part of the GetInstanceAccess
|
5216
|
+
# request, as shown in one of the examples for this action.
|
4528
5217
|
#
|
4529
5218
|
# To request access to a specific instance, specify the IDs of both the
|
4530
5219
|
# instance and the fleet it belongs to. You can retrieve a fleet's
|
4531
5220
|
# instance IDs by calling DescribeInstances. If successful, an
|
4532
|
-
# InstanceAccess object is returned
|
5221
|
+
# InstanceAccess object is returned that contains the instance's IP
|
4533
5222
|
# address and a set of credentials.
|
4534
5223
|
#
|
5224
|
+
# **Learn more**
|
5225
|
+
#
|
5226
|
+
# [Remotely Access Fleet Instances][1]
|
5227
|
+
#
|
5228
|
+
# [Debug Fleet Issues][2]
|
5229
|
+
#
|
5230
|
+
# **Related operations**
|
5231
|
+
#
|
5232
|
+
# * DescribeInstances
|
5233
|
+
#
|
5234
|
+
# * GetInstanceAccess
|
5235
|
+
#
|
4535
5236
|
#
|
4536
5237
|
#
|
4537
5238
|
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html
|
5239
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html
|
4538
5240
|
#
|
4539
5241
|
# @option params [required, String] :fleet_id
|
4540
5242
|
# A unique identifier for a fleet that contains the instance you want
|
@@ -4554,7 +5256,7 @@ module Aws::GameLift
|
|
4554
5256
|
# @example Request syntax with placeholder values
|
4555
5257
|
#
|
4556
5258
|
# resp = client.get_instance_access({
|
4557
|
-
# fleet_id: "
|
5259
|
+
# fleet_id: "FleetIdOrArn", # required
|
4558
5260
|
# instance_id: "InstanceId", # required
|
4559
5261
|
# })
|
4560
5262
|
#
|
@@ -4662,18 +5364,18 @@ module Aws::GameLift
|
|
4662
5364
|
req.send_request(options)
|
4663
5365
|
end
|
4664
5366
|
|
4665
|
-
# Retrieves build
|
4666
|
-
# in use. You can limit results to builds that are in a specific
|
4667
|
-
# by using the `Status` parameter. Use the pagination parameters
|
4668
|
-
# retrieve results in a set of sequential pages.
|
5367
|
+
# Retrieves build resources for all builds associated with the AWS
|
5368
|
+
# account in use. You can limit results to builds that are in a specific
|
5369
|
+
# status by using the `Status` parameter. Use the pagination parameters
|
5370
|
+
# to retrieve results in a set of sequential pages.
|
4669
5371
|
#
|
4670
|
-
# <note markdown="1"> Build
|
5372
|
+
# <note markdown="1"> Build resources are not listed in any particular order.
|
4671
5373
|
#
|
4672
5374
|
# </note>
|
4673
5375
|
#
|
4674
5376
|
# **Learn more**
|
4675
5377
|
#
|
4676
|
-
# [
|
5378
|
+
# [ Upload a Custom Server Build][1]
|
4677
5379
|
#
|
4678
5380
|
# **Related operations**
|
4679
5381
|
#
|
@@ -4689,7 +5391,7 @@ module Aws::GameLift
|
|
4689
5391
|
#
|
4690
5392
|
#
|
4691
5393
|
#
|
4692
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/build-intro.html
|
5394
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html
|
4693
5395
|
#
|
4694
5396
|
# @option params [String] :status
|
4695
5397
|
# Build status to filter results by. To retrieve all builds, leave this
|
@@ -4752,18 +5454,18 @@ module Aws::GameLift
|
|
4752
5454
|
req.send_request(options)
|
4753
5455
|
end
|
4754
5456
|
|
4755
|
-
# Retrieves a collection of fleet
|
4756
|
-
# filter the result set to find only those fleets that are deployed
|
4757
|
-
# a specific build or script. Use the pagination parameters to
|
4758
|
-
# results in sequential pages.
|
5457
|
+
# Retrieves a collection of fleet resources for this AWS account. You
|
5458
|
+
# can filter the result set to find only those fleets that are deployed
|
5459
|
+
# with a specific build or script. Use the pagination parameters to
|
5460
|
+
# retrieve results in sequential pages.
|
4759
5461
|
#
|
4760
|
-
# <note markdown="1"> Fleet
|
5462
|
+
# <note markdown="1"> Fleet resources are not listed in a particular order.
|
4761
5463
|
#
|
4762
5464
|
# </note>
|
4763
5465
|
#
|
4764
5466
|
# **Learn more**
|
4765
5467
|
#
|
4766
|
-
# [
|
5468
|
+
# [Setting up GameLift Fleets][1]
|
4767
5469
|
#
|
4768
5470
|
# **Related operations**
|
4769
5471
|
#
|
@@ -4777,11 +5479,7 @@ module Aws::GameLift
|
|
4777
5479
|
#
|
4778
5480
|
# * UpdateFleetAttributes
|
4779
5481
|
#
|
4780
|
-
# *
|
4781
|
-
#
|
4782
|
-
# * StartFleetActions
|
4783
|
-
#
|
4784
|
-
# * StopFleetActions
|
5482
|
+
# * StartFleetActions or StopFleetActions
|
4785
5483
|
#
|
4786
5484
|
#
|
4787
5485
|
#
|
@@ -4789,14 +5487,14 @@ module Aws::GameLift
|
|
4789
5487
|
#
|
4790
5488
|
# @option params [String] :build_id
|
4791
5489
|
# A unique identifier for a build to return fleets for. Use this
|
4792
|
-
# parameter to return only fleets using
|
4793
|
-
# the build ID or ARN value.To retrieve all fleets,
|
4794
|
-
#
|
5490
|
+
# parameter to return only fleets using a specified build. Use either
|
5491
|
+
# the build ID or ARN value. To retrieve all fleets, do not include
|
5492
|
+
# either a BuildId and ScriptID parameter.
|
4795
5493
|
#
|
4796
5494
|
# @option params [String] :script_id
|
4797
5495
|
# A unique identifier for a Realtime script to return fleets for. Use
|
4798
|
-
# this parameter to return only fleets using
|
4799
|
-
# either the script ID or ARN value.To retrieve all fleets, leave this
|
5496
|
+
# this parameter to return only fleets using a specified script. Use
|
5497
|
+
# either the script ID or ARN value. To retrieve all fleets, leave this
|
4800
5498
|
# parameter empty.
|
4801
5499
|
#
|
4802
5500
|
# @option params [Integer] :limit
|
@@ -4816,8 +5514,8 @@ module Aws::GameLift
|
|
4816
5514
|
# @example Request syntax with placeholder values
|
4817
5515
|
#
|
4818
5516
|
# resp = client.list_fleets({
|
4819
|
-
# build_id: "
|
4820
|
-
# script_id: "
|
5517
|
+
# build_id: "BuildIdOrArn",
|
5518
|
+
# script_id: "ScriptIdOrArn",
|
4821
5519
|
# limit: 1,
|
4822
5520
|
# next_token: "NonZeroAndMaxString",
|
4823
5521
|
# })
|
@@ -4837,6 +5535,178 @@ module Aws::GameLift
|
|
4837
5535
|
req.send_request(options)
|
4838
5536
|
end
|
4839
5537
|
|
5538
|
+
# **This action is part of Amazon GameLift FleetIQ with game server
|
5539
|
+
# groups, which is in preview release and is subject to change.**
|
5540
|
+
#
|
5541
|
+
# Retrieves information on all game servers groups that exist in the
|
5542
|
+
# current AWS account for the selected region. Use the pagination
|
5543
|
+
# parameters to retrieve results in a set of sequential pages.
|
5544
|
+
#
|
5545
|
+
# **Learn more**
|
5546
|
+
#
|
5547
|
+
# [GameLift FleetIQ Guide][1]
|
5548
|
+
#
|
5549
|
+
# **Related operations**
|
5550
|
+
#
|
5551
|
+
# * CreateGameServerGroup
|
5552
|
+
#
|
5553
|
+
# * ListGameServerGroups
|
5554
|
+
#
|
5555
|
+
# * DescribeGameServerGroup
|
5556
|
+
#
|
5557
|
+
# * UpdateGameServerGroup
|
5558
|
+
#
|
5559
|
+
# * DeleteGameServerGroup
|
5560
|
+
#
|
5561
|
+
# * ResumeGameServerGroup
|
5562
|
+
#
|
5563
|
+
# * SuspendGameServerGroup
|
5564
|
+
#
|
5565
|
+
#
|
5566
|
+
#
|
5567
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
|
5568
|
+
#
|
5569
|
+
# @option params [Integer] :limit
|
5570
|
+
# The maximum number of results to return. Use this parameter with
|
5571
|
+
# `NextToken` to get results as a set of sequential pages.
|
5572
|
+
#
|
5573
|
+
# @option params [String] :next_token
|
5574
|
+
# A token that indicates the start of the next sequential page of
|
5575
|
+
# results. Use the token that is returned with a previous call to this
|
5576
|
+
# action. To start at the beginning of the result set, do not specify a
|
5577
|
+
# value.
|
5578
|
+
#
|
5579
|
+
# @return [Types::ListGameServerGroupsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5580
|
+
#
|
5581
|
+
# * {Types::ListGameServerGroupsOutput#game_server_groups #game_server_groups} => Array<Types::GameServerGroup>
|
5582
|
+
# * {Types::ListGameServerGroupsOutput#next_token #next_token} => String
|
5583
|
+
#
|
5584
|
+
# @example Request syntax with placeholder values
|
5585
|
+
#
|
5586
|
+
# resp = client.list_game_server_groups({
|
5587
|
+
# limit: 1,
|
5588
|
+
# next_token: "NonZeroAndMaxString",
|
5589
|
+
# })
|
5590
|
+
#
|
5591
|
+
# @example Response structure
|
5592
|
+
#
|
5593
|
+
# resp.game_server_groups #=> Array
|
5594
|
+
# resp.game_server_groups[0].game_server_group_name #=> String
|
5595
|
+
# resp.game_server_groups[0].game_server_group_arn #=> String
|
5596
|
+
# resp.game_server_groups[0].role_arn #=> String
|
5597
|
+
# resp.game_server_groups[0].instance_definitions #=> Array
|
5598
|
+
# resp.game_server_groups[0].instance_definitions[0].instance_type #=> String, one of "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge"
|
5599
|
+
# resp.game_server_groups[0].instance_definitions[0].weighted_capacity #=> String
|
5600
|
+
# resp.game_server_groups[0].balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED"
|
5601
|
+
# resp.game_server_groups[0].game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
|
5602
|
+
# resp.game_server_groups[0].auto_scaling_group_arn #=> String
|
5603
|
+
# resp.game_server_groups[0].status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
|
5604
|
+
# resp.game_server_groups[0].status_reason #=> String
|
5605
|
+
# resp.game_server_groups[0].suspended_actions #=> Array
|
5606
|
+
# resp.game_server_groups[0].suspended_actions[0] #=> String, one of "REPLACE_INSTANCE_TYPES"
|
5607
|
+
# resp.game_server_groups[0].creation_time #=> Time
|
5608
|
+
# resp.game_server_groups[0].last_updated_time #=> Time
|
5609
|
+
# resp.next_token #=> String
|
5610
|
+
#
|
5611
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListGameServerGroups AWS API Documentation
|
5612
|
+
#
|
5613
|
+
# @overload list_game_server_groups(params = {})
|
5614
|
+
# @param [Hash] params ({})
|
5615
|
+
def list_game_server_groups(params = {}, options = {})
|
5616
|
+
req = build_request(:list_game_server_groups, params)
|
5617
|
+
req.send_request(options)
|
5618
|
+
end
|
5619
|
+
|
5620
|
+
# **This action is part of Amazon GameLift FleetIQ with game server
|
5621
|
+
# groups, which is in preview release and is subject to change.**
|
5622
|
+
#
|
5623
|
+
# Retrieves information on all game servers that are currently running
|
5624
|
+
# in a specified game server group. If there are custom key sort values
|
5625
|
+
# for your game servers, you can opt to have the returned list sorted
|
5626
|
+
# based on these values. Use the pagination parameters to retrieve
|
5627
|
+
# results in a set of sequential pages.
|
5628
|
+
#
|
5629
|
+
# **Learn more**
|
5630
|
+
#
|
5631
|
+
# [GameLift FleetIQ Guide][1]
|
5632
|
+
#
|
5633
|
+
# **Related operations**
|
5634
|
+
#
|
5635
|
+
# * RegisterGameServer
|
5636
|
+
#
|
5637
|
+
# * ListGameServers
|
5638
|
+
#
|
5639
|
+
# * ClaimGameServer
|
5640
|
+
#
|
5641
|
+
# * DescribeGameServer
|
5642
|
+
#
|
5643
|
+
# * UpdateGameServer
|
5644
|
+
#
|
5645
|
+
# * DeregisterGameServer
|
5646
|
+
#
|
5647
|
+
#
|
5648
|
+
#
|
5649
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
|
5650
|
+
#
|
5651
|
+
# @option params [required, String] :game_server_group_name
|
5652
|
+
# An identifier for the game server group for the game server you want
|
5653
|
+
# to list. Use either the GameServerGroup name or ARN value.
|
5654
|
+
#
|
5655
|
+
# @option params [String] :sort_order
|
5656
|
+
# Indicates how to sort the returned data based on the game servers'
|
5657
|
+
# custom key sort value. If this parameter is left empty, the list of
|
5658
|
+
# game servers is returned in no particular order.
|
5659
|
+
#
|
5660
|
+
# @option params [Integer] :limit
|
5661
|
+
# The maximum number of results to return. Use this parameter with
|
5662
|
+
# `NextToken` to get results as a set of sequential pages.
|
5663
|
+
#
|
5664
|
+
# @option params [String] :next_token
|
5665
|
+
# A token that indicates the start of the next sequential page of
|
5666
|
+
# results. Use the token that is returned with a previous call to this
|
5667
|
+
# action. To start at the beginning of the result set, do not specify a
|
5668
|
+
# value.
|
5669
|
+
#
|
5670
|
+
# @return [Types::ListGameServersOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5671
|
+
#
|
5672
|
+
# * {Types::ListGameServersOutput#game_servers #game_servers} => Array<Types::GameServer>
|
5673
|
+
# * {Types::ListGameServersOutput#next_token #next_token} => String
|
5674
|
+
#
|
5675
|
+
# @example Request syntax with placeholder values
|
5676
|
+
#
|
5677
|
+
# resp = client.list_game_servers({
|
5678
|
+
# game_server_group_name: "GameServerGroupNameOrArn", # required
|
5679
|
+
# sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
|
5680
|
+
# limit: 1,
|
5681
|
+
# next_token: "NonZeroAndMaxString",
|
5682
|
+
# })
|
5683
|
+
#
|
5684
|
+
# @example Response structure
|
5685
|
+
#
|
5686
|
+
# resp.game_servers #=> Array
|
5687
|
+
# resp.game_servers[0].game_server_group_name #=> String
|
5688
|
+
# resp.game_servers[0].game_server_group_arn #=> String
|
5689
|
+
# resp.game_servers[0].game_server_id #=> String
|
5690
|
+
# resp.game_servers[0].instance_id #=> String
|
5691
|
+
# resp.game_servers[0].connection_info #=> String
|
5692
|
+
# resp.game_servers[0].game_server_data #=> String
|
5693
|
+
# resp.game_servers[0].custom_sort_key #=> String
|
5694
|
+
# resp.game_servers[0].claim_status #=> String, one of "CLAIMED"
|
5695
|
+
# resp.game_servers[0].utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
|
5696
|
+
# resp.game_servers[0].registration_time #=> Time
|
5697
|
+
# resp.game_servers[0].last_claim_time #=> Time
|
5698
|
+
# resp.game_servers[0].last_health_check_time #=> Time
|
5699
|
+
# resp.next_token #=> String
|
5700
|
+
#
|
5701
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ListGameServers AWS API Documentation
|
5702
|
+
#
|
5703
|
+
# @overload list_game_servers(params = {})
|
5704
|
+
# @param [Hash] params ({})
|
5705
|
+
def list_game_servers(params = {}, options = {})
|
5706
|
+
req = build_request(:list_game_servers, params)
|
5707
|
+
req.send_request(options)
|
5708
|
+
end
|
5709
|
+
|
4840
5710
|
# Retrieves script records for all Realtime scripts that are associated
|
4841
5711
|
# with the AWS account in use.
|
4842
5712
|
#
|
@@ -5194,7 +6064,7 @@ module Aws::GameLift
|
|
5194
6064
|
#
|
5195
6065
|
# resp = client.put_scaling_policy({
|
5196
6066
|
# name: "NonZeroAndMaxString", # required
|
5197
|
-
# fleet_id: "
|
6067
|
+
# fleet_id: "FleetIdOrArn", # required
|
5198
6068
|
# scaling_adjustment: 1,
|
5199
6069
|
# scaling_adjustment_type: "ChangeInCapacity", # accepts ChangeInCapacity, ExactCapacity, PercentChangeInCapacity
|
5200
6070
|
# threshold: 1.0,
|
@@ -5220,6 +6090,137 @@ module Aws::GameLift
|
|
5220
6090
|
req.send_request(options)
|
5221
6091
|
end
|
5222
6092
|
|
6093
|
+
# **This action is part of Amazon GameLift FleetIQ with game server
|
6094
|
+
# groups, which is in preview release and is subject to change.**
|
6095
|
+
#
|
6096
|
+
# Creates a new game server resource and notifies GameLift FleetIQ that
|
6097
|
+
# the game server is ready to host gameplay and players. This action is
|
6098
|
+
# called by a game server process that is running on an instance in a
|
6099
|
+
# game server group. Registering game servers enables GameLift FleetIQ
|
6100
|
+
# to track available game servers and enables game clients and services
|
6101
|
+
# to claim a game server for a new game session.
|
6102
|
+
#
|
6103
|
+
# To register a game server, identify the game server group and instance
|
6104
|
+
# where the game server is running, and provide a unique identifier for
|
6105
|
+
# the game server. You can also include connection and game server data;
|
6106
|
+
# when a game client or service requests a game server by calling
|
6107
|
+
# ClaimGameServer, this information is returned in response.
|
6108
|
+
#
|
6109
|
+
# Once a game server is successfully registered, it is put in status
|
6110
|
+
# AVAILABLE. A request to register a game server may fail if the
|
6111
|
+
# instance it is in the process of shutting down as part of instance
|
6112
|
+
# rebalancing or scale-down activity.
|
6113
|
+
#
|
6114
|
+
# **Learn more**
|
6115
|
+
#
|
6116
|
+
# [GameLift FleetIQ Guide][1]
|
6117
|
+
#
|
6118
|
+
# **Related operations**
|
6119
|
+
#
|
6120
|
+
# * RegisterGameServer
|
6121
|
+
#
|
6122
|
+
# * ListGameServers
|
6123
|
+
#
|
6124
|
+
# * ClaimGameServer
|
6125
|
+
#
|
6126
|
+
# * DescribeGameServer
|
6127
|
+
#
|
6128
|
+
# * UpdateGameServer
|
6129
|
+
#
|
6130
|
+
# * DeregisterGameServer
|
6131
|
+
#
|
6132
|
+
#
|
6133
|
+
#
|
6134
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
|
6135
|
+
#
|
6136
|
+
# @option params [required, String] :game_server_group_name
|
6137
|
+
# An identifier for the game server group where the game server is
|
6138
|
+
# running. You can use either the GameServerGroup name or ARN value.
|
6139
|
+
#
|
6140
|
+
# @option params [required, String] :game_server_id
|
6141
|
+
# A custom string that uniquely identifies the new game server. Game
|
6142
|
+
# server IDs are developer-defined and must be unique across all game
|
6143
|
+
# server groups in your AWS account.
|
6144
|
+
#
|
6145
|
+
# @option params [required, String] :instance_id
|
6146
|
+
# The unique identifier for the instance where the game server is
|
6147
|
+
# running. This ID is available in the instance metadata.
|
6148
|
+
#
|
6149
|
+
# @option params [String] :connection_info
|
6150
|
+
# Information needed to make inbound client connections to the game
|
6151
|
+
# server. This might include IP address and port, DNS name, etc.
|
6152
|
+
#
|
6153
|
+
# @option params [String] :game_server_data
|
6154
|
+
# A set of custom game server properties, formatted as a single string
|
6155
|
+
# value. This data is passed to a game client or service when it
|
6156
|
+
# requests information on a game servers using ListGameServers or
|
6157
|
+
# ClaimGameServer.
|
6158
|
+
#
|
6159
|
+
# @option params [String] :custom_sort_key
|
6160
|
+
# A game server tag that can be used to request sorted lists of game
|
6161
|
+
# servers using ListGameServers. Custom sort keys are developer-defined
|
6162
|
+
# based on how you want to organize the retrieved game server
|
6163
|
+
# information.
|
6164
|
+
#
|
6165
|
+
# @option params [Array<Types::Tag>] :tags
|
6166
|
+
# A list of labels to assign to the new game server resource. Tags are
|
6167
|
+
# developer-defined key-value pairs. Tagging AWS resources are useful
|
6168
|
+
# for resource management, access management, and cost allocation. For
|
6169
|
+
# more information, see [ Tagging AWS Resources][1] in the *AWS General
|
6170
|
+
# Reference*. Once the resource is created, you can use TagResource,
|
6171
|
+
# UntagResource, and ListTagsForResource to add, remove, and view tags.
|
6172
|
+
# The maximum tag limit may be lower than stated. See the AWS General
|
6173
|
+
# Reference for actual tagging limits.
|
6174
|
+
#
|
6175
|
+
#
|
6176
|
+
#
|
6177
|
+
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
6178
|
+
#
|
6179
|
+
# @return [Types::RegisterGameServerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6180
|
+
#
|
6181
|
+
# * {Types::RegisterGameServerOutput#game_server #game_server} => Types::GameServer
|
6182
|
+
#
|
6183
|
+
# @example Request syntax with placeholder values
|
6184
|
+
#
|
6185
|
+
# resp = client.register_game_server({
|
6186
|
+
# game_server_group_name: "GameServerGroupNameOrArn", # required
|
6187
|
+
# game_server_id: "GameServerId", # required
|
6188
|
+
# instance_id: "GameServerInstanceId", # required
|
6189
|
+
# connection_info: "GameServerConnectionInfo",
|
6190
|
+
# game_server_data: "GameServerData",
|
6191
|
+
# custom_sort_key: "GameServerSortKey",
|
6192
|
+
# tags: [
|
6193
|
+
# {
|
6194
|
+
# key: "TagKey", # required
|
6195
|
+
# value: "TagValue", # required
|
6196
|
+
# },
|
6197
|
+
# ],
|
6198
|
+
# })
|
6199
|
+
#
|
6200
|
+
# @example Response structure
|
6201
|
+
#
|
6202
|
+
# resp.game_server.game_server_group_name #=> String
|
6203
|
+
# resp.game_server.game_server_group_arn #=> String
|
6204
|
+
# resp.game_server.game_server_id #=> String
|
6205
|
+
# resp.game_server.instance_id #=> String
|
6206
|
+
# resp.game_server.connection_info #=> String
|
6207
|
+
# resp.game_server.game_server_data #=> String
|
6208
|
+
# resp.game_server.custom_sort_key #=> String
|
6209
|
+
# resp.game_server.claim_status #=> String, one of "CLAIMED"
|
6210
|
+
# resp.game_server.utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
|
6211
|
+
# resp.game_server.registration_time #=> Time
|
6212
|
+
# resp.game_server.last_claim_time #=> Time
|
6213
|
+
# resp.game_server.last_health_check_time #=> Time
|
6214
|
+
#
|
6215
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/RegisterGameServer AWS API Documentation
|
6216
|
+
#
|
6217
|
+
# @overload register_game_server(params = {})
|
6218
|
+
# @param [Hash] params ({})
|
6219
|
+
def register_game_server(params = {}, options = {})
|
6220
|
+
req = build_request(:register_game_server, params)
|
6221
|
+
req.send_request(options)
|
6222
|
+
end
|
6223
|
+
|
5223
6224
|
# Retrieves a fresh set of credentials for use when uploading a new set
|
5224
6225
|
# of game build files to Amazon GameLift's Amazon S3. This is done as
|
5225
6226
|
# part of the build creation process; see CreateBuild.
|
@@ -5231,7 +6232,7 @@ module Aws::GameLift
|
|
5231
6232
|
#
|
5232
6233
|
# **Learn more**
|
5233
6234
|
#
|
5234
|
-
# [
|
6235
|
+
# [ Create a Build with Files in S3][1]
|
5235
6236
|
#
|
5236
6237
|
# **Related operations**
|
5237
6238
|
#
|
@@ -5247,7 +6248,7 @@ module Aws::GameLift
|
|
5247
6248
|
#
|
5248
6249
|
#
|
5249
6250
|
#
|
5250
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-
|
6251
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-cli-uploading.html#gamelift-build-cli-uploading-create-build
|
5251
6252
|
#
|
5252
6253
|
# @option params [required, String] :build_id
|
5253
6254
|
# A unique identifier for a build to get credentials for. You can use
|
@@ -5261,7 +6262,7 @@ module Aws::GameLift
|
|
5261
6262
|
# @example Request syntax with placeholder values
|
5262
6263
|
#
|
5263
6264
|
# resp = client.request_upload_credentials({
|
5264
|
-
# build_id: "
|
6265
|
+
# build_id: "BuildIdOrArn", # required
|
5265
6266
|
# })
|
5266
6267
|
#
|
5267
6268
|
# @example Response structure
|
@@ -5309,7 +6310,7 @@ module Aws::GameLift
|
|
5309
6310
|
# @example Request syntax with placeholder values
|
5310
6311
|
#
|
5311
6312
|
# resp = client.resolve_alias({
|
5312
|
-
# alias_id: "
|
6313
|
+
# alias_id: "AliasIdOrArn", # required
|
5313
6314
|
# })
|
5314
6315
|
#
|
5315
6316
|
# @example Response structure
|
@@ -5326,6 +6327,89 @@ module Aws::GameLift
|
|
5326
6327
|
req.send_request(options)
|
5327
6328
|
end
|
5328
6329
|
|
6330
|
+
# **This action is part of Amazon GameLift FleetIQ with game server
|
6331
|
+
# groups, which is in preview release and is subject to change.**
|
6332
|
+
#
|
6333
|
+
# Reinstates activity on a game server group after it has been
|
6334
|
+
# suspended. A game server group may be suspended by calling
|
6335
|
+
# SuspendGameServerGroup, or it may have been involuntarily suspended
|
6336
|
+
# due to a configuration problem. You can manually resume activity on
|
6337
|
+
# the group once the configuration problem has been resolved. Refer to
|
6338
|
+
# the game server group status and status reason for more information on
|
6339
|
+
# why group activity is suspended.
|
6340
|
+
#
|
6341
|
+
# To resume activity, specify a game server group ARN and the type of
|
6342
|
+
# activity to be resumed.
|
6343
|
+
#
|
6344
|
+
# **Learn more**
|
6345
|
+
#
|
6346
|
+
# [GameLift FleetIQ Guide][1]
|
6347
|
+
#
|
6348
|
+
# **Related operations**
|
6349
|
+
#
|
6350
|
+
# * CreateGameServerGroup
|
6351
|
+
#
|
6352
|
+
# * ListGameServerGroups
|
6353
|
+
#
|
6354
|
+
# * DescribeGameServerGroup
|
6355
|
+
#
|
6356
|
+
# * UpdateGameServerGroup
|
6357
|
+
#
|
6358
|
+
# * DeleteGameServerGroup
|
6359
|
+
#
|
6360
|
+
# * ResumeGameServerGroup
|
6361
|
+
#
|
6362
|
+
# * SuspendGameServerGroup
|
6363
|
+
#
|
6364
|
+
#
|
6365
|
+
#
|
6366
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
|
6367
|
+
#
|
6368
|
+
# @option params [required, String] :game_server_group_name
|
6369
|
+
# The unique identifier of the game server group to resume activity on.
|
6370
|
+
# Use either the GameServerGroup name or ARN value.
|
6371
|
+
#
|
6372
|
+
# @option params [required, Array<String>] :resume_actions
|
6373
|
+
# The action to resume for this game server group.
|
6374
|
+
#
|
6375
|
+
# @return [Types::ResumeGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6376
|
+
#
|
6377
|
+
# * {Types::ResumeGameServerGroupOutput#game_server_group #game_server_group} => Types::GameServerGroup
|
6378
|
+
#
|
6379
|
+
# @example Request syntax with placeholder values
|
6380
|
+
#
|
6381
|
+
# resp = client.resume_game_server_group({
|
6382
|
+
# game_server_group_name: "GameServerGroupNameOrArn", # required
|
6383
|
+
# resume_actions: ["REPLACE_INSTANCE_TYPES"], # required, accepts REPLACE_INSTANCE_TYPES
|
6384
|
+
# })
|
6385
|
+
#
|
6386
|
+
# @example Response structure
|
6387
|
+
#
|
6388
|
+
# resp.game_server_group.game_server_group_name #=> String
|
6389
|
+
# resp.game_server_group.game_server_group_arn #=> String
|
6390
|
+
# resp.game_server_group.role_arn #=> String
|
6391
|
+
# resp.game_server_group.instance_definitions #=> Array
|
6392
|
+
# resp.game_server_group.instance_definitions[0].instance_type #=> String, one of "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge"
|
6393
|
+
# resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
|
6394
|
+
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED"
|
6395
|
+
# resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
|
6396
|
+
# resp.game_server_group.auto_scaling_group_arn #=> String
|
6397
|
+
# resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
|
6398
|
+
# resp.game_server_group.status_reason #=> String
|
6399
|
+
# resp.game_server_group.suspended_actions #=> Array
|
6400
|
+
# resp.game_server_group.suspended_actions[0] #=> String, one of "REPLACE_INSTANCE_TYPES"
|
6401
|
+
# resp.game_server_group.creation_time #=> Time
|
6402
|
+
# resp.game_server_group.last_updated_time #=> Time
|
6403
|
+
#
|
6404
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/ResumeGameServerGroup AWS API Documentation
|
6405
|
+
#
|
6406
|
+
# @overload resume_game_server_group(params = {})
|
6407
|
+
# @param [Hash] params ({})
|
6408
|
+
def resume_game_server_group(params = {}, options = {})
|
6409
|
+
req = build_request(:resume_game_server_group, params)
|
6410
|
+
req.send_request(options)
|
6411
|
+
end
|
6412
|
+
|
5329
6413
|
# Retrieves all active game sessions that match a set of search criteria
|
5330
6414
|
# and sorts them in a specified order. You can search or sort by the
|
5331
6415
|
# following game session attributes:
|
@@ -5497,8 +6581,8 @@ module Aws::GameLift
|
|
5497
6581
|
# @example Request syntax with placeholder values
|
5498
6582
|
#
|
5499
6583
|
# resp = client.search_game_sessions({
|
5500
|
-
# fleet_id: "
|
5501
|
-
# alias_id: "
|
6584
|
+
# fleet_id: "FleetIdOrArn",
|
6585
|
+
# alias_id: "AliasIdOrArn",
|
5502
6586
|
# filter_expression: "NonZeroAndMaxString",
|
5503
6587
|
# sort_expression: "NonZeroAndMaxString",
|
5504
6588
|
# limit: 1,
|
@@ -5552,7 +6636,7 @@ module Aws::GameLift
|
|
5552
6636
|
#
|
5553
6637
|
# **Learn more**
|
5554
6638
|
#
|
5555
|
-
# [
|
6639
|
+
# [Setting up GameLift Fleets][1]
|
5556
6640
|
#
|
5557
6641
|
# **Related operations**
|
5558
6642
|
#
|
@@ -5562,37 +6646,11 @@ module Aws::GameLift
|
|
5562
6646
|
#
|
5563
6647
|
# * DeleteFleet
|
5564
6648
|
#
|
5565
|
-
# *
|
5566
|
-
#
|
5567
|
-
# * DescribeFleetAttributes
|
5568
|
-
#
|
5569
|
-
# * DescribeFleetCapacity
|
5570
|
-
#
|
5571
|
-
# * DescribeFleetPortSettings
|
5572
|
-
#
|
5573
|
-
# * DescribeFleetUtilization
|
5574
|
-
#
|
5575
|
-
# * DescribeRuntimeConfiguration
|
5576
|
-
#
|
5577
|
-
# * DescribeEC2InstanceLimits
|
5578
|
-
#
|
5579
|
-
# * DescribeFleetEvents
|
5580
|
-
#
|
5581
|
-
# * Update fleets:
|
5582
|
-
#
|
5583
|
-
# * UpdateFleetAttributes
|
5584
|
-
#
|
5585
|
-
# * UpdateFleetCapacity
|
5586
|
-
#
|
5587
|
-
# * UpdateFleetPortSettings
|
5588
|
-
#
|
5589
|
-
# * UpdateRuntimeConfiguration
|
5590
|
-
#
|
5591
|
-
# * Manage fleet actions:
|
6649
|
+
# * DescribeFleetAttributes
|
5592
6650
|
#
|
5593
|
-
#
|
6651
|
+
# * UpdateFleetAttributes
|
5594
6652
|
#
|
5595
|
-
#
|
6653
|
+
# * StartFleetActions or StopFleetActions
|
5596
6654
|
#
|
5597
6655
|
#
|
5598
6656
|
#
|
@@ -5610,7 +6668,7 @@ module Aws::GameLift
|
|
5610
6668
|
# @example Request syntax with placeholder values
|
5611
6669
|
#
|
5612
6670
|
# resp = client.start_fleet_actions({
|
5613
|
-
# fleet_id: "
|
6671
|
+
# fleet_id: "FleetIdOrArn", # required
|
5614
6672
|
# actions: ["AUTO_SCALING"], # required, accepts AUTO_SCALING
|
5615
6673
|
# })
|
5616
6674
|
#
|
@@ -5697,7 +6755,7 @@ module Aws::GameLift
|
|
5697
6755
|
#
|
5698
6756
|
# @option params [required, String] :game_session_queue_name
|
5699
6757
|
# Name of the queue to use to place the new game session. You can use
|
5700
|
-
# either the
|
6758
|
+
# either the queue name or ARN value.
|
5701
6759
|
#
|
5702
6760
|
# @option params [Array<Types::GameProperty>] :game_properties
|
5703
6761
|
# Set of custom properties for a game session, formatted as key:value
|
@@ -5744,7 +6802,7 @@ module Aws::GameLift
|
|
5744
6802
|
#
|
5745
6803
|
# resp = client.start_game_session_placement({
|
5746
6804
|
# placement_id: "IdStringModel", # required
|
5747
|
-
# game_session_queue_name: "
|
6805
|
+
# game_session_queue_name: "GameSessionQueueNameOrArn", # required
|
5748
6806
|
# game_properties: [
|
5749
6807
|
# {
|
5750
6808
|
# key: "GamePropertyKey", # required
|
@@ -6127,20 +7185,18 @@ module Aws::GameLift
|
|
6127
7185
|
|
6128
7186
|
# Suspends activity on a fleet. Currently, this operation is used to
|
6129
7187
|
# stop a fleet's auto-scaling activity. It is used to temporarily stop
|
6130
|
-
# scaling events
|
6131
|
-
#
|
6132
|
-
#
|
6133
|
-
# DescribeFleetAttributes.
|
7188
|
+
# triggering scaling events. The policies can be retained and
|
7189
|
+
# auto-scaling activity can be restarted using StartFleetActions. You
|
7190
|
+
# can view a fleet's stopped actions using DescribeFleetAttributes.
|
6134
7191
|
#
|
6135
7192
|
# To stop fleet actions, specify the fleet ID and the type of actions to
|
6136
7193
|
# suspend. When auto-scaling fleet actions are stopped, Amazon GameLift
|
6137
|
-
# no longer initiates scaling events except
|
6138
|
-
#
|
6139
|
-
# capacity must be done manually using UpdateFleetCapacity.
|
7194
|
+
# no longer initiates scaling events except in response to manual
|
7195
|
+
# changes using UpdateFleetCapacity.
|
6140
7196
|
#
|
6141
7197
|
# **Learn more**
|
6142
7198
|
#
|
6143
|
-
# [
|
7199
|
+
# [Setting up GameLift Fleets][1]
|
6144
7200
|
#
|
6145
7201
|
# **Related operations**
|
6146
7202
|
#
|
@@ -6150,37 +7206,11 @@ module Aws::GameLift
|
|
6150
7206
|
#
|
6151
7207
|
# * DeleteFleet
|
6152
7208
|
#
|
6153
|
-
# *
|
6154
|
-
#
|
6155
|
-
# * DescribeFleetAttributes
|
6156
|
-
#
|
6157
|
-
# * DescribeFleetCapacity
|
6158
|
-
#
|
6159
|
-
# * DescribeFleetPortSettings
|
6160
|
-
#
|
6161
|
-
# * DescribeFleetUtilization
|
6162
|
-
#
|
6163
|
-
# * DescribeRuntimeConfiguration
|
6164
|
-
#
|
6165
|
-
# * DescribeEC2InstanceLimits
|
6166
|
-
#
|
6167
|
-
# * DescribeFleetEvents
|
6168
|
-
#
|
6169
|
-
# * Update fleets:
|
6170
|
-
#
|
6171
|
-
# * UpdateFleetAttributes
|
6172
|
-
#
|
6173
|
-
# * UpdateFleetCapacity
|
6174
|
-
#
|
6175
|
-
# * UpdateFleetPortSettings
|
6176
|
-
#
|
6177
|
-
# * UpdateRuntimeConfiguration
|
6178
|
-
#
|
6179
|
-
# * Manage fleet actions:
|
7209
|
+
# * DescribeFleetAttributes
|
6180
7210
|
#
|
6181
|
-
#
|
7211
|
+
# * UpdateFleetAttributes
|
6182
7212
|
#
|
6183
|
-
#
|
7213
|
+
# * StartFleetActions or StopFleetActions
|
6184
7214
|
#
|
6185
7215
|
#
|
6186
7216
|
#
|
@@ -6198,7 +7228,7 @@ module Aws::GameLift
|
|
6198
7228
|
# @example Request syntax with placeholder values
|
6199
7229
|
#
|
6200
7230
|
# resp = client.stop_fleet_actions({
|
6201
|
-
# fleet_id: "
|
7231
|
+
# fleet_id: "FleetIdOrArn", # required
|
6202
7232
|
# actions: ["AUTO_SCALING"], # required, accepts AUTO_SCALING
|
6203
7233
|
# })
|
6204
7234
|
#
|
@@ -6341,6 +7371,97 @@ module Aws::GameLift
|
|
6341
7371
|
req.send_request(options)
|
6342
7372
|
end
|
6343
7373
|
|
7374
|
+
# **This action is part of Amazon GameLift FleetIQ with game server
|
7375
|
+
# groups, which is in preview release and is subject to change.**
|
7376
|
+
#
|
7377
|
+
# Temporarily stops activity on a game server group without terminating
|
7378
|
+
# instances or the game server group. Activity can be restarted by
|
7379
|
+
# calling ResumeGameServerGroup. Activities that can suspended are:
|
7380
|
+
#
|
7381
|
+
# * Instance type replacement. This activity evaluates the current Spot
|
7382
|
+
# viability of all instance types that are defined for the game server
|
7383
|
+
# group. It updates the Auto Scaling group to remove nonviable Spot
|
7384
|
+
# instance types (which have a higher chance of game server
|
7385
|
+
# interruptions) and rebalances capacity across the remaining viable
|
7386
|
+
# Spot instance types. When this activity is suspended, the Auto
|
7387
|
+
# Scaling group continues with its current balance, regardless of
|
7388
|
+
# viability. Instance protection, utilization metrics, and capacity
|
7389
|
+
# autoscaling activities continue to be active.
|
7390
|
+
#
|
7391
|
+
# ^
|
7392
|
+
#
|
7393
|
+
# To suspend activity, specify a game server group ARN and the type of
|
7394
|
+
# activity to be suspended.
|
7395
|
+
#
|
7396
|
+
# **Learn more**
|
7397
|
+
#
|
7398
|
+
# [GameLift FleetIQ Guide][1]
|
7399
|
+
#
|
7400
|
+
# **Related operations**
|
7401
|
+
#
|
7402
|
+
# * CreateGameServerGroup
|
7403
|
+
#
|
7404
|
+
# * ListGameServerGroups
|
7405
|
+
#
|
7406
|
+
# * DescribeGameServerGroup
|
7407
|
+
#
|
7408
|
+
# * UpdateGameServerGroup
|
7409
|
+
#
|
7410
|
+
# * DeleteGameServerGroup
|
7411
|
+
#
|
7412
|
+
# * ResumeGameServerGroup
|
7413
|
+
#
|
7414
|
+
# * SuspendGameServerGroup
|
7415
|
+
#
|
7416
|
+
#
|
7417
|
+
#
|
7418
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
|
7419
|
+
#
|
7420
|
+
# @option params [required, String] :game_server_group_name
|
7421
|
+
# The unique identifier of the game server group to stop activity on.
|
7422
|
+
# Use either the GameServerGroup name or ARN value.
|
7423
|
+
#
|
7424
|
+
# @option params [required, Array<String>] :suspend_actions
|
7425
|
+
# The action to suspend for this game server group.
|
7426
|
+
#
|
7427
|
+
# @return [Types::SuspendGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7428
|
+
#
|
7429
|
+
# * {Types::SuspendGameServerGroupOutput#game_server_group #game_server_group} => Types::GameServerGroup
|
7430
|
+
#
|
7431
|
+
# @example Request syntax with placeholder values
|
7432
|
+
#
|
7433
|
+
# resp = client.suspend_game_server_group({
|
7434
|
+
# game_server_group_name: "GameServerGroupNameOrArn", # required
|
7435
|
+
# suspend_actions: ["REPLACE_INSTANCE_TYPES"], # required, accepts REPLACE_INSTANCE_TYPES
|
7436
|
+
# })
|
7437
|
+
#
|
7438
|
+
# @example Response structure
|
7439
|
+
#
|
7440
|
+
# resp.game_server_group.game_server_group_name #=> String
|
7441
|
+
# resp.game_server_group.game_server_group_arn #=> String
|
7442
|
+
# resp.game_server_group.role_arn #=> String
|
7443
|
+
# resp.game_server_group.instance_definitions #=> Array
|
7444
|
+
# resp.game_server_group.instance_definitions[0].instance_type #=> String, one of "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge"
|
7445
|
+
# resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
|
7446
|
+
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED"
|
7447
|
+
# resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
|
7448
|
+
# resp.game_server_group.auto_scaling_group_arn #=> String
|
7449
|
+
# resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
|
7450
|
+
# resp.game_server_group.status_reason #=> String
|
7451
|
+
# resp.game_server_group.suspended_actions #=> Array
|
7452
|
+
# resp.game_server_group.suspended_actions[0] #=> String, one of "REPLACE_INSTANCE_TYPES"
|
7453
|
+
# resp.game_server_group.creation_time #=> Time
|
7454
|
+
# resp.game_server_group.last_updated_time #=> Time
|
7455
|
+
#
|
7456
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/SuspendGameServerGroup AWS API Documentation
|
7457
|
+
#
|
7458
|
+
# @overload suspend_game_server_group(params = {})
|
7459
|
+
# @param [Hash] params ({})
|
7460
|
+
def suspend_game_server_group(params = {}, options = {})
|
7461
|
+
req = build_request(:suspend_game_server_group, params)
|
7462
|
+
req.send_request(options)
|
7463
|
+
end
|
7464
|
+
|
6344
7465
|
# Assigns a tag to a GameLift resource. AWS resource tags provide an
|
6345
7466
|
# additional management tool set. You can use tags to organize
|
6346
7467
|
# resources, create IAM permissions policies to manage access to groups
|
@@ -6363,7 +7484,7 @@ module Aws::GameLift
|
|
6363
7484
|
# * MatchmakingRuleSet
|
6364
7485
|
#
|
6365
7486
|
# To add a tag to a resource, specify the unique ARN value for the
|
6366
|
-
# resource and provide a
|
7487
|
+
# resource and provide a tag list containing one or more tags. The
|
6367
7488
|
# operation succeeds even if the list includes tags that are already
|
6368
7489
|
# assigned to the specified resource.
|
6369
7490
|
#
|
@@ -6485,9 +7606,9 @@ module Aws::GameLift
|
|
6485
7606
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
|
6486
7607
|
#
|
6487
7608
|
# @option params [required, Array<String>] :tag_keys
|
6488
|
-
# A list of one or more
|
6489
|
-
# resource.
|
6490
|
-
#
|
7609
|
+
# A list of one or more tag keys to remove from the specified GameLift
|
7610
|
+
# resource. An AWS resource can have only one tag with a specific tag
|
7611
|
+
# key, so specifying the tag key identifies which tag to remove.
|
6491
7612
|
#
|
6492
7613
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
6493
7614
|
#
|
@@ -6546,7 +7667,7 @@ module Aws::GameLift
|
|
6546
7667
|
# @example Request syntax with placeholder values
|
6547
7668
|
#
|
6548
7669
|
# resp = client.update_alias({
|
6549
|
-
# alias_id: "
|
7670
|
+
# alias_id: "AliasIdOrArn", # required
|
6550
7671
|
# name: "NonBlankAndLengthConstraintString",
|
6551
7672
|
# description: "NonZeroAndMaxString",
|
6552
7673
|
# routing_strategy: {
|
@@ -6577,14 +7698,14 @@ module Aws::GameLift
|
|
6577
7698
|
req.send_request(options)
|
6578
7699
|
end
|
6579
7700
|
|
6580
|
-
# Updates metadata in a build
|
7701
|
+
# Updates metadata in a build resource, including the build name and
|
6581
7702
|
# version. To update the metadata, specify the build ID to update and
|
6582
7703
|
# provide the new values. If successful, a build object containing the
|
6583
7704
|
# updated metadata is returned.
|
6584
7705
|
#
|
6585
7706
|
# **Learn more**
|
6586
7707
|
#
|
6587
|
-
# [
|
7708
|
+
# [ Upload a Custom Server Build][1]
|
6588
7709
|
#
|
6589
7710
|
# **Related operations**
|
6590
7711
|
#
|
@@ -6600,7 +7721,7 @@ module Aws::GameLift
|
|
6600
7721
|
#
|
6601
7722
|
#
|
6602
7723
|
#
|
6603
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/build-intro.html
|
7724
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-build-intro.html
|
6604
7725
|
#
|
6605
7726
|
# @option params [required, String] :build_id
|
6606
7727
|
# A unique identifier for a build to update. You can use either the
|
@@ -6621,7 +7742,7 @@ module Aws::GameLift
|
|
6621
7742
|
# @example Request syntax with placeholder values
|
6622
7743
|
#
|
6623
7744
|
# resp = client.update_build({
|
6624
|
-
# build_id: "
|
7745
|
+
# build_id: "BuildIdOrArn", # required
|
6625
7746
|
# name: "NonZeroAndMaxString",
|
6626
7747
|
# version: "NonZeroAndMaxString",
|
6627
7748
|
# })
|
@@ -6653,7 +7774,7 @@ module Aws::GameLift
|
|
6653
7774
|
#
|
6654
7775
|
# **Learn more**
|
6655
7776
|
#
|
6656
|
-
# [
|
7777
|
+
# [Setting up GameLift Fleets][1]
|
6657
7778
|
#
|
6658
7779
|
# **Related operations**
|
6659
7780
|
#
|
@@ -6675,11 +7796,7 @@ module Aws::GameLift
|
|
6675
7796
|
#
|
6676
7797
|
# * UpdateRuntimeConfiguration
|
6677
7798
|
#
|
6678
|
-
# *
|
6679
|
-
#
|
6680
|
-
# * StartFleetActions
|
6681
|
-
#
|
6682
|
-
# * StopFleetActions
|
7799
|
+
# * StartFleetActions or StopFleetActions
|
6683
7800
|
#
|
6684
7801
|
#
|
6685
7802
|
#
|
@@ -6725,7 +7842,7 @@ module Aws::GameLift
|
|
6725
7842
|
# @example Request syntax with placeholder values
|
6726
7843
|
#
|
6727
7844
|
# resp = client.update_fleet_attributes({
|
6728
|
-
# fleet_id: "
|
7845
|
+
# fleet_id: "FleetIdOrArn", # required
|
6729
7846
|
# name: "NonZeroAndMaxString",
|
6730
7847
|
# description: "NonZeroAndMaxString",
|
6731
7848
|
# new_game_session_protection_policy: "NoProtection", # accepts NoProtection, FullProtection
|
@@ -6771,7 +7888,7 @@ module Aws::GameLift
|
|
6771
7888
|
#
|
6772
7889
|
# **Learn more**
|
6773
7890
|
#
|
6774
|
-
# [
|
7891
|
+
# [Setting up GameLift Fleets][1]
|
6775
7892
|
#
|
6776
7893
|
# **Related operations**
|
6777
7894
|
#
|
@@ -6793,11 +7910,7 @@ module Aws::GameLift
|
|
6793
7910
|
#
|
6794
7911
|
# * UpdateRuntimeConfiguration
|
6795
7912
|
#
|
6796
|
-
# *
|
6797
|
-
#
|
6798
|
-
# * StartFleetActions
|
6799
|
-
#
|
6800
|
-
# * StopFleetActions
|
7913
|
+
# * StartFleetActions or StopFleetActions
|
6801
7914
|
#
|
6802
7915
|
#
|
6803
7916
|
#
|
@@ -6825,7 +7938,7 @@ module Aws::GameLift
|
|
6825
7938
|
# @example Request syntax with placeholder values
|
6826
7939
|
#
|
6827
7940
|
# resp = client.update_fleet_capacity({
|
6828
|
-
# fleet_id: "
|
7941
|
+
# fleet_id: "FleetIdOrArn", # required
|
6829
7942
|
# desired_instances: 1,
|
6830
7943
|
# min_size: 1,
|
6831
7944
|
# max_size: 1,
|
@@ -6854,7 +7967,7 @@ module Aws::GameLift
|
|
6854
7967
|
#
|
6855
7968
|
# **Learn more**
|
6856
7969
|
#
|
6857
|
-
# [
|
7970
|
+
# [Setting up GameLift Fleets][1]
|
6858
7971
|
#
|
6859
7972
|
# **Related operations**
|
6860
7973
|
#
|
@@ -6876,11 +7989,7 @@ module Aws::GameLift
|
|
6876
7989
|
#
|
6877
7990
|
# * UpdateRuntimeConfiguration
|
6878
7991
|
#
|
6879
|
-
# *
|
6880
|
-
#
|
6881
|
-
# * StartFleetActions
|
6882
|
-
#
|
6883
|
-
# * StopFleetActions
|
7992
|
+
# * StartFleetActions or StopFleetActions
|
6884
7993
|
#
|
6885
7994
|
#
|
6886
7995
|
#
|
@@ -6891,10 +8000,10 @@ module Aws::GameLift
|
|
6891
8000
|
# use either the fleet ID or ARN value.
|
6892
8001
|
#
|
6893
8002
|
# @option params [Array<Types::IpPermission>] :inbound_permission_authorizations
|
6894
|
-
# A collection of port settings to be added to the fleet
|
8003
|
+
# A collection of port settings to be added to the fleet resource.
|
6895
8004
|
#
|
6896
8005
|
# @option params [Array<Types::IpPermission>] :inbound_permission_revocations
|
6897
|
-
# A collection of port settings to be removed from the fleet
|
8006
|
+
# A collection of port settings to be removed from the fleet resource.
|
6898
8007
|
#
|
6899
8008
|
# @return [Types::UpdateFleetPortSettingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6900
8009
|
#
|
@@ -6903,7 +8012,7 @@ module Aws::GameLift
|
|
6903
8012
|
# @example Request syntax with placeholder values
|
6904
8013
|
#
|
6905
8014
|
# resp = client.update_fleet_port_settings({
|
6906
|
-
# fleet_id: "
|
8015
|
+
# fleet_id: "FleetIdOrArn", # required
|
6907
8016
|
# inbound_permission_authorizations: [
|
6908
8017
|
# {
|
6909
8018
|
# from_port: 1, # required
|
@@ -6935,6 +8044,270 @@ module Aws::GameLift
|
|
6935
8044
|
req.send_request(options)
|
6936
8045
|
end
|
6937
8046
|
|
8047
|
+
# **This action is part of Amazon GameLift FleetIQ with game server
|
8048
|
+
# groups, which is in preview release and is subject to change.**
|
8049
|
+
#
|
8050
|
+
# Updates information about a registered game server. This action is
|
8051
|
+
# called by a game server process that is running on an instance in a
|
8052
|
+
# game server group. There are three reasons to update game server
|
8053
|
+
# information: (1) to change the utilization status of the game server,
|
8054
|
+
# (2) to report game server health status, and (3) to change game server
|
8055
|
+
# metadata. A registered game server should regularly report health and
|
8056
|
+
# should update utilization status when it is supporting gameplay so
|
8057
|
+
# that GameLift FleetIQ can accurately track game server availability.
|
8058
|
+
# You can make all three types of updates in the same request.
|
8059
|
+
#
|
8060
|
+
# * To update the game server's utilization status, identify the game
|
8061
|
+
# server and game server group and specify the current utilization
|
8062
|
+
# status. Use this status to identify when game servers are currently
|
8063
|
+
# hosting games and when they are available to be claimed.
|
8064
|
+
#
|
8065
|
+
# * To report health status, identify the game server and game server
|
8066
|
+
# group and set health check to HEALTHY. If a game server does not
|
8067
|
+
# report health status for a certain length of time, the game server
|
8068
|
+
# is no longer considered healthy and will be eventually de-registered
|
8069
|
+
# from the game server group to avoid affecting utilization metrics.
|
8070
|
+
# The best practice is to report health every 60 seconds.
|
8071
|
+
#
|
8072
|
+
# * To change game server metadata, provide updated game server data and
|
8073
|
+
# custom sort key values.
|
8074
|
+
#
|
8075
|
+
# Once a game server is successfully updated, the relevant statuses and
|
8076
|
+
# timestamps are updated.
|
8077
|
+
#
|
8078
|
+
# **Learn more**
|
8079
|
+
#
|
8080
|
+
# [GameLift FleetIQ Guide][1]
|
8081
|
+
#
|
8082
|
+
# **Related operations**
|
8083
|
+
#
|
8084
|
+
# * RegisterGameServer
|
8085
|
+
#
|
8086
|
+
# * ListGameServers
|
8087
|
+
#
|
8088
|
+
# * ClaimGameServer
|
8089
|
+
#
|
8090
|
+
# * DescribeGameServer
|
8091
|
+
#
|
8092
|
+
# * UpdateGameServer
|
8093
|
+
#
|
8094
|
+
# * DeregisterGameServer
|
8095
|
+
#
|
8096
|
+
#
|
8097
|
+
#
|
8098
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
|
8099
|
+
#
|
8100
|
+
# @option params [required, String] :game_server_group_name
|
8101
|
+
# An identifier for the game server group where the game server is
|
8102
|
+
# running. Use either the GameServerGroup name or ARN value.
|
8103
|
+
#
|
8104
|
+
# @option params [required, String] :game_server_id
|
8105
|
+
# The identifier for the game server to be updated.
|
8106
|
+
#
|
8107
|
+
# @option params [String] :game_server_data
|
8108
|
+
# A set of custom game server properties, formatted as a single string
|
8109
|
+
# value. This data is passed to a game client or service when it
|
8110
|
+
# requests information on a game servers using DescribeGameServer or
|
8111
|
+
# ClaimGameServer.
|
8112
|
+
#
|
8113
|
+
# @option params [String] :custom_sort_key
|
8114
|
+
# A game server tag that can be used to request sorted lists of game
|
8115
|
+
# servers using ListGameServers. Custom sort keys are developer-defined
|
8116
|
+
# based on how you want to organize the retrieved game server
|
8117
|
+
# information.
|
8118
|
+
#
|
8119
|
+
# @option params [String] :utilization_status
|
8120
|
+
# Indicates whether the game server is available or is currently hosting
|
8121
|
+
# gameplay.
|
8122
|
+
#
|
8123
|
+
# @option params [String] :health_check
|
8124
|
+
# Indicates health status of the game server. An update that explicitly
|
8125
|
+
# includes this parameter updates the game server's
|
8126
|
+
# *LastHealthCheckTime* time stamp.
|
8127
|
+
#
|
8128
|
+
# @return [Types::UpdateGameServerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8129
|
+
#
|
8130
|
+
# * {Types::UpdateGameServerOutput#game_server #game_server} => Types::GameServer
|
8131
|
+
#
|
8132
|
+
# @example Request syntax with placeholder values
|
8133
|
+
#
|
8134
|
+
# resp = client.update_game_server({
|
8135
|
+
# game_server_group_name: "GameServerGroupNameOrArn", # required
|
8136
|
+
# game_server_id: "GameServerId", # required
|
8137
|
+
# game_server_data: "GameServerData",
|
8138
|
+
# custom_sort_key: "GameServerSortKey",
|
8139
|
+
# utilization_status: "AVAILABLE", # accepts AVAILABLE, UTILIZED
|
8140
|
+
# health_check: "HEALTHY", # accepts HEALTHY
|
8141
|
+
# })
|
8142
|
+
#
|
8143
|
+
# @example Response structure
|
8144
|
+
#
|
8145
|
+
# resp.game_server.game_server_group_name #=> String
|
8146
|
+
# resp.game_server.game_server_group_arn #=> String
|
8147
|
+
# resp.game_server.game_server_id #=> String
|
8148
|
+
# resp.game_server.instance_id #=> String
|
8149
|
+
# resp.game_server.connection_info #=> String
|
8150
|
+
# resp.game_server.game_server_data #=> String
|
8151
|
+
# resp.game_server.custom_sort_key #=> String
|
8152
|
+
# resp.game_server.claim_status #=> String, one of "CLAIMED"
|
8153
|
+
# resp.game_server.utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
|
8154
|
+
# resp.game_server.registration_time #=> Time
|
8155
|
+
# resp.game_server.last_claim_time #=> Time
|
8156
|
+
# resp.game_server.last_health_check_time #=> Time
|
8157
|
+
#
|
8158
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateGameServer AWS API Documentation
|
8159
|
+
#
|
8160
|
+
# @overload update_game_server(params = {})
|
8161
|
+
# @param [Hash] params ({})
|
8162
|
+
def update_game_server(params = {}, options = {})
|
8163
|
+
req = build_request(:update_game_server, params)
|
8164
|
+
req.send_request(options)
|
8165
|
+
end
|
8166
|
+
|
8167
|
+
# **This action is part of Amazon GameLift FleetIQ with game server
|
8168
|
+
# groups, which is in preview release and is subject to change.**
|
8169
|
+
#
|
8170
|
+
# Updates GameLift FleetIQ-specific properties for a game server group.
|
8171
|
+
# These properties include instance rebalancing and game server
|
8172
|
+
# protection. Many Auto Scaling group properties are updated directly.
|
8173
|
+
# These include autoscaling policies, minimum/maximum/desired instance
|
8174
|
+
# counts, and launch template.
|
8175
|
+
#
|
8176
|
+
# To update the game server group, specify the game server group ID and
|
8177
|
+
# provide the updated values.
|
8178
|
+
#
|
8179
|
+
# Updated properties are validated to ensure that GameLift FleetIQ can
|
8180
|
+
# continue to perform its core instance rebalancing activity. When you
|
8181
|
+
# change Auto Scaling group properties directly and the changes cause
|
8182
|
+
# errors with GameLift FleetIQ activities, an alert is sent.
|
8183
|
+
#
|
8184
|
+
# **Learn more**
|
8185
|
+
#
|
8186
|
+
# [GameLift FleetIQ Guide][1]
|
8187
|
+
#
|
8188
|
+
# [Updating a GameLift FleetIQ-Linked Auto Scaling Group][2]
|
8189
|
+
#
|
8190
|
+
# **Related operations**
|
8191
|
+
#
|
8192
|
+
# * CreateGameServerGroup
|
8193
|
+
#
|
8194
|
+
# * ListGameServerGroups
|
8195
|
+
#
|
8196
|
+
# * DescribeGameServerGroup
|
8197
|
+
#
|
8198
|
+
# * UpdateGameServerGroup
|
8199
|
+
#
|
8200
|
+
# * DeleteGameServerGroup
|
8201
|
+
#
|
8202
|
+
# * ResumeGameServerGroup
|
8203
|
+
#
|
8204
|
+
# * SuspendGameServerGroup
|
8205
|
+
#
|
8206
|
+
#
|
8207
|
+
#
|
8208
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
|
8209
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-asgroups.html
|
8210
|
+
#
|
8211
|
+
# @option params [required, String] :game_server_group_name
|
8212
|
+
# The unique identifier of the game server group to update. Use either
|
8213
|
+
# the GameServerGroup name or ARN value.
|
8214
|
+
#
|
8215
|
+
# @option params [String] :role_arn
|
8216
|
+
# The Amazon Resource Name ([ARN][1]) for an IAM role that allows Amazon
|
8217
|
+
# GameLift to access your EC2 Auto Scaling groups. The submitted role is
|
8218
|
+
# validated to ensure that it contains the necessary permissions for
|
8219
|
+
# game server groups.
|
8220
|
+
#
|
8221
|
+
#
|
8222
|
+
#
|
8223
|
+
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
|
8224
|
+
#
|
8225
|
+
# @option params [Array<Types::InstanceDefinition>] :instance_definitions
|
8226
|
+
# An updated list of EC2 instance types to use when creating instances
|
8227
|
+
# in the group. The instance definition must specify instance types that
|
8228
|
+
# are supported by GameLift FleetIQ, and must include at least two
|
8229
|
+
# instance types. This updated list replaces the entire current list of
|
8230
|
+
# instance definitions for the game server group. For more information
|
8231
|
+
# on instance types, see [EC2 Instance Types][1] in the *Amazon EC2 User
|
8232
|
+
# Guide*..
|
8233
|
+
#
|
8234
|
+
#
|
8235
|
+
#
|
8236
|
+
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html
|
8237
|
+
#
|
8238
|
+
# @option params [String] :game_server_protection_policy
|
8239
|
+
# A flag that indicates whether instances in the game server group are
|
8240
|
+
# protected from early termination. Unprotected instances that have
|
8241
|
+
# active game servers running may by terminated during a scale-down
|
8242
|
+
# event, causing players to be dropped from the game. Protected
|
8243
|
+
# instances cannot be terminated while there are active game servers
|
8244
|
+
# running. An exception to this is Spot Instances, which may be
|
8245
|
+
# terminated by AWS regardless of protection status. This property is
|
8246
|
+
# set to NO\_PROTECTION by default.
|
8247
|
+
#
|
8248
|
+
# @option params [String] :balancing_strategy
|
8249
|
+
# The fallback balancing method to use for the game server group when
|
8250
|
+
# Spot instances in a Region become unavailable or are not viable for
|
8251
|
+
# game hosting. Once triggered, this method remains active until Spot
|
8252
|
+
# instances can once again be used. Method options include:
|
8253
|
+
#
|
8254
|
+
# * SPOT\_ONLY -- If Spot instances are unavailable, the game server
|
8255
|
+
# group provides no hosting capacity. No new instances are started,
|
8256
|
+
# and the existing nonviable Spot instances are terminated (once
|
8257
|
+
# current gameplay ends) and not replaced.
|
8258
|
+
#
|
8259
|
+
# * SPOT\_PREFERRED -- If Spot instances are unavailable, the game
|
8260
|
+
# server group continues to provide hosting capacity by using
|
8261
|
+
# On-Demand instances. Existing nonviable Spot instances are
|
8262
|
+
# terminated (once current gameplay ends) and replaced with new
|
8263
|
+
# On-Demand instances.
|
8264
|
+
#
|
8265
|
+
# @return [Types::UpdateGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8266
|
+
#
|
8267
|
+
# * {Types::UpdateGameServerGroupOutput#game_server_group #game_server_group} => Types::GameServerGroup
|
8268
|
+
#
|
8269
|
+
# @example Request syntax with placeholder values
|
8270
|
+
#
|
8271
|
+
# resp = client.update_game_server_group({
|
8272
|
+
# game_server_group_name: "GameServerGroupNameOrArn", # required
|
8273
|
+
# role_arn: "IamRoleArn",
|
8274
|
+
# instance_definitions: [
|
8275
|
+
# {
|
8276
|
+
# 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
|
8277
|
+
# weighted_capacity: "WeightedCapacity",
|
8278
|
+
# },
|
8279
|
+
# ],
|
8280
|
+
# game_server_protection_policy: "NO_PROTECTION", # accepts NO_PROTECTION, FULL_PROTECTION
|
8281
|
+
# balancing_strategy: "SPOT_ONLY", # accepts SPOT_ONLY, SPOT_PREFERRED
|
8282
|
+
# })
|
8283
|
+
#
|
8284
|
+
# @example Response structure
|
8285
|
+
#
|
8286
|
+
# resp.game_server_group.game_server_group_name #=> String
|
8287
|
+
# resp.game_server_group.game_server_group_arn #=> String
|
8288
|
+
# resp.game_server_group.role_arn #=> String
|
8289
|
+
# resp.game_server_group.instance_definitions #=> Array
|
8290
|
+
# resp.game_server_group.instance_definitions[0].instance_type #=> String, one of "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge"
|
8291
|
+
# resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
|
8292
|
+
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED"
|
8293
|
+
# resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
|
8294
|
+
# resp.game_server_group.auto_scaling_group_arn #=> String
|
8295
|
+
# resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
|
8296
|
+
# resp.game_server_group.status_reason #=> String
|
8297
|
+
# resp.game_server_group.suspended_actions #=> Array
|
8298
|
+
# resp.game_server_group.suspended_actions[0] #=> String, one of "REPLACE_INSTANCE_TYPES"
|
8299
|
+
# resp.game_server_group.creation_time #=> Time
|
8300
|
+
# resp.game_server_group.last_updated_time #=> Time
|
8301
|
+
#
|
8302
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateGameServerGroup AWS API Documentation
|
8303
|
+
#
|
8304
|
+
# @overload update_game_server_group(params = {})
|
8305
|
+
# @param [Hash] params ({})
|
8306
|
+
def update_game_server_group(params = {}, options = {})
|
8307
|
+
req = build_request(:update_game_server_group, params)
|
8308
|
+
req.send_request(options)
|
8309
|
+
end
|
8310
|
+
|
6938
8311
|
# Updates game session properties. This includes the session name,
|
6939
8312
|
# maximum player count, protection policy, which controls whether or not
|
6940
8313
|
# an active game session can be terminated during a scale-down event,
|
@@ -7038,6 +8411,12 @@ module Aws::GameLift
|
|
7038
8411
|
# specify the queue name to be updated and provide the new settings.
|
7039
8412
|
# When updating destinations, provide a complete list of destinations.
|
7040
8413
|
#
|
8414
|
+
# **Learn more**
|
8415
|
+
#
|
8416
|
+
# [ Using Multi-Region Queues][1]
|
8417
|
+
#
|
8418
|
+
# **Related operations**
|
8419
|
+
#
|
7041
8420
|
# * CreateGameSessionQueue
|
7042
8421
|
#
|
7043
8422
|
# * DescribeGameSessionQueues
|
@@ -7046,6 +8425,10 @@ module Aws::GameLift
|
|
7046
8425
|
#
|
7047
8426
|
# * DeleteGameSessionQueue
|
7048
8427
|
#
|
8428
|
+
#
|
8429
|
+
#
|
8430
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/queues-intro.html
|
8431
|
+
#
|
7049
8432
|
# @option params [required, String] :name
|
7050
8433
|
# A descriptive label that is associated with game session queue. Queue
|
7051
8434
|
# names must be unique within each Region. You can use either the queue
|
@@ -7082,7 +8465,7 @@ module Aws::GameLift
|
|
7082
8465
|
# @example Request syntax with placeholder values
|
7083
8466
|
#
|
7084
8467
|
# resp = client.update_game_session_queue({
|
7085
|
-
# name: "
|
8468
|
+
# name: "GameSessionQueueNameOrArn", # required
|
7086
8469
|
# timeout_in_seconds: 1,
|
7087
8470
|
# player_latency_policies: [
|
7088
8471
|
# {
|
@@ -7320,7 +8703,7 @@ module Aws::GameLift
|
|
7320
8703
|
#
|
7321
8704
|
# **Learn more**
|
7322
8705
|
#
|
7323
|
-
# [
|
8706
|
+
# [Setting up GameLift Fleets][1]
|
7324
8707
|
#
|
7325
8708
|
# **Related operations**
|
7326
8709
|
#
|
@@ -7342,11 +8725,7 @@ module Aws::GameLift
|
|
7342
8725
|
#
|
7343
8726
|
# * UpdateRuntimeConfiguration
|
7344
8727
|
#
|
7345
|
-
# *
|
7346
|
-
#
|
7347
|
-
# * StartFleetActions
|
7348
|
-
#
|
7349
|
-
# * StopFleetActions
|
8728
|
+
# * StartFleetActions or StopFleetActions
|
7350
8729
|
#
|
7351
8730
|
#
|
7352
8731
|
#
|
@@ -7373,7 +8752,7 @@ module Aws::GameLift
|
|
7373
8752
|
# @example Request syntax with placeholder values
|
7374
8753
|
#
|
7375
8754
|
# resp = client.update_runtime_configuration({
|
7376
|
-
# fleet_id: "
|
8755
|
+
# fleet_id: "FleetIdOrArn", # required
|
7377
8756
|
# runtime_configuration: { # required
|
7378
8757
|
# server_processes: [
|
7379
8758
|
# {
|
@@ -7479,7 +8858,7 @@ module Aws::GameLift
|
|
7479
8858
|
# @example Request syntax with placeholder values
|
7480
8859
|
#
|
7481
8860
|
# resp = client.update_script({
|
7482
|
-
# script_id: "
|
8861
|
+
# script_id: "ScriptIdOrArn", # required
|
7483
8862
|
# name: "NonZeroAndMaxString",
|
7484
8863
|
# version: "NonZeroAndMaxString",
|
7485
8864
|
# storage_location: {
|
@@ -7586,7 +8965,7 @@ module Aws::GameLift
|
|
7586
8965
|
params: params,
|
7587
8966
|
config: config)
|
7588
8967
|
context[:gem_name] = 'aws-sdk-gamelift'
|
7589
|
-
context[:gem_version] = '1.
|
8968
|
+
context[:gem_version] = '1.33.0'
|
7590
8969
|
Seahorse::Client::Request.new(handlers, context)
|
7591
8970
|
end
|
7592
8971
|
|