aws-sdk-gamelift 1.34.0 → 1.39.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/aws-sdk-gamelift.rb +3 -2
- data/lib/aws-sdk-gamelift/client.rb +862 -659
- data/lib/aws-sdk-gamelift/client_api.rb +164 -7
- data/lib/aws-sdk-gamelift/types.rb +829 -569
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 92ea3af47c9c89e9444ee8c8661ed9d6697775cb75025ea78072af8ae847667c
|
4
|
+
data.tar.gz: 1a21bf1df2cd7b15bbeda40a75ba6670d13a7de398a14ed624307a196001f972
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 8488cab39d5416ecf0be08b4deaa838aaabbb8296b6faa2af7fb2ae527a294547dbe8a876ac883f4113c7f56d9836581fde72033198bdca34f25389e4c609e04
|
7
|
+
data.tar.gz: dac1500477200020733ce8adcd036e070e2a1df187fba9b99132d684c5667374be091c39a4618e2752fc7ad3247cd2dbc413c3cbe2d6547b29015425cf9549a4
|
data/lib/aws-sdk-gamelift.rb
CHANGED
@@ -7,6 +7,7 @@
|
|
7
7
|
#
|
8
8
|
# WARNING ABOUT GENERATED CODE
|
9
9
|
|
10
|
+
|
10
11
|
require 'aws-sdk-core'
|
11
12
|
require 'aws-sigv4'
|
12
13
|
|
@@ -44,9 +45,9 @@ require_relative 'aws-sdk-gamelift/customizations'
|
|
44
45
|
#
|
45
46
|
# See {Errors} for more information.
|
46
47
|
#
|
47
|
-
#
|
48
|
+
# @!group service
|
48
49
|
module Aws::GameLift
|
49
50
|
|
50
|
-
GEM_VERSION = '1.
|
51
|
+
GEM_VERSION = '1.39.0'
|
51
52
|
|
52
53
|
end
|
@@ -85,13 +85,28 @@ module Aws::GameLift
|
|
85
85
|
# * `Aws::Credentials` - Used for configuring static, non-refreshing
|
86
86
|
# credentials.
|
87
87
|
#
|
88
|
+
# * `Aws::SharedCredentials` - Used for loading static credentials from a
|
89
|
+
# shared file, such as `~/.aws/config`.
|
90
|
+
#
|
91
|
+
# * `Aws::AssumeRoleCredentials` - Used when you need to assume a role.
|
92
|
+
#
|
93
|
+
# * `Aws::AssumeRoleWebIdentityCredentials` - Used when you need to
|
94
|
+
# assume a role after providing credentials via the web.
|
95
|
+
#
|
96
|
+
# * `Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an
|
97
|
+
# access token generated from `aws login`.
|
98
|
+
#
|
99
|
+
# * `Aws::ProcessCredentials` - Used for loading credentials from a
|
100
|
+
# process that outputs to stdout.
|
101
|
+
#
|
88
102
|
# * `Aws::InstanceProfileCredentials` - Used for loading credentials
|
89
103
|
# from an EC2 IMDS on an EC2 instance.
|
90
104
|
#
|
91
|
-
# * `Aws::
|
92
|
-
#
|
105
|
+
# * `Aws::ECSCredentials` - Used for loading credentials from
|
106
|
+
# instances running in ECS.
|
93
107
|
#
|
94
|
-
# * `Aws::
|
108
|
+
# * `Aws::CognitoIdentityCredentials` - Used for loading credentials
|
109
|
+
# from the Cognito Identity service.
|
95
110
|
#
|
96
111
|
# When `:credentials` are not configured directly, the following
|
97
112
|
# locations will be searched for credentials:
|
@@ -101,10 +116,10 @@ module Aws::GameLift
|
|
101
116
|
# * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
|
102
117
|
# * `~/.aws/credentials`
|
103
118
|
# * `~/.aws/config`
|
104
|
-
# * EC2 IMDS instance profile - When used by default, the timeouts
|
105
|
-
# very aggressive. Construct and pass an instance of
|
106
|
-
# `Aws::InstanceProfileCredentails`
|
107
|
-
# timeouts.
|
119
|
+
# * EC2/ECS IMDS instance profile - When used by default, the timeouts
|
120
|
+
# are very aggressive. Construct and pass an instance of
|
121
|
+
# `Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to
|
122
|
+
# enable retries and extended timeouts.
|
108
123
|
#
|
109
124
|
# @option options [required, String] :region
|
110
125
|
# The AWS region to connect to. The configured `:region` is
|
@@ -368,8 +383,8 @@ module Aws::GameLift
|
|
368
383
|
#
|
369
384
|
#
|
370
385
|
#
|
371
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
372
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/
|
386
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html
|
387
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html
|
373
388
|
#
|
374
389
|
# @option params [required, String] :ticket_id
|
375
390
|
# A unique identifier for a matchmaking ticket. The ticket must be in
|
@@ -401,47 +416,46 @@ module Aws::GameLift
|
|
401
416
|
req.send_request(options)
|
402
417
|
end
|
403
418
|
|
404
|
-
# **This
|
405
|
-
#
|
419
|
+
# **This operation is used with the Amazon GameLift FleetIQ solution and
|
420
|
+
# game server groups.**
|
406
421
|
#
|
407
422
|
# Locates an available game server and temporarily reserves it to host
|
408
|
-
# gameplay and players. This
|
409
|
-
# service (such as a matchmaker) to request hosting resources for
|
410
|
-
# game session. In response, GameLift FleetIQ
|
411
|
-
# game server in
|
412
|
-
#
|
413
|
-
#
|
414
|
-
#
|
415
|
-
#
|
416
|
-
#
|
417
|
-
#
|
418
|
-
#
|
419
|
-
#
|
420
|
-
# consolidate gameplay on as few instances as possible to minimize
|
421
|
-
# hosting costs. For the second option, you request a specific game
|
422
|
-
# server by its ID. This option results in a less efficient claiming
|
423
|
-
# process because it does not take advantage of consolidation and may
|
424
|
-
# fail if the requested game server is unavailable.
|
425
|
-
#
|
426
|
-
# To claim a game server, identify a game server group and (optionally)
|
427
|
-
# a game server ID. If your game requires that game data be provided to
|
428
|
-
# the game server at the start of a game, such as a game map or player
|
429
|
-
# information, you can provide it in your claim request.
|
423
|
+
# gameplay and players. This operation is called from a game client or
|
424
|
+
# client service (such as a matchmaker) to request hosting resources for
|
425
|
+
# a new game session. In response, GameLift FleetIQ locates an available
|
426
|
+
# game server, places it in `CLAIMED` status for 60 seconds, and returns
|
427
|
+
# connection information that players can use to connect to the game
|
428
|
+
# server.
|
429
|
+
#
|
430
|
+
# To claim a game server, identify a game server group. You can also
|
431
|
+
# specify a game server ID, although this approach bypasses GameLift
|
432
|
+
# FleetIQ placement optimization. Optionally, include game data to pass
|
433
|
+
# to the game server at the start of a game session, such as a game map
|
434
|
+
# or player information.
|
430
435
|
#
|
431
436
|
# When a game server is successfully claimed, connection information is
|
432
437
|
# returned. A claimed game server's utilization status remains
|
433
|
-
# AVAILABLE
|
434
|
-
# seconds. This time period
|
435
|
-
#
|
436
|
-
# server's status is not updated within 60 seconds, the game
|
437
|
-
# reverts to unclaimed status and is available to be claimed by
|
438
|
-
# request.
|
438
|
+
# `AVAILABLE` while the claim status is set to `CLAIMED` for up to 60
|
439
|
+
# seconds. This time period gives the game server time to update its
|
440
|
+
# status to `UTILIZED` (using UpdateGameServer) once players join. If
|
441
|
+
# the game server's status is not updated within 60 seconds, the game
|
442
|
+
# server reverts to unclaimed status and is available to be claimed by
|
443
|
+
# another request. The claim time period is a fixed value and is not
|
444
|
+
# configurable.
|
439
445
|
#
|
440
446
|
# If you try to claim a specific game server, this request will fail in
|
441
|
-
# the following cases:
|
442
|
-
#
|
443
|
-
#
|
444
|
-
#
|
447
|
+
# the following cases:
|
448
|
+
#
|
449
|
+
# * If the game server utilization status is `UTILIZED`.
|
450
|
+
#
|
451
|
+
# * If the game server claim status is `CLAIMED`.
|
452
|
+
#
|
453
|
+
# <note markdown="1"> When claiming a specific game server, this request will succeed even
|
454
|
+
# if the game server is running on an instance in `DRAINING` status. To
|
455
|
+
# avoid this, first check the instance status by calling
|
456
|
+
# DescribeGameServerInstances.
|
457
|
+
#
|
458
|
+
# </note>
|
445
459
|
#
|
446
460
|
# **Learn more**
|
447
461
|
#
|
@@ -463,14 +477,13 @@ module Aws::GameLift
|
|
463
477
|
#
|
464
478
|
#
|
465
479
|
#
|
466
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
480
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
467
481
|
#
|
468
482
|
# @option params [required, String] :game_server_group_name
|
469
|
-
#
|
470
|
-
#
|
471
|
-
#
|
472
|
-
#
|
473
|
-
# either the GameServerGroup name or ARN value.
|
483
|
+
# A unique identifier for the game server group where the game server is
|
484
|
+
# running. Use either the GameServerGroup name or ARN value.. If you are
|
485
|
+
# not specifying a game server to claim, this value identifies where you
|
486
|
+
# want GameLift FleetIQ to look for an available game server to claim.
|
474
487
|
#
|
475
488
|
# @option params [String] :game_server_id
|
476
489
|
# A custom string that uniquely identifies the game server to claim. If
|
@@ -479,7 +492,9 @@ module Aws::GameLift
|
|
479
492
|
#
|
480
493
|
# @option params [String] :game_server_data
|
481
494
|
# A set of custom game server properties, formatted as a single string
|
482
|
-
# value
|
495
|
+
# value. This data is passed to a game client or service when it
|
496
|
+
# requests information on game servers using ListGameServers or
|
497
|
+
# ClaimGameServer.
|
483
498
|
#
|
484
499
|
# @return [Types::ClaimGameServerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
485
500
|
#
|
@@ -501,7 +516,6 @@ module Aws::GameLift
|
|
501
516
|
# resp.game_server.instance_id #=> String
|
502
517
|
# resp.game_server.connection_info #=> String
|
503
518
|
# resp.game_server.game_server_data #=> String
|
504
|
-
# resp.game_server.custom_sort_key #=> String
|
505
519
|
# resp.game_server.claim_status #=> String, one of "CLAIMED"
|
506
520
|
# resp.game_server.utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
|
507
521
|
# resp.game_server.registration_time #=> Time
|
@@ -636,12 +650,13 @@ module Aws::GameLift
|
|
636
650
|
#
|
637
651
|
# * To directly upload your build files to a GameLift S3 location. To
|
638
652
|
# use this option, first call `CreateBuild` and specify a build name
|
639
|
-
# and operating system. This
|
640
|
-
# also returns an S3 location with temporary access credentials.
|
641
|
-
# the credentials to manually upload your build files to the
|
642
|
-
# S3 location. For more information, see [Uploading
|
643
|
-
# *Amazon S3 Developer Guide*. Build files can be
|
644
|
-
# GameLift S3 location once only; that can't be
|
653
|
+
# and operating system. This operation creates a new build resource
|
654
|
+
# and also returns an S3 location with temporary access credentials.
|
655
|
+
# Use the credentials to manually upload your build files to the
|
656
|
+
# specified S3 location. For more information, see [Uploading
|
657
|
+
# Objects][1] in the *Amazon S3 Developer Guide*. Build files can be
|
658
|
+
# uploaded to the GameLift S3 location once only; that can't be
|
659
|
+
# updated.
|
645
660
|
#
|
646
661
|
# If successful, this operation creates a new build resource with a
|
647
662
|
# unique build ID and places it in `INITIALIZED` status. A build must be
|
@@ -682,12 +697,19 @@ module Aws::GameLift
|
|
682
697
|
# this value later.
|
683
698
|
#
|
684
699
|
# @option params [Types::S3Location] :storage_location
|
685
|
-
#
|
686
|
-
#
|
687
|
-
# bucket that you own.
|
688
|
-
#
|
689
|
-
#
|
690
|
-
#
|
700
|
+
# The location where your game build files are stored. Use this
|
701
|
+
# parameter only when creating a build using files that are stored in an
|
702
|
+
# S3 bucket that you own. Identify an S3 bucket name and key, which must
|
703
|
+
# in the same Region where you're creating a build. This parameter must
|
704
|
+
# also specify the ARN for an IAM role that you've set up to give
|
705
|
+
# Amazon GameLift access your S3 bucket. To call this operation with a
|
706
|
+
# storage location, you must have IAM PassRole permission. For more
|
707
|
+
# details on IAM roles and PassRole permissions, see [ Set up a role for
|
708
|
+
# GameLift access][1].
|
709
|
+
#
|
710
|
+
#
|
711
|
+
#
|
712
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/setting-up-role.html
|
691
713
|
#
|
692
714
|
# @option params [String] :operating_system
|
693
715
|
# The operating system that the game server binaries are built to run
|
@@ -959,17 +981,17 @@ module Aws::GameLift
|
|
959
981
|
#
|
960
982
|
# @option params [String] :instance_role_arn
|
961
983
|
# A unique identifier for an AWS IAM role that manages access to your
|
962
|
-
# AWS services.
|
963
|
-
#
|
964
|
-
#
|
965
|
-
#
|
966
|
-
#
|
967
|
-
#
|
984
|
+
# AWS services. Fleets with an instance role ARN allow applications that
|
985
|
+
# are running on the fleet's instances to assume the role. Learn more
|
986
|
+
# about using on-box credentials for your game servers at [ Access
|
987
|
+
# external resources from a game server][1]. To call this operation with
|
988
|
+
# instance role ARN, you must have IAM PassRole permissions. See [IAM
|
989
|
+
# policy examples for GameLift][2].
|
968
990
|
#
|
969
991
|
#
|
970
992
|
#
|
971
|
-
# [1]: https://
|
972
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-
|
993
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html
|
994
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-iam-policy-examples.html
|
973
995
|
#
|
974
996
|
# @option params [Types::CertificateConfiguration] :certificate_configuration
|
975
997
|
# Indicates whether to generate a TLS/SSL certificate for the new fleet.
|
@@ -1024,7 +1046,7 @@ module Aws::GameLift
|
|
1024
1046
|
# server_launch_path: "NonZeroAndMaxString",
|
1025
1047
|
# server_launch_parameters: "NonZeroAndMaxString",
|
1026
1048
|
# log_paths: ["NonZeroAndMaxString"],
|
1027
|
-
# ec2_instance_type: "t2.micro", # required, accepts t2.micro, t2.small, t2.medium, t2.large, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, 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, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, 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, m3.medium, m3.large, m3.xlarge, m3.2xlarge, 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
|
1049
|
+
# ec2_instance_type: "t2.micro", # required, accepts t2.micro, t2.small, t2.medium, t2.large, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, 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, c5a.large, c5a.xlarge, c5a.2xlarge, c5a.4xlarge, c5a.8xlarge, c5a.12xlarge, c5a.16xlarge, c5a.24xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, 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, r5a.large, r5a.xlarge, r5a.2xlarge, r5a.4xlarge, r5a.8xlarge, r5a.12xlarge, r5a.16xlarge, r5a.24xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, 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, m5a.large, m5a.xlarge, m5a.2xlarge, m5a.4xlarge, m5a.8xlarge, m5a.12xlarge, m5a.16xlarge, m5a.24xlarge
|
1028
1050
|
# ec2_inbound_permissions: [
|
1029
1051
|
# {
|
1030
1052
|
# from_port: 1, # required
|
@@ -1070,7 +1092,7 @@ module Aws::GameLift
|
|
1070
1092
|
# resp.fleet_attributes.fleet_id #=> String
|
1071
1093
|
# resp.fleet_attributes.fleet_arn #=> String
|
1072
1094
|
# resp.fleet_attributes.fleet_type #=> String, one of "ON_DEMAND", "SPOT"
|
1073
|
-
# resp.fleet_attributes.instance_type #=> String, one of "t2.micro", "t2.small", "t2.medium", "t2.large", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "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", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "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", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "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"
|
1095
|
+
# resp.fleet_attributes.instance_type #=> String, one of "t2.micro", "t2.small", "t2.medium", "t2.large", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "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", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "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", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "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", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge"
|
1074
1096
|
# resp.fleet_attributes.description #=> String
|
1075
1097
|
# resp.fleet_attributes.name #=> String
|
1076
1098
|
# resp.fleet_attributes.creation_time #=> Time
|
@@ -1104,54 +1126,49 @@ module Aws::GameLift
|
|
1104
1126
|
req.send_request(options)
|
1105
1127
|
end
|
1106
1128
|
|
1107
|
-
# **This
|
1108
|
-
#
|
1109
|
-
#
|
1110
|
-
# Creates a GameLift FleetIQ game server group
|
1111
|
-
# EC2 instances for game hosting.
|
1112
|
-
# server group,
|
1113
|
-
# AWS account and establishes a link between the two groups.
|
1114
|
-
# full control over configuration of the Auto Scaling group, but
|
1115
|
-
# GameLift FleetIQ routinely certain Auto Scaling group properties in
|
1116
|
-
# order to optimize the group's instances for low-cost game hosting.
|
1129
|
+
# **This operation is used with the Amazon GameLift FleetIQ solution and
|
1130
|
+
# game server groups.**
|
1131
|
+
#
|
1132
|
+
# Creates a GameLift FleetIQ game server group for managing game hosting
|
1133
|
+
# on a collection of Amazon EC2 instances for game hosting. This
|
1134
|
+
# operation creates the game server group, creates an Auto Scaling group
|
1135
|
+
# in your AWS account, and establishes a link between the two groups.
|
1117
1136
|
# You can view the status of your game server groups in the GameLift
|
1118
|
-
#
|
1137
|
+
# console. Game server group metrics and events are emitted to Amazon
|
1119
1138
|
# CloudWatch.
|
1120
1139
|
#
|
1121
|
-
#
|
1140
|
+
# Before creating a new game server group, you must have the following:
|
1122
1141
|
#
|
1123
|
-
# * An EC2 launch template
|
1124
|
-
#
|
1125
|
-
#
|
1126
|
-
#
|
1127
|
-
# Launch Template][1] in the *Amazon EC2 User Guide*.
|
1142
|
+
# * An Amazon EC2 launch template that specifies how to launch Amazon
|
1143
|
+
# EC2 instances with your game server build. For more information, see
|
1144
|
+
# [ Launching an Instance from a Launch Template][1] in the *Amazon
|
1145
|
+
# EC2 User Guide*.
|
1128
1146
|
#
|
1129
|
-
# * An IAM role
|
1130
|
-
#
|
1131
|
-
#
|
1132
|
-
#
|
1133
|
-
# principal access for GameLift, see [ Specifying a Principal in a
|
1134
|
-
# Policy][2] in the *Amazon S3 Developer Guide*.
|
1147
|
+
# * An IAM role that extends limited access to your AWS account to allow
|
1148
|
+
# GameLift FleetIQ to create and interact with the Auto Scaling group.
|
1149
|
+
# For more information, see [Create IAM roles for cross-service
|
1150
|
+
# interaction][2] in the *GameLift FleetIQ Developer Guide*.
|
1135
1151
|
#
|
1136
|
-
# To create a new game server group,
|
1137
|
-
# role and EC2 launch template
|
1138
|
-
#
|
1139
|
-
# minimum limits on the group's instance count. You can optionally
|
1140
|
-
# an
|
1141
|
-
# metric.
|
1152
|
+
# To create a new game server group, specify a unique group name, IAM
|
1153
|
+
# role and Amazon EC2 launch template, and provide a list of instance
|
1154
|
+
# types that can be used in the group. You must also set initial maximum
|
1155
|
+
# and minimum limits on the group's instance count. You can optionally
|
1156
|
+
# set an Auto Scaling policy with target tracking based on a GameLift
|
1157
|
+
# FleetIQ metric.
|
1142
1158
|
#
|
1143
1159
|
# Once the game server group and corresponding Auto Scaling group are
|
1144
1160
|
# created, you have full access to change the Auto Scaling group's
|
1145
|
-
# configuration as needed.
|
1146
|
-
#
|
1147
|
-
#
|
1161
|
+
# configuration as needed. Several properties that are set when creating
|
1162
|
+
# a game server group, including maximum/minimum size and auto-scaling
|
1163
|
+
# policy settings, must be updated directly in the Auto Scaling group.
|
1164
|
+
# Keep in mind that some Auto Scaling group properties are periodically
|
1165
|
+
# updated by GameLift FleetIQ as part of its balancing activities to
|
1166
|
+
# optimize for availability and cost.
|
1148
1167
|
#
|
1149
1168
|
# **Learn more**
|
1150
1169
|
#
|
1151
1170
|
# [GameLift FleetIQ Guide][3]
|
1152
1171
|
#
|
1153
|
-
# [Updating a GameLift FleetIQ-Linked Auto Scaling Group][4]
|
1154
|
-
#
|
1155
1172
|
# **Related operations**
|
1156
1173
|
#
|
1157
1174
|
# * CreateGameServerGroup
|
@@ -1168,12 +1185,13 @@ module Aws::GameLift
|
|
1168
1185
|
#
|
1169
1186
|
# * SuspendGameServerGroup
|
1170
1187
|
#
|
1188
|
+
# * DescribeGameServerInstances
|
1189
|
+
#
|
1171
1190
|
#
|
1172
1191
|
#
|
1173
1192
|
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html
|
1174
|
-
# [2]: https://docs.aws.amazon.com/
|
1175
|
-
# [3]: https://docs.aws.amazon.com/gamelift/latest/
|
1176
|
-
# [4]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-asgroups.html
|
1193
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-iam-permissions-roles.html
|
1194
|
+
# [3]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
1177
1195
|
#
|
1178
1196
|
# @option params [required, String] :game_server_group_name
|
1179
1197
|
# An identifier for the new game server group. This value is used to
|
@@ -1183,9 +1201,7 @@ module Aws::GameLift
|
|
1183
1201
|
#
|
1184
1202
|
# @option params [required, String] :role_arn
|
1185
1203
|
# The Amazon Resource Name ([ARN][1]) for an IAM role that allows Amazon
|
1186
|
-
# GameLift to access your EC2 Auto Scaling groups.
|
1187
|
-
# validated to ensure that it contains the necessary permissions for
|
1188
|
-
# game server groups.
|
1204
|
+
# GameLift to access your EC2 Auto Scaling groups.
|
1189
1205
|
#
|
1190
1206
|
#
|
1191
1207
|
#
|
@@ -1193,14 +1209,18 @@ module Aws::GameLift
|
|
1193
1209
|
#
|
1194
1210
|
# @option params [required, Integer] :min_size
|
1195
1211
|
# The minimum number of instances allowed in the EC2 Auto Scaling group.
|
1196
|
-
# During
|
1197
|
-
# the group below this minimum. In production, this value should be
|
1198
|
-
# to at least 1.
|
1212
|
+
# During automatic scaling events, GameLift FleetIQ and EC2 do not scale
|
1213
|
+
# down the group below this minimum. In production, this value should be
|
1214
|
+
# set to at least 1. After the Auto Scaling group is created, update
|
1215
|
+
# this value directly in the Auto Scaling group using the AWS console or
|
1216
|
+
# APIs.
|
1199
1217
|
#
|
1200
1218
|
# @option params [required, Integer] :max_size
|
1201
1219
|
# The maximum number of instances allowed in the EC2 Auto Scaling group.
|
1202
|
-
# During
|
1203
|
-
# the group above this maximum.
|
1220
|
+
# During automatic scaling events, GameLift FleetIQ and EC2 do not scale
|
1221
|
+
# up the group above this maximum. After the Auto Scaling group is
|
1222
|
+
# created, update this value directly in the Auto Scaling group using
|
1223
|
+
# the AWS console or APIs.
|
1204
1224
|
#
|
1205
1225
|
# @option params [required, Types::LaunchTemplateSpecification] :launch_template
|
1206
1226
|
# The EC2 launch template that contains configuration settings and game
|
@@ -1208,72 +1228,88 @@ module Aws::GameLift
|
|
1208
1228
|
# You can specify the template using either the template name or ID. For
|
1209
1229
|
# help with creating a launch template, see [Creating a Launch Template
|
1210
1230
|
# for an Auto Scaling Group][1] in the *Amazon EC2 Auto Scaling User
|
1211
|
-
# Guide*.
|
1231
|
+
# Guide*. After the Auto Scaling group is created, update this value
|
1232
|
+
# directly in the Auto Scaling group using the AWS console or APIs.
|
1212
1233
|
#
|
1213
1234
|
#
|
1214
1235
|
#
|
1215
1236
|
# [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html
|
1216
1237
|
#
|
1217
1238
|
# @option params [required, Array<Types::InstanceDefinition>] :instance_definitions
|
1218
|
-
#
|
1219
|
-
#
|
1220
|
-
#
|
1221
|
-
#
|
1222
|
-
#
|
1239
|
+
# The EC2 instance types and sizes to use in the Auto Scaling group. The
|
1240
|
+
# instance definitions must specify at least two different instance
|
1241
|
+
# types that are supported by GameLift FleetIQ. For more information on
|
1242
|
+
# instance types, see [EC2 Instance Types][1] in the *Amazon EC2 User
|
1243
|
+
# Guide*. You can optionally specify capacity weighting for each
|
1244
|
+
# instance type. If no weight value is specified for an instance type,
|
1245
|
+
# it is set to the default value "1". For more information about
|
1246
|
+
# capacity weighting, see [ Instance Weighting for Amazon EC2 Auto
|
1247
|
+
# Scaling][2] in the Amazon EC2 Auto Scaling User Guide.
|
1223
1248
|
#
|
1224
1249
|
#
|
1225
1250
|
#
|
1226
1251
|
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html
|
1252
|
+
# [2]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html
|
1227
1253
|
#
|
1228
1254
|
# @option params [Types::GameServerGroupAutoScalingPolicy] :auto_scaling_policy
|
1229
1255
|
# Configuration settings to define a scaling policy for the Auto Scaling
|
1230
1256
|
# group that is optimized for game hosting. The scaling policy uses the
|
1231
|
-
# metric "PercentUtilizedGameServers" to maintain a buffer of idle
|
1257
|
+
# metric `"PercentUtilizedGameServers"` to maintain a buffer of idle
|
1232
1258
|
# game servers that can immediately accommodate new games and players.
|
1233
|
-
#
|
1234
|
-
#
|
1259
|
+
# After the Auto Scaling group is created, update this value directly in
|
1260
|
+
# the Auto Scaling group using the AWS console or APIs.
|
1235
1261
|
#
|
1236
1262
|
# @option params [String] :balancing_strategy
|
1237
|
-
#
|
1238
|
-
#
|
1239
|
-
#
|
1240
|
-
#
|
1241
|
-
#
|
1242
|
-
#
|
1243
|
-
# group provides no hosting capacity
|
1244
|
-
#
|
1245
|
-
#
|
1246
|
-
#
|
1247
|
-
#
|
1248
|
-
#
|
1249
|
-
#
|
1250
|
-
#
|
1251
|
-
# On-Demand
|
1263
|
+
# Indicates how GameLift FleetIQ balances the use of Spot Instances and
|
1264
|
+
# On-Demand Instances in the game server group. Method options include
|
1265
|
+
# the following:
|
1266
|
+
#
|
1267
|
+
# * `SPOT_ONLY` - Only Spot Instances are used in the game server group.
|
1268
|
+
# If Spot Instances are unavailable or not viable for game hosting,
|
1269
|
+
# the game server group provides no hosting capacity until Spot
|
1270
|
+
# Instances can again be used. Until then, no new instances are
|
1271
|
+
# started, and the existing nonviable Spot Instances are terminated
|
1272
|
+
# (after current gameplay ends) and are not replaced.
|
1273
|
+
#
|
1274
|
+
# * `SPOT_PREFERRED` - (default value) Spot Instances are used whenever
|
1275
|
+
# available in the game server group. If Spot Instances are
|
1276
|
+
# unavailable, the game server group continues to provide hosting
|
1277
|
+
# capacity by falling back to On-Demand Instances. Existing nonviable
|
1278
|
+
# Spot Instances are terminated (after current gameplay ends) and are
|
1279
|
+
# replaced with new On-Demand Instances.
|
1280
|
+
#
|
1281
|
+
# * `ON_DEMAND_ONLY` - Only On-Demand Instances are used in the game
|
1282
|
+
# server group. No Spot Instances are used, even when available, while
|
1283
|
+
# this balancing strategy is in force.
|
1252
1284
|
#
|
1253
1285
|
# @option params [String] :game_server_protection_policy
|
1254
1286
|
# A flag that indicates whether instances in the game server group are
|
1255
1287
|
# protected from early termination. Unprotected instances that have
|
1256
|
-
# active game servers running
|
1288
|
+
# active game servers running might be terminated during a scale-down
|
1257
1289
|
# event, causing players to be dropped from the game. Protected
|
1258
1290
|
# instances cannot be terminated while there are active game servers
|
1259
|
-
# running
|
1291
|
+
# running except in the event of a forced game server group deletion
|
1292
|
+
# (see ). An exception to this is with Spot Instances, which can be
|
1260
1293
|
# terminated by AWS regardless of protection status. This property is
|
1261
|
-
# set to
|
1294
|
+
# set to `NO_PROTECTION` by default.
|
1262
1295
|
#
|
1263
1296
|
# @option params [Array<String>] :vpc_subnets
|
1264
1297
|
# A list of virtual private cloud (VPC) subnets to use with instances in
|
1265
1298
|
# the game server group. By default, all GameLift FleetIQ-supported
|
1266
|
-
#
|
1267
|
-
# that you've set up.
|
1299
|
+
# Availability Zones are used. You can use this parameter to specify
|
1300
|
+
# VPCs that you've set up. This property cannot be updated after the
|
1301
|
+
# game server group is created, and the corresponding Auto Scaling group
|
1302
|
+
# will always use the property value that is set with this request, even
|
1303
|
+
# if the Auto Scaling group is updated directly.
|
1268
1304
|
#
|
1269
1305
|
# @option params [Array<Types::Tag>] :tags
|
1270
1306
|
# A list of labels to assign to the new game server group resource. Tags
|
1271
|
-
# are developer-defined key-value pairs. Tagging AWS resources
|
1272
|
-
#
|
1273
|
-
#
|
1274
|
-
#
|
1275
|
-
#
|
1276
|
-
#
|
1307
|
+
# are developer-defined key-value pairs. Tagging AWS resources is useful
|
1308
|
+
# for resource management, access management, and cost allocation. For
|
1309
|
+
# more information, see [ Tagging AWS Resources][1] in the *AWS General
|
1310
|
+
# Reference*. Once the resource is created, you can use TagResource,
|
1311
|
+
# UntagResource, and ListTagsForResource to add, remove, and view tags,
|
1312
|
+
# respectively. The maximum tag limit may be lower than stated. See the
|
1277
1313
|
# AWS General Reference for actual tagging limits.
|
1278
1314
|
#
|
1279
1315
|
#
|
@@ -1308,7 +1344,7 @@ module Aws::GameLift
|
|
1308
1344
|
# target_value: 1.0, # required
|
1309
1345
|
# },
|
1310
1346
|
# },
|
1311
|
-
# balancing_strategy: "SPOT_ONLY", # accepts SPOT_ONLY, SPOT_PREFERRED
|
1347
|
+
# balancing_strategy: "SPOT_ONLY", # accepts SPOT_ONLY, SPOT_PREFERRED, ON_DEMAND_ONLY
|
1312
1348
|
# game_server_protection_policy: "NO_PROTECTION", # accepts NO_PROTECTION, FULL_PROTECTION
|
1313
1349
|
# vpc_subnets: ["VpcSubnet"],
|
1314
1350
|
# tags: [
|
@@ -1327,7 +1363,7 @@ module Aws::GameLift
|
|
1327
1363
|
# resp.game_server_group.instance_definitions #=> Array
|
1328
1364
|
# resp.game_server_group.instance_definitions[0].instance_type #=> String, one of "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge"
|
1329
1365
|
# resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
|
1330
|
-
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED"
|
1366
|
+
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED", "ON_DEMAND_ONLY"
|
1331
1367
|
# resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
|
1332
1368
|
# resp.game_server_group.auto_scaling_group_arn #=> String
|
1333
1369
|
# resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
|
@@ -1346,8 +1382,8 @@ module Aws::GameLift
|
|
1346
1382
|
req.send_request(options)
|
1347
1383
|
end
|
1348
1384
|
|
1349
|
-
# Creates a multiplayer game session for players. This
|
1350
|
-
# game session record and assigns an available server process in the
|
1385
|
+
# Creates a multiplayer game session for players. This operation creates
|
1386
|
+
# a game session record and assigns an available server process in the
|
1351
1387
|
# specified fleet to host the game session. A fleet must have an
|
1352
1388
|
# `ACTIVE` status before a game session can be created in it.
|
1353
1389
|
#
|
@@ -1664,34 +1700,38 @@ module Aws::GameLift
|
|
1664
1700
|
req.send_request(options)
|
1665
1701
|
end
|
1666
1702
|
|
1667
|
-
# Defines a new matchmaking configuration for use with FlexMatch.
|
1668
|
-
#
|
1669
|
-
#
|
1670
|
-
#
|
1671
|
-
#
|
1672
|
-
#
|
1673
|
-
#
|
1674
|
-
#
|
1675
|
-
#
|
1676
|
-
#
|
1677
|
-
#
|
1678
|
-
#
|
1679
|
-
#
|
1680
|
-
#
|
1681
|
-
#
|
1682
|
-
#
|
1683
|
-
#
|
1684
|
-
#
|
1685
|
-
#
|
1686
|
-
#
|
1687
|
-
#
|
1688
|
-
#
|
1703
|
+
# Defines a new matchmaking configuration for use with FlexMatch.
|
1704
|
+
# Whether your are using FlexMatch with GameLift hosting or as a
|
1705
|
+
# standalone matchmaking service, the matchmaking configuration sets out
|
1706
|
+
# rules for matching players and forming teams. If you're also using
|
1707
|
+
# GameLift hosting, it defines how to start game sessions for each
|
1708
|
+
# match. Your matchmaking system can use multiple configurations to
|
1709
|
+
# handle different game scenarios. All matchmaking requests
|
1710
|
+
# (StartMatchmaking or StartMatchBackfill) identify the matchmaking
|
1711
|
+
# configuration to use and provide player attributes consistent with
|
1712
|
+
# that configuration.
|
1713
|
+
#
|
1714
|
+
# To create a matchmaking configuration, you must provide the following:
|
1715
|
+
# configuration name and FlexMatch mode (with or without GameLift
|
1716
|
+
# hosting); a rule set that specifies how to evaluate players and find
|
1717
|
+
# acceptable matches; whether player acceptance is required; and the
|
1718
|
+
# maximum time allowed for a matchmaking attempt. When using FlexMatch
|
1719
|
+
# with GameLift hosting, you also need to identify the game session
|
1720
|
+
# queue to use when starting a game session for the match.
|
1721
|
+
#
|
1722
|
+
# In addition, you must set up an Amazon Simple Notification Service
|
1723
|
+
# (SNS) to receive matchmaking notifications, and provide the topic ARN
|
1724
|
+
# in the matchmaking configuration. An alternative method, continuously
|
1725
|
+
# polling ticket status with DescribeMatchmaking, is only suitable for
|
1726
|
+
# games in development with low matchmaking usage.
|
1689
1727
|
#
|
1690
1728
|
# **Learn more**
|
1691
1729
|
#
|
1692
|
-
# [
|
1730
|
+
# [ FlexMatch Developer Guide][1]
|
1731
|
+
#
|
1732
|
+
# [ Design a FlexMatch Matchmaker][2]
|
1693
1733
|
#
|
1694
|
-
# [
|
1734
|
+
# [ Set Up FlexMatch Event Notification][3]
|
1695
1735
|
#
|
1696
1736
|
# **Related operations**
|
1697
1737
|
#
|
@@ -1713,8 +1753,9 @@ module Aws::GameLift
|
|
1713
1753
|
#
|
1714
1754
|
#
|
1715
1755
|
#
|
1716
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
1717
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/
|
1756
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html
|
1757
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-configuration.html
|
1758
|
+
# [3]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html
|
1718
1759
|
#
|
1719
1760
|
# @option params [required, String] :name
|
1720
1761
|
# A unique identifier for a matchmaking configuration. This name is used
|
@@ -1724,12 +1765,13 @@ module Aws::GameLift
|
|
1724
1765
|
# @option params [String] :description
|
1725
1766
|
# A human-readable description of the matchmaking configuration.
|
1726
1767
|
#
|
1727
|
-
# @option params [
|
1768
|
+
# @option params [Array<String>] :game_session_queue_arns
|
1728
1769
|
# Amazon Resource Name ([ARN][1]) that is assigned to a GameLift game
|
1729
1770
|
# session queue resource and uniquely identifies it. ARNs are unique
|
1730
|
-
# across all Regions.
|
1731
|
-
#
|
1732
|
-
#
|
1771
|
+
# across all Regions. Queues can be located in any Region. Queues are
|
1772
|
+
# used to start new GameLift-hosted game sessions for matches that are
|
1773
|
+
# created with this matchmaking configuration. If `FlexMatchMode` is set
|
1774
|
+
# to `STANDALONE`, do not set this parameter.
|
1733
1775
|
#
|
1734
1776
|
#
|
1735
1777
|
#
|
@@ -1742,14 +1784,17 @@ module Aws::GameLift
|
|
1742
1784
|
#
|
1743
1785
|
# @option params [Integer] :acceptance_timeout_seconds
|
1744
1786
|
# The length of time (in seconds) to wait for players to accept a
|
1745
|
-
# proposed match. If any player rejects the
|
1746
|
-
# before the timeout, the
|
1787
|
+
# proposed match, if acceptance is required. If any player rejects the
|
1788
|
+
# match or fails to accept before the timeout, the tickets are returned
|
1789
|
+
# to the ticket pool and continue to be evaluated for an acceptable
|
1747
1790
|
# match.
|
1748
1791
|
#
|
1749
1792
|
# @option params [required, Boolean] :acceptance_required
|
1750
1793
|
# A flag that determines whether a match that was created with this
|
1751
1794
|
# configuration must be accepted by the matched players. To require
|
1752
|
-
# acceptance, set to `TRUE`.
|
1795
|
+
# acceptance, set to `TRUE`. With this option enabled, matchmaking
|
1796
|
+
# tickets use the status `REQUIRES_ACCEPTANCE` to indicate when a
|
1797
|
+
# completed potential match is waiting for player acceptance.
|
1753
1798
|
#
|
1754
1799
|
# @option params [required, String] :rule_set_name
|
1755
1800
|
# A unique identifier for a matchmaking rule set to use with this
|
@@ -1764,7 +1809,8 @@ module Aws::GameLift
|
|
1764
1809
|
# The number of player slots in a match to keep open for future players.
|
1765
1810
|
# For example, assume that the configuration's rule set specifies a
|
1766
1811
|
# match for a single 12-person team. If the additional player count is
|
1767
|
-
# set to 2, only 10 players are initially selected for the match.
|
1812
|
+
# set to 2, only 10 players are initially selected for the match. This
|
1813
|
+
# parameter is not used if `FlexMatchMode` is set to `STANDALONE`.
|
1768
1814
|
#
|
1769
1815
|
# @option params [String] :custom_event_data
|
1770
1816
|
# Information to be added to all events related to this matchmaking
|
@@ -1775,7 +1821,8 @@ module Aws::GameLift
|
|
1775
1821
|
# pairs. These properties are passed to a game server process in the
|
1776
1822
|
# GameSession object with a request to start a new game session (see
|
1777
1823
|
# [Start a Game Session][1]). This information is added to the new
|
1778
|
-
# GameSession object that is created for a successful match.
|
1824
|
+
# GameSession object that is created for a successful match. This
|
1825
|
+
# parameter is not used if `FlexMatchMode` is set to `STANDALONE`.
|
1779
1826
|
#
|
1780
1827
|
#
|
1781
1828
|
#
|
@@ -1786,7 +1833,8 @@ module Aws::GameLift
|
|
1786
1833
|
# value. This data is passed to a game server process in the GameSession
|
1787
1834
|
# object with a request to start a new game session (see [Start a Game
|
1788
1835
|
# Session][1]). This information is added to the new GameSession object
|
1789
|
-
# that is created for a successful match.
|
1836
|
+
# that is created for a successful match. This parameter is not used if
|
1837
|
+
# `FlexMatchMode` is set to `STANDALONE`.
|
1790
1838
|
#
|
1791
1839
|
#
|
1792
1840
|
#
|
@@ -1799,11 +1847,27 @@ module Aws::GameLift
|
|
1799
1847
|
# Specify `AUTOMATIC` to have GameLift create a StartMatchBackfill
|
1800
1848
|
# request whenever a game session has one or more open slots. Learn more
|
1801
1849
|
# about manual and automatic backfill in [ Backfill Existing Games with
|
1802
|
-
# FlexMatch][1].
|
1850
|
+
# FlexMatch][1]. Automatic backfill is not available when
|
1851
|
+
# `FlexMatchMode` is set to `STANDALONE`.
|
1852
|
+
#
|
1853
|
+
#
|
1803
1854
|
#
|
1855
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html
|
1804
1856
|
#
|
1857
|
+
# @option params [String] :flex_match_mode
|
1858
|
+
# Indicates whether this matchmaking configuration is being used with
|
1859
|
+
# GameLift hosting or as a standalone matchmaking solution.
|
1805
1860
|
#
|
1806
|
-
#
|
1861
|
+
# * **STANDALONE** - FlexMatch forms matches and returns match
|
1862
|
+
# information, including players and team assignments, in a [
|
1863
|
+
# MatchmakingSucceeded][1] event.
|
1864
|
+
#
|
1865
|
+
# * **WITH\_QUEUE** - FlexMatch forms matches and uses the specified
|
1866
|
+
# GameLift queue to start a game session for the match.
|
1867
|
+
#
|
1868
|
+
#
|
1869
|
+
#
|
1870
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded
|
1807
1871
|
#
|
1808
1872
|
# @option params [Array<Types::Tag>] :tags
|
1809
1873
|
# A list of labels to assign to the new matchmaking configuration
|
@@ -1828,7 +1892,7 @@ module Aws::GameLift
|
|
1828
1892
|
# resp = client.create_matchmaking_configuration({
|
1829
1893
|
# name: "MatchmakingIdStringModel", # required
|
1830
1894
|
# description: "NonZeroAndMaxString",
|
1831
|
-
# game_session_queue_arns: ["ArnStringModel"],
|
1895
|
+
# game_session_queue_arns: ["ArnStringModel"],
|
1832
1896
|
# request_timeout_seconds: 1, # required
|
1833
1897
|
# acceptance_timeout_seconds: 1,
|
1834
1898
|
# acceptance_required: false, # required
|
@@ -1844,6 +1908,7 @@ module Aws::GameLift
|
|
1844
1908
|
# ],
|
1845
1909
|
# game_session_data: "GameSessionData",
|
1846
1910
|
# backfill_mode: "AUTOMATIC", # accepts AUTOMATIC, MANUAL
|
1911
|
+
# flex_match_mode: "STANDALONE", # accepts STANDALONE, WITH_QUEUE
|
1847
1912
|
# tags: [
|
1848
1913
|
# {
|
1849
1914
|
# key: "TagKey", # required
|
@@ -1873,6 +1938,7 @@ module Aws::GameLift
|
|
1873
1938
|
# resp.configuration.game_properties[0].value #=> String
|
1874
1939
|
# resp.configuration.game_session_data #=> String
|
1875
1940
|
# resp.configuration.backfill_mode #=> String, one of "AUTOMATIC", "MANUAL"
|
1941
|
+
# resp.configuration.flex_match_mode #=> String, one of "STANDALONE", "WITH_QUEUE"
|
1876
1942
|
#
|
1877
1943
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateMatchmakingConfiguration AWS API Documentation
|
1878
1944
|
#
|
@@ -1925,9 +1991,9 @@ module Aws::GameLift
|
|
1925
1991
|
#
|
1926
1992
|
#
|
1927
1993
|
#
|
1928
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
1929
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/
|
1930
|
-
# [3]: https://docs.aws.amazon.com/gamelift/latest/
|
1994
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html
|
1995
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-configuration.html
|
1996
|
+
# [3]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-intro.html
|
1931
1997
|
#
|
1932
1998
|
# @option params [required, String] :name
|
1933
1999
|
# A unique identifier for a matchmaking rule set. A matchmaking
|
@@ -2204,16 +2270,22 @@ module Aws::GameLift
|
|
2204
2270
|
# value later.
|
2205
2271
|
#
|
2206
2272
|
# @option params [Types::S3Location] :storage_location
|
2207
|
-
# The location of
|
2208
|
-
#
|
2209
|
-
#
|
2210
|
-
#
|
2211
|
-
#
|
2212
|
-
#
|
2213
|
-
#
|
2214
|
-
#
|
2215
|
-
#
|
2216
|
-
#
|
2273
|
+
# The Amazon S3 location of your Realtime scripts. The storage location
|
2274
|
+
# must specify the S3 bucket name, the zip file name (the "key"), and
|
2275
|
+
# an IAM role ARN that allows Amazon GameLift to access the S3 storage
|
2276
|
+
# location. The S3 bucket must be in the same Region where you are
|
2277
|
+
# creating a new script. By default, Amazon GameLift uploads the latest
|
2278
|
+
# version of the zip file; if you have S3 object versioning turned on,
|
2279
|
+
# you can use the `ObjectVersion` parameter to specify an earlier
|
2280
|
+
# version. To call this operation with a storage location, you must have
|
2281
|
+
# IAM PassRole permission. For more details on IAM roles and PassRole
|
2282
|
+
# permissions, see [ Set up a role for GameLift access][1].
|
2283
|
+
#
|
2284
|
+
#
|
2285
|
+
#
|
2286
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/setting-up-role.html
|
2287
|
+
#
|
2288
|
+
# @option params [String, StringIO, File] :zip_file
|
2217
2289
|
# A data object containing your Realtime scripts and dependencies as a
|
2218
2290
|
# zip file. The zip file can have one or multiple files. Maximum size of
|
2219
2291
|
# a zip file is 5 MB.
|
@@ -2459,7 +2531,7 @@ module Aws::GameLift
|
|
2459
2531
|
req.send_request(options)
|
2460
2532
|
end
|
2461
2533
|
|
2462
|
-
# Deletes an alias. This
|
2534
|
+
# Deletes an alias. This operation removes all record of the alias. Game
|
2463
2535
|
# clients attempting to access a server process using the deleted alias
|
2464
2536
|
# receive an error. To delete an alias, specify the alias ID to be
|
2465
2537
|
# deleted.
|
@@ -2497,7 +2569,7 @@ module Aws::GameLift
|
|
2497
2569
|
req.send_request(options)
|
2498
2570
|
end
|
2499
2571
|
|
2500
|
-
# Deletes a build. This
|
2572
|
+
# Deletes a build. This operation permanently deletes the build resource
|
2501
2573
|
# and any uploaded build files. Deleting a build does not affect the
|
2502
2574
|
# status of any active fleets using the build, but you can no longer
|
2503
2575
|
# create new fleets with the deleted build.
|
@@ -2555,7 +2627,7 @@ module Aws::GameLift
|
|
2555
2627
|
# the VPC peering connection--this is done as part of the delete fleet
|
2556
2628
|
# process.
|
2557
2629
|
#
|
2558
|
-
# This
|
2630
|
+
# This operation removes the fleet and its resources. Once a fleet is
|
2559
2631
|
# deleted, you can no longer use any of the resource in that fleet.
|
2560
2632
|
#
|
2561
2633
|
# **Learn more**
|
@@ -2601,27 +2673,33 @@ module Aws::GameLift
|
|
2601
2673
|
req.send_request(options)
|
2602
2674
|
end
|
2603
2675
|
|
2604
|
-
# **This
|
2605
|
-
#
|
2676
|
+
# **This operation is used with the Amazon GameLift FleetIQ solution and
|
2677
|
+
# game server groups.**
|
2606
2678
|
#
|
2607
2679
|
# Terminates a game server group and permanently deletes the game server
|
2608
2680
|
# group record. You have several options for how these resources are
|
2609
2681
|
# impacted when deleting the game server group. Depending on the type of
|
2610
|
-
# delete
|
2611
|
-
# resources:
|
2612
|
-
#
|
2682
|
+
# delete operation selected, this operation might affect these
|
2683
|
+
# resources:
|
2684
|
+
#
|
2685
|
+
# * The game server group
|
2686
|
+
#
|
2687
|
+
# * The corresponding Auto Scaling group
|
2688
|
+
#
|
2689
|
+
# * All game servers that are currently running in the group
|
2613
2690
|
#
|
2614
2691
|
# To delete a game server group, identify the game server group to
|
2615
|
-
# delete and specify the type of delete
|
2616
|
-
# groups can only be deleted if they are in ACTIVE or ERROR
|
2692
|
+
# delete and specify the type of delete operation to initiate. Game
|
2693
|
+
# server groups can only be deleted if they are in `ACTIVE` or `ERROR`
|
2694
|
+
# status.
|
2617
2695
|
#
|
2618
|
-
# If the delete request is successful, a series of
|
2619
|
-
# off. The game server group status is changed to
|
2696
|
+
# If the delete request is successful, a series of operations are kicked
|
2697
|
+
# off. The game server group status is changed to `DELETE_SCHEDULED`,
|
2620
2698
|
# which prevents new game servers from being registered and stops
|
2621
|
-
#
|
2622
|
-
# are
|
2623
|
-
# any of the delete
|
2624
|
-
# ERROR status.
|
2699
|
+
# automatic scaling activity. Once all game servers in the game server
|
2700
|
+
# group are deregistered, GameLift FleetIQ can begin deleting resources.
|
2701
|
+
# If any of the delete operations fail, the game server group is placed
|
2702
|
+
# in `ERROR` status.
|
2625
2703
|
#
|
2626
2704
|
# GameLift FleetIQ emits delete events to Amazon CloudWatch.
|
2627
2705
|
#
|
@@ -2645,26 +2723,29 @@ module Aws::GameLift
|
|
2645
2723
|
#
|
2646
2724
|
# * SuspendGameServerGroup
|
2647
2725
|
#
|
2726
|
+
# * DescribeGameServerInstances
|
2727
|
+
#
|
2648
2728
|
#
|
2649
2729
|
#
|
2650
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
2730
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
2651
2731
|
#
|
2652
2732
|
# @option params [required, String] :game_server_group_name
|
2653
|
-
#
|
2654
|
-
#
|
2733
|
+
# A unique identifier for the game server group. Use either the
|
2734
|
+
# GameServerGroup name or ARN value.
|
2655
2735
|
#
|
2656
2736
|
# @option params [String] :delete_option
|
2657
|
-
# The type of delete to perform. Options include:
|
2737
|
+
# The type of delete to perform. Options include the following:
|
2658
2738
|
#
|
2659
|
-
# *
|
2660
|
-
# group only when it has no game servers that are in
|
2739
|
+
# * `SAFE_DELETE` – (default) Terminates the game server group and EC2
|
2740
|
+
# Auto Scaling group only when it has no game servers that are in
|
2741
|
+
# `UTILIZED` status.
|
2661
2742
|
#
|
2662
|
-
# *
|
2743
|
+
# * `FORCE_DELETE` – Terminates the game server group, including all
|
2663
2744
|
# active game servers regardless of their utilization status, and the
|
2664
2745
|
# EC2 Auto Scaling group.
|
2665
2746
|
#
|
2666
|
-
# * RETAIN – Does a safe delete of the game server group but retains
|
2667
|
-
# EC2 Auto Scaling group as is.
|
2747
|
+
# * `RETAIN` – Does a safe delete of the game server group but retains
|
2748
|
+
# the EC2 Auto Scaling group as is.
|
2668
2749
|
#
|
2669
2750
|
# @return [Types::DeleteGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2670
2751
|
#
|
@@ -2685,7 +2766,7 @@ module Aws::GameLift
|
|
2685
2766
|
# resp.game_server_group.instance_definitions #=> Array
|
2686
2767
|
# resp.game_server_group.instance_definitions[0].instance_type #=> String, one of "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge"
|
2687
2768
|
# resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
|
2688
|
-
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED"
|
2769
|
+
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED", "ON_DEMAND_ONLY"
|
2689
2770
|
# resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
|
2690
2771
|
# resp.game_server_group.auto_scaling_group_arn #=> String
|
2691
2772
|
# resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
|
@@ -2704,9 +2785,9 @@ module Aws::GameLift
|
|
2704
2785
|
req.send_request(options)
|
2705
2786
|
end
|
2706
2787
|
|
2707
|
-
# Deletes a game session queue.
|
2708
|
-
# StartGameSessionPlacement requests that reference
|
2709
|
-
# fail. To delete a queue, specify the queue name.
|
2788
|
+
# Deletes a game session queue. Once a queue is successfully deleted,
|
2789
|
+
# unfulfilled StartGameSessionPlacement requests that reference the
|
2790
|
+
# queue will fail. To delete a queue, specify the queue name.
|
2710
2791
|
#
|
2711
2792
|
# **Learn more**
|
2712
2793
|
#
|
@@ -2821,7 +2902,7 @@ module Aws::GameLift
|
|
2821
2902
|
#
|
2822
2903
|
#
|
2823
2904
|
#
|
2824
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
2905
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html
|
2825
2906
|
#
|
2826
2907
|
# @option params [required, String] :name
|
2827
2908
|
# A unique identifier for a matchmaking rule set to be deleted. (Note:
|
@@ -2845,8 +2926,8 @@ module Aws::GameLift
|
|
2845
2926
|
req.send_request(options)
|
2846
2927
|
end
|
2847
2928
|
|
2848
|
-
# Deletes a fleet scaling policy.
|
2849
|
-
#
|
2929
|
+
# Deletes a fleet scaling policy. Once deleted, the policy is no longer
|
2930
|
+
# in force and GameLift removes all record of it. To delete a scaling
|
2850
2931
|
# policy, specify both the scaling policy name and the fleet ID it is
|
2851
2932
|
# associated with.
|
2852
2933
|
#
|
@@ -2899,9 +2980,9 @@ module Aws::GameLift
|
|
2899
2980
|
req.send_request(options)
|
2900
2981
|
end
|
2901
2982
|
|
2902
|
-
# Deletes a Realtime script. This
|
2903
|
-
# record. If script files were uploaded, they are also deleted
|
2904
|
-
# stored in an S3 bucket are not deleted).
|
2983
|
+
# Deletes a Realtime script. This operation permanently deletes the
|
2984
|
+
# script record. If script files were uploaded, they are also deleted
|
2985
|
+
# (files stored in an S3 bucket are not deleted).
|
2905
2986
|
#
|
2906
2987
|
# To delete a script, specify the script ID. Before deleting a script,
|
2907
2988
|
# be sure to terminate all fleets that are deployed with the script
|
@@ -3052,16 +3133,16 @@ module Aws::GameLift
|
|
3052
3133
|
req.send_request(options)
|
3053
3134
|
end
|
3054
3135
|
|
3055
|
-
# **This
|
3056
|
-
#
|
3136
|
+
# **This operation is used with the Amazon GameLift FleetIQ solution and
|
3137
|
+
# game server groups.**
|
3057
3138
|
#
|
3058
|
-
# Removes the game server
|
3059
|
-
#
|
3060
|
-
#
|
3139
|
+
# Removes the game server from a game server group. As a result of this
|
3140
|
+
# operation, the deregistered game server can no longer be claimed and
|
3141
|
+
# will not be returned in a list of active game servers.
|
3061
3142
|
#
|
3062
|
-
# To
|
3063
|
-
# server ID. If successful, this
|
3064
|
-
# termination
|
3143
|
+
# To deregister a game server, specify the game server group and game
|
3144
|
+
# server ID. If successful, this operation emits a CloudWatch event with
|
3145
|
+
# termination timestamp and reason.
|
3065
3146
|
#
|
3066
3147
|
# **Learn more**
|
3067
3148
|
#
|
@@ -3083,15 +3164,15 @@ module Aws::GameLift
|
|
3083
3164
|
#
|
3084
3165
|
#
|
3085
3166
|
#
|
3086
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
3167
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
3087
3168
|
#
|
3088
3169
|
# @option params [required, String] :game_server_group_name
|
3089
|
-
#
|
3090
|
-
#
|
3091
|
-
# value.
|
3170
|
+
# A unique identifier for the game server group where the game server is
|
3171
|
+
# running. Use either the GameServerGroup name or ARN value.
|
3092
3172
|
#
|
3093
3173
|
# @option params [required, String] :game_server_id
|
3094
|
-
#
|
3174
|
+
# A custom string that uniquely identifies the game server to
|
3175
|
+
# deregister.
|
3095
3176
|
#
|
3096
3177
|
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
3097
3178
|
#
|
@@ -3276,13 +3357,13 @@ module Aws::GameLift
|
|
3276
3357
|
# @example Request syntax with placeholder values
|
3277
3358
|
#
|
3278
3359
|
# resp = client.describe_ec2_instance_limits({
|
3279
|
-
# ec2_instance_type: "t2.micro", # accepts t2.micro, t2.small, t2.medium, t2.large, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, 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, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, 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, m3.medium, m3.large, m3.xlarge, m3.2xlarge, 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
|
3360
|
+
# ec2_instance_type: "t2.micro", # accepts t2.micro, t2.small, t2.medium, t2.large, c3.large, c3.xlarge, c3.2xlarge, c3.4xlarge, c3.8xlarge, 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, c5a.large, c5a.xlarge, c5a.2xlarge, c5a.4xlarge, c5a.8xlarge, c5a.12xlarge, c5a.16xlarge, c5a.24xlarge, r3.large, r3.xlarge, r3.2xlarge, r3.4xlarge, r3.8xlarge, 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, r5a.large, r5a.xlarge, r5a.2xlarge, r5a.4xlarge, r5a.8xlarge, r5a.12xlarge, r5a.16xlarge, r5a.24xlarge, m3.medium, m3.large, m3.xlarge, m3.2xlarge, 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, m5a.large, m5a.xlarge, m5a.2xlarge, m5a.4xlarge, m5a.8xlarge, m5a.12xlarge, m5a.16xlarge, m5a.24xlarge
|
3280
3361
|
# })
|
3281
3362
|
#
|
3282
3363
|
# @example Response structure
|
3283
3364
|
#
|
3284
3365
|
# resp.ec2_instance_limits #=> Array
|
3285
|
-
# resp.ec2_instance_limits[0].ec2_instance_type #=> String, one of "t2.micro", "t2.small", "t2.medium", "t2.large", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "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", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "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", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "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"
|
3366
|
+
# resp.ec2_instance_limits[0].ec2_instance_type #=> String, one of "t2.micro", "t2.small", "t2.medium", "t2.large", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "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", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "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", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "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", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge"
|
3286
3367
|
# resp.ec2_instance_limits[0].current_instances #=> Integer
|
3287
3368
|
# resp.ec2_instance_limits[0].instance_limit #=> Integer
|
3288
3369
|
#
|
@@ -3305,7 +3386,7 @@ module Aws::GameLift
|
|
3305
3386
|
# pages. If successful, a FleetAttributes object is returned for each
|
3306
3387
|
# fleet requested, unless the fleet identifier is not found.
|
3307
3388
|
#
|
3308
|
-
# <note markdown="1"> Some API
|
3389
|
+
# <note markdown="1"> Some API operations may limit the number of fleet IDs allowed in one
|
3309
3390
|
# request. If a request exceeds this limit, the request fails and the
|
3310
3391
|
# error message includes the maximum allowed number.
|
3311
3392
|
#
|
@@ -3362,16 +3443,18 @@ module Aws::GameLift
|
|
3362
3443
|
#
|
3363
3444
|
# @option params [String] :next_token
|
3364
3445
|
# Token that indicates the start of the next sequential page of results.
|
3365
|
-
# Use the token that is returned with a previous call to this
|
3366
|
-
# start at the beginning of the result set, do not specify a value.
|
3367
|
-
# parameter is ignored when the request specifies one or a list of
|
3368
|
-
# IDs.
|
3446
|
+
# Use the token that is returned with a previous call to this operation.
|
3447
|
+
# To start at the beginning of the result set, do not specify a value.
|
3448
|
+
# This parameter is ignored when the request specifies one or a list of
|
3449
|
+
# fleet IDs.
|
3369
3450
|
#
|
3370
3451
|
# @return [Types::DescribeFleetAttributesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3371
3452
|
#
|
3372
3453
|
# * {Types::DescribeFleetAttributesOutput#fleet_attributes #fleet_attributes} => Array<Types::FleetAttributes>
|
3373
3454
|
# * {Types::DescribeFleetAttributesOutput#next_token #next_token} => String
|
3374
3455
|
#
|
3456
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3457
|
+
#
|
3375
3458
|
# @example Request syntax with placeholder values
|
3376
3459
|
#
|
3377
3460
|
# resp = client.describe_fleet_attributes({
|
@@ -3386,7 +3469,7 @@ module Aws::GameLift
|
|
3386
3469
|
# resp.fleet_attributes[0].fleet_id #=> String
|
3387
3470
|
# resp.fleet_attributes[0].fleet_arn #=> String
|
3388
3471
|
# resp.fleet_attributes[0].fleet_type #=> String, one of "ON_DEMAND", "SPOT"
|
3389
|
-
# resp.fleet_attributes[0].instance_type #=> String, one of "t2.micro", "t2.small", "t2.medium", "t2.large", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "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", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "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", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "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"
|
3472
|
+
# resp.fleet_attributes[0].instance_type #=> String, one of "t2.micro", "t2.small", "t2.medium", "t2.large", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "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", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "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", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "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", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge"
|
3390
3473
|
# resp.fleet_attributes[0].description #=> String
|
3391
3474
|
# resp.fleet_attributes[0].name #=> String
|
3392
3475
|
# resp.fleet_attributes[0].creation_time #=> Time
|
@@ -3434,7 +3517,7 @@ module Aws::GameLift
|
|
3434
3517
|
# requested fleet ID. When a list of fleet IDs is provided, attribute
|
3435
3518
|
# objects are returned only for fleets that currently exist.
|
3436
3519
|
#
|
3437
|
-
# <note markdown="1"> Some API
|
3520
|
+
# <note markdown="1"> Some API operations may limit the number of fleet IDs allowed in one
|
3438
3521
|
# request. If a request exceeds this limit, the request fails and the
|
3439
3522
|
# error message includes the maximum allowed.
|
3440
3523
|
#
|
@@ -3491,16 +3574,18 @@ module Aws::GameLift
|
|
3491
3574
|
#
|
3492
3575
|
# @option params [String] :next_token
|
3493
3576
|
# Token that indicates the start of the next sequential page of results.
|
3494
|
-
# Use the token that is returned with a previous call to this
|
3495
|
-
# start at the beginning of the result set, do not specify a value.
|
3496
|
-
# parameter is ignored when the request specifies one or a list of
|
3497
|
-
# IDs.
|
3577
|
+
# Use the token that is returned with a previous call to this operation.
|
3578
|
+
# To start at the beginning of the result set, do not specify a value.
|
3579
|
+
# This parameter is ignored when the request specifies one or a list of
|
3580
|
+
# fleet IDs.
|
3498
3581
|
#
|
3499
3582
|
# @return [Types::DescribeFleetCapacityOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3500
3583
|
#
|
3501
3584
|
# * {Types::DescribeFleetCapacityOutput#fleet_capacity #fleet_capacity} => Array<Types::FleetCapacity>
|
3502
3585
|
# * {Types::DescribeFleetCapacityOutput#next_token #next_token} => String
|
3503
3586
|
#
|
3587
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3588
|
+
#
|
3504
3589
|
# @example Request syntax with placeholder values
|
3505
3590
|
#
|
3506
3591
|
# resp = client.describe_fleet_capacity({
|
@@ -3513,7 +3598,7 @@ module Aws::GameLift
|
|
3513
3598
|
#
|
3514
3599
|
# resp.fleet_capacity #=> Array
|
3515
3600
|
# resp.fleet_capacity[0].fleet_id #=> String
|
3516
|
-
# resp.fleet_capacity[0].instance_type #=> String, one of "t2.micro", "t2.small", "t2.medium", "t2.large", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "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", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "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", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "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"
|
3601
|
+
# resp.fleet_capacity[0].instance_type #=> String, one of "t2.micro", "t2.small", "t2.medium", "t2.large", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "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", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "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", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "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", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge"
|
3517
3602
|
# resp.fleet_capacity[0].instance_counts.desired #=> Integer
|
3518
3603
|
# resp.fleet_capacity[0].instance_counts.minimum #=> Integer
|
3519
3604
|
# resp.fleet_capacity[0].instance_counts.maximum #=> Integer
|
@@ -3596,14 +3681,16 @@ module Aws::GameLift
|
|
3596
3681
|
#
|
3597
3682
|
# @option params [String] :next_token
|
3598
3683
|
# Token that indicates the start of the next sequential page of results.
|
3599
|
-
# Use the token that is returned with a previous call to this
|
3600
|
-
# start at the beginning of the result set, do not specify a value.
|
3684
|
+
# Use the token that is returned with a previous call to this operation.
|
3685
|
+
# To start at the beginning of the result set, do not specify a value.
|
3601
3686
|
#
|
3602
3687
|
# @return [Types::DescribeFleetEventsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3603
3688
|
#
|
3604
3689
|
# * {Types::DescribeFleetEventsOutput#events #events} => Array<Types::Event>
|
3605
3690
|
# * {Types::DescribeFleetEventsOutput#next_token #next_token} => String
|
3606
3691
|
#
|
3692
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3693
|
+
#
|
3607
3694
|
# @example Request syntax with placeholder values
|
3608
3695
|
#
|
3609
3696
|
# resp = client.describe_fleet_events({
|
@@ -3723,7 +3810,7 @@ module Aws::GameLift
|
|
3723
3810
|
# pages. If successful, a FleetUtilization object is returned for each
|
3724
3811
|
# requested fleet ID, unless the fleet identifier is not found.
|
3725
3812
|
#
|
3726
|
-
# <note markdown="1"> Some API
|
3813
|
+
# <note markdown="1"> Some API operations may limit the number of fleet IDs allowed in one
|
3727
3814
|
# request. If a request exceeds this limit, the request fails and the
|
3728
3815
|
# error message includes the maximum allowed.
|
3729
3816
|
#
|
@@ -3783,16 +3870,18 @@ module Aws::GameLift
|
|
3783
3870
|
#
|
3784
3871
|
# @option params [String] :next_token
|
3785
3872
|
# Token that indicates the start of the next sequential page of results.
|
3786
|
-
# Use the token that is returned with a previous call to this
|
3787
|
-
# start at the beginning of the result set, do not specify a value.
|
3788
|
-
# parameter is ignored when the request specifies one or a list of
|
3789
|
-
# IDs.
|
3873
|
+
# Use the token that is returned with a previous call to this operation.
|
3874
|
+
# To start at the beginning of the result set, do not specify a value.
|
3875
|
+
# This parameter is ignored when the request specifies one or a list of
|
3876
|
+
# fleet IDs.
|
3790
3877
|
#
|
3791
3878
|
# @return [Types::DescribeFleetUtilizationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3792
3879
|
#
|
3793
3880
|
# * {Types::DescribeFleetUtilizationOutput#fleet_utilization #fleet_utilization} => Array<Types::FleetUtilization>
|
3794
3881
|
# * {Types::DescribeFleetUtilizationOutput#next_token #next_token} => String
|
3795
3882
|
#
|
3883
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3884
|
+
#
|
3796
3885
|
# @example Request syntax with placeholder values
|
3797
3886
|
#
|
3798
3887
|
# resp = client.describe_fleet_utilization({
|
@@ -3820,12 +3909,12 @@ module Aws::GameLift
|
|
3820
3909
|
req.send_request(options)
|
3821
3910
|
end
|
3822
3911
|
|
3823
|
-
# **This
|
3824
|
-
#
|
3912
|
+
# **This operation is used with the Amazon GameLift FleetIQ solution and
|
3913
|
+
# game server groups.**
|
3825
3914
|
#
|
3826
|
-
# Retrieves information for a game server
|
3827
|
-
#
|
3828
|
-
# server is running on.
|
3915
|
+
# Retrieves information for a registered game server. Information
|
3916
|
+
# includes game server status, health check info, and the instance that
|
3917
|
+
# the game server is running on.
|
3829
3918
|
#
|
3830
3919
|
# To retrieve game server information, specify the game server ID. If
|
3831
3920
|
# successful, the requested game server object is returned.
|
@@ -3850,14 +3939,15 @@ module Aws::GameLift
|
|
3850
3939
|
#
|
3851
3940
|
#
|
3852
3941
|
#
|
3853
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
3942
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
3854
3943
|
#
|
3855
3944
|
# @option params [required, String] :game_server_group_name
|
3856
|
-
#
|
3945
|
+
# A unique identifier for the game server group where the game server is
|
3857
3946
|
# running. Use either the GameServerGroup name or ARN value.
|
3858
3947
|
#
|
3859
3948
|
# @option params [required, String] :game_server_id
|
3860
|
-
#
|
3949
|
+
# A custom string that uniquely identifies the game server information
|
3950
|
+
# to be retrieved.
|
3861
3951
|
#
|
3862
3952
|
# @return [Types::DescribeGameServerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3863
3953
|
#
|
@@ -3878,7 +3968,6 @@ module Aws::GameLift
|
|
3878
3968
|
# resp.game_server.instance_id #=> String
|
3879
3969
|
# resp.game_server.connection_info #=> String
|
3880
3970
|
# resp.game_server.game_server_data #=> String
|
3881
|
-
# resp.game_server.custom_sort_key #=> String
|
3882
3971
|
# resp.game_server.claim_status #=> String, one of "CLAIMED"
|
3883
3972
|
# resp.game_server.utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
|
3884
3973
|
# resp.game_server.registration_time #=> Time
|
@@ -3894,10 +3983,14 @@ module Aws::GameLift
|
|
3894
3983
|
req.send_request(options)
|
3895
3984
|
end
|
3896
3985
|
|
3897
|
-
# **This
|
3898
|
-
#
|
3986
|
+
# **This operation is used with the Amazon GameLift FleetIQ solution and
|
3987
|
+
# game server groups.**
|
3899
3988
|
#
|
3900
|
-
# Retrieves information on a game server group.
|
3989
|
+
# Retrieves information on a game server group. This operation returns
|
3990
|
+
# only properties related to GameLift FleetIQ. To view or update
|
3991
|
+
# properties for the corresponding Auto Scaling group, such as launch
|
3992
|
+
# template, auto scaling policies, and maximum/minimum group size,
|
3993
|
+
# access the Auto Scaling group directly.
|
3901
3994
|
#
|
3902
3995
|
# To get attributes for a game server group, provide a group name or ARN
|
3903
3996
|
# value. If successful, a GameServerGroup object is returned.
|
@@ -3922,13 +4015,15 @@ module Aws::GameLift
|
|
3922
4015
|
#
|
3923
4016
|
# * SuspendGameServerGroup
|
3924
4017
|
#
|
4018
|
+
# * DescribeGameServerInstances
|
4019
|
+
#
|
3925
4020
|
#
|
3926
4021
|
#
|
3927
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
4022
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
3928
4023
|
#
|
3929
4024
|
# @option params [required, String] :game_server_group_name
|
3930
|
-
#
|
3931
|
-
#
|
4025
|
+
# A unique identifier for the game server group. Use either the
|
4026
|
+
# GameServerGroup name or ARN value.
|
3932
4027
|
#
|
3933
4028
|
# @return [Types::DescribeGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
3934
4029
|
#
|
@@ -3948,7 +4043,7 @@ module Aws::GameLift
|
|
3948
4043
|
# resp.game_server_group.instance_definitions #=> Array
|
3949
4044
|
# resp.game_server_group.instance_definitions[0].instance_type #=> String, one of "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge"
|
3950
4045
|
# resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
|
3951
|
-
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED"
|
4046
|
+
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED", "ON_DEMAND_ONLY"
|
3952
4047
|
# resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
|
3953
4048
|
# resp.game_server_group.auto_scaling_group_arn #=> String
|
3954
4049
|
# resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
|
@@ -3967,8 +4062,109 @@ module Aws::GameLift
|
|
3967
4062
|
req.send_request(options)
|
3968
4063
|
end
|
3969
4064
|
|
4065
|
+
# **This operation is used with the Amazon GameLift FleetIQ solution and
|
4066
|
+
# game server groups.**
|
4067
|
+
#
|
4068
|
+
# Retrieves status information about the Amazon EC2 instances associated
|
4069
|
+
# with a GameLift FleetIQ game server group. Use this operation to
|
4070
|
+
# detect when instances are active or not available to host new game
|
4071
|
+
# servers. If you are looking for instance configuration information,
|
4072
|
+
# call DescribeGameServerGroup or access the corresponding Auto Scaling
|
4073
|
+
# group properties.
|
4074
|
+
#
|
4075
|
+
# To request status for all instances in the game server group, provide
|
4076
|
+
# a game server group ID only. To request status for specific instances,
|
4077
|
+
# provide the game server group ID and one or more instance IDs. Use the
|
4078
|
+
# pagination parameters to retrieve results in sequential segments. If
|
4079
|
+
# successful, a collection of `GameServerInstance` objects is returned.
|
4080
|
+
#
|
4081
|
+
# This operation is not designed to be called with every game server
|
4082
|
+
# claim request; this practice can cause you to exceed your API limit,
|
4083
|
+
# which results in errors. Instead, as a best practice, cache the
|
4084
|
+
# results and refresh your cache no more than once every 10 seconds.
|
4085
|
+
#
|
4086
|
+
# **Learn more**
|
4087
|
+
#
|
4088
|
+
# [GameLift FleetIQ Guide][1]
|
4089
|
+
#
|
4090
|
+
# **Related operations**
|
4091
|
+
#
|
4092
|
+
# * CreateGameServerGroup
|
4093
|
+
#
|
4094
|
+
# * ListGameServerGroups
|
4095
|
+
#
|
4096
|
+
# * DescribeGameServerGroup
|
4097
|
+
#
|
4098
|
+
# * UpdateGameServerGroup
|
4099
|
+
#
|
4100
|
+
# * DeleteGameServerGroup
|
4101
|
+
#
|
4102
|
+
# * ResumeGameServerGroup
|
4103
|
+
#
|
4104
|
+
# * SuspendGameServerGroup
|
4105
|
+
#
|
4106
|
+
# * DescribeGameServerInstances
|
4107
|
+
#
|
4108
|
+
#
|
4109
|
+
#
|
4110
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
4111
|
+
#
|
4112
|
+
# @option params [required, String] :game_server_group_name
|
4113
|
+
# A unique identifier for the game server group. Use either the
|
4114
|
+
# GameServerGroup name or ARN value.
|
4115
|
+
#
|
4116
|
+
# @option params [Array<String>] :instance_ids
|
4117
|
+
# The EC2 instance IDs that you want to retrieve status on. EC2 instance
|
4118
|
+
# IDs use a 17-character format, for example: `i-1234567890abcdef0`. To
|
4119
|
+
# retrieve all instances in the game server group, leave this parameter
|
4120
|
+
# empty.
|
4121
|
+
#
|
4122
|
+
# @option params [Integer] :limit
|
4123
|
+
# The maximum number of results to return. Use this parameter with
|
4124
|
+
# `NextToken` to get results as a set of sequential segments.
|
4125
|
+
#
|
4126
|
+
# @option params [String] :next_token
|
4127
|
+
# A token that indicates the start of the next sequential segment of
|
4128
|
+
# results. Use the token returned with the previous call to this
|
4129
|
+
# operation. To start at the beginning of the result set, do not specify
|
4130
|
+
# a value.
|
4131
|
+
#
|
4132
|
+
# @return [Types::DescribeGameServerInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4133
|
+
#
|
4134
|
+
# * {Types::DescribeGameServerInstancesOutput#game_server_instances #game_server_instances} => Array<Types::GameServerInstance>
|
4135
|
+
# * {Types::DescribeGameServerInstancesOutput#next_token #next_token} => String
|
4136
|
+
#
|
4137
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4138
|
+
#
|
4139
|
+
# @example Request syntax with placeholder values
|
4140
|
+
#
|
4141
|
+
# resp = client.describe_game_server_instances({
|
4142
|
+
# game_server_group_name: "GameServerGroupNameOrArn", # required
|
4143
|
+
# instance_ids: ["GameServerInstanceId"],
|
4144
|
+
# limit: 1,
|
4145
|
+
# next_token: "NonZeroAndMaxString",
|
4146
|
+
# })
|
4147
|
+
#
|
4148
|
+
# @example Response structure
|
4149
|
+
#
|
4150
|
+
# resp.game_server_instances #=> Array
|
4151
|
+
# resp.game_server_instances[0].game_server_group_name #=> String
|
4152
|
+
# resp.game_server_instances[0].game_server_group_arn #=> String
|
4153
|
+
# resp.game_server_instances[0].instance_id #=> String
|
4154
|
+
# resp.game_server_instances[0].instance_status #=> String, one of "ACTIVE", "DRAINING", "SPOT_TERMINATING"
|
4155
|
+
# resp.next_token #=> String
|
4156
|
+
#
|
4157
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeGameServerInstances AWS API Documentation
|
4158
|
+
#
|
4159
|
+
# @overload describe_game_server_instances(params = {})
|
4160
|
+
# @param [Hash] params ({})
|
4161
|
+
def describe_game_server_instances(params = {}, options = {})
|
4162
|
+
req = build_request(:describe_game_server_instances, params)
|
4163
|
+
req.send_request(options)
|
4164
|
+
end
|
4165
|
+
|
3970
4166
|
# Retrieves properties, including the protection policy in force, for
|
3971
|
-
# one or more game sessions. This
|
4167
|
+
# one or more game sessions. This operation can be used in several ways:
|
3972
4168
|
# (1) provide a `GameSessionId` or `GameSessionArn` to request details
|
3973
4169
|
# for a specific game session; (2) provide either a `FleetId` or an
|
3974
4170
|
# `AliasId` to request properties for all game sessions running on a
|
@@ -4022,14 +4218,16 @@ module Aws::GameLift
|
|
4022
4218
|
#
|
4023
4219
|
# @option params [String] :next_token
|
4024
4220
|
# Token that indicates the start of the next sequential page of results.
|
4025
|
-
# Use the token that is returned with a previous call to this
|
4026
|
-
# start at the beginning of the result set, do not specify a value.
|
4221
|
+
# Use the token that is returned with a previous call to this operation.
|
4222
|
+
# To start at the beginning of the result set, do not specify a value.
|
4027
4223
|
#
|
4028
4224
|
# @return [Types::DescribeGameSessionDetailsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4029
4225
|
#
|
4030
4226
|
# * {Types::DescribeGameSessionDetailsOutput#game_session_details #game_session_details} => Array<Types::GameSessionDetail>
|
4031
4227
|
# * {Types::DescribeGameSessionDetailsOutput#next_token #next_token} => String
|
4032
4228
|
#
|
4229
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4230
|
+
#
|
4033
4231
|
# @example Request syntax with placeholder values
|
4034
4232
|
#
|
4035
4233
|
# resp = client.describe_game_session_details({
|
@@ -4182,19 +4380,22 @@ module Aws::GameLift
|
|
4182
4380
|
#
|
4183
4381
|
# @option params [Integer] :limit
|
4184
4382
|
# The maximum number of results to return. Use this parameter with
|
4185
|
-
# `NextToken` to get results as a set of sequential pages.
|
4383
|
+
# `NextToken` to get results as a set of sequential pages. You can
|
4384
|
+
# request up to 50 results.
|
4186
4385
|
#
|
4187
4386
|
# @option params [String] :next_token
|
4188
4387
|
# A token that indicates the start of the next sequential page of
|
4189
4388
|
# results. Use the token that is returned with a previous call to this
|
4190
|
-
#
|
4191
|
-
# value.
|
4389
|
+
# operation. To start at the beginning of the result set, do not specify
|
4390
|
+
# a value.
|
4192
4391
|
#
|
4193
4392
|
# @return [Types::DescribeGameSessionQueuesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4194
4393
|
#
|
4195
4394
|
# * {Types::DescribeGameSessionQueuesOutput#game_session_queues #game_session_queues} => Array<Types::GameSessionQueue>
|
4196
4395
|
# * {Types::DescribeGameSessionQueuesOutput#next_token #next_token} => String
|
4197
4396
|
#
|
4397
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4398
|
+
#
|
4198
4399
|
# @example Request syntax with placeholder values
|
4199
4400
|
#
|
4200
4401
|
# resp = client.describe_game_session_queues({
|
@@ -4281,14 +4482,16 @@ module Aws::GameLift
|
|
4281
4482
|
#
|
4282
4483
|
# @option params [String] :next_token
|
4283
4484
|
# Token that indicates the start of the next sequential page of results.
|
4284
|
-
# Use the token that is returned with a previous call to this
|
4285
|
-
# start at the beginning of the result set, do not specify a value.
|
4485
|
+
# Use the token that is returned with a previous call to this operation.
|
4486
|
+
# To start at the beginning of the result set, do not specify a value.
|
4286
4487
|
#
|
4287
4488
|
# @return [Types::DescribeGameSessionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4288
4489
|
#
|
4289
4490
|
# * {Types::DescribeGameSessionsOutput#game_sessions #game_sessions} => Array<Types::GameSession>
|
4290
4491
|
# * {Types::DescribeGameSessionsOutput#next_token #next_token} => String
|
4291
4492
|
#
|
4493
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4494
|
+
#
|
4292
4495
|
# @example Request syntax with placeholder values
|
4293
4496
|
#
|
4294
4497
|
# resp = client.describe_game_sessions({
|
@@ -4335,8 +4538,8 @@ module Aws::GameLift
|
|
4335
4538
|
end
|
4336
4539
|
|
4337
4540
|
# Retrieves information about a fleet's instances, including instance
|
4338
|
-
# IDs. Use this
|
4339
|
-
# get details on one specific instance.
|
4541
|
+
# IDs. Use this operation to get details on all instances in the fleet
|
4542
|
+
# or get details on one specific instance.
|
4340
4543
|
#
|
4341
4544
|
# To get a specific instance, specify fleet ID and instance ID. To get
|
4342
4545
|
# all instances in a fleet, specify a fleet ID only. Use the pagination
|
@@ -4374,14 +4577,16 @@ module Aws::GameLift
|
|
4374
4577
|
#
|
4375
4578
|
# @option params [String] :next_token
|
4376
4579
|
# Token that indicates the start of the next sequential page of results.
|
4377
|
-
# Use the token that is returned with a previous call to this
|
4378
|
-
# start at the beginning of the result set, do not specify a value.
|
4580
|
+
# Use the token that is returned with a previous call to this operation.
|
4581
|
+
# To start at the beginning of the result set, do not specify a value.
|
4379
4582
|
#
|
4380
4583
|
# @return [Types::DescribeInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4381
4584
|
#
|
4382
4585
|
# * {Types::DescribeInstancesOutput#instances #instances} => Array<Types::Instance>
|
4383
4586
|
# * {Types::DescribeInstancesOutput#next_token #next_token} => String
|
4384
4587
|
#
|
4588
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4589
|
+
#
|
4385
4590
|
# @example Request syntax with placeholder values
|
4386
4591
|
#
|
4387
4592
|
# resp = client.describe_instances({
|
@@ -4399,7 +4604,7 @@ module Aws::GameLift
|
|
4399
4604
|
# resp.instances[0].ip_address #=> String
|
4400
4605
|
# resp.instances[0].dns_name #=> String
|
4401
4606
|
# resp.instances[0].operating_system #=> String, one of "WINDOWS_2012", "AMAZON_LINUX", "AMAZON_LINUX_2"
|
4402
|
-
# resp.instances[0].type #=> String, one of "t2.micro", "t2.small", "t2.medium", "t2.large", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "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", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "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", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "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"
|
4607
|
+
# resp.instances[0].type #=> String, one of "t2.micro", "t2.small", "t2.medium", "t2.large", "c3.large", "c3.xlarge", "c3.2xlarge", "c3.4xlarge", "c3.8xlarge", "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", "c5a.large", "c5a.xlarge", "c5a.2xlarge", "c5a.4xlarge", "c5a.8xlarge", "c5a.12xlarge", "c5a.16xlarge", "c5a.24xlarge", "r3.large", "r3.xlarge", "r3.2xlarge", "r3.4xlarge", "r3.8xlarge", "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", "r5a.large", "r5a.xlarge", "r5a.2xlarge", "r5a.4xlarge", "r5a.8xlarge", "r5a.12xlarge", "r5a.16xlarge", "r5a.24xlarge", "m3.medium", "m3.large", "m3.xlarge", "m3.2xlarge", "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", "m5a.large", "m5a.xlarge", "m5a.2xlarge", "m5a.4xlarge", "m5a.8xlarge", "m5a.12xlarge", "m5a.16xlarge", "m5a.24xlarge"
|
4403
4608
|
# resp.instances[0].status #=> String, one of "PENDING", "ACTIVE", "TERMINATING"
|
4404
4609
|
# resp.instances[0].creation_time #=> Time
|
4405
4610
|
# resp.next_token #=> String
|
@@ -4414,19 +4619,24 @@ module Aws::GameLift
|
|
4414
4619
|
end
|
4415
4620
|
|
4416
4621
|
# Retrieves one or more matchmaking tickets. Use this operation to
|
4417
|
-
# retrieve ticket information, including
|
4418
|
-
#
|
4419
|
-
# game session.
|
4420
|
-
#
|
4421
|
-
# You can use this operation to track the progress of matchmaking
|
4422
|
-
# requests (through polling) as an alternative to using event
|
4423
|
-
# notifications. See more details on tracking matchmaking requests
|
4424
|
-
# through polling or notifications in StartMatchmaking.
|
4622
|
+
# retrieve ticket information, including--after a successful match is
|
4623
|
+
# made--connection information for the resulting new game session.
|
4425
4624
|
#
|
4426
4625
|
# To request matchmaking tickets, provide a list of up to 10 ticket IDs.
|
4427
4626
|
# If the request is successful, a ticket object is returned for each
|
4428
4627
|
# requested ID that currently exists.
|
4429
4628
|
#
|
4629
|
+
# This operation is not designed to be continually called to track
|
4630
|
+
# matchmaking ticket status. This practice can cause you to exceed your
|
4631
|
+
# API limit, which results in errors. Instead, as a best practice, set
|
4632
|
+
# up an Amazon Simple Notification Service (SNS) to receive
|
4633
|
+
# notifications, and provide the topic ARN in the matchmaking
|
4634
|
+
# configuration. Continuously poling ticket status with
|
4635
|
+
# DescribeMatchmaking should only be used for games in development with
|
4636
|
+
# low matchmaking usage.
|
4637
|
+
#
|
4638
|
+
#
|
4639
|
+
#
|
4430
4640
|
# **Learn more**
|
4431
4641
|
#
|
4432
4642
|
# [ Add FlexMatch to a Game Client][1]
|
@@ -4447,8 +4657,8 @@ module Aws::GameLift
|
|
4447
4657
|
#
|
4448
4658
|
#
|
4449
4659
|
#
|
4450
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
4451
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/
|
4660
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html
|
4661
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html
|
4452
4662
|
#
|
4453
4663
|
# @option params [required, Array<String>] :ticket_ids
|
4454
4664
|
# A unique identifier for a matchmaking ticket. You can include up to 10
|
@@ -4500,15 +4710,18 @@ module Aws::GameLift
|
|
4500
4710
|
req.send_request(options)
|
4501
4711
|
end
|
4502
4712
|
|
4503
|
-
# Retrieves the details of FlexMatch matchmaking configurations.
|
4504
|
-
#
|
4505
|
-
#
|
4506
|
-
# configurations
|
4507
|
-
#
|
4713
|
+
# Retrieves the details of FlexMatch matchmaking configurations.
|
4714
|
+
#
|
4715
|
+
# This operation offers the following options: (1) retrieve all
|
4716
|
+
# matchmaking configurations, (2) retrieve configurations for a
|
4717
|
+
# specified list, or (3) retrieve all configurations that use a
|
4718
|
+
# specified rule set name. When requesting multiple items, use the
|
4508
4719
|
# pagination parameters to retrieve results as a set of sequential
|
4509
|
-
# pages.
|
4510
|
-
#
|
4511
|
-
#
|
4720
|
+
# pages.
|
4721
|
+
#
|
4722
|
+
# If successful, a configuration is returned for each requested name.
|
4723
|
+
# When specifying a list of names, only configurations that currently
|
4724
|
+
# exist are returned.
|
4512
4725
|
#
|
4513
4726
|
# **Learn more**
|
4514
4727
|
#
|
@@ -4534,7 +4747,7 @@ module Aws::GameLift
|
|
4534
4747
|
#
|
4535
4748
|
#
|
4536
4749
|
#
|
4537
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
4750
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/matchmaker-build.html
|
4538
4751
|
#
|
4539
4752
|
# @option params [Array<String>] :names
|
4540
4753
|
# A unique identifier for a matchmaking configuration(s) to retrieve.
|
@@ -4554,14 +4767,16 @@ module Aws::GameLift
|
|
4554
4767
|
# @option params [String] :next_token
|
4555
4768
|
# A token that indicates the start of the next sequential page of
|
4556
4769
|
# results. Use the token that is returned with a previous call to this
|
4557
|
-
#
|
4558
|
-
# value.
|
4770
|
+
# operation. To start at the beginning of the result set, do not specify
|
4771
|
+
# a value.
|
4559
4772
|
#
|
4560
4773
|
# @return [Types::DescribeMatchmakingConfigurationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4561
4774
|
#
|
4562
4775
|
# * {Types::DescribeMatchmakingConfigurationsOutput#configurations #configurations} => Array<Types::MatchmakingConfiguration>
|
4563
4776
|
# * {Types::DescribeMatchmakingConfigurationsOutput#next_token #next_token} => String
|
4564
4777
|
#
|
4778
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4779
|
+
#
|
4565
4780
|
# @example Request syntax with placeholder values
|
4566
4781
|
#
|
4567
4782
|
# resp = client.describe_matchmaking_configurations({
|
@@ -4593,6 +4808,7 @@ module Aws::GameLift
|
|
4593
4808
|
# resp.configurations[0].game_properties[0].value #=> String
|
4594
4809
|
# resp.configurations[0].game_session_data #=> String
|
4595
4810
|
# resp.configurations[0].backfill_mode #=> String, one of "AUTOMATIC", "MANUAL"
|
4811
|
+
# resp.configurations[0].flex_match_mode #=> String, one of "STANDALONE", "WITH_QUEUE"
|
4596
4812
|
# resp.next_token #=> String
|
4597
4813
|
#
|
4598
4814
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeMatchmakingConfigurations AWS API Documentation
|
@@ -4636,7 +4852,7 @@ module Aws::GameLift
|
|
4636
4852
|
#
|
4637
4853
|
#
|
4638
4854
|
#
|
4639
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
4855
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html
|
4640
4856
|
#
|
4641
4857
|
# @option params [Array<String>] :names
|
4642
4858
|
# A list of one or more matchmaking rule set names to retrieve details
|
@@ -4651,14 +4867,16 @@ module Aws::GameLift
|
|
4651
4867
|
# @option params [String] :next_token
|
4652
4868
|
# A token that indicates the start of the next sequential page of
|
4653
4869
|
# results. Use the token that is returned with a previous call to this
|
4654
|
-
#
|
4655
|
-
# value.
|
4870
|
+
# operation. To start at the beginning of the result set, do not specify
|
4871
|
+
# a value.
|
4656
4872
|
#
|
4657
4873
|
# @return [Types::DescribeMatchmakingRuleSetsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4658
4874
|
#
|
4659
4875
|
# * {Types::DescribeMatchmakingRuleSetsOutput#rule_sets #rule_sets} => Array<Types::MatchmakingRuleSet>
|
4660
4876
|
# * {Types::DescribeMatchmakingRuleSetsOutput#next_token #next_token} => String
|
4661
4877
|
#
|
4878
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4879
|
+
#
|
4662
4880
|
# @example Request syntax with placeholder values
|
4663
4881
|
#
|
4664
4882
|
# resp = client.describe_matchmaking_rule_sets({
|
@@ -4685,9 +4903,9 @@ module Aws::GameLift
|
|
4685
4903
|
req.send_request(options)
|
4686
4904
|
end
|
4687
4905
|
|
4688
|
-
# Retrieves properties for one or more player sessions. This
|
4689
|
-
# be used in several ways: (1) provide a `PlayerSessionId` to
|
4690
|
-
# properties for a specific player session; (2) provide a
|
4906
|
+
# Retrieves properties for one or more player sessions. This operation
|
4907
|
+
# can be used in several ways: (1) provide a `PlayerSessionId` to
|
4908
|
+
# request properties for a specific player session; (2) provide a
|
4691
4909
|
# `GameSessionId` to request properties for all player sessions in the
|
4692
4910
|
# specified game session; (3) provide a `PlayerId` to request properties
|
4693
4911
|
# for all player sessions of a specified player.
|
@@ -4750,15 +4968,17 @@ module Aws::GameLift
|
|
4750
4968
|
#
|
4751
4969
|
# @option params [String] :next_token
|
4752
4970
|
# Token that indicates the start of the next sequential page of results.
|
4753
|
-
# Use the token that is returned with a previous call to this
|
4754
|
-
# start at the beginning of the result set, do not specify a value.
|
4755
|
-
# player session ID is specified, this parameter is ignored.
|
4971
|
+
# Use the token that is returned with a previous call to this operation.
|
4972
|
+
# To start at the beginning of the result set, do not specify a value.
|
4973
|
+
# If a player session ID is specified, this parameter is ignored.
|
4756
4974
|
#
|
4757
4975
|
# @return [Types::DescribePlayerSessionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4758
4976
|
#
|
4759
4977
|
# * {Types::DescribePlayerSessionsOutput#player_sessions #player_sessions} => Array<Types::PlayerSession>
|
4760
4978
|
# * {Types::DescribePlayerSessionsOutput#next_token #next_token} => String
|
4761
4979
|
#
|
4980
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
4981
|
+
#
|
4762
4982
|
# @example Request syntax with placeholder values
|
4763
4983
|
#
|
4764
4984
|
# resp = client.describe_player_sessions({
|
@@ -4885,7 +5105,7 @@ module Aws::GameLift
|
|
4885
5105
|
# is returned for the fleet.
|
4886
5106
|
#
|
4887
5107
|
# A fleet may have all of its scaling policies suspended
|
4888
|
-
# (StopFleetActions). This
|
5108
|
+
# (StopFleetActions). This operation does not affect the status of the
|
4889
5109
|
# scaling policies, which remains ACTIVE. To see whether a fleet's
|
4890
5110
|
# scaling policies are in force or suspended, call
|
4891
5111
|
# DescribeFleetAttributes and check the stopped actions.
|
@@ -4941,14 +5161,16 @@ module Aws::GameLift
|
|
4941
5161
|
#
|
4942
5162
|
# @option params [String] :next_token
|
4943
5163
|
# Token that indicates the start of the next sequential page of results.
|
4944
|
-
# Use the token that is returned with a previous call to this
|
4945
|
-
# start at the beginning of the result set, do not specify a value.
|
5164
|
+
# Use the token that is returned with a previous call to this operation.
|
5165
|
+
# To start at the beginning of the result set, do not specify a value.
|
4946
5166
|
#
|
4947
5167
|
# @return [Types::DescribeScalingPoliciesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4948
5168
|
#
|
4949
5169
|
# * {Types::DescribeScalingPoliciesOutput#scaling_policies #scaling_policies} => Array<Types::ScalingPolicy>
|
4950
5170
|
# * {Types::DescribeScalingPoliciesOutput#next_token #next_token} => String
|
4951
5171
|
#
|
5172
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5173
|
+
#
|
4952
5174
|
# @example Request syntax with placeholder values
|
4953
5175
|
#
|
4954
5176
|
# resp = client.describe_scaling_policies({
|
@@ -5213,7 +5435,7 @@ module Aws::GameLift
|
|
5213
5435
|
# an SSH client. The private key must be saved in the proper format to a
|
5214
5436
|
# `.pem` file before using. If you're making this request using the AWS
|
5215
5437
|
# CLI, saving the secret can be handled as part of the GetInstanceAccess
|
5216
|
-
# request, as shown in one of the examples for this
|
5438
|
+
# request, as shown in one of the examples for this operation.
|
5217
5439
|
#
|
5218
5440
|
# To request access to a specific instance, specify the IDs of both the
|
5219
5441
|
# instance and the fleet it belongs to. You can retrieve a fleet's
|
@@ -5324,14 +5546,16 @@ module Aws::GameLift
|
|
5324
5546
|
# @option params [String] :next_token
|
5325
5547
|
# A token that indicates the start of the next sequential page of
|
5326
5548
|
# results. Use the token that is returned with a previous call to this
|
5327
|
-
#
|
5328
|
-
# value.
|
5549
|
+
# operation. To start at the beginning of the result set, do not specify
|
5550
|
+
# a value.
|
5329
5551
|
#
|
5330
5552
|
# @return [Types::ListAliasesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5331
5553
|
#
|
5332
5554
|
# * {Types::ListAliasesOutput#aliases #aliases} => Array<Types::Alias>
|
5333
5555
|
# * {Types::ListAliasesOutput#next_token #next_token} => String
|
5334
5556
|
#
|
5557
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5558
|
+
#
|
5335
5559
|
# @example Request syntax with placeholder values
|
5336
5560
|
#
|
5337
5561
|
# resp = client.list_aliases({
|
@@ -5416,14 +5640,16 @@ module Aws::GameLift
|
|
5416
5640
|
#
|
5417
5641
|
# @option params [String] :next_token
|
5418
5642
|
# Token that indicates the start of the next sequential page of results.
|
5419
|
-
# Use the token that is returned with a previous call to this
|
5420
|
-
# start at the beginning of the result set, do not specify a value.
|
5643
|
+
# Use the token that is returned with a previous call to this operation.
|
5644
|
+
# To start at the beginning of the result set, do not specify a value.
|
5421
5645
|
#
|
5422
5646
|
# @return [Types::ListBuildsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5423
5647
|
#
|
5424
5648
|
# * {Types::ListBuildsOutput#builds #builds} => Array<Types::Build>
|
5425
5649
|
# * {Types::ListBuildsOutput#next_token #next_token} => String
|
5426
5650
|
#
|
5651
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5652
|
+
#
|
5427
5653
|
# @example Request syntax with placeholder values
|
5428
5654
|
#
|
5429
5655
|
# resp = client.list_builds({
|
@@ -5503,14 +5729,16 @@ module Aws::GameLift
|
|
5503
5729
|
#
|
5504
5730
|
# @option params [String] :next_token
|
5505
5731
|
# Token that indicates the start of the next sequential page of results.
|
5506
|
-
# Use the token that is returned with a previous call to this
|
5507
|
-
# start at the beginning of the result set, do not specify a value.
|
5732
|
+
# Use the token that is returned with a previous call to this operation.
|
5733
|
+
# To start at the beginning of the result set, do not specify a value.
|
5508
5734
|
#
|
5509
5735
|
# @return [Types::ListFleetsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5510
5736
|
#
|
5511
5737
|
# * {Types::ListFleetsOutput#fleet_ids #fleet_ids} => Array<String>
|
5512
5738
|
# * {Types::ListFleetsOutput#next_token #next_token} => String
|
5513
5739
|
#
|
5740
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5741
|
+
#
|
5514
5742
|
# @example Request syntax with placeholder values
|
5515
5743
|
#
|
5516
5744
|
# resp = client.list_fleets({
|
@@ -5535,12 +5763,12 @@ module Aws::GameLift
|
|
5535
5763
|
req.send_request(options)
|
5536
5764
|
end
|
5537
5765
|
|
5538
|
-
# **This
|
5539
|
-
#
|
5766
|
+
# **This operation is used with the Amazon GameLift FleetIQ solution and
|
5767
|
+
# game server groups.**
|
5540
5768
|
#
|
5541
5769
|
# Retrieves information on all game servers groups that exist in the
|
5542
|
-
# current AWS account for the selected
|
5543
|
-
# parameters to retrieve results in a set of sequential
|
5770
|
+
# current AWS account for the selected Region. Use the pagination
|
5771
|
+
# parameters to retrieve results in a set of sequential segments.
|
5544
5772
|
#
|
5545
5773
|
# **Learn more**
|
5546
5774
|
#
|
@@ -5562,25 +5790,29 @@ module Aws::GameLift
|
|
5562
5790
|
#
|
5563
5791
|
# * SuspendGameServerGroup
|
5564
5792
|
#
|
5793
|
+
# * DescribeGameServerInstances
|
5794
|
+
#
|
5565
5795
|
#
|
5566
5796
|
#
|
5567
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
5797
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
5568
5798
|
#
|
5569
5799
|
# @option params [Integer] :limit
|
5570
5800
|
# The maximum number of results to return. Use this parameter with
|
5571
|
-
# `NextToken` to get results as a set of sequential
|
5801
|
+
# `NextToken` to get results as a set of sequential segments.
|
5572
5802
|
#
|
5573
5803
|
# @option params [String] :next_token
|
5574
|
-
# A token that indicates the start of the next sequential
|
5575
|
-
# results. Use the token
|
5576
|
-
#
|
5577
|
-
# value.
|
5804
|
+
# A token that indicates the start of the next sequential segment of
|
5805
|
+
# results. Use the token returned with the previous call to this
|
5806
|
+
# operation. To start at the beginning of the result set, do not specify
|
5807
|
+
# a value.
|
5578
5808
|
#
|
5579
5809
|
# @return [Types::ListGameServerGroupsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5580
5810
|
#
|
5581
5811
|
# * {Types::ListGameServerGroupsOutput#game_server_groups #game_server_groups} => Array<Types::GameServerGroup>
|
5582
5812
|
# * {Types::ListGameServerGroupsOutput#next_token #next_token} => String
|
5583
5813
|
#
|
5814
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5815
|
+
#
|
5584
5816
|
# @example Request syntax with placeholder values
|
5585
5817
|
#
|
5586
5818
|
# resp = client.list_game_server_groups({
|
@@ -5597,7 +5829,7 @@ module Aws::GameLift
|
|
5597
5829
|
# resp.game_server_groups[0].instance_definitions #=> Array
|
5598
5830
|
# resp.game_server_groups[0].instance_definitions[0].instance_type #=> String, one of "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge"
|
5599
5831
|
# resp.game_server_groups[0].instance_definitions[0].weighted_capacity #=> String
|
5600
|
-
# resp.game_server_groups[0].balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED"
|
5832
|
+
# resp.game_server_groups[0].balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED", "ON_DEMAND_ONLY"
|
5601
5833
|
# resp.game_server_groups[0].game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
|
5602
5834
|
# resp.game_server_groups[0].auto_scaling_group_arn #=> String
|
5603
5835
|
# resp.game_server_groups[0].status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
|
@@ -5617,14 +5849,13 @@ module Aws::GameLift
|
|
5617
5849
|
req.send_request(options)
|
5618
5850
|
end
|
5619
5851
|
|
5620
|
-
# **This
|
5621
|
-
#
|
5852
|
+
# **This operation is used with the Amazon GameLift FleetIQ solution and
|
5853
|
+
# game server groups.**
|
5622
5854
|
#
|
5623
|
-
# Retrieves information on all game servers that are currently
|
5624
|
-
#
|
5625
|
-
#
|
5626
|
-
#
|
5627
|
-
# results in a set of sequential pages.
|
5855
|
+
# Retrieves information on all game servers that are currently active in
|
5856
|
+
# a specified game server group. You can opt to sort the list by game
|
5857
|
+
# server age. Use the pagination parameters to retrieve results in a set
|
5858
|
+
# of sequential segments.
|
5628
5859
|
#
|
5629
5860
|
# **Learn more**
|
5630
5861
|
#
|
@@ -5646,32 +5877,36 @@ module Aws::GameLift
|
|
5646
5877
|
#
|
5647
5878
|
#
|
5648
5879
|
#
|
5649
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
5880
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
5650
5881
|
#
|
5651
5882
|
# @option params [required, String] :game_server_group_name
|
5652
|
-
# An identifier for the game server group
|
5653
|
-
#
|
5883
|
+
# An identifier for the game server group to retrieve a list of game
|
5884
|
+
# servers from. Use either the GameServerGroup name or ARN value.
|
5654
5885
|
#
|
5655
5886
|
# @option params [String] :sort_order
|
5656
|
-
# Indicates how to sort the returned data based on
|
5657
|
-
#
|
5658
|
-
#
|
5887
|
+
# Indicates how to sort the returned data based on game server
|
5888
|
+
# registration timestamp. Use ASCENDING to retrieve oldest game servers
|
5889
|
+
# first, or use DESCENDING to retrieve newest game servers first. If
|
5890
|
+
# this parameter is left empty, game servers are returned in no
|
5891
|
+
# particular order.
|
5659
5892
|
#
|
5660
5893
|
# @option params [Integer] :limit
|
5661
5894
|
# The maximum number of results to return. Use this parameter with
|
5662
|
-
# `NextToken` to get results as a set of sequential
|
5895
|
+
# `NextToken` to get results as a set of sequential segments.
|
5663
5896
|
#
|
5664
5897
|
# @option params [String] :next_token
|
5665
|
-
# A token that indicates the start of the next sequential
|
5666
|
-
# results. Use the token
|
5667
|
-
#
|
5668
|
-
# value.
|
5898
|
+
# A token that indicates the start of the next sequential segment of
|
5899
|
+
# results. Use the token returned with the previous call to this
|
5900
|
+
# operation. To start at the beginning of the result set, do not specify
|
5901
|
+
# a value.
|
5669
5902
|
#
|
5670
5903
|
# @return [Types::ListGameServersOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5671
5904
|
#
|
5672
5905
|
# * {Types::ListGameServersOutput#game_servers #game_servers} => Array<Types::GameServer>
|
5673
5906
|
# * {Types::ListGameServersOutput#next_token #next_token} => String
|
5674
5907
|
#
|
5908
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5909
|
+
#
|
5675
5910
|
# @example Request syntax with placeholder values
|
5676
5911
|
#
|
5677
5912
|
# resp = client.list_game_servers({
|
@@ -5690,7 +5925,6 @@ module Aws::GameLift
|
|
5690
5925
|
# resp.game_servers[0].instance_id #=> String
|
5691
5926
|
# resp.game_servers[0].connection_info #=> String
|
5692
5927
|
# resp.game_servers[0].game_server_data #=> String
|
5693
|
-
# resp.game_servers[0].custom_sort_key #=> String
|
5694
5928
|
# resp.game_servers[0].claim_status #=> String, one of "CLAIMED"
|
5695
5929
|
# resp.game_servers[0].utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
|
5696
5930
|
# resp.game_servers[0].registration_time #=> Time
|
@@ -5737,14 +5971,16 @@ module Aws::GameLift
|
|
5737
5971
|
# @option params [String] :next_token
|
5738
5972
|
# A token that indicates the start of the next sequential page of
|
5739
5973
|
# results. Use the token that is returned with a previous call to this
|
5740
|
-
#
|
5741
|
-
# value.
|
5974
|
+
# operation. To start at the beginning of the result set, do not specify
|
5975
|
+
# a value.
|
5742
5976
|
#
|
5743
5977
|
# @return [Types::ListScriptsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5744
5978
|
#
|
5745
5979
|
# * {Types::ListScriptsOutput#scripts #scripts} => Array<Types::Script>
|
5746
5980
|
# * {Types::ListScriptsOutput#next_token #next_token} => String
|
5747
5981
|
#
|
5982
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
5983
|
+
#
|
5748
5984
|
# @example Request syntax with placeholder values
|
5749
5985
|
#
|
5750
5986
|
# resp = client.list_scripts({
|
@@ -5778,7 +6014,7 @@ module Aws::GameLift
|
|
5778
6014
|
|
5779
6015
|
# Retrieves all tags that are assigned to a GameLift resource. Resource
|
5780
6016
|
# tags are used to organize AWS resources for a range of purposes. This
|
5781
|
-
#
|
6017
|
+
# operation handles the permissions necessary to manage tags for the
|
5782
6018
|
# following GameLift resource types:
|
5783
6019
|
#
|
5784
6020
|
# * Build
|
@@ -5821,8 +6057,8 @@ module Aws::GameLift
|
|
5821
6057
|
# The Amazon Resource Name ([ARN][1]) that is assigned to and uniquely
|
5822
6058
|
# identifies the GameLift resource that you want to retrieve tags for.
|
5823
6059
|
# GameLift resource ARNs are included in the data object for the
|
5824
|
-
# resource, which can be retrieved by calling a List or Describe
|
5825
|
-
# for the resource type.
|
6060
|
+
# resource, which can be retrieved by calling a List or Describe
|
6061
|
+
# operation for the resource type.
|
5826
6062
|
#
|
5827
6063
|
#
|
5828
6064
|
#
|
@@ -6090,26 +6326,26 @@ module Aws::GameLift
|
|
6090
6326
|
req.send_request(options)
|
6091
6327
|
end
|
6092
6328
|
|
6093
|
-
# **This
|
6094
|
-
#
|
6329
|
+
# **This operation is used with the Amazon GameLift FleetIQ solution and
|
6330
|
+
# game server groups.**
|
6095
6331
|
#
|
6096
6332
|
# Creates a new game server resource and notifies GameLift FleetIQ that
|
6097
|
-
# the game server is ready to host gameplay and players. This
|
6098
|
-
# called by a game server process that is running on an instance in a
|
6333
|
+
# the game server is ready to host gameplay and players. This operation
|
6334
|
+
# is called by a game server process that is running on an instance in a
|
6099
6335
|
# game server group. Registering game servers enables GameLift FleetIQ
|
6100
6336
|
# to track available game servers and enables game clients and services
|
6101
6337
|
# to claim a game server for a new game session.
|
6102
6338
|
#
|
6103
6339
|
# To register a game server, identify the game server group and instance
|
6104
6340
|
# where the game server is running, and provide a unique identifier for
|
6105
|
-
# the game server. You can also include connection and game server data
|
6106
|
-
#
|
6107
|
-
# ClaimGameServer, this information is returned in response.
|
6341
|
+
# the game server. You can also include connection and game server data.
|
6342
|
+
# When a game client or service requests a game server by calling
|
6343
|
+
# ClaimGameServer, this information is returned in the response.
|
6108
6344
|
#
|
6109
6345
|
# Once a game server is successfully registered, it is put in status
|
6110
|
-
# AVAILABLE
|
6111
|
-
# instance it is in the process of shutting down as part
|
6112
|
-
#
|
6346
|
+
# `AVAILABLE`. A request to register a game server may fail if the
|
6347
|
+
# instance it is running on is in the process of shutting down as part
|
6348
|
+
# of instance balancing or scale-down activity.
|
6113
6349
|
#
|
6114
6350
|
# **Learn more**
|
6115
6351
|
#
|
@@ -6131,51 +6367,33 @@ module Aws::GameLift
|
|
6131
6367
|
#
|
6132
6368
|
#
|
6133
6369
|
#
|
6134
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
6370
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
6135
6371
|
#
|
6136
6372
|
# @option params [required, String] :game_server_group_name
|
6137
|
-
#
|
6138
|
-
# running.
|
6373
|
+
# A unique identifier for the game server group where the game server is
|
6374
|
+
# running. Use either the GameServerGroup name or ARN value.
|
6139
6375
|
#
|
6140
6376
|
# @option params [required, String] :game_server_id
|
6141
|
-
# A custom string that uniquely identifies the
|
6142
|
-
# server IDs are developer-defined and must be unique across all
|
6143
|
-
# server groups in your AWS account.
|
6377
|
+
# A custom string that uniquely identifies the game server to register.
|
6378
|
+
# Game server IDs are developer-defined and must be unique across all
|
6379
|
+
# game server groups in your AWS account.
|
6144
6380
|
#
|
6145
6381
|
# @option params [required, String] :instance_id
|
6146
6382
|
# The unique identifier for the instance where the game server is
|
6147
|
-
# running. This ID is available in the instance metadata.
|
6383
|
+
# running. This ID is available in the instance metadata. EC2 instance
|
6384
|
+
# IDs use a 17-character format, for example: `i-1234567890abcdef0`.
|
6148
6385
|
#
|
6149
6386
|
# @option params [String] :connection_info
|
6150
|
-
# Information needed to make inbound client connections to the
|
6151
|
-
# server. This might include IP address and port, DNS name,
|
6387
|
+
# Information that is needed to make inbound client connections to the
|
6388
|
+
# game server. This might include the IP address and port, DNS name, and
|
6389
|
+
# other information.
|
6152
6390
|
#
|
6153
6391
|
# @option params [String] :game_server_data
|
6154
6392
|
# A set of custom game server properties, formatted as a single string
|
6155
6393
|
# value. This data is passed to a game client or service when it
|
6156
|
-
# requests information on
|
6394
|
+
# requests information on game servers using ListGameServers or
|
6157
6395
|
# ClaimGameServer.
|
6158
6396
|
#
|
6159
|
-
# @option params [String] :custom_sort_key
|
6160
|
-
# A game server tag that can be used to request sorted lists of game
|
6161
|
-
# servers using ListGameServers. Custom sort keys are developer-defined
|
6162
|
-
# based on how you want to organize the retrieved game server
|
6163
|
-
# information.
|
6164
|
-
#
|
6165
|
-
# @option params [Array<Types::Tag>] :tags
|
6166
|
-
# A list of labels to assign to the new game server resource. Tags are
|
6167
|
-
# developer-defined key-value pairs. Tagging AWS resources are useful
|
6168
|
-
# for resource management, access management, and cost allocation. For
|
6169
|
-
# more information, see [ Tagging AWS Resources][1] in the *AWS General
|
6170
|
-
# Reference*. Once the resource is created, you can use TagResource,
|
6171
|
-
# UntagResource, and ListTagsForResource to add, remove, and view tags.
|
6172
|
-
# The maximum tag limit may be lower than stated. See the AWS General
|
6173
|
-
# Reference for actual tagging limits.
|
6174
|
-
#
|
6175
|
-
#
|
6176
|
-
#
|
6177
|
-
# [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
|
6178
|
-
#
|
6179
6397
|
# @return [Types::RegisterGameServerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6180
6398
|
#
|
6181
6399
|
# * {Types::RegisterGameServerOutput#game_server #game_server} => Types::GameServer
|
@@ -6188,13 +6406,6 @@ module Aws::GameLift
|
|
6188
6406
|
# instance_id: "GameServerInstanceId", # required
|
6189
6407
|
# connection_info: "GameServerConnectionInfo",
|
6190
6408
|
# game_server_data: "GameServerData",
|
6191
|
-
# custom_sort_key: "GameServerSortKey",
|
6192
|
-
# tags: [
|
6193
|
-
# {
|
6194
|
-
# key: "TagKey", # required
|
6195
|
-
# value: "TagValue", # required
|
6196
|
-
# },
|
6197
|
-
# ],
|
6198
6409
|
# })
|
6199
6410
|
#
|
6200
6411
|
# @example Response structure
|
@@ -6205,7 +6416,6 @@ module Aws::GameLift
|
|
6205
6416
|
# resp.game_server.instance_id #=> String
|
6206
6417
|
# resp.game_server.connection_info #=> String
|
6207
6418
|
# resp.game_server.game_server_data #=> String
|
6208
|
-
# resp.game_server.custom_sort_key #=> String
|
6209
6419
|
# resp.game_server.claim_status #=> String, one of "CLAIMED"
|
6210
6420
|
# resp.game_server.utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
|
6211
6421
|
# resp.game_server.registration_time #=> Time
|
@@ -6327,19 +6537,21 @@ module Aws::GameLift
|
|
6327
6537
|
req.send_request(options)
|
6328
6538
|
end
|
6329
6539
|
|
6330
|
-
# **This
|
6331
|
-
#
|
6540
|
+
# **This operation is used with the Amazon GameLift FleetIQ solution and
|
6541
|
+
# game server groups.**
|
6332
6542
|
#
|
6333
6543
|
# Reinstates activity on a game server group after it has been
|
6334
|
-
# suspended. A game server group
|
6335
|
-
#
|
6336
|
-
# due to a configuration problem.
|
6337
|
-
# the group once the configuration
|
6338
|
-
# the game server group status and
|
6339
|
-
# why group activity is suspended.
|
6544
|
+
# suspended. A game server group might be suspended by
|
6545
|
+
# theSuspendGameServerGroup operation, or it might be suspended
|
6546
|
+
# involuntarily due to a configuration problem. In the second case, you
|
6547
|
+
# can manually resume activity on the group once the configuration
|
6548
|
+
# problem has been resolved. Refer to the game server group status and
|
6549
|
+
# status reason for more information on why group activity is suspended.
|
6340
6550
|
#
|
6341
6551
|
# To resume activity, specify a game server group ARN and the type of
|
6342
|
-
# activity to be resumed.
|
6552
|
+
# activity to be resumed. If successful, a GameServerGroup object is
|
6553
|
+
# returned showing that the resumed activity is no longer listed in
|
6554
|
+
# `SuspendedActions`.
|
6343
6555
|
#
|
6344
6556
|
# **Learn more**
|
6345
6557
|
#
|
@@ -6361,16 +6573,18 @@ module Aws::GameLift
|
|
6361
6573
|
#
|
6362
6574
|
# * SuspendGameServerGroup
|
6363
6575
|
#
|
6576
|
+
# * DescribeGameServerInstances
|
6577
|
+
#
|
6364
6578
|
#
|
6365
6579
|
#
|
6366
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
6580
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
6367
6581
|
#
|
6368
6582
|
# @option params [required, String] :game_server_group_name
|
6369
|
-
#
|
6370
|
-
#
|
6583
|
+
# A unique identifier for the game server group. Use either the
|
6584
|
+
# GameServerGroup name or ARN value.
|
6371
6585
|
#
|
6372
6586
|
# @option params [required, Array<String>] :resume_actions
|
6373
|
-
# The
|
6587
|
+
# The activity to resume for this game server group.
|
6374
6588
|
#
|
6375
6589
|
# @return [Types::ResumeGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6376
6590
|
#
|
@@ -6391,7 +6605,7 @@ module Aws::GameLift
|
|
6391
6605
|
# resp.game_server_group.instance_definitions #=> Array
|
6392
6606
|
# resp.game_server_group.instance_definitions[0].instance_type #=> String, one of "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge"
|
6393
6607
|
# resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
|
6394
|
-
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED"
|
6608
|
+
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED", "ON_DEMAND_ONLY"
|
6395
6609
|
# resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
|
6396
6610
|
# resp.game_server_group.auto_scaling_group_arn #=> String
|
6397
6611
|
# resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
|
@@ -6570,14 +6784,16 @@ module Aws::GameLift
|
|
6570
6784
|
#
|
6571
6785
|
# @option params [String] :next_token
|
6572
6786
|
# Token that indicates the start of the next sequential page of results.
|
6573
|
-
# Use the token that is returned with a previous call to this
|
6574
|
-
# start at the beginning of the result set, do not specify a value.
|
6787
|
+
# Use the token that is returned with a previous call to this operation.
|
6788
|
+
# To start at the beginning of the result set, do not specify a value.
|
6575
6789
|
#
|
6576
6790
|
# @return [Types::SearchGameSessionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6577
6791
|
#
|
6578
6792
|
# * {Types::SearchGameSessionsOutput#game_sessions #game_sessions} => Array<Types::GameSession>
|
6579
6793
|
# * {Types::SearchGameSessionsOutput#next_token #next_token} => String
|
6580
6794
|
#
|
6795
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
6796
|
+
#
|
6581
6797
|
# @example Request syntax with placeholder values
|
6582
6798
|
#
|
6583
6799
|
# resp = client.search_game_sessions({
|
@@ -6910,8 +7126,8 @@ module Aws::GameLift
|
|
6910
7126
|
#
|
6911
7127
|
#
|
6912
7128
|
#
|
6913
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
6914
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/
|
7129
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html
|
7130
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html
|
6915
7131
|
#
|
6916
7132
|
# @option params [String] :ticket_id
|
6917
7133
|
# A unique identifier for a matchmaking ticket. If no ticket ID is
|
@@ -6925,7 +7141,7 @@ module Aws::GameLift
|
|
6925
7141
|
# used with the original game session is listed in the GameSession
|
6926
7142
|
# object, `MatchmakerData` property.
|
6927
7143
|
#
|
6928
|
-
# @option params [
|
7144
|
+
# @option params [String] :game_session_arn
|
6929
7145
|
# Amazon Resource Name ([ARN][1]) that is assigned to a game session and
|
6930
7146
|
# uniquely identifies it. This is the same as the game session ID.
|
6931
7147
|
#
|
@@ -6950,7 +7166,7 @@ module Aws::GameLift
|
|
6950
7166
|
#
|
6951
7167
|
#
|
6952
7168
|
#
|
6953
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
7169
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data
|
6954
7170
|
#
|
6955
7171
|
# @return [Types::StartMatchBackfillOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
6956
7172
|
#
|
@@ -6961,7 +7177,7 @@ module Aws::GameLift
|
|
6961
7177
|
# resp = client.start_match_backfill({
|
6962
7178
|
# ticket_id: "MatchmakingIdStringModel",
|
6963
7179
|
# configuration_name: "MatchmakingConfigurationName", # required
|
6964
|
-
# game_session_arn: "ArnStringModel",
|
7180
|
+
# game_session_arn: "ArnStringModel",
|
6965
7181
|
# players: [ # required
|
6966
7182
|
# {
|
6967
7183
|
# player_id: "NonZeroAndMaxString",
|
@@ -7012,71 +7228,27 @@ module Aws::GameLift
|
|
7012
7228
|
end
|
7013
7229
|
|
7014
7230
|
# Uses FlexMatch to create a game match for a group of players based on
|
7015
|
-
# custom matchmaking rules
|
7016
|
-
#
|
7017
|
-
#
|
7018
|
-
#
|
7019
|
-
#
|
7020
|
-
#
|
7021
|
-
#
|
7022
|
-
#
|
7023
|
-
# session are defined in a `MatchmakingConfiguration`.
|
7231
|
+
# custom matchmaking rules. If you're also using GameLift hosting, a
|
7232
|
+
# new game session is started for the matched players. Each matchmaking
|
7233
|
+
# request identifies one or more players to find a match for, and
|
7234
|
+
# specifies the type of match to build, including the team configuration
|
7235
|
+
# and the rules for an acceptable match. When a matchmaking request
|
7236
|
+
# identifies a group of players who want to play together, FlexMatch
|
7237
|
+
# finds additional players to fill the match. Match type, rules, and
|
7238
|
+
# other features are defined in a `MatchmakingConfiguration`.
|
7024
7239
|
#
|
7025
7240
|
# To start matchmaking, provide a unique ticket ID, specify a
|
7026
|
-
# matchmaking configuration, and include the players to be matched.
|
7027
|
-
# must also include
|
7028
|
-
# matchmaking configuration
|
7029
|
-
#
|
7030
|
-
#
|
7031
|
-
#
|
7032
|
-
#
|
7033
|
-
#
|
7034
|
-
#
|
7035
|
-
#
|
7036
|
-
#
|
7037
|
-
# full ticket object, including current status and (for completed
|
7038
|
-
# tickets) game session connection info. We recommend polling no more
|
7039
|
-
# than once every 10 seconds.
|
7040
|
-
#
|
7041
|
-
# * Notifications -- Get event notifications for changes in ticket
|
7042
|
-
# status using Amazon Simple Notification Service (SNS). Notifications
|
7043
|
-
# are easy to set up (see CreateMatchmakingConfiguration) and
|
7044
|
-
# typically deliver match status changes faster and more efficiently
|
7045
|
-
# than polling. We recommend that you use polling to back up to
|
7046
|
-
# notifications (since delivery is not guaranteed) and call
|
7047
|
-
# `DescribeMatchmaking` only when notifications are not received
|
7048
|
-
# within 30 seconds.
|
7049
|
-
#
|
7050
|
-
# **Processing a matchmaking request** -- FlexMatch handles a
|
7051
|
-
# matchmaking request as follows:
|
7052
|
-
#
|
7053
|
-
# 1. Your client code submits a `StartMatchmaking` request for one or
|
7054
|
-
# more players and tracks the status of the request ticket.
|
7055
|
-
#
|
7056
|
-
# 2. FlexMatch uses this ticket and others in process to build an
|
7057
|
-
# acceptable match. When a potential match is identified, all
|
7058
|
-
# tickets in the proposed match are advanced to the next status.
|
7059
|
-
#
|
7060
|
-
# 3. If the match requires player acceptance (set in the matchmaking
|
7061
|
-
# configuration), the tickets move into status
|
7062
|
-
# `REQUIRES_ACCEPTANCE`. This status triggers your client code to
|
7063
|
-
# solicit acceptance from all players in every ticket involved in
|
7064
|
-
# the match, and then call AcceptMatch for each player. If any
|
7065
|
-
# player rejects or fails to accept the match before a specified
|
7066
|
-
# timeout, the proposed match is dropped (see `AcceptMatch` for more
|
7067
|
-
# details).
|
7068
|
-
#
|
7069
|
-
# 4. Once a match is proposed and accepted, the matchmaking tickets
|
7070
|
-
# move into status `PLACING`. FlexMatch locates resources for a new
|
7071
|
-
# game session using the game session queue (set in the matchmaking
|
7072
|
-
# configuration) and creates the game session based on the match
|
7073
|
-
# data.
|
7074
|
-
#
|
7075
|
-
# 5. When the match is successfully placed, the matchmaking tickets
|
7076
|
-
# move into `COMPLETED` status. Connection information (including
|
7077
|
-
# game session endpoint and player session) is added to the
|
7078
|
-
# matchmaking tickets. Matched players can use the connection
|
7079
|
-
# information to join the game.
|
7241
|
+
# matchmaking configuration, and include the players to be matched. For
|
7242
|
+
# each player, you must also include the player attribute values that
|
7243
|
+
# are required by the matchmaking configuration (in the rule set). If
|
7244
|
+
# successful, a matchmaking ticket is returned with status set to
|
7245
|
+
# `QUEUED`.
|
7246
|
+
#
|
7247
|
+
# Track the status of the ticket to respond as needed. If you're also
|
7248
|
+
# using GameLift hosting, a successfully completed ticket contains game
|
7249
|
+
# session connection information. Ticket status updates are tracked
|
7250
|
+
# using event notification through Amazon Simple Notification Service
|
7251
|
+
# (SNS), which is defined in the matchmaking configuration.
|
7080
7252
|
#
|
7081
7253
|
# **Learn more**
|
7082
7254
|
#
|
@@ -7102,10 +7274,10 @@ module Aws::GameLift
|
|
7102
7274
|
#
|
7103
7275
|
#
|
7104
7276
|
#
|
7105
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
7106
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/
|
7107
|
-
# [3]: https://docs.aws.amazon.com/gamelift/latest/
|
7108
|
-
# [4]: https://docs.aws.amazon.com/gamelift/latest/
|
7277
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html
|
7278
|
+
# [2]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html
|
7279
|
+
# [3]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-tasks.html
|
7280
|
+
# [4]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/gamelift-match.html
|
7109
7281
|
#
|
7110
7282
|
# @option params [String] :ticket_id
|
7111
7283
|
# A unique identifier for a matchmaking ticket. If no ticket ID is
|
@@ -7326,7 +7498,7 @@ module Aws::GameLift
|
|
7326
7498
|
# The ticket ID is included in the `MatchmakerData` of an updated game
|
7327
7499
|
# session object, which is provided to the game server.
|
7328
7500
|
#
|
7329
|
-
# <note markdown="1"> If the
|
7501
|
+
# <note markdown="1"> If the operation is successful, the service sends back an empty JSON
|
7330
7502
|
# struct with the HTTP 200 response (not an empty HTTP body).
|
7331
7503
|
#
|
7332
7504
|
# </note>
|
@@ -7349,7 +7521,7 @@ module Aws::GameLift
|
|
7349
7521
|
#
|
7350
7522
|
#
|
7351
7523
|
#
|
7352
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
7524
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html
|
7353
7525
|
#
|
7354
7526
|
# @option params [required, String] :ticket_id
|
7355
7527
|
# A unique identifier for a matchmaking ticket.
|
@@ -7371,27 +7543,28 @@ module Aws::GameLift
|
|
7371
7543
|
req.send_request(options)
|
7372
7544
|
end
|
7373
7545
|
|
7374
|
-
# **This
|
7375
|
-
#
|
7546
|
+
# **This operation is used with the Amazon GameLift FleetIQ solution and
|
7547
|
+
# game server groups.**
|
7376
7548
|
#
|
7377
7549
|
# Temporarily stops activity on a game server group without terminating
|
7378
|
-
# instances or the game server group.
|
7379
|
-
# calling ResumeGameServerGroup.
|
7380
|
-
#
|
7381
|
-
# * Instance type replacement
|
7382
|
-
# viability of all instance types that are defined
|
7383
|
-
# group. It updates the Auto Scaling group to
|
7384
|
-
#
|
7385
|
-
# interruptions
|
7386
|
-
# Spot
|
7387
|
-
# Scaling group continues with its current
|
7388
|
-
# viability. Instance protection, utilization
|
7389
|
-
#
|
7550
|
+
# instances or the game server group. You can restart activity by
|
7551
|
+
# calling ResumeGameServerGroup. You can suspend the following activity:
|
7552
|
+
#
|
7553
|
+
# * **Instance type replacement** - This activity evaluates the current
|
7554
|
+
# game hosting viability of all Spot instance types that are defined
|
7555
|
+
# for the game server group. It updates the Auto Scaling group to
|
7556
|
+
# remove nonviable Spot Instance types, which have a higher chance of
|
7557
|
+
# game server interruptions. It then balances capacity across the
|
7558
|
+
# remaining viable Spot Instance types. When this activity is
|
7559
|
+
# suspended, the Auto Scaling group continues with its current
|
7560
|
+
# balance, regardless of viability. Instance protection, utilization
|
7561
|
+
# metrics, and capacity scaling activities continue to be active.
|
7390
7562
|
#
|
7391
7563
|
# ^
|
7392
7564
|
#
|
7393
7565
|
# To suspend activity, specify a game server group ARN and the type of
|
7394
|
-
# activity to be suspended.
|
7566
|
+
# activity to be suspended. If successful, a GameServerGroup object is
|
7567
|
+
# returned showing that the activity is listed in `SuspendedActions`.
|
7395
7568
|
#
|
7396
7569
|
# **Learn more**
|
7397
7570
|
#
|
@@ -7413,16 +7586,18 @@ module Aws::GameLift
|
|
7413
7586
|
#
|
7414
7587
|
# * SuspendGameServerGroup
|
7415
7588
|
#
|
7589
|
+
# * DescribeGameServerInstances
|
7590
|
+
#
|
7416
7591
|
#
|
7417
7592
|
#
|
7418
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
7593
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
7419
7594
|
#
|
7420
7595
|
# @option params [required, String] :game_server_group_name
|
7421
|
-
#
|
7422
|
-
#
|
7596
|
+
# A unique identifier for the game server group. Use either the
|
7597
|
+
# GameServerGroup name or ARN value.
|
7423
7598
|
#
|
7424
7599
|
# @option params [required, Array<String>] :suspend_actions
|
7425
|
-
# The
|
7600
|
+
# The activity to suspend for this game server group.
|
7426
7601
|
#
|
7427
7602
|
# @return [Types::SuspendGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
7428
7603
|
#
|
@@ -7443,7 +7618,7 @@ module Aws::GameLift
|
|
7443
7618
|
# resp.game_server_group.instance_definitions #=> Array
|
7444
7619
|
# resp.game_server_group.instance_definitions[0].instance_type #=> String, one of "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge"
|
7445
7620
|
# resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
|
7446
|
-
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED"
|
7621
|
+
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED", "ON_DEMAND_ONLY"
|
7447
7622
|
# resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
|
7448
7623
|
# resp.game_server_group.auto_scaling_group_arn #=> String
|
7449
7624
|
# resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
|
@@ -7465,9 +7640,9 @@ module Aws::GameLift
|
|
7465
7640
|
# Assigns a tag to a GameLift resource. AWS resource tags provide an
|
7466
7641
|
# additional management tool set. You can use tags to organize
|
7467
7642
|
# resources, create IAM permissions policies to manage access to groups
|
7468
|
-
# of resources, customize AWS cost breakdowns, etc. This
|
7469
|
-
# the permissions necessary to manage tags for the following
|
7470
|
-
# resource types:
|
7643
|
+
# of resources, customize AWS cost breakdowns, etc. This operation
|
7644
|
+
# handles the permissions necessary to manage tags for the following
|
7645
|
+
# GameLift resource types:
|
7471
7646
|
#
|
7472
7647
|
# * Build
|
7473
7648
|
#
|
@@ -7511,8 +7686,8 @@ module Aws::GameLift
|
|
7511
7686
|
# The Amazon Resource Name ([ARN][1]) that is assigned to and uniquely
|
7512
7687
|
# identifies the GameLift resource that you want to assign tags to.
|
7513
7688
|
# GameLift resource ARNs are included in the data object for the
|
7514
|
-
# resource, which can be retrieved by calling a List or Describe
|
7515
|
-
# for the resource type.
|
7689
|
+
# resource, which can be retrieved by calling a List or Describe
|
7690
|
+
# operation for the resource type.
|
7516
7691
|
#
|
7517
7692
|
#
|
7518
7693
|
#
|
@@ -7553,7 +7728,7 @@ module Aws::GameLift
|
|
7553
7728
|
|
7554
7729
|
# Removes a tag that is assigned to a GameLift resource. Resource tags
|
7555
7730
|
# are used to organize AWS resources for a range of purposes. This
|
7556
|
-
#
|
7731
|
+
# operation handles the permissions necessary to manage tags for the
|
7557
7732
|
# following GameLift resource types:
|
7558
7733
|
#
|
7559
7734
|
# * Build
|
@@ -7572,8 +7747,8 @@ module Aws::GameLift
|
|
7572
7747
|
#
|
7573
7748
|
# To remove a tag from a resource, specify the unique ARN value for the
|
7574
7749
|
# resource and provide a string list containing one or more tags to be
|
7575
|
-
# removed. This
|
7576
|
-
# not currently assigned to the specified resource.
|
7750
|
+
# removed. This operation succeeds even if the list includes tags that
|
7751
|
+
# are not currently assigned to the specified resource.
|
7577
7752
|
#
|
7578
7753
|
# **Learn more**
|
7579
7754
|
#
|
@@ -7598,8 +7773,8 @@ module Aws::GameLift
|
|
7598
7773
|
# The Amazon Resource Name ([ARN][1]) that is assigned to and uniquely
|
7599
7774
|
# identifies the GameLift resource that you want to remove tags from.
|
7600
7775
|
# GameLift resource ARNs are included in the data object for the
|
7601
|
-
# resource, which can be retrieved by calling a List or Describe
|
7602
|
-
# for the resource type.
|
7776
|
+
# resource, which can be retrieved by calling a List or Describe
|
7777
|
+
# operation for the resource type.
|
7603
7778
|
#
|
7604
7779
|
#
|
7605
7780
|
#
|
@@ -7866,9 +8041,9 @@ module Aws::GameLift
|
|
7866
8041
|
req.send_request(options)
|
7867
8042
|
end
|
7868
8043
|
|
7869
|
-
# Updates capacity settings for a fleet. Use this
|
7870
|
-
# number of EC2 instances (hosts) that you want this fleet to
|
7871
|
-
# Before calling this
|
8044
|
+
# Updates capacity settings for a fleet. Use this operation to specify
|
8045
|
+
# the number of EC2 instances (hosts) that you want this fleet to
|
8046
|
+
# contain. Before calling this operation, you may want to call
|
7872
8047
|
# DescribeEC2InstanceLimits to get the maximum capacity based on the
|
7873
8048
|
# fleet's EC2 instance type.
|
7874
8049
|
#
|
@@ -8044,18 +8219,17 @@ module Aws::GameLift
|
|
8044
8219
|
req.send_request(options)
|
8045
8220
|
end
|
8046
8221
|
|
8047
|
-
# **This
|
8048
|
-
#
|
8049
|
-
#
|
8050
|
-
# Updates information about a registered game server
|
8051
|
-
#
|
8052
|
-
# game server
|
8053
|
-
#
|
8054
|
-
#
|
8055
|
-
#
|
8056
|
-
#
|
8057
|
-
#
|
8058
|
-
# You can make all three types of updates in the same request.
|
8222
|
+
# **This operation is used with the Amazon GameLift FleetIQ solution and
|
8223
|
+
# game server groups.**
|
8224
|
+
#
|
8225
|
+
# Updates information about a registered game server to help GameLift
|
8226
|
+
# FleetIQ to track game server availability. This operation is called by
|
8227
|
+
# a game server process that is running on an instance in a game server
|
8228
|
+
# group.
|
8229
|
+
#
|
8230
|
+
# Use this operation to update the following types of game server
|
8231
|
+
# information. You can make all three types of updates in the same
|
8232
|
+
# request:
|
8059
8233
|
#
|
8060
8234
|
# * To update the game server's utilization status, identify the game
|
8061
8235
|
# server and game server group and specify the current utilization
|
@@ -8063,14 +8237,14 @@ module Aws::GameLift
|
|
8063
8237
|
# hosting games and when they are available to be claimed.
|
8064
8238
|
#
|
8065
8239
|
# * To report health status, identify the game server and game server
|
8066
|
-
# group and set health check to HEALTHY
|
8240
|
+
# group and set health check to `HEALTHY`. If a game server does not
|
8067
8241
|
# report health status for a certain length of time, the game server
|
8068
|
-
# is no longer considered healthy
|
8069
|
-
# from the game server group to avoid affecting
|
8070
|
-
# The best practice is to report health every 60
|
8242
|
+
# is no longer considered healthy. As a result, it will be eventually
|
8243
|
+
# deregistered from the game server group to avoid affecting
|
8244
|
+
# utilization metrics. The best practice is to report health every 60
|
8245
|
+
# seconds.
|
8071
8246
|
#
|
8072
|
-
# * To change game server metadata, provide updated game server data
|
8073
|
-
# custom sort key values.
|
8247
|
+
# * To change game server metadata, provide updated game server data.
|
8074
8248
|
#
|
8075
8249
|
# Once a game server is successfully updated, the relevant statuses and
|
8076
8250
|
# timestamps are updated.
|
@@ -8095,35 +8269,29 @@ module Aws::GameLift
|
|
8095
8269
|
#
|
8096
8270
|
#
|
8097
8271
|
#
|
8098
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
8272
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
8099
8273
|
#
|
8100
8274
|
# @option params [required, String] :game_server_group_name
|
8101
|
-
#
|
8275
|
+
# A unique identifier for the game server group where the game server is
|
8102
8276
|
# running. Use either the GameServerGroup name or ARN value.
|
8103
8277
|
#
|
8104
8278
|
# @option params [required, String] :game_server_id
|
8105
|
-
#
|
8279
|
+
# A custom string that uniquely identifies the game server to update.
|
8106
8280
|
#
|
8107
8281
|
# @option params [String] :game_server_data
|
8108
8282
|
# A set of custom game server properties, formatted as a single string
|
8109
8283
|
# value. This data is passed to a game client or service when it
|
8110
|
-
# requests information on
|
8284
|
+
# requests information on game servers using ListGameServers or
|
8111
8285
|
# ClaimGameServer.
|
8112
8286
|
#
|
8113
|
-
# @option params [String] :custom_sort_key
|
8114
|
-
# A game server tag that can be used to request sorted lists of game
|
8115
|
-
# servers using ListGameServers. Custom sort keys are developer-defined
|
8116
|
-
# based on how you want to organize the retrieved game server
|
8117
|
-
# information.
|
8118
|
-
#
|
8119
8287
|
# @option params [String] :utilization_status
|
8120
8288
|
# Indicates whether the game server is available or is currently hosting
|
8121
8289
|
# gameplay.
|
8122
8290
|
#
|
8123
8291
|
# @option params [String] :health_check
|
8124
|
-
# Indicates health status of the game server.
|
8125
|
-
#
|
8126
|
-
#
|
8292
|
+
# Indicates health status of the game server. A request that includes
|
8293
|
+
# this parameter updates the game server's *LastHealthCheckTime*
|
8294
|
+
# timestamp.
|
8127
8295
|
#
|
8128
8296
|
# @return [Types::UpdateGameServerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8129
8297
|
#
|
@@ -8135,7 +8303,6 @@ module Aws::GameLift
|
|
8135
8303
|
# game_server_group_name: "GameServerGroupNameOrArn", # required
|
8136
8304
|
# game_server_id: "GameServerId", # required
|
8137
8305
|
# game_server_data: "GameServerData",
|
8138
|
-
# custom_sort_key: "GameServerSortKey",
|
8139
8306
|
# utilization_status: "AVAILABLE", # accepts AVAILABLE, UTILIZED
|
8140
8307
|
# health_check: "HEALTHY", # accepts HEALTHY
|
8141
8308
|
# })
|
@@ -8148,7 +8315,6 @@ module Aws::GameLift
|
|
8148
8315
|
# resp.game_server.instance_id #=> String
|
8149
8316
|
# resp.game_server.connection_info #=> String
|
8150
8317
|
# resp.game_server.game_server_data #=> String
|
8151
|
-
# resp.game_server.custom_sort_key #=> String
|
8152
8318
|
# resp.game_server.claim_status #=> String, one of "CLAIMED"
|
8153
8319
|
# resp.game_server.utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
|
8154
8320
|
# resp.game_server.registration_time #=> Time
|
@@ -8164,29 +8330,24 @@ module Aws::GameLift
|
|
8164
8330
|
req.send_request(options)
|
8165
8331
|
end
|
8166
8332
|
|
8167
|
-
# **This
|
8168
|
-
#
|
8333
|
+
# **This operation is used with the Amazon GameLift FleetIQ solution and
|
8334
|
+
# game server groups.**
|
8169
8335
|
#
|
8170
8336
|
# Updates GameLift FleetIQ-specific properties for a game server group.
|
8171
|
-
#
|
8172
|
-
#
|
8173
|
-
#
|
8174
|
-
# counts, and launch template.
|
8337
|
+
# Many Auto Scaling group properties are updated on the Auto Scaling
|
8338
|
+
# group directly, including the launch template, Auto Scaling policies,
|
8339
|
+
# and maximum/minimum/desired instance counts.
|
8175
8340
|
#
|
8176
8341
|
# To update the game server group, specify the game server group ID and
|
8177
|
-
# provide the updated values.
|
8178
|
-
#
|
8179
|
-
#
|
8180
|
-
#
|
8181
|
-
# change Auto Scaling group properties directly and the changes cause
|
8182
|
-
# errors with GameLift FleetIQ activities, an alert is sent.
|
8342
|
+
# provide the updated values. Before applying the updates, the new
|
8343
|
+
# values are validated to ensure that GameLift FleetIQ can continue to
|
8344
|
+
# perform instance balancing activity. If successful, a GameServerGroup
|
8345
|
+
# object is returned.
|
8183
8346
|
#
|
8184
8347
|
# **Learn more**
|
8185
8348
|
#
|
8186
8349
|
# [GameLift FleetIQ Guide][1]
|
8187
8350
|
#
|
8188
|
-
# [Updating a GameLift FleetIQ-Linked Auto Scaling Group][2]
|
8189
|
-
#
|
8190
8351
|
# **Related operations**
|
8191
8352
|
#
|
8192
8353
|
# * CreateGameServerGroup
|
@@ -8203,64 +8364,75 @@ module Aws::GameLift
|
|
8203
8364
|
#
|
8204
8365
|
# * SuspendGameServerGroup
|
8205
8366
|
#
|
8367
|
+
# * DescribeGameServerInstances
|
8368
|
+
#
|
8206
8369
|
#
|
8207
8370
|
#
|
8208
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
8209
|
-
# [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-asgroups.html
|
8371
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
|
8210
8372
|
#
|
8211
8373
|
# @option params [required, String] :game_server_group_name
|
8212
|
-
#
|
8213
|
-
#
|
8374
|
+
# A unique identifier for the game server group. Use either the
|
8375
|
+
# GameServerGroup name or ARN value.
|
8214
8376
|
#
|
8215
8377
|
# @option params [String] :role_arn
|
8216
8378
|
# The Amazon Resource Name ([ARN][1]) for an IAM role that allows Amazon
|
8217
|
-
# GameLift to access your EC2 Auto Scaling groups.
|
8218
|
-
# validated to ensure that it contains the necessary permissions for
|
8219
|
-
# game server groups.
|
8379
|
+
# GameLift to access your EC2 Auto Scaling groups.
|
8220
8380
|
#
|
8221
8381
|
#
|
8222
8382
|
#
|
8223
8383
|
# [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
|
8224
8384
|
#
|
8225
8385
|
# @option params [Array<Types::InstanceDefinition>] :instance_definitions
|
8226
|
-
# An updated list of EC2 instance types to use
|
8227
|
-
#
|
8228
|
-
# are supported by GameLift FleetIQ
|
8229
|
-
#
|
8230
|
-
#
|
8231
|
-
#
|
8232
|
-
#
|
8386
|
+
# An updated list of EC2 instance types to use in the Auto Scaling
|
8387
|
+
# group. The instance definitions must specify at least two different
|
8388
|
+
# instance types that are supported by GameLift FleetIQ. This updated
|
8389
|
+
# list replaces the entire current list of instance definitions for the
|
8390
|
+
# game server group. For more information on instance types, see [EC2
|
8391
|
+
# Instance Types][1] in the *Amazon EC2 User Guide*. You can optionally
|
8392
|
+
# specify capacity weighting for each instance type. If no weight value
|
8393
|
+
# is specified for an instance type, it is set to the default value
|
8394
|
+
# "1". For more information about capacity weighting, see [ Instance
|
8395
|
+
# Weighting for Amazon EC2 Auto Scaling][2] in the Amazon EC2 Auto
|
8396
|
+
# Scaling User Guide.
|
8233
8397
|
#
|
8234
8398
|
#
|
8235
8399
|
#
|
8236
8400
|
# [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html
|
8401
|
+
# [2]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/asg-instance-weighting.html
|
8237
8402
|
#
|
8238
8403
|
# @option params [String] :game_server_protection_policy
|
8239
8404
|
# A flag that indicates whether instances in the game server group are
|
8240
8405
|
# protected from early termination. Unprotected instances that have
|
8241
|
-
# active game servers running
|
8406
|
+
# active game servers running might be terminated during a scale-down
|
8242
8407
|
# event, causing players to be dropped from the game. Protected
|
8243
8408
|
# instances cannot be terminated while there are active game servers
|
8244
|
-
# running
|
8409
|
+
# running except in the event of a forced game server group deletion
|
8410
|
+
# (see ). An exception to this is with Spot Instances, which can be
|
8245
8411
|
# terminated by AWS regardless of protection status. This property is
|
8246
|
-
# set to
|
8412
|
+
# set to `NO_PROTECTION` by default.
|
8247
8413
|
#
|
8248
8414
|
# @option params [String] :balancing_strategy
|
8249
|
-
#
|
8250
|
-
#
|
8251
|
-
#
|
8252
|
-
#
|
8253
|
-
#
|
8254
|
-
#
|
8255
|
-
# group provides no hosting capacity
|
8256
|
-
#
|
8257
|
-
#
|
8258
|
-
#
|
8259
|
-
#
|
8260
|
-
#
|
8261
|
-
#
|
8262
|
-
#
|
8263
|
-
# On-Demand
|
8415
|
+
# Indicates how GameLift FleetIQ balances the use of Spot Instances and
|
8416
|
+
# On-Demand Instances in the game server group. Method options include
|
8417
|
+
# the following:
|
8418
|
+
#
|
8419
|
+
# * `SPOT_ONLY` - Only Spot Instances are used in the game server group.
|
8420
|
+
# If Spot Instances are unavailable or not viable for game hosting,
|
8421
|
+
# the game server group provides no hosting capacity until Spot
|
8422
|
+
# Instances can again be used. Until then, no new instances are
|
8423
|
+
# started, and the existing nonviable Spot Instances are terminated
|
8424
|
+
# (after current gameplay ends) and are not replaced.
|
8425
|
+
#
|
8426
|
+
# * `SPOT_PREFERRED` - (default value) Spot Instances are used whenever
|
8427
|
+
# available in the game server group. If Spot Instances are
|
8428
|
+
# unavailable, the game server group continues to provide hosting
|
8429
|
+
# capacity by falling back to On-Demand Instances. Existing nonviable
|
8430
|
+
# Spot Instances are terminated (after current gameplay ends) and are
|
8431
|
+
# replaced with new On-Demand Instances.
|
8432
|
+
#
|
8433
|
+
# * `ON_DEMAND_ONLY` - Only On-Demand Instances are used in the game
|
8434
|
+
# server group. No Spot Instances are used, even when available, while
|
8435
|
+
# this balancing strategy is in force.
|
8264
8436
|
#
|
8265
8437
|
# @return [Types::UpdateGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8266
8438
|
#
|
@@ -8278,7 +8450,7 @@ module Aws::GameLift
|
|
8278
8450
|
# },
|
8279
8451
|
# ],
|
8280
8452
|
# game_server_protection_policy: "NO_PROTECTION", # accepts NO_PROTECTION, FULL_PROTECTION
|
8281
|
-
# balancing_strategy: "SPOT_ONLY", # accepts SPOT_ONLY, SPOT_PREFERRED
|
8453
|
+
# balancing_strategy: "SPOT_ONLY", # accepts SPOT_ONLY, SPOT_PREFERRED, ON_DEMAND_ONLY
|
8282
8454
|
# })
|
8283
8455
|
#
|
8284
8456
|
# @example Response structure
|
@@ -8289,7 +8461,7 @@ module Aws::GameLift
|
|
8289
8461
|
# resp.game_server_group.instance_definitions #=> Array
|
8290
8462
|
# resp.game_server_group.instance_definitions[0].instance_type #=> String, one of "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge", "c5.large", "c5.xlarge", "c5.2xlarge", "c5.4xlarge", "c5.9xlarge", "c5.12xlarge", "c5.18xlarge", "c5.24xlarge", "r4.large", "r4.xlarge", "r4.2xlarge", "r4.4xlarge", "r4.8xlarge", "r4.16xlarge", "r5.large", "r5.xlarge", "r5.2xlarge", "r5.4xlarge", "r5.8xlarge", "r5.12xlarge", "r5.16xlarge", "r5.24xlarge", "m4.large", "m4.xlarge", "m4.2xlarge", "m4.4xlarge", "m4.10xlarge", "m5.large", "m5.xlarge", "m5.2xlarge", "m5.4xlarge", "m5.8xlarge", "m5.12xlarge", "m5.16xlarge", "m5.24xlarge"
|
8291
8463
|
# resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
|
8292
|
-
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED"
|
8464
|
+
# resp.game_server_group.balancing_strategy #=> String, one of "SPOT_ONLY", "SPOT_PREFERRED", "ON_DEMAND_ONLY"
|
8293
8465
|
# resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
|
8294
8466
|
# resp.game_server_group.auto_scaling_group_arn #=> String
|
8295
8467
|
# resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
|
@@ -8529,7 +8701,7 @@ module Aws::GameLift
|
|
8529
8701
|
#
|
8530
8702
|
#
|
8531
8703
|
#
|
8532
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
8704
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-configuration.html
|
8533
8705
|
#
|
8534
8706
|
# @option params [required, String] :name
|
8535
8707
|
# A unique identifier for a matchmaking configuration to update. You can
|
@@ -8541,9 +8713,10 @@ module Aws::GameLift
|
|
8541
8713
|
# @option params [Array<String>] :game_session_queue_arns
|
8542
8714
|
# Amazon Resource Name ([ARN][1]) that is assigned to a GameLift game
|
8543
8715
|
# session queue resource and uniquely identifies it. ARNs are unique
|
8544
|
-
# across all Regions.
|
8545
|
-
#
|
8546
|
-
#
|
8716
|
+
# across all Regions. Queues can be located in any Region. Queues are
|
8717
|
+
# used to start new GameLift-hosted game sessions for matches that are
|
8718
|
+
# created with this matchmaking configuration. If `FlexMatchMode` is set
|
8719
|
+
# to `STANDALONE`, do not set this parameter.
|
8547
8720
|
#
|
8548
8721
|
#
|
8549
8722
|
#
|
@@ -8556,14 +8729,17 @@ module Aws::GameLift
|
|
8556
8729
|
#
|
8557
8730
|
# @option params [Integer] :acceptance_timeout_seconds
|
8558
8731
|
# The length of time (in seconds) to wait for players to accept a
|
8559
|
-
# proposed match. If any player rejects the
|
8560
|
-
# before the timeout, the
|
8732
|
+
# proposed match, if acceptance is required. If any player rejects the
|
8733
|
+
# match or fails to accept before the timeout, the tickets are returned
|
8734
|
+
# to the ticket pool and continue to be evaluated for an acceptable
|
8561
8735
|
# match.
|
8562
8736
|
#
|
8563
8737
|
# @option params [Boolean] :acceptance_required
|
8564
8738
|
# A flag that indicates whether a match that was created with this
|
8565
8739
|
# configuration must be accepted by the matched players. To require
|
8566
|
-
# acceptance, set to TRUE.
|
8740
|
+
# acceptance, set to TRUE. With this option enabled, matchmaking tickets
|
8741
|
+
# use the status `REQUIRES_ACCEPTANCE` to indicate when a completed
|
8742
|
+
# potential match is waiting for player acceptance.
|
8567
8743
|
#
|
8568
8744
|
# @option params [String] :rule_set_name
|
8569
8745
|
# A unique identifier for a matchmaking rule set to use with this
|
@@ -8578,13 +8754,14 @@ module Aws::GameLift
|
|
8578
8754
|
#
|
8579
8755
|
#
|
8580
8756
|
#
|
8581
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
8757
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html
|
8582
8758
|
#
|
8583
8759
|
# @option params [Integer] :additional_player_count
|
8584
8760
|
# The number of player slots in a match to keep open for future players.
|
8585
8761
|
# For example, assume that the configuration's rule set specifies a
|
8586
8762
|
# match for a single 12-person team. If the additional player count is
|
8587
|
-
# set to 2, only 10 players are initially selected for the match.
|
8763
|
+
# set to 2, only 10 players are initially selected for the match. This
|
8764
|
+
# parameter is not used if `FlexMatchMode` is set to `STANDALONE`.
|
8588
8765
|
#
|
8589
8766
|
# @option params [String] :custom_event_data
|
8590
8767
|
# Information to add to all events related to the matchmaking
|
@@ -8595,7 +8772,8 @@ module Aws::GameLift
|
|
8595
8772
|
# pairs. These properties are passed to a game server process in the
|
8596
8773
|
# GameSession object with a request to start a new game session (see
|
8597
8774
|
# [Start a Game Session][1]). This information is added to the new
|
8598
|
-
# GameSession object that is created for a successful match.
|
8775
|
+
# GameSession object that is created for a successful match. This
|
8776
|
+
# parameter is not used if `FlexMatchMode` is set to `STANDALONE`.
|
8599
8777
|
#
|
8600
8778
|
#
|
8601
8779
|
#
|
@@ -8606,7 +8784,8 @@ module Aws::GameLift
|
|
8606
8784
|
# value. This data is passed to a game server process in the GameSession
|
8607
8785
|
# object with a request to start a new game session (see [Start a Game
|
8608
8786
|
# Session][1]). This information is added to the new GameSession object
|
8609
|
-
# that is created for a successful match.
|
8787
|
+
# that is created for a successful match. This parameter is not used if
|
8788
|
+
# `FlexMatchMode` is set to `STANDALONE`.
|
8610
8789
|
#
|
8611
8790
|
#
|
8612
8791
|
#
|
@@ -8619,11 +8798,27 @@ module Aws::GameLift
|
|
8619
8798
|
# Specify AUTOMATIC to have GameLift create a StartMatchBackfill request
|
8620
8799
|
# whenever a game session has one or more open slots. Learn more about
|
8621
8800
|
# manual and automatic backfill in [Backfill Existing Games with
|
8622
|
-
# FlexMatch][1].
|
8801
|
+
# FlexMatch][1]. Automatic backfill is not available when
|
8802
|
+
# `FlexMatchMode` is set to `STANDALONE`.
|
8803
|
+
#
|
8804
|
+
#
|
8805
|
+
#
|
8806
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html
|
8807
|
+
#
|
8808
|
+
# @option params [String] :flex_match_mode
|
8809
|
+
# Indicates whether this matchmaking configuration is being used with
|
8810
|
+
# GameLift hosting or as a standalone matchmaking solution.
|
8811
|
+
#
|
8812
|
+
# * **STANDALONE** - FlexMatch forms matches and returns match
|
8813
|
+
# information, including players and team assignments, in a [
|
8814
|
+
# MatchmakingSucceeded][1] event.
|
8623
8815
|
#
|
8816
|
+
# * **WITH\_QUEUE** - FlexMatch forms matches and uses the specified
|
8817
|
+
# GameLift queue to start a game session for the match.
|
8624
8818
|
#
|
8625
8819
|
#
|
8626
|
-
#
|
8820
|
+
#
|
8821
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded
|
8627
8822
|
#
|
8628
8823
|
# @return [Types::UpdateMatchmakingConfigurationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
8629
8824
|
#
|
@@ -8650,6 +8845,7 @@ module Aws::GameLift
|
|
8650
8845
|
# ],
|
8651
8846
|
# game_session_data: "GameSessionData",
|
8652
8847
|
# backfill_mode: "AUTOMATIC", # accepts AUTOMATIC, MANUAL
|
8848
|
+
# flex_match_mode: "STANDALONE", # accepts STANDALONE, WITH_QUEUE
|
8653
8849
|
# })
|
8654
8850
|
#
|
8655
8851
|
# @example Response structure
|
@@ -8673,6 +8869,7 @@ module Aws::GameLift
|
|
8673
8869
|
# resp.configuration.game_properties[0].value #=> String
|
8674
8870
|
# resp.configuration.game_session_data #=> String
|
8675
8871
|
# resp.configuration.backfill_mode #=> String, one of "AUTOMATIC", "MANUAL"
|
8872
|
+
# resp.configuration.flex_match_mode #=> String, one of "STANDALONE", "WITH_QUEUE"
|
8676
8873
|
#
|
8677
8874
|
# @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateMatchmakingConfiguration AWS API Documentation
|
8678
8875
|
#
|
@@ -8832,16 +9029,22 @@ module Aws::GameLift
|
|
8832
9029
|
# do not need to be unique.
|
8833
9030
|
#
|
8834
9031
|
# @option params [Types::S3Location] :storage_location
|
8835
|
-
# The location of
|
8836
|
-
#
|
8837
|
-
#
|
8838
|
-
#
|
8839
|
-
#
|
8840
|
-
#
|
8841
|
-
#
|
8842
|
-
#
|
8843
|
-
#
|
8844
|
-
#
|
9032
|
+
# The Amazon S3 location of your Realtime scripts. The storage location
|
9033
|
+
# must specify the S3 bucket name, the zip file name (the "key"), and
|
9034
|
+
# an IAM role ARN that allows Amazon GameLift to access the S3 storage
|
9035
|
+
# location. The S3 bucket must be in the same Region as the script
|
9036
|
+
# you're updating. By default, Amazon GameLift uploads the latest
|
9037
|
+
# version of the zip file; if you have S3 object versioning turned on,
|
9038
|
+
# you can use the `ObjectVersion` parameter to specify an earlier
|
9039
|
+
# version. To call this operation with a storage location, you must have
|
9040
|
+
# IAM PassRole permission. For more details on IAM roles and PassRole
|
9041
|
+
# permissions, see [ Set up a role for GameLift access][1].
|
9042
|
+
#
|
9043
|
+
#
|
9044
|
+
#
|
9045
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/setting-up-role.html
|
9046
|
+
#
|
9047
|
+
# @option params [String, StringIO, File] :zip_file
|
8845
9048
|
# A data object containing your Realtime scripts and dependencies as a
|
8846
9049
|
# zip file. The zip file can have one or multiple files. Maximum size of
|
8847
9050
|
# a zip file is 5 MB.
|
@@ -8923,7 +9126,7 @@ module Aws::GameLift
|
|
8923
9126
|
#
|
8924
9127
|
#
|
8925
9128
|
#
|
8926
|
-
# [1]: https://docs.aws.amazon.com/gamelift/latest/
|
9129
|
+
# [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html
|
8927
9130
|
#
|
8928
9131
|
# @option params [required, String] :rule_set_body
|
8929
9132
|
# A collection of matchmaking rules to validate, formatted as a JSON
|
@@ -8965,7 +9168,7 @@ module Aws::GameLift
|
|
8965
9168
|
params: params,
|
8966
9169
|
config: config)
|
8967
9170
|
context[:gem_name] = 'aws-sdk-gamelift'
|
8968
|
-
context[:gem_version] = '1.
|
9171
|
+
context[:gem_version] = '1.39.0'
|
8969
9172
|
Seahorse::Client::Request.new(handlers, context)
|
8970
9173
|
end
|
8971
9174
|
|