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