aws-sdk-gamelift 1.35.0 → 1.40.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7b5afd3aef23c74432162276bdaf7639d3a296d959b59c44d072abb47a0f8d18
4
- data.tar.gz: bf1a7074b2781ab0ef27aa683fd4139640e056573fa8b585aaef88332276b1cb
3
+ metadata.gz: a7c4fc2e91d47b087d588561d92bd26d0a5f4ab1902b6216cb78529e57d85907
4
+ data.tar.gz: b3670ae89051405d3c0d3ba088fde944c4e3fb75584bfd598de856c345e5f75c
5
5
  SHA512:
6
- metadata.gz: 525484315be8aa7cbc7e9a12beeb0644a3b057f8f1ce8d7a27e76abeca016d038e26eb9700796b2c1acfab5ddbf796d7a50f2aff3a15d0ab75ea0b08bfa2404e
7
- data.tar.gz: d33836610c47399b615723e326d09fe8b426aa456149ed311bd2629f7294f14bfe8576668999fe02cc5cac8288643537941208d98fe6fe6d7224fdefe2baaf3d
6
+ metadata.gz: 924f7868729ff379e395f09f35f9be6c0b5cce0f5506939aed3f0787bce4fd09a592173ce19674357b43b3635b5359739249fb916673adde583bfc607af472a4
7
+ data.tar.gz: c24856e6791b39d9211a8f58a3c01fb04f17c6aa318137cf6ec26545ba96226369ea7e6a5a2e6ac1eb70ce4d2bf730c9eb4af48b9ce41e4eb2e36ab043b0aa63
@@ -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
 
@@ -47,6 +48,6 @@ require_relative 'aws-sdk-gamelift/customizations'
47
48
  # @!group service
48
49
  module Aws::GameLift
49
50
 
50
- GEM_VERSION = '1.35.0'
51
+ GEM_VERSION = '1.40.0'
51
52
 
52
53
  end
@@ -383,8 +383,8 @@ module Aws::GameLift
383
383
  #
384
384
  #
385
385
  #
386
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-client.html
387
- # [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-events.html
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
388
388
  #
389
389
  # @option params [required, String] :ticket_id
390
390
  # A unique identifier for a matchmaking ticket. The ticket must be in
@@ -416,47 +416,46 @@ module Aws::GameLift
416
416
  req.send_request(options)
417
417
  end
418
418
 
419
- # **This action is part of Amazon GameLift FleetIQ with game server
420
- # groups, which is in preview release and is subject to change.**
419
+ # **This operation is used with the Amazon GameLift FleetIQ solution and
420
+ # game server groups.**
421
421
  #
422
422
  # Locates an available game server and temporarily reserves it to host
423
- # gameplay and players. This action is called by a game client or client
424
- # service (such as a matchmaker) to request hosting resources for a new
425
- # game session. In response, GameLift FleetIQ searches for an available
426
- # game server in the specified game server group, places the game server
427
- # in "claimed" status for 60 seconds, and returns connection
428
- # information back to the requester so that players can connect to the
429
- # game server.
430
- #
431
- # There are two ways you can claim a game server. For the first option,
432
- # you provide a game server group ID only, which prompts GameLift
433
- # FleetIQ to search for an available game server in the specified group
434
- # and claim it. With this option, GameLift FleetIQ attempts to
435
- # consolidate gameplay on as few instances as possible to minimize
436
- # hosting costs. For the second option, you request a specific game
437
- # server by its ID. This option results in a less efficient claiming
438
- # process because it does not take advantage of consolidation and may
439
- # fail if the requested game server is unavailable.
440
- #
441
- # To claim a game server, identify a game server group and (optionally)
442
- # a game server ID. If your game requires that game data be provided to
443
- # the game server at the start of a game, such as a game map or player
444
- # 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.
445
435
  #
446
436
  # When a game server is successfully claimed, connection information is
447
437
  # returned. A claimed game server's utilization status remains
448
- # AVAILABLE, while the claim status is set to CLAIMED for up to 60
449
- # seconds. This time period allows the game server to be prompted to
450
- # update its status to UTILIZED (using UpdateGameServer). If the game
451
- # server's status is not updated within 60 seconds, the game server
452
- # reverts to unclaimed status and is available to be claimed by another
453
- # 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.
454
445
  #
455
446
  # If you try to claim a specific game server, this request will fail in
456
- # the following cases: (1) if the game server utilization status is
457
- # UTILIZED, (2) if the game server claim status is CLAIMED, or (3) if
458
- # the instance that the game server is running on is flagged as
459
- # draining.
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>
460
459
  #
461
460
  # **Learn more**
462
461
  #
@@ -478,14 +477,13 @@ module Aws::GameLift
478
477
  #
479
478
  #
480
479
  #
481
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
480
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
482
481
  #
483
482
  # @option params [required, String] :game_server_group_name
484
- # An identifier for the game server group. When claiming a specific game
485
- # server, this is the game server group whether the game server is
486
- # located. When requesting that GameLift FleetIQ locate an available
487
- # game server, this is the game server group to search on. You can use
488
- # 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.
489
487
  #
490
488
  # @option params [String] :game_server_id
491
489
  # A custom string that uniquely identifies the game server to claim. If
@@ -494,7 +492,9 @@ module Aws::GameLift
494
492
  #
495
493
  # @option params [String] :game_server_data
496
494
  # A set of custom game server properties, formatted as a single string
497
- # value, to be passed to the claimed game server.
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.
498
498
  #
499
499
  # @return [Types::ClaimGameServerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
500
500
  #
@@ -516,7 +516,6 @@ module Aws::GameLift
516
516
  # resp.game_server.instance_id #=> String
517
517
  # resp.game_server.connection_info #=> String
518
518
  # resp.game_server.game_server_data #=> String
519
- # resp.game_server.custom_sort_key #=> String
520
519
  # resp.game_server.claim_status #=> String, one of "CLAIMED"
521
520
  # resp.game_server.utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
522
521
  # resp.game_server.registration_time #=> Time
@@ -651,12 +650,13 @@ module Aws::GameLift
651
650
  #
652
651
  # * To directly upload your build files to a GameLift S3 location. To
653
652
  # use this option, first call `CreateBuild` and specify a build name
654
- # and operating system. This action creates a new build resource and
655
- # also returns an S3 location with temporary access credentials. Use
656
- # the credentials to manually upload your build files to the specified
657
- # S3 location. For more information, see [Uploading Objects][1] in the
658
- # *Amazon S3 Developer Guide*. Build files can be uploaded to the
659
- # GameLift S3 location once only; that can't be updated.
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.
660
660
  #
661
661
  # If successful, this operation creates a new build resource with a
662
662
  # unique build ID and places it in `INITIALIZED` status. A build must be
@@ -697,12 +697,19 @@ module Aws::GameLift
697
697
  # this value later.
698
698
  #
699
699
  # @option params [Types::S3Location] :storage_location
700
- # Information indicating where your game build files are stored. Use
701
- # this parameter only when creating a build with files stored in an S3
702
- # bucket that you own. The storage location must specify an S3 bucket
703
- # name and key. The location must also specify a role ARN that you set
704
- # up to allow Amazon GameLift to access your S3 bucket. The S3 bucket
705
- # and your new build must be in the same Region.
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
706
713
  #
707
714
  # @option params [String] :operating_system
708
715
  # The operating system that the game server binaries are built to run
@@ -974,17 +981,17 @@ module Aws::GameLift
974
981
  #
975
982
  # @option params [String] :instance_role_arn
976
983
  # A unique identifier for an AWS IAM role that manages access to your
977
- # AWS services. With an instance role ARN set, any application that runs
978
- # on an instance in this fleet can assume the role, including install
979
- # scripts, server processes, and daemons (background processes). Create
980
- # a role or look up a role's ARN from the [IAM dashboard][1] in the AWS
981
- # Management Console. Learn more about using on-box credentials for your
982
- # game servers at [ Access external resources from a game server][2].
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].
983
990
  #
984
991
  #
985
992
  #
986
- # [1]: https://console.aws.amazon.com/iam/
987
- # [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html
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
988
995
  #
989
996
  # @option params [Types::CertificateConfiguration] :certificate_configuration
990
997
  # Indicates whether to generate a TLS/SSL certificate for the new fleet.
@@ -1039,7 +1046,7 @@ module Aws::GameLift
1039
1046
  # server_launch_path: "NonZeroAndMaxString",
1040
1047
  # server_launch_parameters: "NonZeroAndMaxString",
1041
1048
  # log_paths: ["NonZeroAndMaxString"],
1042
- # 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
1043
1050
  # ec2_inbound_permissions: [
1044
1051
  # {
1045
1052
  # from_port: 1, # required
@@ -1085,7 +1092,7 @@ module Aws::GameLift
1085
1092
  # resp.fleet_attributes.fleet_id #=> String
1086
1093
  # resp.fleet_attributes.fleet_arn #=> String
1087
1094
  # resp.fleet_attributes.fleet_type #=> String, one of "ON_DEMAND", "SPOT"
1088
- # 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"
1089
1096
  # resp.fleet_attributes.description #=> String
1090
1097
  # resp.fleet_attributes.name #=> String
1091
1098
  # resp.fleet_attributes.creation_time #=> Time
@@ -1119,54 +1126,49 @@ module Aws::GameLift
1119
1126
  req.send_request(options)
1120
1127
  end
1121
1128
 
1122
- # **This action is part of Amazon GameLift FleetIQ with game server
1123
- # groups, which is in preview release and is subject to change.**
1124
- #
1125
- # Creates a GameLift FleetIQ game server group to manage a collection of
1126
- # EC2 instances for game hosting. In addition to creating the game
1127
- # server group, this action also creates an Auto Scaling group in your
1128
- # AWS account and establishes a link between the two groups. You have
1129
- # full control over configuration of the Auto Scaling group, but
1130
- # GameLift FleetIQ routinely certain Auto Scaling group properties in
1131
- # 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.
1132
1136
  # You can view the status of your game server groups in the GameLift
1133
- # Console. Game server group metrics and events are emitted to Amazon
1137
+ # console. Game server group metrics and events are emitted to Amazon
1134
1138
  # CloudWatch.
1135
1139
  #
1136
- # Prior creating a new game server group, you must set up the following:
1140
+ # Before creating a new game server group, you must have the following:
1137
1141
  #
1138
- # * An EC2 launch template. The template provides configuration settings
1139
- # for a set of EC2 instances and includes the game server build that
1140
- # you want to deploy and run on each instance. For more information on
1141
- # creating a launch template, see [ Launching an Instance from a
1142
- # 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*.
1143
1146
  #
1144
- # * An IAM role. The role sets up limited access to your AWS account,
1145
- # allowing GameLift FleetIQ to create and manage the EC2 Auto Scaling
1146
- # group, get instance data, and emit metrics and events to CloudWatch.
1147
- # For more information on setting up an IAM permissions policy with
1148
- # principal access for GameLift, see [ Specifying a Principal in a
1149
- # 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*.
1150
1151
  #
1151
- # To create a new game server group, provide a name and specify the IAM
1152
- # role and EC2 launch template. You also need to provide a list of
1153
- # instance types to be used in the group and set initial maximum and
1154
- # minimum limits on the group's instance count. You can optionally set
1155
- # an autoscaling policy with target tracking based on a GameLift FleetIQ
1156
- # 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.
1157
1158
  #
1158
1159
  # Once the game server group and corresponding Auto Scaling group are
1159
1160
  # created, you have full access to change the Auto Scaling group's
1160
- # configuration as needed. Keep in mind, however, that some properties
1161
- # are periodically updated by GameLift FleetIQ as it balances the
1162
- # group's instances based on availability and cost.
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.
1163
1167
  #
1164
1168
  # **Learn more**
1165
1169
  #
1166
1170
  # [GameLift FleetIQ Guide][3]
1167
1171
  #
1168
- # [Updating a GameLift FleetIQ-Linked Auto Scaling Group][4]
1169
- #
1170
1172
  # **Related operations**
1171
1173
  #
1172
1174
  # * CreateGameServerGroup
@@ -1183,12 +1185,13 @@ module Aws::GameLift
1183
1185
  #
1184
1186
  # * SuspendGameServerGroup
1185
1187
  #
1188
+ # * DescribeGameServerInstances
1189
+ #
1186
1190
  #
1187
1191
  #
1188
1192
  # [1]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html
1189
- # [2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-bucket-user-policy-specifying-principal-intro.html
1190
- # [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
1191
- # [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
1192
1195
  #
1193
1196
  # @option params [required, String] :game_server_group_name
1194
1197
  # An identifier for the new game server group. This value is used to
@@ -1198,9 +1201,7 @@ module Aws::GameLift
1198
1201
  #
1199
1202
  # @option params [required, String] :role_arn
1200
1203
  # The Amazon Resource Name ([ARN][1]) for an IAM role that allows Amazon
1201
- # GameLift to access your EC2 Auto Scaling groups. The submitted role is
1202
- # validated to ensure that it contains the necessary permissions for
1203
- # game server groups.
1204
+ # GameLift to access your EC2 Auto Scaling groups.
1204
1205
  #
1205
1206
  #
1206
1207
  #
@@ -1208,14 +1209,18 @@ module Aws::GameLift
1208
1209
  #
1209
1210
  # @option params [required, Integer] :min_size
1210
1211
  # The minimum number of instances allowed in the EC2 Auto Scaling group.
1211
- # During autoscaling events, GameLift FleetIQ and EC2 do not scale down
1212
- # the group below this minimum. In production, this value should be set
1213
- # 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.
1214
1217
  #
1215
1218
  # @option params [required, Integer] :max_size
1216
1219
  # The maximum number of instances allowed in the EC2 Auto Scaling group.
1217
- # During autoscaling events, GameLift FleetIQ and EC2 do not scale up
1218
- # 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.
1219
1224
  #
1220
1225
  # @option params [required, Types::LaunchTemplateSpecification] :launch_template
1221
1226
  # The EC2 launch template that contains configuration settings and game
@@ -1223,72 +1228,88 @@ module Aws::GameLift
1223
1228
  # You can specify the template using either the template name or ID. For
1224
1229
  # help with creating a launch template, see [Creating a Launch Template
1225
1230
  # for an Auto Scaling Group][1] in the *Amazon EC2 Auto Scaling User
1226
- # 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.
1227
1233
  #
1228
1234
  #
1229
1235
  #
1230
1236
  # [1]: https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-launch-template.html
1231
1237
  #
1232
1238
  # @option params [required, Array<Types::InstanceDefinition>] :instance_definitions
1233
- # A set of EC2 instance types to use when creating instances in the
1234
- # group. The instance definitions must specify at least two different
1235
- # instance types that are supported by GameLift FleetIQ. For more
1236
- # information on instance types, see [EC2 Instance Types][1] in the
1237
- # *Amazon EC2 User Guide*.
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.
1238
1248
  #
1239
1249
  #
1240
1250
  #
1241
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
1242
1253
  #
1243
1254
  # @option params [Types::GameServerGroupAutoScalingPolicy] :auto_scaling_policy
1244
1255
  # Configuration settings to define a scaling policy for the Auto Scaling
1245
1256
  # group that is optimized for game hosting. The scaling policy uses the
1246
- # metric "PercentUtilizedGameServers" to maintain a buffer of idle
1257
+ # metric `"PercentUtilizedGameServers"` to maintain a buffer of idle
1247
1258
  # game servers that can immediately accommodate new games and players.
1248
- # Once the game server and Auto Scaling groups are created, you can
1249
- # update the scaling policy settings directly in Auto Scaling Groups.
1259
+ # After the Auto Scaling group is created, update this value directly in
1260
+ # the Auto Scaling group using the AWS console or APIs.
1250
1261
  #
1251
1262
  # @option params [String] :balancing_strategy
1252
- # The fallback balancing method to use for the game server group when
1253
- # Spot instances in a Region become unavailable or are not viable for
1254
- # game hosting. Once triggered, this method remains active until Spot
1255
- # instances can once again be used. Method options include:
1256
- #
1257
- # * SPOT\_ONLY -- If Spot instances are unavailable, the game server
1258
- # group provides no hosting capacity. No new instances are started,
1259
- # and the existing nonviable Spot instances are terminated (once
1260
- # current gameplay ends) and not replaced.
1261
- #
1262
- # * SPOT\_PREFERRED -- If Spot instances are unavailable, the game
1263
- # server group continues to provide hosting capacity by using
1264
- # On-Demand instances. Existing nonviable Spot instances are
1265
- # terminated (once current gameplay ends) and replaced with new
1266
- # On-Demand instances.
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.
1267
1284
  #
1268
1285
  # @option params [String] :game_server_protection_policy
1269
1286
  # A flag that indicates whether instances in the game server group are
1270
1287
  # protected from early termination. Unprotected instances that have
1271
- # active game servers running may by terminated during a scale-down
1288
+ # active game servers running might be terminated during a scale-down
1272
1289
  # event, causing players to be dropped from the game. Protected
1273
1290
  # instances cannot be terminated while there are active game servers
1274
- # running. An exception to this is Spot Instances, which may be
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
1275
1293
  # terminated by AWS regardless of protection status. This property is
1276
- # set to NO\_PROTECTION by default.
1294
+ # set to `NO_PROTECTION` by default.
1277
1295
  #
1278
1296
  # @option params [Array<String>] :vpc_subnets
1279
1297
  # A list of virtual private cloud (VPC) subnets to use with instances in
1280
1298
  # the game server group. By default, all GameLift FleetIQ-supported
1281
- # availability zones are used; this parameter allows you to specify VPCs
1282
- # 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.
1283
1304
  #
1284
1305
  # @option params [Array<Types::Tag>] :tags
1285
1306
  # A list of labels to assign to the new game server group resource. Tags
1286
- # are developer-defined key-value pairs. Tagging AWS resources are
1287
- # useful for resource management, access management, and cost
1288
- # allocation. For more information, see [ Tagging AWS Resources][1] in
1289
- # the *AWS General Reference*. Once the resource is created, you can use
1290
- # TagResource, UntagResource, and ListTagsForResource to add, remove,
1291
- # and view tags. The maximum tag limit may be lower than stated. See the
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
1292
1313
  # AWS General Reference for actual tagging limits.
1293
1314
  #
1294
1315
  #
@@ -1323,7 +1344,7 @@ module Aws::GameLift
1323
1344
  # target_value: 1.0, # required
1324
1345
  # },
1325
1346
  # },
1326
- # balancing_strategy: "SPOT_ONLY", # accepts SPOT_ONLY, SPOT_PREFERRED
1347
+ # balancing_strategy: "SPOT_ONLY", # accepts SPOT_ONLY, SPOT_PREFERRED, ON_DEMAND_ONLY
1327
1348
  # game_server_protection_policy: "NO_PROTECTION", # accepts NO_PROTECTION, FULL_PROTECTION
1328
1349
  # vpc_subnets: ["VpcSubnet"],
1329
1350
  # tags: [
@@ -1342,7 +1363,7 @@ module Aws::GameLift
1342
1363
  # resp.game_server_group.instance_definitions #=> Array
1343
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"
1344
1365
  # resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
1345
- # 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"
1346
1367
  # resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
1347
1368
  # resp.game_server_group.auto_scaling_group_arn #=> String
1348
1369
  # resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
@@ -1361,8 +1382,8 @@ module Aws::GameLift
1361
1382
  req.send_request(options)
1362
1383
  end
1363
1384
 
1364
- # Creates a multiplayer game session for players. This action creates a
1365
- # 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
1366
1387
  # specified fleet to host the game session. A fleet must have an
1367
1388
  # `ACTIVE` status before a game session can be created in it.
1368
1389
  #
@@ -1679,34 +1700,38 @@ module Aws::GameLift
1679
1700
  req.send_request(options)
1680
1701
  end
1681
1702
 
1682
- # Defines a new matchmaking configuration for use with FlexMatch. A
1683
- # matchmaking configuration sets out guidelines for matching players and
1684
- # getting the matches into games. You can set up multiple matchmaking
1685
- # configurations to handle the scenarios needed for your game. Each
1686
- # matchmaking ticket (StartMatchmaking or StartMatchBackfill) specifies
1687
- # a configuration for the match and provides player attributes to
1688
- # support the configuration being used.
1689
- #
1690
- # To create a matchmaking configuration, at a minimum you must specify
1691
- # the following: configuration name; a rule set that governs how to
1692
- # evaluate players and find acceptable matches; a game session queue to
1693
- # use when placing a new game session for the match; and the maximum
1694
- # time allowed for a matchmaking attempt.
1695
- #
1696
- # There are two ways to track the progress of matchmaking tickets: (1)
1697
- # polling ticket status with DescribeMatchmaking; or (2) receiving
1698
- # notifications with Amazon Simple Notification Service (SNS). To use
1699
- # notifications, you first need to set up an SNS topic to receive the
1700
- # notifications, and provide the topic ARN in the matchmaking
1701
- # configuration. Since notifications promise only "best effort"
1702
- # delivery, we recommend calling `DescribeMatchmaking` if no
1703
- # notifications are received within 30 seconds.
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.
1704
1727
  #
1705
1728
  # **Learn more**
1706
1729
  #
1707
- # [ Design a FlexMatch Matchmaker][1]
1730
+ # [ FlexMatch Developer Guide][1]
1708
1731
  #
1709
- # [ Setting up Notifications for Matchmaking][2]
1732
+ # [ Design a FlexMatch Matchmaker][2]
1733
+ #
1734
+ # [ Set Up FlexMatch Event Notification][3]
1710
1735
  #
1711
1736
  # **Related operations**
1712
1737
  #
@@ -1728,8 +1753,9 @@ module Aws::GameLift
1728
1753
  #
1729
1754
  #
1730
1755
  #
1731
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-configuration.html
1732
- # [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-notification.html
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
1733
1759
  #
1734
1760
  # @option params [required, String] :name
1735
1761
  # A unique identifier for a matchmaking configuration. This name is used
@@ -1739,12 +1765,13 @@ module Aws::GameLift
1739
1765
  # @option params [String] :description
1740
1766
  # A human-readable description of the matchmaking configuration.
1741
1767
  #
1742
- # @option params [required, Array<String>] :game_session_queue_arns
1768
+ # @option params [Array<String>] :game_session_queue_arns
1743
1769
  # Amazon Resource Name ([ARN][1]) that is assigned to a GameLift game
1744
1770
  # session queue resource and uniquely identifies it. ARNs are unique
1745
- # across all Regions. These queues are used when placing game sessions
1746
- # for matches that are created with this matchmaking configuration.
1747
- # Queues can be located in any Region.
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.
1748
1775
  #
1749
1776
  #
1750
1777
  #
@@ -1757,14 +1784,17 @@ module Aws::GameLift
1757
1784
  #
1758
1785
  # @option params [Integer] :acceptance_timeout_seconds
1759
1786
  # The length of time (in seconds) to wait for players to accept a
1760
- # proposed match. If any player rejects the match or fails to accept
1761
- # before the timeout, the ticket continues to look for an acceptable
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
1762
1790
  # match.
1763
1791
  #
1764
1792
  # @option params [required, Boolean] :acceptance_required
1765
1793
  # A flag that determines whether a match that was created with this
1766
1794
  # configuration must be accepted by the matched players. To require
1767
- # 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.
1768
1798
  #
1769
1799
  # @option params [required, String] :rule_set_name
1770
1800
  # A unique identifier for a matchmaking rule set to use with this
@@ -1779,7 +1809,8 @@ module Aws::GameLift
1779
1809
  # The number of player slots in a match to keep open for future players.
1780
1810
  # For example, assume that the configuration's rule set specifies a
1781
1811
  # match for a single 12-person team. If the additional player count is
1782
- # 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`.
1783
1814
  #
1784
1815
  # @option params [String] :custom_event_data
1785
1816
  # Information to be added to all events related to this matchmaking
@@ -1790,7 +1821,8 @@ module Aws::GameLift
1790
1821
  # pairs. These properties are passed to a game server process in the
1791
1822
  # GameSession object with a request to start a new game session (see
1792
1823
  # [Start a Game Session][1]). This information is added to the new
1793
- # 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`.
1794
1826
  #
1795
1827
  #
1796
1828
  #
@@ -1801,7 +1833,8 @@ module Aws::GameLift
1801
1833
  # value. This data is passed to a game server process in the GameSession
1802
1834
  # object with a request to start a new game session (see [Start a Game
1803
1835
  # Session][1]). This information is added to the new GameSession object
1804
- # 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`.
1805
1838
  #
1806
1839
  #
1807
1840
  #
@@ -1814,11 +1847,27 @@ module Aws::GameLift
1814
1847
  # Specify `AUTOMATIC` to have GameLift create a StartMatchBackfill
1815
1848
  # request whenever a game session has one or more open slots. Learn more
1816
1849
  # about manual and automatic backfill in [ Backfill Existing Games with
1817
- # FlexMatch][1].
1850
+ # FlexMatch][1]. Automatic backfill is not available when
1851
+ # `FlexMatchMode` is set to `STANDALONE`.
1852
+ #
1853
+ #
1854
+ #
1855
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html
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.
1818
1860
  #
1861
+ # * **STANDALONE** - FlexMatch forms matches and returns match
1862
+ # information, including players and team assignments, in a [
1863
+ # MatchmakingSucceeded][1] event.
1819
1864
  #
1865
+ # * **WITH\_QUEUE** - FlexMatch forms matches and uses the specified
1866
+ # GameLift queue to start a game session for the match.
1820
1867
  #
1821
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-backfill.html
1868
+ #
1869
+ #
1870
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded
1822
1871
  #
1823
1872
  # @option params [Array<Types::Tag>] :tags
1824
1873
  # A list of labels to assign to the new matchmaking configuration
@@ -1843,7 +1892,7 @@ module Aws::GameLift
1843
1892
  # resp = client.create_matchmaking_configuration({
1844
1893
  # name: "MatchmakingIdStringModel", # required
1845
1894
  # description: "NonZeroAndMaxString",
1846
- # game_session_queue_arns: ["ArnStringModel"], # required
1895
+ # game_session_queue_arns: ["ArnStringModel"],
1847
1896
  # request_timeout_seconds: 1, # required
1848
1897
  # acceptance_timeout_seconds: 1,
1849
1898
  # acceptance_required: false, # required
@@ -1859,6 +1908,7 @@ module Aws::GameLift
1859
1908
  # ],
1860
1909
  # game_session_data: "GameSessionData",
1861
1910
  # backfill_mode: "AUTOMATIC", # accepts AUTOMATIC, MANUAL
1911
+ # flex_match_mode: "STANDALONE", # accepts STANDALONE, WITH_QUEUE
1862
1912
  # tags: [
1863
1913
  # {
1864
1914
  # key: "TagKey", # required
@@ -1888,6 +1938,7 @@ module Aws::GameLift
1888
1938
  # resp.configuration.game_properties[0].value #=> String
1889
1939
  # resp.configuration.game_session_data #=> String
1890
1940
  # resp.configuration.backfill_mode #=> String, one of "AUTOMATIC", "MANUAL"
1941
+ # resp.configuration.flex_match_mode #=> String, one of "STANDALONE", "WITH_QUEUE"
1891
1942
  #
1892
1943
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/CreateMatchmakingConfiguration AWS API Documentation
1893
1944
  #
@@ -1940,9 +1991,9 @@ module Aws::GameLift
1940
1991
  #
1941
1992
  #
1942
1993
  #
1943
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-rulesets.html
1944
- # [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-configuration.html
1945
- # [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-intro.html
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
1946
1997
  #
1947
1998
  # @option params [required, String] :name
1948
1999
  # A unique identifier for a matchmaking rule set. A matchmaking
@@ -2219,14 +2270,20 @@ module Aws::GameLift
2219
2270
  # value later.
2220
2271
  #
2221
2272
  # @option params [Types::S3Location] :storage_location
2222
- # The location of the Amazon S3 bucket where a zipped file containing
2223
- # your Realtime scripts is stored. The storage location must specify the
2224
- # Amazon S3 bucket name, the zip file name (the "key"), and a role ARN
2225
- # that allows Amazon GameLift to access the Amazon S3 storage location.
2226
- # The S3 bucket must be in the same Region where you want to create a
2227
- # new script. By default, Amazon GameLift uploads the latest version of
2228
- # the zip file; if you have S3 object versioning turned on, you can use
2229
- # the `ObjectVersion` parameter to specify an earlier version.
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
2230
2287
  #
2231
2288
  # @option params [String, StringIO, File] :zip_file
2232
2289
  # A data object containing your Realtime scripts and dependencies as a
@@ -2474,7 +2531,7 @@ module Aws::GameLift
2474
2531
  req.send_request(options)
2475
2532
  end
2476
2533
 
2477
- # Deletes an alias. This action removes all record of the alias. Game
2534
+ # Deletes an alias. This operation removes all record of the alias. Game
2478
2535
  # clients attempting to access a server process using the deleted alias
2479
2536
  # receive an error. To delete an alias, specify the alias ID to be
2480
2537
  # deleted.
@@ -2512,7 +2569,7 @@ module Aws::GameLift
2512
2569
  req.send_request(options)
2513
2570
  end
2514
2571
 
2515
- # Deletes a build. This action permanently deletes the build resource
2572
+ # Deletes a build. This operation permanently deletes the build resource
2516
2573
  # and any uploaded build files. Deleting a build does not affect the
2517
2574
  # status of any active fleets using the build, but you can no longer
2518
2575
  # create new fleets with the deleted build.
@@ -2570,7 +2627,7 @@ module Aws::GameLift
2570
2627
  # the VPC peering connection--this is done as part of the delete fleet
2571
2628
  # process.
2572
2629
  #
2573
- # This action removes the fleet and its resources. Once a fleet is
2630
+ # This operation removes the fleet and its resources. Once a fleet is
2574
2631
  # deleted, you can no longer use any of the resource in that fleet.
2575
2632
  #
2576
2633
  # **Learn more**
@@ -2616,27 +2673,33 @@ module Aws::GameLift
2616
2673
  req.send_request(options)
2617
2674
  end
2618
2675
 
2619
- # **This action is part of Amazon GameLift FleetIQ with game server
2620
- # groups, which is in preview release and is subject to change.**
2676
+ # **This operation is used with the Amazon GameLift FleetIQ solution and
2677
+ # game server groups.**
2621
2678
  #
2622
2679
  # Terminates a game server group and permanently deletes the game server
2623
2680
  # group record. You have several options for how these resources are
2624
2681
  # impacted when deleting the game server group. Depending on the type of
2625
- # delete action selected, this action may affect three types of
2626
- # resources: the game server group, the corresponding Auto Scaling
2627
- # group, and all game servers currently running in the group.
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
2628
2690
  #
2629
2691
  # To delete a game server group, identify the game server group to
2630
- # delete and specify the type of delete action to initiate. Game server
2631
- # groups can only be deleted if they are in ACTIVE or ERROR status.
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.
2632
2695
  #
2633
- # If the delete request is successful, a series of actions are kicked
2634
- # off. The game server group status is changed to DELETE\_SCHEDULED,
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`,
2635
2698
  # which prevents new game servers from being registered and stops
2636
- # autoscaling activity. Once all game servers in the game server group
2637
- # are de-registered, GameLift FleetIQ can begin deleting resources. If
2638
- # any of the delete actions fail, the game server group is placed in
2639
- # 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.
2640
2703
  #
2641
2704
  # GameLift FleetIQ emits delete events to Amazon CloudWatch.
2642
2705
  #
@@ -2660,26 +2723,29 @@ module Aws::GameLift
2660
2723
  #
2661
2724
  # * SuspendGameServerGroup
2662
2725
  #
2726
+ # * DescribeGameServerInstances
2727
+ #
2663
2728
  #
2664
2729
  #
2665
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
2730
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
2666
2731
  #
2667
2732
  # @option params [required, String] :game_server_group_name
2668
- # The unique identifier of the game server group to delete. Use either
2669
- # the GameServerGroup name or ARN value.
2733
+ # A unique identifier for the game server group. Use either the
2734
+ # GameServerGroup name or ARN value.
2670
2735
  #
2671
2736
  # @option params [String] :delete_option
2672
- # The type of delete to perform. Options include:
2737
+ # The type of delete to perform. Options include the following:
2673
2738
  #
2674
- # * SAFE\_DELETE – Terminates the game server group and EC2 Auto Scaling
2675
- # group only when it has no game servers that are in IN\_USE status.
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.
2676
2742
  #
2677
- # * FORCE\_DELETE – Terminates the game server group, including all
2743
+ # * `FORCE_DELETE` – Terminates the game server group, including all
2678
2744
  # active game servers regardless of their utilization status, and the
2679
2745
  # EC2 Auto Scaling group.
2680
2746
  #
2681
- # * RETAIN – Does a safe delete of the game server group but retains the
2682
- # 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.
2683
2749
  #
2684
2750
  # @return [Types::DeleteGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
2685
2751
  #
@@ -2700,7 +2766,7 @@ module Aws::GameLift
2700
2766
  # resp.game_server_group.instance_definitions #=> Array
2701
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"
2702
2768
  # resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
2703
- # 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"
2704
2770
  # resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
2705
2771
  # resp.game_server_group.auto_scaling_group_arn #=> String
2706
2772
  # resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
@@ -2719,9 +2785,9 @@ module Aws::GameLift
2719
2785
  req.send_request(options)
2720
2786
  end
2721
2787
 
2722
- # Deletes a game session queue. This action means that any
2723
- # StartGameSessionPlacement requests that reference this queue will
2724
- # 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.
2725
2791
  #
2726
2792
  # **Learn more**
2727
2793
  #
@@ -2836,7 +2902,7 @@ module Aws::GameLift
2836
2902
  #
2837
2903
  #
2838
2904
  #
2839
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-rulesets.html
2905
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html
2840
2906
  #
2841
2907
  # @option params [required, String] :name
2842
2908
  # A unique identifier for a matchmaking rule set to be deleted. (Note:
@@ -2860,8 +2926,8 @@ module Aws::GameLift
2860
2926
  req.send_request(options)
2861
2927
  end
2862
2928
 
2863
- # Deletes a fleet scaling policy. This action means that the policy is
2864
- # no longer in force and removes all record of it. To delete a scaling
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
2865
2931
  # policy, specify both the scaling policy name and the fleet ID it is
2866
2932
  # associated with.
2867
2933
  #
@@ -2914,9 +2980,9 @@ module Aws::GameLift
2914
2980
  req.send_request(options)
2915
2981
  end
2916
2982
 
2917
- # Deletes a Realtime script. This action permanently deletes the script
2918
- # record. If script files were uploaded, they are also deleted (files
2919
- # 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).
2920
2986
  #
2921
2987
  # To delete a script, specify the script ID. Before deleting a script,
2922
2988
  # be sure to terminate all fleets that are deployed with the script
@@ -3067,16 +3133,16 @@ module Aws::GameLift
3067
3133
  req.send_request(options)
3068
3134
  end
3069
3135
 
3070
- # **This action is part of Amazon GameLift FleetIQ with game server
3071
- # groups, which is in preview release and is subject to change.**
3136
+ # **This operation is used with the Amazon GameLift FleetIQ solution and
3137
+ # game server groups.**
3072
3138
  #
3073
- # Removes the game server resource from the game server group. As a
3074
- # result of this action, the de-registered game server can no longer be
3075
- # claimed and will not returned in a list of active game servers.
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.
3076
3142
  #
3077
- # To de-register a game server, specify the game server group and game
3078
- # server ID. If successful, this action emits a CloudWatch event with
3079
- # termination time stamp and reason.
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.
3080
3146
  #
3081
3147
  # **Learn more**
3082
3148
  #
@@ -3098,15 +3164,15 @@ module Aws::GameLift
3098
3164
  #
3099
3165
  #
3100
3166
  #
3101
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
3167
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
3102
3168
  #
3103
3169
  # @option params [required, String] :game_server_group_name
3104
- # An identifier for the game server group where the game server to be
3105
- # de-registered is running. Use either the GameServerGroup name or ARN
3106
- # 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.
3107
3172
  #
3108
3173
  # @option params [required, String] :game_server_id
3109
- # The identifier for the game server to be de-registered.
3174
+ # A custom string that uniquely identifies the game server to
3175
+ # deregister.
3110
3176
  #
3111
3177
  # @return [Struct] Returns an empty {Seahorse::Client::Response response}.
3112
3178
  #
@@ -3291,13 +3357,13 @@ module Aws::GameLift
3291
3357
  # @example Request syntax with placeholder values
3292
3358
  #
3293
3359
  # resp = client.describe_ec2_instance_limits({
3294
- # 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
3295
3361
  # })
3296
3362
  #
3297
3363
  # @example Response structure
3298
3364
  #
3299
3365
  # resp.ec2_instance_limits #=> Array
3300
- # 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"
3301
3367
  # resp.ec2_instance_limits[0].current_instances #=> Integer
3302
3368
  # resp.ec2_instance_limits[0].instance_limit #=> Integer
3303
3369
  #
@@ -3320,7 +3386,7 @@ module Aws::GameLift
3320
3386
  # pages. If successful, a FleetAttributes object is returned for each
3321
3387
  # fleet requested, unless the fleet identifier is not found.
3322
3388
  #
3323
- # <note markdown="1"> Some API actions may limit the number of fleet IDs allowed in one
3389
+ # <note markdown="1"> Some API operations may limit the number of fleet IDs allowed in one
3324
3390
  # request. If a request exceeds this limit, the request fails and the
3325
3391
  # error message includes the maximum allowed number.
3326
3392
  #
@@ -3377,16 +3443,18 @@ module Aws::GameLift
3377
3443
  #
3378
3444
  # @option params [String] :next_token
3379
3445
  # Token that indicates the start of the next sequential page of results.
3380
- # Use the token that is returned with a previous call to this action. To
3381
- # start at the beginning of the result set, do not specify a value. This
3382
- # parameter is ignored when the request specifies one or a list of fleet
3383
- # 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.
3384
3450
  #
3385
3451
  # @return [Types::DescribeFleetAttributesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3386
3452
  #
3387
3453
  # * {Types::DescribeFleetAttributesOutput#fleet_attributes #fleet_attributes} => Array&lt;Types::FleetAttributes&gt;
3388
3454
  # * {Types::DescribeFleetAttributesOutput#next_token #next_token} => String
3389
3455
  #
3456
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3457
+ #
3390
3458
  # @example Request syntax with placeholder values
3391
3459
  #
3392
3460
  # resp = client.describe_fleet_attributes({
@@ -3401,7 +3469,7 @@ module Aws::GameLift
3401
3469
  # resp.fleet_attributes[0].fleet_id #=> String
3402
3470
  # resp.fleet_attributes[0].fleet_arn #=> String
3403
3471
  # resp.fleet_attributes[0].fleet_type #=> String, one of "ON_DEMAND", "SPOT"
3404
- # 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"
3405
3473
  # resp.fleet_attributes[0].description #=> String
3406
3474
  # resp.fleet_attributes[0].name #=> String
3407
3475
  # resp.fleet_attributes[0].creation_time #=> Time
@@ -3449,7 +3517,7 @@ module Aws::GameLift
3449
3517
  # requested fleet ID. When a list of fleet IDs is provided, attribute
3450
3518
  # objects are returned only for fleets that currently exist.
3451
3519
  #
3452
- # <note markdown="1"> Some API actions may limit the number of fleet IDs allowed in one
3520
+ # <note markdown="1"> Some API operations may limit the number of fleet IDs allowed in one
3453
3521
  # request. If a request exceeds this limit, the request fails and the
3454
3522
  # error message includes the maximum allowed.
3455
3523
  #
@@ -3506,16 +3574,18 @@ module Aws::GameLift
3506
3574
  #
3507
3575
  # @option params [String] :next_token
3508
3576
  # Token that indicates the start of the next sequential page of results.
3509
- # Use the token that is returned with a previous call to this action. To
3510
- # start at the beginning of the result set, do not specify a value. This
3511
- # parameter is ignored when the request specifies one or a list of fleet
3512
- # 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.
3513
3581
  #
3514
3582
  # @return [Types::DescribeFleetCapacityOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3515
3583
  #
3516
3584
  # * {Types::DescribeFleetCapacityOutput#fleet_capacity #fleet_capacity} => Array&lt;Types::FleetCapacity&gt;
3517
3585
  # * {Types::DescribeFleetCapacityOutput#next_token #next_token} => String
3518
3586
  #
3587
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3588
+ #
3519
3589
  # @example Request syntax with placeholder values
3520
3590
  #
3521
3591
  # resp = client.describe_fleet_capacity({
@@ -3528,7 +3598,7 @@ module Aws::GameLift
3528
3598
  #
3529
3599
  # resp.fleet_capacity #=> Array
3530
3600
  # resp.fleet_capacity[0].fleet_id #=> String
3531
- # 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"
3532
3602
  # resp.fleet_capacity[0].instance_counts.desired #=> Integer
3533
3603
  # resp.fleet_capacity[0].instance_counts.minimum #=> Integer
3534
3604
  # resp.fleet_capacity[0].instance_counts.maximum #=> Integer
@@ -3611,14 +3681,16 @@ module Aws::GameLift
3611
3681
  #
3612
3682
  # @option params [String] :next_token
3613
3683
  # Token that indicates the start of the next sequential page of results.
3614
- # Use the token that is returned with a previous call to this action. To
3615
- # 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.
3616
3686
  #
3617
3687
  # @return [Types::DescribeFleetEventsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3618
3688
  #
3619
3689
  # * {Types::DescribeFleetEventsOutput#events #events} => Array&lt;Types::Event&gt;
3620
3690
  # * {Types::DescribeFleetEventsOutput#next_token #next_token} => String
3621
3691
  #
3692
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3693
+ #
3622
3694
  # @example Request syntax with placeholder values
3623
3695
  #
3624
3696
  # resp = client.describe_fleet_events({
@@ -3738,7 +3810,7 @@ module Aws::GameLift
3738
3810
  # pages. If successful, a FleetUtilization object is returned for each
3739
3811
  # requested fleet ID, unless the fleet identifier is not found.
3740
3812
  #
3741
- # <note markdown="1"> Some API actions may limit the number of fleet IDs allowed in one
3813
+ # <note markdown="1"> Some API operations may limit the number of fleet IDs allowed in one
3742
3814
  # request. If a request exceeds this limit, the request fails and the
3743
3815
  # error message includes the maximum allowed.
3744
3816
  #
@@ -3798,16 +3870,18 @@ module Aws::GameLift
3798
3870
  #
3799
3871
  # @option params [String] :next_token
3800
3872
  # Token that indicates the start of the next sequential page of results.
3801
- # Use the token that is returned with a previous call to this action. To
3802
- # start at the beginning of the result set, do not specify a value. This
3803
- # parameter is ignored when the request specifies one or a list of fleet
3804
- # 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.
3805
3877
  #
3806
3878
  # @return [Types::DescribeFleetUtilizationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3807
3879
  #
3808
3880
  # * {Types::DescribeFleetUtilizationOutput#fleet_utilization #fleet_utilization} => Array&lt;Types::FleetUtilization&gt;
3809
3881
  # * {Types::DescribeFleetUtilizationOutput#next_token #next_token} => String
3810
3882
  #
3883
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
3884
+ #
3811
3885
  # @example Request syntax with placeholder values
3812
3886
  #
3813
3887
  # resp = client.describe_fleet_utilization({
@@ -3835,12 +3909,12 @@ module Aws::GameLift
3835
3909
  req.send_request(options)
3836
3910
  end
3837
3911
 
3838
- # **This action is part of Amazon GameLift FleetIQ with game server
3839
- # groups, which is in preview release and is subject to change.**
3912
+ # **This operation is used with the Amazon GameLift FleetIQ solution and
3913
+ # game server groups.**
3840
3914
  #
3841
- # Retrieves information for a game server resource. Information includes
3842
- # the game server statuses, health check info, and the instance the game
3843
- # 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.
3844
3918
  #
3845
3919
  # To retrieve game server information, specify the game server ID. If
3846
3920
  # successful, the requested game server object is returned.
@@ -3865,14 +3939,15 @@ module Aws::GameLift
3865
3939
  #
3866
3940
  #
3867
3941
  #
3868
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
3942
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
3869
3943
  #
3870
3944
  # @option params [required, String] :game_server_group_name
3871
- # An identifier for the game server group where the game server is
3945
+ # A unique identifier for the game server group where the game server is
3872
3946
  # running. Use either the GameServerGroup name or ARN value.
3873
3947
  #
3874
3948
  # @option params [required, String] :game_server_id
3875
- # The identifier for the game server to be retrieved.
3949
+ # A custom string that uniquely identifies the game server information
3950
+ # to be retrieved.
3876
3951
  #
3877
3952
  # @return [Types::DescribeGameServerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3878
3953
  #
@@ -3893,7 +3968,6 @@ module Aws::GameLift
3893
3968
  # resp.game_server.instance_id #=> String
3894
3969
  # resp.game_server.connection_info #=> String
3895
3970
  # resp.game_server.game_server_data #=> String
3896
- # resp.game_server.custom_sort_key #=> String
3897
3971
  # resp.game_server.claim_status #=> String, one of "CLAIMED"
3898
3972
  # resp.game_server.utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
3899
3973
  # resp.game_server.registration_time #=> Time
@@ -3909,10 +3983,14 @@ module Aws::GameLift
3909
3983
  req.send_request(options)
3910
3984
  end
3911
3985
 
3912
- # **This action is part of Amazon GameLift FleetIQ with game server
3913
- # groups, which is in preview release and is subject to change.**
3986
+ # **This operation is used with the Amazon GameLift FleetIQ solution and
3987
+ # game server groups.**
3914
3988
  #
3915
- # 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.
3916
3994
  #
3917
3995
  # To get attributes for a game server group, provide a group name or ARN
3918
3996
  # value. If successful, a GameServerGroup object is returned.
@@ -3937,13 +4015,15 @@ module Aws::GameLift
3937
4015
  #
3938
4016
  # * SuspendGameServerGroup
3939
4017
  #
4018
+ # * DescribeGameServerInstances
4019
+ #
3940
4020
  #
3941
4021
  #
3942
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
4022
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
3943
4023
  #
3944
4024
  # @option params [required, String] :game_server_group_name
3945
- # The unique identifier for the game server group being requested. Use
3946
- # either the GameServerGroup name or ARN value.
4025
+ # A unique identifier for the game server group. Use either the
4026
+ # GameServerGroup name or ARN value.
3947
4027
  #
3948
4028
  # @return [Types::DescribeGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
3949
4029
  #
@@ -3963,7 +4043,7 @@ module Aws::GameLift
3963
4043
  # resp.game_server_group.instance_definitions #=> Array
3964
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"
3965
4045
  # resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
3966
- # 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"
3967
4047
  # resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
3968
4048
  # resp.game_server_group.auto_scaling_group_arn #=> String
3969
4049
  # resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
@@ -3982,8 +4062,109 @@ module Aws::GameLift
3982
4062
  req.send_request(options)
3983
4063
  end
3984
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&lt;Types::GameServerInstance&gt;
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
+
3985
4166
  # Retrieves properties, including the protection policy in force, for
3986
- # one or more game sessions. This action can be used in several ways:
4167
+ # one or more game sessions. This operation can be used in several ways:
3987
4168
  # (1) provide a `GameSessionId` or `GameSessionArn` to request details
3988
4169
  # for a specific game session; (2) provide either a `FleetId` or an
3989
4170
  # `AliasId` to request properties for all game sessions running on a
@@ -4037,14 +4218,16 @@ module Aws::GameLift
4037
4218
  #
4038
4219
  # @option params [String] :next_token
4039
4220
  # Token that indicates the start of the next sequential page of results.
4040
- # Use the token that is returned with a previous call to this action. To
4041
- # 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.
4042
4223
  #
4043
4224
  # @return [Types::DescribeGameSessionDetailsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4044
4225
  #
4045
4226
  # * {Types::DescribeGameSessionDetailsOutput#game_session_details #game_session_details} => Array&lt;Types::GameSessionDetail&gt;
4046
4227
  # * {Types::DescribeGameSessionDetailsOutput#next_token #next_token} => String
4047
4228
  #
4229
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4230
+ #
4048
4231
  # @example Request syntax with placeholder values
4049
4232
  #
4050
4233
  # resp = client.describe_game_session_details({
@@ -4197,19 +4380,22 @@ module Aws::GameLift
4197
4380
  #
4198
4381
  # @option params [Integer] :limit
4199
4382
  # The maximum number of results to return. Use this parameter with
4200
- # `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.
4201
4385
  #
4202
4386
  # @option params [String] :next_token
4203
4387
  # A token that indicates the start of the next sequential page of
4204
4388
  # results. Use the token that is returned with a previous call to this
4205
- # action. To start at the beginning of the result set, do not specify a
4206
- # value.
4389
+ # operation. To start at the beginning of the result set, do not specify
4390
+ # a value.
4207
4391
  #
4208
4392
  # @return [Types::DescribeGameSessionQueuesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4209
4393
  #
4210
4394
  # * {Types::DescribeGameSessionQueuesOutput#game_session_queues #game_session_queues} => Array&lt;Types::GameSessionQueue&gt;
4211
4395
  # * {Types::DescribeGameSessionQueuesOutput#next_token #next_token} => String
4212
4396
  #
4397
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4398
+ #
4213
4399
  # @example Request syntax with placeholder values
4214
4400
  #
4215
4401
  # resp = client.describe_game_session_queues({
@@ -4296,14 +4482,16 @@ module Aws::GameLift
4296
4482
  #
4297
4483
  # @option params [String] :next_token
4298
4484
  # Token that indicates the start of the next sequential page of results.
4299
- # Use the token that is returned with a previous call to this action. To
4300
- # 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.
4301
4487
  #
4302
4488
  # @return [Types::DescribeGameSessionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4303
4489
  #
4304
4490
  # * {Types::DescribeGameSessionsOutput#game_sessions #game_sessions} => Array&lt;Types::GameSession&gt;
4305
4491
  # * {Types::DescribeGameSessionsOutput#next_token #next_token} => String
4306
4492
  #
4493
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4494
+ #
4307
4495
  # @example Request syntax with placeholder values
4308
4496
  #
4309
4497
  # resp = client.describe_game_sessions({
@@ -4350,8 +4538,8 @@ module Aws::GameLift
4350
4538
  end
4351
4539
 
4352
4540
  # Retrieves information about a fleet's instances, including instance
4353
- # IDs. Use this action to get details on all instances in the fleet or
4354
- # 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.
4355
4543
  #
4356
4544
  # To get a specific instance, specify fleet ID and instance ID. To get
4357
4545
  # all instances in a fleet, specify a fleet ID only. Use the pagination
@@ -4389,14 +4577,16 @@ module Aws::GameLift
4389
4577
  #
4390
4578
  # @option params [String] :next_token
4391
4579
  # Token that indicates the start of the next sequential page of results.
4392
- # Use the token that is returned with a previous call to this action. To
4393
- # 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.
4394
4582
  #
4395
4583
  # @return [Types::DescribeInstancesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4396
4584
  #
4397
4585
  # * {Types::DescribeInstancesOutput#instances #instances} => Array&lt;Types::Instance&gt;
4398
4586
  # * {Types::DescribeInstancesOutput#next_token #next_token} => String
4399
4587
  #
4588
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4589
+ #
4400
4590
  # @example Request syntax with placeholder values
4401
4591
  #
4402
4592
  # resp = client.describe_instances({
@@ -4414,7 +4604,7 @@ module Aws::GameLift
4414
4604
  # resp.instances[0].ip_address #=> String
4415
4605
  # resp.instances[0].dns_name #=> String
4416
4606
  # resp.instances[0].operating_system #=> String, one of "WINDOWS_2012", "AMAZON_LINUX", "AMAZON_LINUX_2"
4417
- # 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"
4418
4608
  # resp.instances[0].status #=> String, one of "PENDING", "ACTIVE", "TERMINATING"
4419
4609
  # resp.instances[0].creation_time #=> Time
4420
4610
  # resp.next_token #=> String
@@ -4429,19 +4619,24 @@ module Aws::GameLift
4429
4619
  end
4430
4620
 
4431
4621
  # Retrieves one or more matchmaking tickets. Use this operation to
4432
- # retrieve ticket information, including status and--once a successful
4433
- # match is made--acquire connection information for the resulting new
4434
- # game session.
4435
- #
4436
- # You can use this operation to track the progress of matchmaking
4437
- # requests (through polling) as an alternative to using event
4438
- # notifications. See more details on tracking matchmaking requests
4439
- # 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.
4440
4624
  #
4441
4625
  # To request matchmaking tickets, provide a list of up to 10 ticket IDs.
4442
4626
  # If the request is successful, a ticket object is returned for each
4443
4627
  # requested ID that currently exists.
4444
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
+ #
4445
4640
  # **Learn more**
4446
4641
  #
4447
4642
  # [ Add FlexMatch to a Game Client][1]
@@ -4462,8 +4657,8 @@ module Aws::GameLift
4462
4657
  #
4463
4658
  #
4464
4659
  #
4465
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-client.html
4466
- # [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-notification.html
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
4467
4662
  #
4468
4663
  # @option params [required, Array<String>] :ticket_ids
4469
4664
  # A unique identifier for a matchmaking ticket. You can include up to 10
@@ -4515,15 +4710,18 @@ module Aws::GameLift
4515
4710
  req.send_request(options)
4516
4711
  end
4517
4712
 
4518
- # Retrieves the details of FlexMatch matchmaking configurations. With
4519
- # this operation, you have the following options: (1) retrieve all
4520
- # existing configurations, (2) provide the names of one or more
4521
- # configurations to retrieve, or (3) retrieve all configurations that
4522
- # use a specified rule set name. When requesting multiple items, use the
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
4523
4719
  # pagination parameters to retrieve results as a set of sequential
4524
- # pages. If successful, a configuration is returned for each requested
4525
- # name. When specifying a list of names, only configurations that
4526
- # currently exist are returned.
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.
4527
4725
  #
4528
4726
  # **Learn more**
4529
4727
  #
@@ -4549,7 +4747,7 @@ module Aws::GameLift
4549
4747
  #
4550
4748
  #
4551
4749
  #
4552
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/matchmaker-build.html
4750
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/matchmaker-build.html
4553
4751
  #
4554
4752
  # @option params [Array<String>] :names
4555
4753
  # A unique identifier for a matchmaking configuration(s) to retrieve.
@@ -4569,14 +4767,16 @@ module Aws::GameLift
4569
4767
  # @option params [String] :next_token
4570
4768
  # A token that indicates the start of the next sequential page of
4571
4769
  # results. Use the token that is returned with a previous call to this
4572
- # action. To start at the beginning of the result set, do not specify a
4573
- # value.
4770
+ # operation. To start at the beginning of the result set, do not specify
4771
+ # a value.
4574
4772
  #
4575
4773
  # @return [Types::DescribeMatchmakingConfigurationsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4576
4774
  #
4577
4775
  # * {Types::DescribeMatchmakingConfigurationsOutput#configurations #configurations} => Array&lt;Types::MatchmakingConfiguration&gt;
4578
4776
  # * {Types::DescribeMatchmakingConfigurationsOutput#next_token #next_token} => String
4579
4777
  #
4778
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4779
+ #
4580
4780
  # @example Request syntax with placeholder values
4581
4781
  #
4582
4782
  # resp = client.describe_matchmaking_configurations({
@@ -4608,6 +4808,7 @@ module Aws::GameLift
4608
4808
  # resp.configurations[0].game_properties[0].value #=> String
4609
4809
  # resp.configurations[0].game_session_data #=> String
4610
4810
  # resp.configurations[0].backfill_mode #=> String, one of "AUTOMATIC", "MANUAL"
4811
+ # resp.configurations[0].flex_match_mode #=> String, one of "STANDALONE", "WITH_QUEUE"
4611
4812
  # resp.next_token #=> String
4612
4813
  #
4613
4814
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeMatchmakingConfigurations AWS API Documentation
@@ -4651,7 +4852,7 @@ module Aws::GameLift
4651
4852
  #
4652
4853
  #
4653
4854
  #
4654
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-rulesets.html
4855
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html
4655
4856
  #
4656
4857
  # @option params [Array<String>] :names
4657
4858
  # A list of one or more matchmaking rule set names to retrieve details
@@ -4666,14 +4867,16 @@ module Aws::GameLift
4666
4867
  # @option params [String] :next_token
4667
4868
  # A token that indicates the start of the next sequential page of
4668
4869
  # results. Use the token that is returned with a previous call to this
4669
- # action. To start at the beginning of the result set, do not specify a
4670
- # value.
4870
+ # operation. To start at the beginning of the result set, do not specify
4871
+ # a value.
4671
4872
  #
4672
4873
  # @return [Types::DescribeMatchmakingRuleSetsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4673
4874
  #
4674
4875
  # * {Types::DescribeMatchmakingRuleSetsOutput#rule_sets #rule_sets} => Array&lt;Types::MatchmakingRuleSet&gt;
4675
4876
  # * {Types::DescribeMatchmakingRuleSetsOutput#next_token #next_token} => String
4676
4877
  #
4878
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4879
+ #
4677
4880
  # @example Request syntax with placeholder values
4678
4881
  #
4679
4882
  # resp = client.describe_matchmaking_rule_sets({
@@ -4700,9 +4903,9 @@ module Aws::GameLift
4700
4903
  req.send_request(options)
4701
4904
  end
4702
4905
 
4703
- # Retrieves properties for one or more player sessions. This action can
4704
- # be used in several ways: (1) provide a `PlayerSessionId` to request
4705
- # 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
4706
4909
  # `GameSessionId` to request properties for all player sessions in the
4707
4910
  # specified game session; (3) provide a `PlayerId` to request properties
4708
4911
  # for all player sessions of a specified player.
@@ -4765,15 +4968,17 @@ module Aws::GameLift
4765
4968
  #
4766
4969
  # @option params [String] :next_token
4767
4970
  # Token that indicates the start of the next sequential page of results.
4768
- # Use the token that is returned with a previous call to this action. To
4769
- # start at the beginning of the result set, do not specify a value. If a
4770
- # 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.
4771
4974
  #
4772
4975
  # @return [Types::DescribePlayerSessionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4773
4976
  #
4774
4977
  # * {Types::DescribePlayerSessionsOutput#player_sessions #player_sessions} => Array&lt;Types::PlayerSession&gt;
4775
4978
  # * {Types::DescribePlayerSessionsOutput#next_token #next_token} => String
4776
4979
  #
4980
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
4981
+ #
4777
4982
  # @example Request syntax with placeholder values
4778
4983
  #
4779
4984
  # resp = client.describe_player_sessions({
@@ -4900,7 +5105,7 @@ module Aws::GameLift
4900
5105
  # is returned for the fleet.
4901
5106
  #
4902
5107
  # A fleet may have all of its scaling policies suspended
4903
- # (StopFleetActions). This action does not affect the status of the
5108
+ # (StopFleetActions). This operation does not affect the status of the
4904
5109
  # scaling policies, which remains ACTIVE. To see whether a fleet's
4905
5110
  # scaling policies are in force or suspended, call
4906
5111
  # DescribeFleetAttributes and check the stopped actions.
@@ -4956,14 +5161,16 @@ module Aws::GameLift
4956
5161
  #
4957
5162
  # @option params [String] :next_token
4958
5163
  # Token that indicates the start of the next sequential page of results.
4959
- # Use the token that is returned with a previous call to this action. To
4960
- # 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.
4961
5166
  #
4962
5167
  # @return [Types::DescribeScalingPoliciesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
4963
5168
  #
4964
5169
  # * {Types::DescribeScalingPoliciesOutput#scaling_policies #scaling_policies} => Array&lt;Types::ScalingPolicy&gt;
4965
5170
  # * {Types::DescribeScalingPoliciesOutput#next_token #next_token} => String
4966
5171
  #
5172
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5173
+ #
4967
5174
  # @example Request syntax with placeholder values
4968
5175
  #
4969
5176
  # resp = client.describe_scaling_policies({
@@ -5228,7 +5435,7 @@ module Aws::GameLift
5228
5435
  # an SSH client. The private key must be saved in the proper format to a
5229
5436
  # `.pem` file before using. If you're making this request using the AWS
5230
5437
  # CLI, saving the secret can be handled as part of the GetInstanceAccess
5231
- # request, as shown in one of the examples for this action.
5438
+ # request, as shown in one of the examples for this operation.
5232
5439
  #
5233
5440
  # To request access to a specific instance, specify the IDs of both the
5234
5441
  # instance and the fleet it belongs to. You can retrieve a fleet's
@@ -5339,14 +5546,16 @@ module Aws::GameLift
5339
5546
  # @option params [String] :next_token
5340
5547
  # A token that indicates the start of the next sequential page of
5341
5548
  # results. Use the token that is returned with a previous call to this
5342
- # action. To start at the beginning of the result set, do not specify a
5343
- # value.
5549
+ # operation. To start at the beginning of the result set, do not specify
5550
+ # a value.
5344
5551
  #
5345
5552
  # @return [Types::ListAliasesOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5346
5553
  #
5347
5554
  # * {Types::ListAliasesOutput#aliases #aliases} => Array&lt;Types::Alias&gt;
5348
5555
  # * {Types::ListAliasesOutput#next_token #next_token} => String
5349
5556
  #
5557
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5558
+ #
5350
5559
  # @example Request syntax with placeholder values
5351
5560
  #
5352
5561
  # resp = client.list_aliases({
@@ -5431,14 +5640,16 @@ module Aws::GameLift
5431
5640
  #
5432
5641
  # @option params [String] :next_token
5433
5642
  # Token that indicates the start of the next sequential page of results.
5434
- # Use the token that is returned with a previous call to this action. To
5435
- # 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.
5436
5645
  #
5437
5646
  # @return [Types::ListBuildsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5438
5647
  #
5439
5648
  # * {Types::ListBuildsOutput#builds #builds} => Array&lt;Types::Build&gt;
5440
5649
  # * {Types::ListBuildsOutput#next_token #next_token} => String
5441
5650
  #
5651
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5652
+ #
5442
5653
  # @example Request syntax with placeholder values
5443
5654
  #
5444
5655
  # resp = client.list_builds({
@@ -5518,14 +5729,16 @@ module Aws::GameLift
5518
5729
  #
5519
5730
  # @option params [String] :next_token
5520
5731
  # Token that indicates the start of the next sequential page of results.
5521
- # Use the token that is returned with a previous call to this action. To
5522
- # 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.
5523
5734
  #
5524
5735
  # @return [Types::ListFleetsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5525
5736
  #
5526
5737
  # * {Types::ListFleetsOutput#fleet_ids #fleet_ids} => Array&lt;String&gt;
5527
5738
  # * {Types::ListFleetsOutput#next_token #next_token} => String
5528
5739
  #
5740
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5741
+ #
5529
5742
  # @example Request syntax with placeholder values
5530
5743
  #
5531
5744
  # resp = client.list_fleets({
@@ -5550,12 +5763,12 @@ module Aws::GameLift
5550
5763
  req.send_request(options)
5551
5764
  end
5552
5765
 
5553
- # **This action is part of Amazon GameLift FleetIQ with game server
5554
- # groups, which is in preview release and is subject to change.**
5766
+ # **This operation is used with the Amazon GameLift FleetIQ solution and
5767
+ # game server groups.**
5555
5768
  #
5556
5769
  # Retrieves information on all game servers groups that exist in the
5557
- # current AWS account for the selected region. Use the pagination
5558
- # parameters to retrieve results in a set of sequential pages.
5770
+ # current AWS account for the selected Region. Use the pagination
5771
+ # parameters to retrieve results in a set of sequential segments.
5559
5772
  #
5560
5773
  # **Learn more**
5561
5774
  #
@@ -5577,25 +5790,29 @@ module Aws::GameLift
5577
5790
  #
5578
5791
  # * SuspendGameServerGroup
5579
5792
  #
5793
+ # * DescribeGameServerInstances
5794
+ #
5580
5795
  #
5581
5796
  #
5582
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
5797
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
5583
5798
  #
5584
5799
  # @option params [Integer] :limit
5585
5800
  # The maximum number of results to return. Use this parameter with
5586
- # `NextToken` to get results as a set of sequential pages.
5801
+ # `NextToken` to get results as a set of sequential segments.
5587
5802
  #
5588
5803
  # @option params [String] :next_token
5589
- # A token that indicates the start of the next sequential page of
5590
- # results. Use the token that is returned with a previous call to this
5591
- # action. To start at the beginning of the result set, do not specify a
5592
- # 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.
5593
5808
  #
5594
5809
  # @return [Types::ListGameServerGroupsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5595
5810
  #
5596
5811
  # * {Types::ListGameServerGroupsOutput#game_server_groups #game_server_groups} => Array&lt;Types::GameServerGroup&gt;
5597
5812
  # * {Types::ListGameServerGroupsOutput#next_token #next_token} => String
5598
5813
  #
5814
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5815
+ #
5599
5816
  # @example Request syntax with placeholder values
5600
5817
  #
5601
5818
  # resp = client.list_game_server_groups({
@@ -5612,7 +5829,7 @@ module Aws::GameLift
5612
5829
  # resp.game_server_groups[0].instance_definitions #=> Array
5613
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"
5614
5831
  # resp.game_server_groups[0].instance_definitions[0].weighted_capacity #=> String
5615
- # 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"
5616
5833
  # resp.game_server_groups[0].game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
5617
5834
  # resp.game_server_groups[0].auto_scaling_group_arn #=> String
5618
5835
  # resp.game_server_groups[0].status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
@@ -5632,14 +5849,13 @@ module Aws::GameLift
5632
5849
  req.send_request(options)
5633
5850
  end
5634
5851
 
5635
- # **This action is part of Amazon GameLift FleetIQ with game server
5636
- # groups, which is in preview release and is subject to change.**
5852
+ # **This operation is used with the Amazon GameLift FleetIQ solution and
5853
+ # game server groups.**
5637
5854
  #
5638
- # Retrieves information on all game servers that are currently running
5639
- # in a specified game server group. If there are custom key sort values
5640
- # for your game servers, you can opt to have the returned list sorted
5641
- # based on these values. Use the pagination parameters to retrieve
5642
- # 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.
5643
5859
  #
5644
5860
  # **Learn more**
5645
5861
  #
@@ -5661,32 +5877,36 @@ module Aws::GameLift
5661
5877
  #
5662
5878
  #
5663
5879
  #
5664
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
5880
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
5665
5881
  #
5666
5882
  # @option params [required, String] :game_server_group_name
5667
- # An identifier for the game server group for the game server you want
5668
- # to list. Use either the GameServerGroup name or ARN value.
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.
5669
5885
  #
5670
5886
  # @option params [String] :sort_order
5671
- # Indicates how to sort the returned data based on the game servers'
5672
- # custom key sort value. If this parameter is left empty, the list of
5673
- # game servers is returned in no particular order.
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.
5674
5892
  #
5675
5893
  # @option params [Integer] :limit
5676
5894
  # The maximum number of results to return. Use this parameter with
5677
- # `NextToken` to get results as a set of sequential pages.
5895
+ # `NextToken` to get results as a set of sequential segments.
5678
5896
  #
5679
5897
  # @option params [String] :next_token
5680
- # A token that indicates the start of the next sequential page of
5681
- # results. Use the token that is returned with a previous call to this
5682
- # action. To start at the beginning of the result set, do not specify a
5683
- # 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.
5684
5902
  #
5685
5903
  # @return [Types::ListGameServersOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5686
5904
  #
5687
5905
  # * {Types::ListGameServersOutput#game_servers #game_servers} => Array&lt;Types::GameServer&gt;
5688
5906
  # * {Types::ListGameServersOutput#next_token #next_token} => String
5689
5907
  #
5908
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5909
+ #
5690
5910
  # @example Request syntax with placeholder values
5691
5911
  #
5692
5912
  # resp = client.list_game_servers({
@@ -5705,7 +5925,6 @@ module Aws::GameLift
5705
5925
  # resp.game_servers[0].instance_id #=> String
5706
5926
  # resp.game_servers[0].connection_info #=> String
5707
5927
  # resp.game_servers[0].game_server_data #=> String
5708
- # resp.game_servers[0].custom_sort_key #=> String
5709
5928
  # resp.game_servers[0].claim_status #=> String, one of "CLAIMED"
5710
5929
  # resp.game_servers[0].utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
5711
5930
  # resp.game_servers[0].registration_time #=> Time
@@ -5752,14 +5971,16 @@ module Aws::GameLift
5752
5971
  # @option params [String] :next_token
5753
5972
  # A token that indicates the start of the next sequential page of
5754
5973
  # results. Use the token that is returned with a previous call to this
5755
- # action. To start at the beginning of the result set, do not specify a
5756
- # value.
5974
+ # operation. To start at the beginning of the result set, do not specify
5975
+ # a value.
5757
5976
  #
5758
5977
  # @return [Types::ListScriptsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
5759
5978
  #
5760
5979
  # * {Types::ListScriptsOutput#scripts #scripts} => Array&lt;Types::Script&gt;
5761
5980
  # * {Types::ListScriptsOutput#next_token #next_token} => String
5762
5981
  #
5982
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
5983
+ #
5763
5984
  # @example Request syntax with placeholder values
5764
5985
  #
5765
5986
  # resp = client.list_scripts({
@@ -5793,7 +6014,7 @@ module Aws::GameLift
5793
6014
 
5794
6015
  # Retrieves all tags that are assigned to a GameLift resource. Resource
5795
6016
  # tags are used to organize AWS resources for a range of purposes. This
5796
- # action handles the permissions necessary to manage tags for the
6017
+ # operation handles the permissions necessary to manage tags for the
5797
6018
  # following GameLift resource types:
5798
6019
  #
5799
6020
  # * Build
@@ -5836,8 +6057,8 @@ module Aws::GameLift
5836
6057
  # The Amazon Resource Name ([ARN][1]) that is assigned to and uniquely
5837
6058
  # identifies the GameLift resource that you want to retrieve tags for.
5838
6059
  # GameLift resource ARNs are included in the data object for the
5839
- # resource, which can be retrieved by calling a List or Describe action
5840
- # for the resource type.
6060
+ # resource, which can be retrieved by calling a List or Describe
6061
+ # operation for the resource type.
5841
6062
  #
5842
6063
  #
5843
6064
  #
@@ -6105,26 +6326,26 @@ module Aws::GameLift
6105
6326
  req.send_request(options)
6106
6327
  end
6107
6328
 
6108
- # **This action is part of Amazon GameLift FleetIQ with game server
6109
- # groups, which is in preview release and is subject to change.**
6329
+ # **This operation is used with the Amazon GameLift FleetIQ solution and
6330
+ # game server groups.**
6110
6331
  #
6111
6332
  # Creates a new game server resource and notifies GameLift FleetIQ that
6112
- # the game server is ready to host gameplay and players. This action is
6113
- # 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
6114
6335
  # game server group. Registering game servers enables GameLift FleetIQ
6115
6336
  # to track available game servers and enables game clients and services
6116
6337
  # to claim a game server for a new game session.
6117
6338
  #
6118
6339
  # To register a game server, identify the game server group and instance
6119
6340
  # where the game server is running, and provide a unique identifier for
6120
- # the game server. You can also include connection and game server data;
6121
- # when a game client or service requests a game server by calling
6122
- # 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.
6123
6344
  #
6124
6345
  # Once a game server is successfully registered, it is put in status
6125
- # AVAILABLE. A request to register a game server may fail if the
6126
- # instance it is in the process of shutting down as part of instance
6127
- # rebalancing or scale-down activity.
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.
6128
6349
  #
6129
6350
  # **Learn more**
6130
6351
  #
@@ -6146,51 +6367,33 @@ module Aws::GameLift
6146
6367
  #
6147
6368
  #
6148
6369
  #
6149
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
6370
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
6150
6371
  #
6151
6372
  # @option params [required, String] :game_server_group_name
6152
- # An identifier for the game server group where the game server is
6153
- # running. You can use either the GameServerGroup name or ARN value.
6373
+ # A unique identifier for the game server group where the game server is
6374
+ # running. Use either the GameServerGroup name or ARN value.
6154
6375
  #
6155
6376
  # @option params [required, String] :game_server_id
6156
- # A custom string that uniquely identifies the new game server. Game
6157
- # server IDs are developer-defined and must be unique across all game
6158
- # 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.
6159
6380
  #
6160
6381
  # @option params [required, String] :instance_id
6161
6382
  # The unique identifier for the instance where the game server is
6162
- # 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`.
6163
6385
  #
6164
6386
  # @option params [String] :connection_info
6165
- # Information needed to make inbound client connections to the game
6166
- # server. This might include IP address and port, DNS name, etc.
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.
6167
6390
  #
6168
6391
  # @option params [String] :game_server_data
6169
6392
  # A set of custom game server properties, formatted as a single string
6170
6393
  # value. This data is passed to a game client or service when it
6171
- # requests information on a game servers using ListGameServers or
6394
+ # requests information on game servers using ListGameServers or
6172
6395
  # ClaimGameServer.
6173
6396
  #
6174
- # @option params [String] :custom_sort_key
6175
- # A game server tag that can be used to request sorted lists of game
6176
- # servers using ListGameServers. Custom sort keys are developer-defined
6177
- # based on how you want to organize the retrieved game server
6178
- # information.
6179
- #
6180
- # @option params [Array<Types::Tag>] :tags
6181
- # A list of labels to assign to the new game server resource. Tags are
6182
- # developer-defined key-value pairs. Tagging AWS resources are useful
6183
- # for resource management, access management, and cost allocation. For
6184
- # more information, see [ Tagging AWS Resources][1] in the *AWS General
6185
- # Reference*. Once the resource is created, you can use TagResource,
6186
- # UntagResource, and ListTagsForResource to add, remove, and view tags.
6187
- # The maximum tag limit may be lower than stated. See the AWS General
6188
- # Reference for actual tagging limits.
6189
- #
6190
- #
6191
- #
6192
- # [1]: https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html
6193
- #
6194
6397
  # @return [Types::RegisterGameServerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6195
6398
  #
6196
6399
  # * {Types::RegisterGameServerOutput#game_server #game_server} => Types::GameServer
@@ -6203,13 +6406,6 @@ module Aws::GameLift
6203
6406
  # instance_id: "GameServerInstanceId", # required
6204
6407
  # connection_info: "GameServerConnectionInfo",
6205
6408
  # game_server_data: "GameServerData",
6206
- # custom_sort_key: "GameServerSortKey",
6207
- # tags: [
6208
- # {
6209
- # key: "TagKey", # required
6210
- # value: "TagValue", # required
6211
- # },
6212
- # ],
6213
6409
  # })
6214
6410
  #
6215
6411
  # @example Response structure
@@ -6220,7 +6416,6 @@ module Aws::GameLift
6220
6416
  # resp.game_server.instance_id #=> String
6221
6417
  # resp.game_server.connection_info #=> String
6222
6418
  # resp.game_server.game_server_data #=> String
6223
- # resp.game_server.custom_sort_key #=> String
6224
6419
  # resp.game_server.claim_status #=> String, one of "CLAIMED"
6225
6420
  # resp.game_server.utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
6226
6421
  # resp.game_server.registration_time #=> Time
@@ -6342,19 +6537,21 @@ module Aws::GameLift
6342
6537
  req.send_request(options)
6343
6538
  end
6344
6539
 
6345
- # **This action is part of Amazon GameLift FleetIQ with game server
6346
- # groups, which is in preview release and is subject to change.**
6540
+ # **This operation is used with the Amazon GameLift FleetIQ solution and
6541
+ # game server groups.**
6347
6542
  #
6348
6543
  # Reinstates activity on a game server group after it has been
6349
- # suspended. A game server group may be suspended by calling
6350
- # SuspendGameServerGroup, or it may have been involuntarily suspended
6351
- # due to a configuration problem. You can manually resume activity on
6352
- # the group once the configuration problem has been resolved. Refer to
6353
- # the game server group status and status reason for more information on
6354
- # 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.
6355
6550
  #
6356
6551
  # To resume activity, specify a game server group ARN and the type of
6357
- # 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`.
6358
6555
  #
6359
6556
  # **Learn more**
6360
6557
  #
@@ -6376,16 +6573,18 @@ module Aws::GameLift
6376
6573
  #
6377
6574
  # * SuspendGameServerGroup
6378
6575
  #
6576
+ # * DescribeGameServerInstances
6577
+ #
6379
6578
  #
6380
6579
  #
6381
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
6580
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
6382
6581
  #
6383
6582
  # @option params [required, String] :game_server_group_name
6384
- # The unique identifier of the game server group to resume activity on.
6385
- # Use either the GameServerGroup name or ARN value.
6583
+ # A unique identifier for the game server group. Use either the
6584
+ # GameServerGroup name or ARN value.
6386
6585
  #
6387
6586
  # @option params [required, Array<String>] :resume_actions
6388
- # The action to resume for this game server group.
6587
+ # The activity to resume for this game server group.
6389
6588
  #
6390
6589
  # @return [Types::ResumeGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6391
6590
  #
@@ -6406,7 +6605,7 @@ module Aws::GameLift
6406
6605
  # resp.game_server_group.instance_definitions #=> Array
6407
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"
6408
6607
  # resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
6409
- # 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"
6410
6609
  # resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
6411
6610
  # resp.game_server_group.auto_scaling_group_arn #=> String
6412
6611
  # resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
@@ -6585,14 +6784,16 @@ module Aws::GameLift
6585
6784
  #
6586
6785
  # @option params [String] :next_token
6587
6786
  # Token that indicates the start of the next sequential page of results.
6588
- # Use the token that is returned with a previous call to this action. To
6589
- # 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.
6590
6789
  #
6591
6790
  # @return [Types::SearchGameSessionsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6592
6791
  #
6593
6792
  # * {Types::SearchGameSessionsOutput#game_sessions #game_sessions} => Array&lt;Types::GameSession&gt;
6594
6793
  # * {Types::SearchGameSessionsOutput#next_token #next_token} => String
6595
6794
  #
6795
+ # The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
6796
+ #
6596
6797
  # @example Request syntax with placeholder values
6597
6798
  #
6598
6799
  # resp = client.search_game_sessions({
@@ -6925,8 +7126,8 @@ module Aws::GameLift
6925
7126
  #
6926
7127
  #
6927
7128
  #
6928
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-match.html
6929
- # [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-backfill.html
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
6930
7131
  #
6931
7132
  # @option params [String] :ticket_id
6932
7133
  # A unique identifier for a matchmaking ticket. If no ticket ID is
@@ -6940,7 +7141,7 @@ module Aws::GameLift
6940
7141
  # used with the original game session is listed in the GameSession
6941
7142
  # object, `MatchmakerData` property.
6942
7143
  #
6943
- # @option params [required, String] :game_session_arn
7144
+ # @option params [String] :game_session_arn
6944
7145
  # Amazon Resource Name ([ARN][1]) that is assigned to a game session and
6945
7146
  # uniquely identifies it. This is the same as the game session ID.
6946
7147
  #
@@ -6965,7 +7166,7 @@ module Aws::GameLift
6965
7166
  #
6966
7167
  #
6967
7168
  #
6968
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-server.html#match-server-data
7169
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data
6969
7170
  #
6970
7171
  # @return [Types::StartMatchBackfillOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6971
7172
  #
@@ -6976,7 +7177,7 @@ module Aws::GameLift
6976
7177
  # resp = client.start_match_backfill({
6977
7178
  # ticket_id: "MatchmakingIdStringModel",
6978
7179
  # configuration_name: "MatchmakingConfigurationName", # required
6979
- # game_session_arn: "ArnStringModel", # required
7180
+ # game_session_arn: "ArnStringModel",
6980
7181
  # players: [ # required
6981
7182
  # {
6982
7183
  # player_id: "NonZeroAndMaxString",
@@ -7027,71 +7228,27 @@ module Aws::GameLift
7027
7228
  end
7028
7229
 
7029
7230
  # Uses FlexMatch to create a game match for a group of players based on
7030
- # custom matchmaking rules, and starts a new game for the matched
7031
- # players. Each matchmaking request specifies the type of match to build
7032
- # (team configuration, rules for an acceptable match, etc.). The request
7033
- # also specifies the players to find a match for and where to host the
7034
- # new game session for optimal performance. A matchmaking request might
7035
- # start with a single player or a group of players who want to play
7036
- # together. FlexMatch finds additional players as needed to fill the
7037
- # match. Match type, rules, and the queue used to place a new game
7038
- # 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`.
7039
7239
  #
7040
7240
  # To start matchmaking, provide a unique ticket ID, specify a
7041
- # matchmaking configuration, and include the players to be matched. You
7042
- # must also include a set of player attributes relevant for the
7043
- # matchmaking configuration. If successful, a matchmaking ticket is
7044
- # returned with status set to `QUEUED`. Track the status of the ticket
7045
- # to respond as needed and acquire game session connection information
7046
- # for successfully completed matches.
7047
- #
7048
- # **Tracking ticket status** -- A couple of options are available for
7049
- # tracking the status of matchmaking requests:
7050
- #
7051
- # * Polling -- Call `DescribeMatchmaking`. This operation returns the
7052
- # full ticket object, including current status and (for completed
7053
- # tickets) game session connection info. We recommend polling no more
7054
- # than once every 10 seconds.
7055
- #
7056
- # * Notifications -- Get event notifications for changes in ticket
7057
- # status using Amazon Simple Notification Service (SNS). Notifications
7058
- # are easy to set up (see CreateMatchmakingConfiguration) and
7059
- # typically deliver match status changes faster and more efficiently
7060
- # than polling. We recommend that you use polling to back up to
7061
- # notifications (since delivery is not guaranteed) and call
7062
- # `DescribeMatchmaking` only when notifications are not received
7063
- # within 30 seconds.
7064
- #
7065
- # **Processing a matchmaking request** -- FlexMatch handles a
7066
- # matchmaking request as follows:
7067
- #
7068
- # 1. Your client code submits a `StartMatchmaking` request for one or
7069
- # more players and tracks the status of the request ticket.
7070
- #
7071
- # 2. FlexMatch uses this ticket and others in process to build an
7072
- # acceptable match. When a potential match is identified, all
7073
- # tickets in the proposed match are advanced to the next status.
7074
- #
7075
- # 3. If the match requires player acceptance (set in the matchmaking
7076
- # configuration), the tickets move into status
7077
- # `REQUIRES_ACCEPTANCE`. This status triggers your client code to
7078
- # solicit acceptance from all players in every ticket involved in
7079
- # the match, and then call AcceptMatch for each player. If any
7080
- # player rejects or fails to accept the match before a specified
7081
- # timeout, the proposed match is dropped (see `AcceptMatch` for more
7082
- # details).
7083
- #
7084
- # 4. Once a match is proposed and accepted, the matchmaking tickets
7085
- # move into status `PLACING`. FlexMatch locates resources for a new
7086
- # game session using the game session queue (set in the matchmaking
7087
- # configuration) and creates the game session based on the match
7088
- # data.
7089
- #
7090
- # 5. When the match is successfully placed, the matchmaking tickets
7091
- # move into `COMPLETED` status. Connection information (including
7092
- # game session endpoint and player session) is added to the
7093
- # matchmaking tickets. Matched players can use the connection
7094
- # 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.
7095
7252
  #
7096
7253
  # **Learn more**
7097
7254
  #
@@ -7117,10 +7274,10 @@ module Aws::GameLift
7117
7274
  #
7118
7275
  #
7119
7276
  #
7120
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-client.html
7121
- # [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-notification.html
7122
- # [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-tasks.html
7123
- # [4]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-match.html
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
7124
7281
  #
7125
7282
  # @option params [String] :ticket_id
7126
7283
  # A unique identifier for a matchmaking ticket. If no ticket ID is
@@ -7341,7 +7498,7 @@ module Aws::GameLift
7341
7498
  # The ticket ID is included in the `MatchmakerData` of an updated game
7342
7499
  # session object, which is provided to the game server.
7343
7500
  #
7344
- # <note markdown="1"> If the action is successful, the service sends back an empty JSON
7501
+ # <note markdown="1"> If the operation is successful, the service sends back an empty JSON
7345
7502
  # struct with the HTTP 200 response (not an empty HTTP body).
7346
7503
  #
7347
7504
  # </note>
@@ -7364,7 +7521,7 @@ module Aws::GameLift
7364
7521
  #
7365
7522
  #
7366
7523
  #
7367
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-client.html
7524
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html
7368
7525
  #
7369
7526
  # @option params [required, String] :ticket_id
7370
7527
  # A unique identifier for a matchmaking ticket.
@@ -7386,27 +7543,28 @@ module Aws::GameLift
7386
7543
  req.send_request(options)
7387
7544
  end
7388
7545
 
7389
- # **This action is part of Amazon GameLift FleetIQ with game server
7390
- # groups, which is in preview release and is subject to change.**
7546
+ # **This operation is used with the Amazon GameLift FleetIQ solution and
7547
+ # game server groups.**
7391
7548
  #
7392
7549
  # Temporarily stops activity on a game server group without terminating
7393
- # instances or the game server group. Activity can be restarted by
7394
- # calling ResumeGameServerGroup. Activities that can suspended are:
7395
- #
7396
- # * Instance type replacement. This activity evaluates the current Spot
7397
- # viability of all instance types that are defined for the game server
7398
- # group. It updates the Auto Scaling group to remove nonviable Spot
7399
- # instance types (which have a higher chance of game server
7400
- # interruptions) and rebalances capacity across the remaining viable
7401
- # Spot instance types. When this activity is suspended, the Auto
7402
- # Scaling group continues with its current balance, regardless of
7403
- # viability. Instance protection, utilization metrics, and capacity
7404
- # autoscaling activities continue to be active.
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.
7405
7562
  #
7406
7563
  # ^
7407
7564
  #
7408
7565
  # To suspend activity, specify a game server group ARN and the type of
7409
- # 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`.
7410
7568
  #
7411
7569
  # **Learn more**
7412
7570
  #
@@ -7428,16 +7586,18 @@ module Aws::GameLift
7428
7586
  #
7429
7587
  # * SuspendGameServerGroup
7430
7588
  #
7589
+ # * DescribeGameServerInstances
7431
7590
  #
7432
7591
  #
7433
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
7592
+ #
7593
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
7434
7594
  #
7435
7595
  # @option params [required, String] :game_server_group_name
7436
- # The unique identifier of the game server group to stop activity on.
7437
- # Use either the GameServerGroup name or ARN value.
7596
+ # A unique identifier for the game server group. Use either the
7597
+ # GameServerGroup name or ARN value.
7438
7598
  #
7439
7599
  # @option params [required, Array<String>] :suspend_actions
7440
- # The action to suspend for this game server group.
7600
+ # The activity to suspend for this game server group.
7441
7601
  #
7442
7602
  # @return [Types::SuspendGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
7443
7603
  #
@@ -7458,7 +7618,7 @@ module Aws::GameLift
7458
7618
  # resp.game_server_group.instance_definitions #=> Array
7459
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"
7460
7620
  # resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
7461
- # 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"
7462
7622
  # resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
7463
7623
  # resp.game_server_group.auto_scaling_group_arn #=> String
7464
7624
  # resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
@@ -7480,9 +7640,9 @@ module Aws::GameLift
7480
7640
  # Assigns a tag to a GameLift resource. AWS resource tags provide an
7481
7641
  # additional management tool set. You can use tags to organize
7482
7642
  # resources, create IAM permissions policies to manage access to groups
7483
- # of resources, customize AWS cost breakdowns, etc. This action handles
7484
- # the permissions necessary to manage tags for the following GameLift
7485
- # 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:
7486
7646
  #
7487
7647
  # * Build
7488
7648
  #
@@ -7526,8 +7686,8 @@ module Aws::GameLift
7526
7686
  # The Amazon Resource Name ([ARN][1]) that is assigned to and uniquely
7527
7687
  # identifies the GameLift resource that you want to assign tags to.
7528
7688
  # GameLift resource ARNs are included in the data object for the
7529
- # resource, which can be retrieved by calling a List or Describe action
7530
- # for the resource type.
7689
+ # resource, which can be retrieved by calling a List or Describe
7690
+ # operation for the resource type.
7531
7691
  #
7532
7692
  #
7533
7693
  #
@@ -7568,7 +7728,7 @@ module Aws::GameLift
7568
7728
 
7569
7729
  # Removes a tag that is assigned to a GameLift resource. Resource tags
7570
7730
  # are used to organize AWS resources for a range of purposes. This
7571
- # action handles the permissions necessary to manage tags for the
7731
+ # operation handles the permissions necessary to manage tags for the
7572
7732
  # following GameLift resource types:
7573
7733
  #
7574
7734
  # * Build
@@ -7587,8 +7747,8 @@ module Aws::GameLift
7587
7747
  #
7588
7748
  # To remove a tag from a resource, specify the unique ARN value for the
7589
7749
  # resource and provide a string list containing one or more tags to be
7590
- # removed. This action succeeds even if the list includes tags that are
7591
- # 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.
7592
7752
  #
7593
7753
  # **Learn more**
7594
7754
  #
@@ -7613,8 +7773,8 @@ module Aws::GameLift
7613
7773
  # The Amazon Resource Name ([ARN][1]) that is assigned to and uniquely
7614
7774
  # identifies the GameLift resource that you want to remove tags from.
7615
7775
  # GameLift resource ARNs are included in the data object for the
7616
- # resource, which can be retrieved by calling a List or Describe action
7617
- # for the resource type.
7776
+ # resource, which can be retrieved by calling a List or Describe
7777
+ # operation for the resource type.
7618
7778
  #
7619
7779
  #
7620
7780
  #
@@ -7881,9 +8041,9 @@ module Aws::GameLift
7881
8041
  req.send_request(options)
7882
8042
  end
7883
8043
 
7884
- # Updates capacity settings for a fleet. Use this action to specify the
7885
- # number of EC2 instances (hosts) that you want this fleet to contain.
7886
- # Before calling this action, you may want to call
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
7887
8047
  # DescribeEC2InstanceLimits to get the maximum capacity based on the
7888
8048
  # fleet's EC2 instance type.
7889
8049
  #
@@ -8059,18 +8219,17 @@ module Aws::GameLift
8059
8219
  req.send_request(options)
8060
8220
  end
8061
8221
 
8062
- # **This action is part of Amazon GameLift FleetIQ with game server
8063
- # groups, which is in preview release and is subject to change.**
8064
- #
8065
- # Updates information about a registered game server. This action is
8066
- # called by a game server process that is running on an instance in a
8067
- # game server group. There are three reasons to update game server
8068
- # information: (1) to change the utilization status of the game server,
8069
- # (2) to report game server health status, and (3) to change game server
8070
- # metadata. A registered game server should regularly report health and
8071
- # should update utilization status when it is supporting gameplay so
8072
- # that GameLift FleetIQ can accurately track game server availability.
8073
- # 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:
8074
8233
  #
8075
8234
  # * To update the game server's utilization status, identify the game
8076
8235
  # server and game server group and specify the current utilization
@@ -8078,14 +8237,14 @@ module Aws::GameLift
8078
8237
  # hosting games and when they are available to be claimed.
8079
8238
  #
8080
8239
  # * To report health status, identify the game server and game server
8081
- # group and set health check to HEALTHY. If a game server does not
8240
+ # group and set health check to `HEALTHY`. If a game server does not
8082
8241
  # report health status for a certain length of time, the game server
8083
- # is no longer considered healthy and will be eventually de-registered
8084
- # from the game server group to avoid affecting utilization metrics.
8085
- # The best practice is to report health every 60 seconds.
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.
8086
8246
  #
8087
- # * To change game server metadata, provide updated game server data and
8088
- # custom sort key values.
8247
+ # * To change game server metadata, provide updated game server data.
8089
8248
  #
8090
8249
  # Once a game server is successfully updated, the relevant statuses and
8091
8250
  # timestamps are updated.
@@ -8110,35 +8269,29 @@ module Aws::GameLift
8110
8269
  #
8111
8270
  #
8112
8271
  #
8113
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
8272
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/fleetiqguide/gsg-intro.html
8114
8273
  #
8115
8274
  # @option params [required, String] :game_server_group_name
8116
- # An identifier for the game server group where the game server is
8275
+ # A unique identifier for the game server group where the game server is
8117
8276
  # running. Use either the GameServerGroup name or ARN value.
8118
8277
  #
8119
8278
  # @option params [required, String] :game_server_id
8120
- # The identifier for the game server to be updated.
8279
+ # A custom string that uniquely identifies the game server to update.
8121
8280
  #
8122
8281
  # @option params [String] :game_server_data
8123
8282
  # A set of custom game server properties, formatted as a single string
8124
8283
  # value. This data is passed to a game client or service when it
8125
- # requests information on a game servers using DescribeGameServer or
8284
+ # requests information on game servers using ListGameServers or
8126
8285
  # ClaimGameServer.
8127
8286
  #
8128
- # @option params [String] :custom_sort_key
8129
- # A game server tag that can be used to request sorted lists of game
8130
- # servers using ListGameServers. Custom sort keys are developer-defined
8131
- # based on how you want to organize the retrieved game server
8132
- # information.
8133
- #
8134
8287
  # @option params [String] :utilization_status
8135
8288
  # Indicates whether the game server is available or is currently hosting
8136
8289
  # gameplay.
8137
8290
  #
8138
8291
  # @option params [String] :health_check
8139
- # Indicates health status of the game server. An update that explicitly
8140
- # includes this parameter updates the game server's
8141
- # *LastHealthCheckTime* time stamp.
8292
+ # Indicates health status of the game server. A request that includes
8293
+ # this parameter updates the game server's *LastHealthCheckTime*
8294
+ # timestamp.
8142
8295
  #
8143
8296
  # @return [Types::UpdateGameServerOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
8144
8297
  #
@@ -8150,7 +8303,6 @@ module Aws::GameLift
8150
8303
  # game_server_group_name: "GameServerGroupNameOrArn", # required
8151
8304
  # game_server_id: "GameServerId", # required
8152
8305
  # game_server_data: "GameServerData",
8153
- # custom_sort_key: "GameServerSortKey",
8154
8306
  # utilization_status: "AVAILABLE", # accepts AVAILABLE, UTILIZED
8155
8307
  # health_check: "HEALTHY", # accepts HEALTHY
8156
8308
  # })
@@ -8163,7 +8315,6 @@ module Aws::GameLift
8163
8315
  # resp.game_server.instance_id #=> String
8164
8316
  # resp.game_server.connection_info #=> String
8165
8317
  # resp.game_server.game_server_data #=> String
8166
- # resp.game_server.custom_sort_key #=> String
8167
8318
  # resp.game_server.claim_status #=> String, one of "CLAIMED"
8168
8319
  # resp.game_server.utilization_status #=> String, one of "AVAILABLE", "UTILIZED"
8169
8320
  # resp.game_server.registration_time #=> Time
@@ -8179,29 +8330,24 @@ module Aws::GameLift
8179
8330
  req.send_request(options)
8180
8331
  end
8181
8332
 
8182
- # **This action is part of Amazon GameLift FleetIQ with game server
8183
- # groups, which is in preview release and is subject to change.**
8333
+ # **This operation is used with the Amazon GameLift FleetIQ solution and
8334
+ # game server groups.**
8184
8335
  #
8185
8336
  # Updates GameLift FleetIQ-specific properties for a game server group.
8186
- # These properties include instance rebalancing and game server
8187
- # protection. Many Auto Scaling group properties are updated directly.
8188
- # These include autoscaling policies, minimum/maximum/desired instance
8189
- # 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.
8190
8340
  #
8191
8341
  # To update the game server group, specify the game server group ID and
8192
- # provide the updated values.
8193
- #
8194
- # Updated properties are validated to ensure that GameLift FleetIQ can
8195
- # continue to perform its core instance rebalancing activity. When you
8196
- # change Auto Scaling group properties directly and the changes cause
8197
- # 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.
8198
8346
  #
8199
8347
  # **Learn more**
8200
8348
  #
8201
8349
  # [GameLift FleetIQ Guide][1]
8202
8350
  #
8203
- # [Updating a GameLift FleetIQ-Linked Auto Scaling Group][2]
8204
- #
8205
8351
  # **Related operations**
8206
8352
  #
8207
8353
  # * CreateGameServerGroup
@@ -8218,64 +8364,75 @@ module Aws::GameLift
8218
8364
  #
8219
8365
  # * SuspendGameServerGroup
8220
8366
  #
8367
+ # * DescribeGameServerInstances
8368
+ #
8221
8369
  #
8222
8370
  #
8223
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gsg-intro.html
8224
- # [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
8225
8372
  #
8226
8373
  # @option params [required, String] :game_server_group_name
8227
- # The unique identifier of the game server group to update. Use either
8228
- # the GameServerGroup name or ARN value.
8374
+ # A unique identifier for the game server group. Use either the
8375
+ # GameServerGroup name or ARN value.
8229
8376
  #
8230
8377
  # @option params [String] :role_arn
8231
8378
  # The Amazon Resource Name ([ARN][1]) for an IAM role that allows Amazon
8232
- # GameLift to access your EC2 Auto Scaling groups. The submitted role is
8233
- # validated to ensure that it contains the necessary permissions for
8234
- # game server groups.
8379
+ # GameLift to access your EC2 Auto Scaling groups.
8235
8380
  #
8236
8381
  #
8237
8382
  #
8238
8383
  # [1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html
8239
8384
  #
8240
8385
  # @option params [Array<Types::InstanceDefinition>] :instance_definitions
8241
- # An updated list of EC2 instance types to use when creating instances
8242
- # in the group. The instance definition must specify instance types that
8243
- # are supported by GameLift FleetIQ, and must include at least two
8244
- # instance types. This updated list replaces the entire current list of
8245
- # instance definitions for the game server group. For more information
8246
- # on instance types, see [EC2 Instance Types][1] in the *Amazon EC2 User
8247
- # Guide*..
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.
8248
8397
  #
8249
8398
  #
8250
8399
  #
8251
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
8252
8402
  #
8253
8403
  # @option params [String] :game_server_protection_policy
8254
8404
  # A flag that indicates whether instances in the game server group are
8255
8405
  # protected from early termination. Unprotected instances that have
8256
- # active game servers running may by terminated during a scale-down
8406
+ # active game servers running might be terminated during a scale-down
8257
8407
  # event, causing players to be dropped from the game. Protected
8258
8408
  # instances cannot be terminated while there are active game servers
8259
- # running. An exception to this is Spot Instances, which may be
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
8260
8411
  # terminated by AWS regardless of protection status. This property is
8261
- # set to NO\_PROTECTION by default.
8412
+ # set to `NO_PROTECTION` by default.
8262
8413
  #
8263
8414
  # @option params [String] :balancing_strategy
8264
- # The fallback balancing method to use for the game server group when
8265
- # Spot instances in a Region become unavailable or are not viable for
8266
- # game hosting. Once triggered, this method remains active until Spot
8267
- # instances can once again be used. Method options include:
8268
- #
8269
- # * SPOT\_ONLY -- If Spot instances are unavailable, the game server
8270
- # group provides no hosting capacity. No new instances are started,
8271
- # and the existing nonviable Spot instances are terminated (once
8272
- # current gameplay ends) and not replaced.
8273
- #
8274
- # * SPOT\_PREFERRED -- If Spot instances are unavailable, the game
8275
- # server group continues to provide hosting capacity by using
8276
- # On-Demand instances. Existing nonviable Spot instances are
8277
- # terminated (once current gameplay ends) and replaced with new
8278
- # On-Demand instances.
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.
8279
8436
  #
8280
8437
  # @return [Types::UpdateGameServerGroupOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
8281
8438
  #
@@ -8293,7 +8450,7 @@ module Aws::GameLift
8293
8450
  # },
8294
8451
  # ],
8295
8452
  # game_server_protection_policy: "NO_PROTECTION", # accepts NO_PROTECTION, FULL_PROTECTION
8296
- # balancing_strategy: "SPOT_ONLY", # accepts SPOT_ONLY, SPOT_PREFERRED
8453
+ # balancing_strategy: "SPOT_ONLY", # accepts SPOT_ONLY, SPOT_PREFERRED, ON_DEMAND_ONLY
8297
8454
  # })
8298
8455
  #
8299
8456
  # @example Response structure
@@ -8304,7 +8461,7 @@ module Aws::GameLift
8304
8461
  # resp.game_server_group.instance_definitions #=> Array
8305
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"
8306
8463
  # resp.game_server_group.instance_definitions[0].weighted_capacity #=> String
8307
- # 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"
8308
8465
  # resp.game_server_group.game_server_protection_policy #=> String, one of "NO_PROTECTION", "FULL_PROTECTION"
8309
8466
  # resp.game_server_group.auto_scaling_group_arn #=> String
8310
8467
  # resp.game_server_group.status #=> String, one of "NEW", "ACTIVATING", "ACTIVE", "DELETE_SCHEDULED", "DELETING", "DELETED", "ERROR"
@@ -8544,7 +8701,7 @@ module Aws::GameLift
8544
8701
  #
8545
8702
  #
8546
8703
  #
8547
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-configuration.html
8704
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-configuration.html
8548
8705
  #
8549
8706
  # @option params [required, String] :name
8550
8707
  # A unique identifier for a matchmaking configuration to update. You can
@@ -8556,9 +8713,10 @@ module Aws::GameLift
8556
8713
  # @option params [Array<String>] :game_session_queue_arns
8557
8714
  # Amazon Resource Name ([ARN][1]) that is assigned to a GameLift game
8558
8715
  # session queue resource and uniquely identifies it. ARNs are unique
8559
- # across all Regions. These queues are used when placing game sessions
8560
- # for matches that are created with this matchmaking configuration.
8561
- # Queues can be located in any Region.
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.
8562
8720
  #
8563
8721
  #
8564
8722
  #
@@ -8571,14 +8729,17 @@ module Aws::GameLift
8571
8729
  #
8572
8730
  # @option params [Integer] :acceptance_timeout_seconds
8573
8731
  # The length of time (in seconds) to wait for players to accept a
8574
- # proposed match. If any player rejects the match or fails to accept
8575
- # before the timeout, the ticket continues to look for an acceptable
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
8576
8735
  # match.
8577
8736
  #
8578
8737
  # @option params [Boolean] :acceptance_required
8579
8738
  # A flag that indicates whether a match that was created with this
8580
8739
  # configuration must be accepted by the matched players. To require
8581
- # 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.
8582
8743
  #
8583
8744
  # @option params [String] :rule_set_name
8584
8745
  # A unique identifier for a matchmaking rule set to use with this
@@ -8593,13 +8754,14 @@ module Aws::GameLift
8593
8754
  #
8594
8755
  #
8595
8756
  #
8596
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-notification.html
8757
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html
8597
8758
  #
8598
8759
  # @option params [Integer] :additional_player_count
8599
8760
  # The number of player slots in a match to keep open for future players.
8600
8761
  # For example, assume that the configuration's rule set specifies a
8601
8762
  # match for a single 12-person team. If the additional player count is
8602
- # 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`.
8603
8765
  #
8604
8766
  # @option params [String] :custom_event_data
8605
8767
  # Information to add to all events related to the matchmaking
@@ -8610,7 +8772,8 @@ module Aws::GameLift
8610
8772
  # pairs. These properties are passed to a game server process in the
8611
8773
  # GameSession object with a request to start a new game session (see
8612
8774
  # [Start a Game Session][1]). This information is added to the new
8613
- # 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`.
8614
8777
  #
8615
8778
  #
8616
8779
  #
@@ -8621,7 +8784,8 @@ module Aws::GameLift
8621
8784
  # value. This data is passed to a game server process in the GameSession
8622
8785
  # object with a request to start a new game session (see [Start a Game
8623
8786
  # Session][1]). This information is added to the new GameSession object
8624
- # 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`.
8625
8789
  #
8626
8790
  #
8627
8791
  #
@@ -8634,11 +8798,27 @@ module Aws::GameLift
8634
8798
  # Specify AUTOMATIC to have GameLift create a StartMatchBackfill request
8635
8799
  # whenever a game session has one or more open slots. Learn more about
8636
8800
  # manual and automatic backfill in [Backfill Existing Games with
8637
- # 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.
8638
8811
  #
8812
+ # * **STANDALONE** - FlexMatch forms matches and returns match
8813
+ # information, including players and team assignments, in a [
8814
+ # MatchmakingSucceeded][1] event.
8639
8815
  #
8816
+ # * **WITH\_QUEUE** - FlexMatch forms matches and uses the specified
8817
+ # GameLift queue to start a game session for the match.
8640
8818
  #
8641
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-backfill.html
8819
+ #
8820
+ #
8821
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded
8642
8822
  #
8643
8823
  # @return [Types::UpdateMatchmakingConfigurationOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
8644
8824
  #
@@ -8665,6 +8845,7 @@ module Aws::GameLift
8665
8845
  # ],
8666
8846
  # game_session_data: "GameSessionData",
8667
8847
  # backfill_mode: "AUTOMATIC", # accepts AUTOMATIC, MANUAL
8848
+ # flex_match_mode: "STANDALONE", # accepts STANDALONE, WITH_QUEUE
8668
8849
  # })
8669
8850
  #
8670
8851
  # @example Response structure
@@ -8688,6 +8869,7 @@ module Aws::GameLift
8688
8869
  # resp.configuration.game_properties[0].value #=> String
8689
8870
  # resp.configuration.game_session_data #=> String
8690
8871
  # resp.configuration.backfill_mode #=> String, one of "AUTOMATIC", "MANUAL"
8872
+ # resp.configuration.flex_match_mode #=> String, one of "STANDALONE", "WITH_QUEUE"
8691
8873
  #
8692
8874
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/UpdateMatchmakingConfiguration AWS API Documentation
8693
8875
  #
@@ -8847,14 +9029,20 @@ module Aws::GameLift
8847
9029
  # do not need to be unique.
8848
9030
  #
8849
9031
  # @option params [Types::S3Location] :storage_location
8850
- # The location of the Amazon S3 bucket where a zipped file containing
8851
- # your Realtime scripts is stored. The storage location must specify the
8852
- # Amazon S3 bucket name, the zip file name (the "key"), and a role ARN
8853
- # that allows Amazon GameLift to access the Amazon S3 storage location.
8854
- # The S3 bucket must be in the same Region where you want to create a
8855
- # new script. By default, Amazon GameLift uploads the latest version of
8856
- # the zip file; if you have S3 object versioning turned on, you can use
8857
- # the `ObjectVersion` parameter to specify an earlier version.
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
8858
9046
  #
8859
9047
  # @option params [String, StringIO, File] :zip_file
8860
9048
  # A data object containing your Realtime scripts and dependencies as a
@@ -8938,7 +9126,7 @@ module Aws::GameLift
8938
9126
  #
8939
9127
  #
8940
9128
  #
8941
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/match-rulesets.html
9129
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html
8942
9130
  #
8943
9131
  # @option params [required, String] :rule_set_body
8944
9132
  # A collection of matchmaking rules to validate, formatted as a JSON
@@ -8980,7 +9168,7 @@ module Aws::GameLift
8980
9168
  params: params,
8981
9169
  config: config)
8982
9170
  context[:gem_name] = 'aws-sdk-gamelift'
8983
- context[:gem_version] = '1.35.0'
9171
+ context[:gem_version] = '1.40.0'
8984
9172
  Seahorse::Client::Request.new(handlers, context)
8985
9173
  end
8986
9174