aws-sdk-gamelift 1.96.0 → 1.98.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -718,41 +718,37 @@ module Aws::GameLift
718
718
  req.send_request(options)
719
719
  end
720
720
 
721
- # Creates an Amazon GameLift build resource for your game server
722
- # software and stores the software for deployment to hosting resources.
723
- # Combine game server binaries and dependencies into a single .zip file
721
+ # Creates a new Amazon GameLift build resource for your game server
722
+ # binary files. Combine game server binaries into a zip file for use
723
+ # with Amazon GameLift.
724
724
  #
725
- # Use the CLI command <b> <a
725
+ # When setting up a new game build for Amazon GameLift, we recommend
726
+ # using the CLI command <b> <a
726
727
  # href="https://docs.aws.amazon.com/cli/latest/reference/gamelift/upload-build.html">upload-build</a>
727
- # </b> to quickly and simply create a new build and upload your game
728
- # build .zip file to Amazon GameLift Amazon S3. This helper command
729
- # eliminates the need to explicitly manage access permissions.
730
- #
731
- # Alternatively, use the `CreateBuild` action for the following
732
- # scenarios:
733
- #
734
- # * You want to create a build and upload a game build zip file from in
735
- # an Amazon S3 location that you control. In this scenario, you need
736
- # to give Amazon GameLift permission to access to the Amazon S3
737
- # bucket. With permission in place, call `CreateBuild` and specify a
738
- # build name, the build's runtime operating system, and the Amazon S3
739
- # storage location where the build file is stored.
740
- #
741
- # * You want to create a build and upload a local game build zip file to
742
- # an Amazon S3 location that's controlled by Amazon GameLift. (See
743
- # the `upload-build` CLI command for this scenario.) In this scenario,
744
- # you need to request temporary access credentials to the Amazon
745
- # GameLift Amazon S3 location. Specify a build name and the build's
746
- # runtime operating system. The response provides an Amazon S3
747
- # location and a set of temporary access credentials. Use the
748
- # credentials to upload your build files to the specified Amazon S3
749
- # location (see [Uploading Objects][1] in the *Amazon S3 Developer
750
- # Guide*). You can't update build files after uploading them to
751
- # Amazon GameLift Amazon S3.
752
- #
753
- # If successful, this action creates a new build resource with a unique
754
- # build ID and places it in `INITIALIZED` status. When the build reaches
755
- # `READY` status, you can create fleets with it.
728
+ # </b>. This helper command combines two tasks: (1) it uploads your
729
+ # build files from a file directory to an Amazon GameLift Amazon S3
730
+ # location, and (2) it creates a new build resource.
731
+ #
732
+ # You can use the `CreateBuild` operation in the following scenarios:
733
+ #
734
+ # * Create a new game build with build files that are in an Amazon S3
735
+ # location under an Amazon Web Services account that you control. To
736
+ # use this option, you give Amazon GameLift access to the Amazon S3
737
+ # bucket. With permissions in place, specify a build name, operating
738
+ # system, and the Amazon S3 storage location of your game build.
739
+ #
740
+ # * Upload your build files to a Amazon GameLift Amazon S3 location. To
741
+ # use this option, specify a build name and operating system. This
742
+ # operation creates a new build resource and also returns an Amazon S3
743
+ # location with temporary access credentials. Use the credentials to
744
+ # manually upload your build files to the specified Amazon S3
745
+ # location. For more information, see [Uploading Objects][1] in the
746
+ # *Amazon S3 Developer Guide*. After you upload build files to the
747
+ # Amazon GameLift Amazon S3 location, you can't update them.
748
+ #
749
+ # If successful, this operation creates a new build resource with a
750
+ # unique build ID and places it in `INITIALIZED` status. A build must be
751
+ # in `READY` status before you can create fleets with it.
756
752
  #
757
753
  # **Learn more**
758
754
  #
@@ -790,11 +786,12 @@ module Aws::GameLift
790
786
  # `SizeOnDisk` of 0.
791
787
  #
792
788
  # @option params [String] :operating_system
793
- # The environment that your game server binaries run on. This value
789
+ # The operating system that your game server binaries run on. This value
794
790
  # determines the type of fleet resources that you use for this build. If
795
791
  # your game build contains multiple executables, they all must run on
796
- # the same operating system. This parameter is required, and there's no
797
- # default value. You can't change a build's operating system later.
792
+ # the same operating system. You must specify a valid operating system
793
+ # in this request. There is no default value. You can't change a
794
+ # build's operating system later.
798
795
  #
799
796
  # <note markdown="1"> Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more
800
797
  # details in the [Amazon Linux 2 FAQs][1]. For game servers that are
@@ -994,8 +991,13 @@ module Aws::GameLift
994
991
  # specific version number.
995
992
  #
996
993
  # Create a container group definition by calling
997
- # CreateContainerGroupDefinition. This operation creates a
998
- # ContainerGroupDefinition resource.
994
+ # [CreateContainerGroupDefinition][1]. This operation creates a
995
+ # [ContainerGroupDefinition][2] resource.
996
+ #
997
+ #
998
+ #
999
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateContainerGroupDefinition.html
1000
+ # [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html
999
1001
  #
1000
1002
  # @option params [String] :per_instance_container_group_definition_name
1001
1003
  # The name of a container group definition resource that describes a set
@@ -1007,8 +1009,15 @@ module Aws::GameLift
1007
1009
  # with a specific version number.
1008
1010
  #
1009
1011
  # Create a container group definition by calling
1010
- # CreateContainerGroupDefinition. This operation creates a
1011
- # ContainerGroupDefinition resource.
1012
+ # [https://docs.aws.amazon.com/gamelift/latest/apireference/API\_CreateContainerGroupDefinition.html][1].
1013
+ # This operation creates a
1014
+ # [https://docs.aws.amazon.com/gamelift/latest/apireference/API\_ContainerGroupDefinition.html][2]
1015
+ # resource.
1016
+ #
1017
+ #
1018
+ #
1019
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateContainerGroupDefinition.html
1020
+ # [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html
1012
1021
  #
1013
1022
  # @option params [Types::ConnectionPortRange] :instance_connection_port_range
1014
1023
  # The set of port numbers to open on each fleet instance. A fleet's
@@ -1187,7 +1196,7 @@ module Aws::GameLift
1187
1196
  # @example Request syntax with placeholder values
1188
1197
  #
1189
1198
  # resp = client.create_container_fleet({
1190
- # fleet_role_arn: "ArnStringModel", # required
1199
+ # fleet_role_arn: "IamRoleArn", # required
1191
1200
  # description: "NonZeroAndMaxString",
1192
1201
  # game_server_container_group_definition_name: "ContainerGroupDefinitionNameOrArn",
1193
1202
  # per_instance_container_group_definition_name: "ContainerGroupDefinitionNameOrArn",
@@ -1279,7 +1288,7 @@ module Aws::GameLift
1279
1288
  # containers for hosting your game server with Amazon GameLift managed
1280
1289
  # containers hosting. An Amazon GameLift container group is similar to a
1281
1290
  # container task or pod. Use container group definitions when you create
1282
- # a container fleet with CreateContainerFleet.
1291
+ # a container fleet with [CreateContainerFleet][1].
1283
1292
  #
1284
1293
  # A container group definition determines how Amazon GameLift deploys
1285
1294
  # your containers to each instance in a container fleet. You can
@@ -1318,7 +1327,7 @@ module Aws::GameLift
1318
1327
  #
1319
1328
  # <note markdown="1"> This operation requires Identity and Access Management (IAM)
1320
1329
  # permissions to access container images in Amazon ECR repositories. See
1321
- # [ IAM permissions for Amazon GameLift][1] for help setting the
1330
+ # [ IAM permissions for Amazon GameLift][2] for help setting the
1322
1331
  # appropriate permissions.
1323
1332
  #
1324
1333
  # </note>
@@ -1375,12 +1384,14 @@ module Aws::GameLift
1375
1384
  # If successful, this request creates a `ContainerGroupDefinition`
1376
1385
  # resource and assigns a unique ARN value. You can update most
1377
1386
  # properties of a container group definition by calling
1378
- # UpdateContainerGroupDefinition, and optionally save the update as a
1379
- # new version.
1387
+ # [UpdateContainerGroupDefinition][3], and optionally save the update as
1388
+ # a new version.
1380
1389
  #
1381
1390
  #
1382
1391
  #
1383
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-iam-policy-examples.html
1392
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_CreateContainerFleet.html
1393
+ # [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-iam-policy-examples.html
1394
+ # [3]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateContainerGroupDefinition.html
1384
1395
  #
1385
1396
  # @option params [required, String] :name
1386
1397
  # A descriptive identifier for the container group definition. The name
@@ -1757,11 +1768,15 @@ module Aws::GameLift
1757
1768
  # access game server processes and other processes on this fleet. Set
1758
1769
  # this parameter for managed EC2 fleets. You can leave this parameter
1759
1770
  # empty when creating the fleet, but you must call
1760
- # UpdateFleetPortSettings to set it before players can connect to game
1761
- # sessions. As a best practice, we recommend opening ports for remote
1762
- # access only when you need them and closing them when you're finished.
1763
- # For Realtime Servers fleets, Amazon GameLift automatically sets TCP
1764
- # and UDP ranges.
1771
+ # [https://docs.aws.amazon.com/gamelift/latest/apireference/API\_UpdateFleetPortSettings][1]
1772
+ # to set it before players can connect to game sessions. As a best
1773
+ # practice, we recommend opening ports for remote access only when you
1774
+ # need them and closing them when you're finished. For Realtime Servers
1775
+ # fleets, Amazon GameLift automatically sets TCP and UDP ranges.
1776
+ #
1777
+ #
1778
+ #
1779
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetPortSettings
1765
1780
  #
1766
1781
  # @option params [String] :new_game_session_protection_policy
1767
1782
  # The status of termination protection for active game sessions on the
@@ -1905,10 +1920,9 @@ module Aws::GameLift
1905
1920
  # * `EC2` – The game server build is deployed to Amazon EC2 instances
1906
1921
  # for cloud hosting. This is the default setting.
1907
1922
  #
1908
- # * `ANYWHERE` – Your game server and supporting software is deployed to
1909
- # compute resources that are provided and managed by you. With this
1910
- # compute type, you can also set the `AnywhereConfiguration`
1911
- # parameter.
1923
+ # * `ANYWHERE` – Game servers and supporting software are deployed to
1924
+ # compute resources that you provide and manage. With this compute
1925
+ # type, you can also set the `AnywhereConfiguration` parameter.
1912
1926
  #
1913
1927
  # @option params [Types::AnywhereConfiguration] :anywhere_configuration
1914
1928
  # Amazon GameLift Anywhere configuration options.
@@ -2038,10 +2052,9 @@ module Aws::GameLift
2038
2052
  req.send_request(options)
2039
2053
  end
2040
2054
 
2041
- # Adds remote locations to a managed EC2 fleet or managed container
2042
- # fleet and begins populating the new locations with instances. The new
2043
- # instances conform to the fleet's instance type, auto-scaling, and
2044
- # other configuration settings.
2055
+ # Adds remote locations to an EC2 and begins populating the new
2056
+ # locations with instances. The new instances conform to the fleet's
2057
+ # instance type, auto-scaling, and other configuration settings.
2045
2058
  #
2046
2059
  # <note markdown="1"> You can't add remote locations to a fleet that resides in an Amazon
2047
2060
  # Web Services Region that doesn't support multiple locations. Fleets
@@ -2367,7 +2380,7 @@ module Aws::GameLift
2367
2380
  # location. This operation prompts an available server process to start
2368
2381
  # a game session and retrieves connection information for the new game
2369
2382
  # session. As an alternative, consider using the Amazon GameLift game
2370
- # session placement feature with [StartGameSessionPlacement][1] , which
2383
+ # session placement feature with [StartGameSessionPlacement][1], which
2371
2384
  # uses the FleetIQ algorithm and queues to optimize the placement
2372
2385
  # process.
2373
2386
  #
@@ -2531,7 +2544,7 @@ module Aws::GameLift
2531
2544
  # resp.game_session.current_player_session_count #=> Integer
2532
2545
  # resp.game_session.maximum_player_session_count #=> Integer
2533
2546
  # resp.game_session.status #=> String, one of "ACTIVE", "ACTIVATING", "TERMINATED", "TERMINATING", "ERROR"
2534
- # resp.game_session.status_reason #=> String, one of "INTERRUPTED"
2547
+ # resp.game_session.status_reason #=> String, one of "INTERRUPTED", "TRIGGERED_ON_PROCESS_TERMINATE", "FORCE_TERMINATED"
2535
2548
  # resp.game_session.game_properties #=> Array
2536
2549
  # resp.game_session.game_properties[0].key #=> String
2537
2550
  # resp.game_session.game_properties[0].value #=> String
@@ -3245,16 +3258,16 @@ module Aws::GameLift
3245
3258
  req.send_request(options)
3246
3259
  end
3247
3260
 
3248
- # Creates a script resource for your Realtime Servers script. Realtime
3249
- # scripts are JavaScript files that provide configuration settings and
3250
- # optional custom game logic for your game. Script logic is executed
3251
- # during an active game session. To deploy Realtime Servers for hosting,
3252
- # create an Amazon GameLift managed fleet with the script.
3261
+ # Creates a new script record for your Realtime Servers script. Realtime
3262
+ # scripts are JavaScript that provide configuration settings and
3263
+ # optional custom game logic for your game. The script is deployed when
3264
+ # you create a Realtime Servers fleet to host your game sessions. Script
3265
+ # logic is executed during an active game session.
3253
3266
  #
3254
- # To create a script resource, specify a script name and provide the
3255
- # script file(s). The script files and all dependencies must be combined
3256
- # into a single .zip file. You can upload the .zip file from either of
3257
- # these locations:
3267
+ # To create a new script record, specify a script name and provide the
3268
+ # script file(s). The script files and all dependencies must be zipped
3269
+ # into a single file. You can pull the zip file from either of these
3270
+ # locations:
3258
3271
  #
3259
3272
  # * A locally available directory. Use the *ZipFile* parameter for this
3260
3273
  # option.
@@ -3265,9 +3278,12 @@ module Aws::GameLift
3265
3278
  # (IAM) role that allows the Amazon GameLift service to access your S3
3266
3279
  # bucket.
3267
3280
  #
3268
- # If the call is successful, Amazon GameLift creates a new script
3269
- # resource with a unique script ID. The script is uploaded to an Amazon
3270
- # S3 bucket that is owned by Amazon GameLift.
3281
+ # If the call is successful, a new script record is created with a
3282
+ # unique script ID. If the script file is provided as a local file, the
3283
+ # file is uploaded to an Amazon GameLift-owned S3 bucket and the script
3284
+ # record's storage location reflects this location. If the script file
3285
+ # is provided as an S3 bucket, Amazon GameLift accesses the file at this
3286
+ # storage location as needed for deployment.
3271
3287
  #
3272
3288
  # **Learn more**
3273
3289
  #
@@ -3665,8 +3681,7 @@ module Aws::GameLift
3665
3681
  req.send_request(options)
3666
3682
  end
3667
3683
 
3668
- # Deletes a container group definition. You can delete a container group
3669
- # definition if there are no fleets using the definition.
3684
+ # Deletes a container group definition.
3670
3685
  #
3671
3686
  # **Request options:**
3672
3687
  #
@@ -3683,6 +3698,20 @@ module Aws::GameLift
3683
3698
  # retain. For example, set `VersionCountToRetain` to 5 to delete all
3684
3699
  # but the five most recent versions.
3685
3700
  #
3701
+ # **Result**
3702
+ #
3703
+ # If successful, Amazon GameLift removes the container group definition
3704
+ # versions that you request deletion for. This request will fail for any
3705
+ # requested versions if the following is true:
3706
+ #
3707
+ # * If the version is being used in an active fleet
3708
+ #
3709
+ # * If the version is being deployed to a fleet in a deployment that's
3710
+ # currently in progress.
3711
+ #
3712
+ # * If the version is designated as a rollback definition in a fleet
3713
+ # deployment that's currently in progress.
3714
+ #
3686
3715
  # **Learn more**
3687
3716
  #
3688
3717
  # * [Manage a container group definition][1]
@@ -4399,7 +4428,8 @@ module Aws::GameLift
4399
4428
  end
4400
4429
 
4401
4430
  # Retrieves properties for a compute resource in an Amazon GameLift
4402
- # fleet. To get a list of all computes in a fleet, call ListCompute.
4431
+ # fleet. To get a list of all computes in a fleet, call
4432
+ # [https://docs.aws.amazon.com/gamelift/latest/apireference/API\_ListCompute.html][1].
4403
4433
  #
4404
4434
  # To request information on a specific compute, provide the fleet ID and
4405
4435
  # compute name.
@@ -4414,6 +4444,10 @@ module Aws::GameLift
4414
4444
  # * For Anywhere fleets, this operation returns information about the
4415
4445
  # registered compute.
4416
4446
  #
4447
+ #
4448
+ #
4449
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListCompute.html
4450
+ #
4417
4451
  # @option params [required, String] :fleet_id
4418
4452
  # A unique identifier for the fleet that the compute belongs to. You can
4419
4453
  # use either the fleet ID or ARN value.
@@ -4872,7 +4906,8 @@ module Aws::GameLift
4872
4906
  #
4873
4907
  # With multi-location fleets, this operation retrieves data for the
4874
4908
  # fleet's home Region only. To retrieve capacity for remote locations,
4875
- # see DescribeFleetLocationCapacity.
4909
+ # see
4910
+ # [https://docs.aws.amazon.com/gamelift/latest/apireference/API\_DescribeFleetLocationCapacity.html][1].
4876
4911
  #
4877
4912
  # This operation can be used in the following ways:
4878
4913
  #
@@ -4898,14 +4933,15 @@ module Aws::GameLift
4898
4933
  #
4899
4934
  # **Learn more**
4900
4935
  #
4901
- # [Setting up Amazon GameLift fleets][1]
4936
+ # [Setting up Amazon GameLift fleets][2]
4902
4937
  #
4903
- # [GameLift metrics for fleets][2]
4938
+ # [GameLift metrics for fleets][3]
4904
4939
  #
4905
4940
  #
4906
4941
  #
4907
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
4908
- # [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet
4942
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html
4943
+ # [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
4944
+ # [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/monitoring-cloudwatch.html#gamelift-metrics-fleet
4909
4945
  #
4910
4946
  # @option params [Array<String>] :fleet_ids
4911
4947
  # A unique identifier for the fleet to retrieve capacity information
@@ -5343,13 +5379,11 @@ module Aws::GameLift
5343
5379
  req.send_request(options)
5344
5380
  end
5345
5381
 
5346
- # Retrieves a fleet's inbound connection permissions. Inbound
5382
+ # Retrieves a fleet's inbound connection permissions. Connection
5347
5383
  # permissions specify IP addresses and port settings that incoming
5348
5384
  # traffic can use to access server processes in the fleet. Game server
5349
5385
  # processes that are running in the fleet must use a port that falls
5350
- # within this range. To connect to game server processes on a managed
5351
- # container fleet, the port settings should include one or more of the
5352
- # container fleet's connection ports.
5386
+ # within this range.
5353
5387
  #
5354
5388
  # Use this operation in the following ways:
5355
5389
  #
@@ -5817,7 +5851,7 @@ module Aws::GameLift
5817
5851
  # resp.game_session_details[0].game_session.current_player_session_count #=> Integer
5818
5852
  # resp.game_session_details[0].game_session.maximum_player_session_count #=> Integer
5819
5853
  # resp.game_session_details[0].game_session.status #=> String, one of "ACTIVE", "ACTIVATING", "TERMINATED", "TERMINATING", "ERROR"
5820
- # resp.game_session_details[0].game_session.status_reason #=> String, one of "INTERRUPTED"
5854
+ # resp.game_session_details[0].game_session.status_reason #=> String, one of "INTERRUPTED", "TRIGGERED_ON_PROCESS_TERMINATE", "FORCE_TERMINATED"
5821
5855
  # resp.game_session_details[0].game_session.game_properties #=> Array
5822
5856
  # resp.game_session_details[0].game_session.game_properties[0].key #=> String
5823
5857
  # resp.game_session_details[0].game_session.game_properties[0].value #=> String
@@ -5848,9 +5882,9 @@ module Aws::GameLift
5848
5882
  #
5849
5883
  # This operation is not designed to be continually called to track game
5850
5884
  # session status. This practice can cause you to exceed your API limit,
5851
- # which results in errors. Instead, you must configure configure an
5852
- # Amazon Simple Notification Service (SNS) topic to receive
5853
- # notifications from FlexMatch or queues. Continuously polling with
5885
+ # which results in errors. Instead, you must configure an Amazon Simple
5886
+ # Notification Service (SNS) topic to receive notifications from
5887
+ # FlexMatch or queues. Continuously polling with
5854
5888
  # `DescribeGameSessionPlacement` should only be used for games in
5855
5889
  # development with low game session usage.
5856
5890
  #
@@ -5894,6 +5928,9 @@ module Aws::GameLift
5894
5928
  # resp.game_session_placement.placed_player_sessions[0].player_session_id #=> String
5895
5929
  # resp.game_session_placement.game_session_data #=> String
5896
5930
  # resp.game_session_placement.matchmaker_data #=> String
5931
+ # resp.game_session_placement.priority_configuration_override.placement_fallback_strategy #=> String, one of "DEFAULT_AFTER_SINGLE_PASS", "NONE"
5932
+ # resp.game_session_placement.priority_configuration_override.location_order #=> Array
5933
+ # resp.game_session_placement.priority_configuration_override.location_order[0] #=> String
5897
5934
  #
5898
5935
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeGameSessionPlacement AWS API Documentation
5899
5936
  #
@@ -6090,7 +6127,7 @@ module Aws::GameLift
6090
6127
  # resp.game_sessions[0].current_player_session_count #=> Integer
6091
6128
  # resp.game_sessions[0].maximum_player_session_count #=> Integer
6092
6129
  # resp.game_sessions[0].status #=> String, one of "ACTIVE", "ACTIVATING", "TERMINATED", "TERMINATING", "ERROR"
6093
- # resp.game_sessions[0].status_reason #=> String, one of "INTERRUPTED"
6130
+ # resp.game_sessions[0].status_reason #=> String, one of "INTERRUPTED", "TRIGGERED_ON_PROCESS_TERMINATE", "FORCE_TERMINATED"
6094
6131
  # resp.game_sessions[0].game_properties #=> Array
6095
6132
  # resp.game_sessions[0].game_properties[0].key #=> String
6096
6133
  # resp.game_sessions[0].game_properties[0].value #=> String
@@ -6117,8 +6154,12 @@ module Aws::GameLift
6117
6154
  # managed fleet, including instance ID, connection data, and status. You
6118
6155
  # can use this operation with a multi-location fleet to get
6119
6156
  # location-specific instance information. As an alternative, use the
6120
- # operations ListCompute and DescribeCompute to retrieve information for
6121
- # compute resources, including EC2 and Anywhere fleets.
6157
+ # operations
6158
+ # [https://docs.aws.amazon.com/gamelift/latest/apireference/API\_ListCompute][1]
6159
+ # and
6160
+ # [https://docs.aws.amazon.com/gamelift/latest/apireference/API\_DescribeCompute][2]
6161
+ # to retrieve information for compute resources, including EC2 and
6162
+ # Anywhere fleets.
6122
6163
  #
6123
6164
  # You can call this operation in the following ways:
6124
6165
  #
@@ -6141,19 +6182,21 @@ module Aws::GameLift
6141
6182
  #
6142
6183
  # **Learn more**
6143
6184
  #
6144
- # [Remotely connect to fleet instances][1]
6185
+ # [Remotely connect to fleet instances][3]
6145
6186
  #
6146
- # [Debug fleet issues][2]
6187
+ # [Debug fleet issues][4]
6147
6188
  #
6148
6189
  # **Related actions**
6149
6190
  #
6150
- # [All APIs by task][3]
6191
+ # [All APIs by task][5]
6151
6192
  #
6152
6193
  #
6153
6194
  #
6154
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html
6155
- # [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html
6156
- # [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
6195
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListCompute
6196
+ # [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeCompute
6197
+ # [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html
6198
+ # [4]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html
6199
+ # [5]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
6157
6200
  #
6158
6201
  # @option params [required, String] :fleet_id
6159
6202
  # A unique identifier for the fleet to retrieve instance information
@@ -6571,10 +6614,11 @@ module Aws::GameLift
6571
6614
  end
6572
6615
 
6573
6616
  # Retrieves a fleet's runtime configuration settings. The runtime
6574
- # configuration determines which server processes run, and how they run,
6575
- # and how many run concurrently on computes in managed EC2 and Anywhere
6576
- # fleets. You can update a fleet's runtime configuration at any time
6577
- # using UpdateRuntimeConfiguration.
6617
+ # configuration determines which server processes run, and how, on
6618
+ # computes in the fleet. For managed EC2 fleets, the runtime
6619
+ # configuration describes server processes that run on each fleet
6620
+ # instance. can update a fleet's runtime configuration at any time
6621
+ # using [UpdateRuntimeConfiguration][1].
6578
6622
  #
6579
6623
  # To get the current runtime configuration for a fleet, provide the
6580
6624
  # fleet ID.
@@ -6585,14 +6629,15 @@ module Aws::GameLift
6585
6629
  #
6586
6630
  # **Learn more**
6587
6631
  #
6588
- # [Setting up Amazon GameLift fleets][1]
6632
+ # [Setting up Amazon GameLift fleets][2]
6589
6633
  #
6590
- # [Running multiple processes on a fleet][2]
6634
+ # [Running multiple processes on a fleet][3]
6591
6635
  #
6592
6636
  #
6593
6637
  #
6594
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
6595
- # [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html
6638
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateRuntimeConfiguration.html
6639
+ # [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-intro.html
6640
+ # [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html
6596
6641
  #
6597
6642
  # @option params [required, String] :fleet_id
6598
6643
  # A unique identifier for the fleet to get the runtime configuration
@@ -6897,8 +6942,13 @@ module Aws::GameLift
6897
6942
  #
6898
6943
  # @option params [required, String] :compute_name
6899
6944
  # A unique identifier for the compute resource that you want to connect
6900
- # to. For an EC2 fleet compute, use the instance ID. Use ListCompute to
6901
- # retrieve compute identifiers.
6945
+ # to. For an EC2 fleet compute, use the instance ID. Use
6946
+ # [https://docs.aws.amazon.com/gamelift/latest/apireference/API\_ListCompute.html][1]
6947
+ # to retrieve compute identifiers.
6948
+ #
6949
+ #
6950
+ #
6951
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListCompute.html
6902
6952
  #
6903
6953
  # @return [Types::GetComputeAccessOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
6904
6954
  #
@@ -7062,11 +7112,12 @@ module Aws::GameLift
7062
7112
  # GameLift managed fleet. Use this operation to connect to instances
7063
7113
  # with game servers that use Amazon GameLift server SDK 4.x or earlier.
7064
7114
  # To connect to instances with game servers that use server SDK 5.x or
7065
- # later, call GetComputeAccess.
7115
+ # later, call
7116
+ # [https://docs.aws.amazon.com/gamelift/latest/apireference/API\_GetComputeAccess][1].
7066
7117
  #
7067
7118
  # To request access to an instance, specify IDs for the instance and the
7068
7119
  # fleet it belongs to. You can retrieve instance IDs for a fleet by
7069
- # calling [DescribeInstances][1] with the fleet ID.
7120
+ # calling [DescribeInstances][2] with the fleet ID.
7070
7121
  #
7071
7122
  # If successful, this operation returns an IP address and credentials.
7072
7123
  # The returned credentials match the operating system of the instance,
@@ -7078,26 +7129,27 @@ module Aws::GameLift
7078
7129
  # * For a Linux instance: returns a user name and secret (RSA private
7079
7130
  # key) for use with an SSH client. You must save the secret to a
7080
7131
  # `.pem` file. If you're using the CLI, see the example [ Get
7081
- # credentials for a Linux instance][2] for tips on automatically
7132
+ # credentials for a Linux instance][3] for tips on automatically
7082
7133
  # saving the secret to a `.pem` file.
7083
7134
  #
7084
7135
  # **Learn more**
7085
7136
  #
7086
- # [Remotely connect to fleet instances][3]
7137
+ # [Remotely connect to fleet instances][4]
7087
7138
  #
7088
- # [Debug fleet issues][4]
7139
+ # [Debug fleet issues][5]
7089
7140
  #
7090
7141
  # **Related actions**
7091
7142
  #
7092
- # [All APIs by task][5]
7143
+ # [All APIs by task][6]
7093
7144
  #
7094
7145
  #
7095
7146
  #
7096
- # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeInstances.html
7097
- # [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_GetInstanceAccess.html#API_GetInstanceAccess_Examples
7098
- # [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html
7099
- # [4]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html
7100
- # [5]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
7147
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_GetComputeAccess
7148
+ # [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeInstances.html
7149
+ # [3]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_GetInstanceAccess.html#API_GetInstanceAccess_Examples
7150
+ # [4]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-remote-access.html
7151
+ # [5]: https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-creating-debug.html
7152
+ # [6]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
7101
7153
  #
7102
7154
  # @option params [required, String] :fleet_id
7103
7155
  # A unique identifier for the fleet that contains the instance you want
@@ -7670,7 +7722,7 @@ module Aws::GameLift
7670
7722
  #
7671
7723
  # This operation returns only the latest version of each definition. To
7672
7724
  # retrieve all versions of a container group definition, use
7673
- # ListContainerGroupDefinitionVersions.
7725
+ # [ListContainerGroupDefinitionVersions][1].
7674
7726
  #
7675
7727
  # **Request options:**
7676
7728
  #
@@ -7691,15 +7743,9 @@ module Aws::GameLift
7691
7743
  #
7692
7744
  # </note>
7693
7745
  #
7694
- # **Learn more**
7695
7746
  #
7696
- # * [Manage a container group definition][1]
7697
7747
  #
7698
- # ^
7699
- #
7700
- #
7701
- #
7702
- # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-create-groups.html
7748
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListContainerGroupDefinitionVersions.html
7703
7749
  #
7704
7750
  # @option params [String] :container_group_type
7705
7751
  # The type of container group to retrieve. Container group type
@@ -7802,7 +7848,8 @@ module Aws::GameLift
7802
7848
  end
7803
7849
 
7804
7850
  # Retrieves a collection of container fleet deployments in an Amazon Web
7805
- # Services Region.
7851
+ # Services Region. Use the pagination parameters to retrieve results as
7852
+ # a set of sequential pages.
7806
7853
  #
7807
7854
  # **Request options**
7808
7855
  #
@@ -7812,19 +7859,13 @@ module Aws::GameLift
7812
7859
  # * Get a list of all deployments for a fleet. Specify the container
7813
7860
  # fleet ID or ARN value.
7814
7861
  #
7815
- # * To get a list of all Realtime Servers fleets with a specific
7816
- # configuration script, provide the script ID.
7817
- #
7818
- # Use the pagination parameters to retrieve results as a set of
7819
- # sequential pages.
7820
- #
7821
7862
  # **Results**
7822
7863
  #
7823
7864
  # If successful, this operation returns a list of deployments that match
7824
7865
  # the request parameters. A NextToken value is also returned if there
7825
7866
  # are more result pages to retrieve.
7826
7867
  #
7827
- # <note markdown="1"> Fleet IDs are returned in no particular order.
7868
+ # <note markdown="1"> Deployments are returned starting with the latest.
7828
7869
  #
7829
7870
  # </note>
7830
7871
  #
@@ -8869,7 +8910,7 @@ module Aws::GameLift
8869
8910
  # If successful, a `GameSession` object is returned for each game
8870
8911
  # session that matches the request. Search finds game sessions that are
8871
8912
  # in `ACTIVE` status only. To retrieve information on game sessions in
8872
- # other statuses, use [DescribeGameSessions][1] .
8913
+ # other statuses, use [DescribeGameSessions][1].
8873
8914
  #
8874
8915
  # To set search and sort criteria, create a filter expression using the
8875
8916
  # following game session attributes. For game session search examples,
@@ -8884,15 +8925,15 @@ module Aws::GameLift
8884
8925
  # * **gameSessionProperties** -- A set of key-value pairs that can store
8885
8926
  # custom data in a game session. For example: `{"Key": "difficulty",
8886
8927
  # "Value": "novice"}`. The filter expression must specify the
8887
- # GameProperty -- a `Key` and a string `Value` to search for the game
8888
- # sessions.
8928
+ # [https://docs.aws.amazon.com/gamelift/latest/apireference/API\_GameProperty][2]
8929
+ # -- a `Key` and a string `Value` to search for the game sessions.
8889
8930
  #
8890
8931
  # For example, to search for the above key-value pair, specify the
8891
8932
  # following search filter: `gameSessionProperties.difficulty =
8892
8933
  # "novice"`. All game property values are searched as strings.
8893
8934
  #
8894
8935
  # For examples of searching game sessions, see the ones below, and
8895
- # also see [Search game sessions by game property][2].
8936
+ # also see [Search game sessions by game property][3].
8896
8937
  #
8897
8938
  # * **maximumSessions** -- Maximum number of player sessions allowed for
8898
8939
  # a game session.
@@ -8918,13 +8959,14 @@ module Aws::GameLift
8918
8959
  #
8919
8960
  # </note>
8920
8961
  #
8921
- # [All APIs by task][3]
8962
+ # [All APIs by task][4]
8922
8963
  #
8923
8964
  #
8924
8965
  #
8925
8966
  # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessions.html
8926
- # [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#game-properties-search
8927
- # [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
8967
+ # [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_GameProperty
8968
+ # [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-client-api.html#game-properties-search
8969
+ # [4]: https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets
8928
8970
  #
8929
8971
  # @option params [String] :fleet_id
8930
8972
  # A unique identifier for the fleet to search for active game sessions.
@@ -9048,7 +9090,7 @@ module Aws::GameLift
9048
9090
  # resp.game_sessions[0].current_player_session_count #=> Integer
9049
9091
  # resp.game_sessions[0].maximum_player_session_count #=> Integer
9050
9092
  # resp.game_sessions[0].status #=> String, one of "ACTIVE", "ACTIVATING", "TERMINATED", "TERMINATING", "ERROR"
9051
- # resp.game_sessions[0].status_reason #=> String, one of "INTERRUPTED"
9093
+ # resp.game_sessions[0].status_reason #=> String, one of "INTERRUPTED", "TRIGGERED_ON_PROCESS_TERMINATE", "FORCE_TERMINATED"
9052
9094
  # resp.game_sessions[0].game_properties #=> Array
9053
9095
  # resp.game_sessions[0].game_properties[0].key #=> String
9054
9096
  # resp.game_sessions[0].game_properties[0].value #=> String
@@ -9136,55 +9178,83 @@ module Aws::GameLift
9136
9178
  req.send_request(options)
9137
9179
  end
9138
9180
 
9139
- # Places a request for a new game session in a queue. When processing a
9140
- # placement request, Amazon GameLift searches for available resources on
9141
- # the queue's destinations, scanning each until it finds resources or
9142
- # the placement request times out.
9143
- #
9144
- # A game session placement request can also request player sessions.
9145
- # When a new game session is successfully created, Amazon GameLift
9146
- # creates a player session for each player included in the request.
9147
- #
9148
- # When placing a game session, by default Amazon GameLift tries each
9149
- # fleet in the order they are listed in the queue configuration.
9150
- # Ideally, a queue's destinations are listed in preference order.
9151
- #
9152
- # Alternatively, when requesting a game session with players, you can
9153
- # also provide latency data for each player in relevant Regions. Latency
9154
- # data indicates the performance lag a player experiences when connected
9155
- # to a fleet in the Region. Amazon GameLift uses latency data to reorder
9156
- # the list of destinations to place the game session in a Region with
9157
- # minimal lag. If latency data is provided for multiple players, Amazon
9158
- # GameLift calculates each Region's average lag for all players and
9159
- # reorders to get the best game play across all players.
9160
- #
9161
- # To place a new game session request, specify the following:
9162
- #
9163
- # * The queue name and a set of game session properties and settings
9164
- #
9165
- # * A unique ID (such as a UUID) for the placement. You use this ID to
9166
- # track the status of the placement request
9167
- #
9168
- # * (Optional) A set of player data and a unique player ID for each
9169
- # player that you are joining to the new game session (player data is
9170
- # optional, but if you include it, you must also provide a unique ID
9171
- # for each player)
9172
- #
9173
- # * Latency data for all players (if you want to optimize game play for
9174
- # the players)
9175
- #
9176
- # If successful, a new game session placement is created.
9177
- #
9178
- # To track the status of a placement request, call
9179
- # [DescribeGameSessionPlacement][1] and check the request's status. If
9180
- # the status is `FULFILLED`, a new game session has been created and a
9181
- # game session ARN and Region are referenced. If the placement request
9182
- # times out, submit a new request to the same queue or a different
9183
- # queue.
9184
- #
9181
+ # Makes a request to start a new game session using a game session
9182
+ # queue. When processing a placement request in a queue, Amazon GameLift
9183
+ # finds the best possible available resource to host the game session
9184
+ # and prompts the resource to start the game session.
9185
9185
  #
9186
+ # **Request options**
9186
9187
  #
9187
- # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionPlacement.html
9188
+ # Call this API with the following minimum parameters:
9189
+ # *GameSessionQueueName*, *MaximumPlayerSessionCount*, and
9190
+ # *PlacementID*. You can also include game session data (data formatted
9191
+ # as strings) or game properties (data formatted as key-value pairs) to
9192
+ # pass to the new game session.
9193
+ #
9194
+ # * You can change how Amazon GameLift chooses a hosting resource for
9195
+ # the new game session. Prioritizing resources for game session
9196
+ # placements is defined when you configure a game session queue. You
9197
+ # can use the default prioritization process or specify a custom
9198
+ # process by providing a [ PriorityConfiguration][1] when you create
9199
+ # or update a queue.
9200
+ #
9201
+ # * Prioritize based on resource cost and location, using the queue's
9202
+ # configured priority settings. Call this API with the minimum
9203
+ # parameters.
9204
+ #
9205
+ # * Prioritize based on latency. Include a set of values for
9206
+ # *PlayerLatencies*. You can provide latency data with or without
9207
+ # player session data. This option instructs Amazon GameLift to
9208
+ # reorder the queue's prioritized locations list based on the
9209
+ # latency data. If latency data is provided for multiple players,
9210
+ # Amazon GameLift calculates each location's average latency for
9211
+ # all players and reorders to find the lowest latency across all
9212
+ # players. Don't include latency data if you're providing a custom
9213
+ # list of locations.
9214
+ #
9215
+ # * Prioritize based on a custom list of locations. If you're using a
9216
+ # queue that's configured to prioritize location first (see
9217
+ # [PriorityConfiguration][1] for game session queues), use the
9218
+ # *PriorityConfigurationOverride* parameter to substitute a
9219
+ # different location list for this placement request. When
9220
+ # prioritizing placements by location, Amazon GameLift searches each
9221
+ # location in prioritized order to find an available hosting
9222
+ # resource for the new game session. You can choose whether to use
9223
+ # the override list for the first placement attempt only or for all
9224
+ # attempts.
9225
+ # * You can request new player sessions for a group of players. Include
9226
+ # the *DesiredPlayerSessions* parameter and include at minimum a
9227
+ # unique player ID for each. You can also include player-specific data
9228
+ # to pass to the new game session.
9229
+ #
9230
+ # **Result**
9231
+ #
9232
+ # If successful, this request generates a new game session placement
9233
+ # request and adds it to the game session queue for Amazon GameLift to
9234
+ # process in turn. You can track the status of individual placement
9235
+ # requests by calling [DescribeGameSessionPlacement][2]. A new game
9236
+ # session is running if the status is `FULFILLED` and the request
9237
+ # returns the game session connection information (IP address and port).
9238
+ # If you include player session data, Amazon GameLift creates a player
9239
+ # session for each player ID in the request.
9240
+ #
9241
+ # The request results in a `BadRequestException` in the following
9242
+ # situations:
9243
+ #
9244
+ # * If the request includes both *PlayerLatencies* and
9245
+ # *PriorityConfigurationOverride* parameters.
9246
+ #
9247
+ # * If the request includes the *PriorityConfigurationOverride*
9248
+ # parameter and designates a queue doesn't prioritize locations.
9249
+ #
9250
+ # Amazon GameLift continues to retry each placement request until it
9251
+ # reaches the queue's timeout setting. If a request times out, you can
9252
+ # resubmit the request to the same queue or try a different queue.
9253
+ #
9254
+ #
9255
+ #
9256
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_PriorityConfiguration.html
9257
+ # [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionPlacement.html
9188
9258
  #
9189
9259
  # @option params [required, String] :placement_id
9190
9260
  # A unique identifier to assign to the new game session placement. This
@@ -9209,9 +9279,10 @@ module Aws::GameLift
9209
9279
  #
9210
9280
  # @option params [Array<Types::PlayerLatency>] :player_latencies
9211
9281
  # A set of values, expressed in milliseconds, that indicates the amount
9212
- # of latency that a player experiences when connected to @aws; Regions.
9213
- # This information is used to try to place the new game session where it
9214
- # can offer the best possible gameplay experience for the players.
9282
+ # of latency that a player experiences when connected to Amazon Web
9283
+ # Services Regions. This information is used to try to place the new
9284
+ # game session where it can offer the best possible gameplay experience
9285
+ # for the players.
9215
9286
  #
9216
9287
  # @option params [Array<Types::DesiredPlayerSession>] :desired_player_sessions
9217
9288
  # Set of information on each player to create a player session for.
@@ -9226,6 +9297,15 @@ module Aws::GameLift
9226
9297
  #
9227
9298
  # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
9228
9299
  #
9300
+ # @option params [Types::PriorityConfigurationOverride] :priority_configuration_override
9301
+ # A prioritized list of locations to use for the game session placement
9302
+ # and instructions on how to use it. This list overrides a queue's
9303
+ # prioritized location list for this game session placement request
9304
+ # only. You can include Amazon Web Services Regions, local zones, and
9305
+ # custom locations (for Anywhere fleets). Choose a fallback strategy to
9306
+ # instruct Amazon GameLift to use the override list for the first
9307
+ # placement attempt only or for all placement attempts.
9308
+ #
9229
9309
  # @return [Types::StartGameSessionPlacementOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
9230
9310
  #
9231
9311
  # * {Types::StartGameSessionPlacementOutput#game_session_placement #game_session_placement} => Types::GameSessionPlacement
@@ -9257,6 +9337,10 @@ module Aws::GameLift
9257
9337
  # },
9258
9338
  # ],
9259
9339
  # game_session_data: "LargeGameSessionData",
9340
+ # priority_configuration_override: {
9341
+ # placement_fallback_strategy: "DEFAULT_AFTER_SINGLE_PASS", # accepts DEFAULT_AFTER_SINGLE_PASS, NONE
9342
+ # location_order: ["LocationStringModel"], # required
9343
+ # },
9260
9344
  # })
9261
9345
  #
9262
9346
  # @example Response structure
@@ -9286,6 +9370,9 @@ module Aws::GameLift
9286
9370
  # resp.game_session_placement.placed_player_sessions[0].player_session_id #=> String
9287
9371
  # resp.game_session_placement.game_session_data #=> String
9288
9372
  # resp.game_session_placement.matchmaker_data #=> String
9373
+ # resp.game_session_placement.priority_configuration_override.placement_fallback_strategy #=> String, one of "DEFAULT_AFTER_SINGLE_PASS", "NONE"
9374
+ # resp.game_session_placement.priority_configuration_override.location_order #=> Array
9375
+ # resp.game_session_placement.priority_configuration_override.location_order[0] #=> String
9289
9376
  #
9290
9377
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/StartGameSessionPlacement AWS API Documentation
9291
9378
  #
@@ -9675,6 +9762,9 @@ module Aws::GameLift
9675
9762
  # resp.game_session_placement.placed_player_sessions[0].player_session_id #=> String
9676
9763
  # resp.game_session_placement.game_session_data #=> String
9677
9764
  # resp.game_session_placement.matchmaker_data #=> String
9765
+ # resp.game_session_placement.priority_configuration_override.placement_fallback_strategy #=> String, one of "DEFAULT_AFTER_SINGLE_PASS", "NONE"
9766
+ # resp.game_session_placement.priority_configuration_override.location_order #=> Array
9767
+ # resp.game_session_placement.priority_configuration_override.location_order[0] #=> String
9678
9768
  #
9679
9769
  # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/StopGameSessionPlacement AWS API Documentation
9680
9770
  #
@@ -9879,6 +9969,136 @@ module Aws::GameLift
9879
9969
  req.send_request(options)
9880
9970
  end
9881
9971
 
9972
+ # Ends a game session that's currently in progress. Use this action to
9973
+ # terminate any game session that isn't in `ERROR` status. Terminating
9974
+ # a game session is the most efficient way to free up a server process
9975
+ # when it's hosting a game session that's in a bad state or not ending
9976
+ # properly. You can use this action to terminate a game session that's
9977
+ # being hosted on any type of Amazon GameLift fleet compute, including
9978
+ # computes for managed EC2, managed container, and Anywhere fleets. The
9979
+ # game server must be integrated with Amazon GameLift server SDK 5.x or
9980
+ # greater.
9981
+ #
9982
+ # **Request options**
9983
+ #
9984
+ # Request termination for a single game session. Provide the game
9985
+ # session ID and the termination mode. There are two potential methods
9986
+ # for terminating a game session:
9987
+ #
9988
+ # * Initiate a graceful termination using the normal game session
9989
+ # shutdown sequence. With this mode, the Amazon GameLift service
9990
+ # prompts the server process that's hosting the game session by
9991
+ # calling the server SDK callback method `OnProcessTerminate()`. The
9992
+ # callback implementation is part of the custom game server code. It
9993
+ # might involve a variety of actions to gracefully end a game session,
9994
+ # such as notifying players, before stopping the server process.
9995
+ #
9996
+ # * Force an immediate game session termination. With this mode, the
9997
+ # Amazon GameLift service takes action to stop the server process,
9998
+ # which ends the game session without the normal game session shutdown
9999
+ # sequence.
10000
+ #
10001
+ # **Results**
10002
+ #
10003
+ # If successful, game session termination is initiated. During this
10004
+ # activity, the game session status is changed to `TERMINATING`. When
10005
+ # completed, the server process that was hosting the game session has
10006
+ # been stopped and replaced with a new server process that's ready to
10007
+ # host a new game session. The old game session's status is changed to
10008
+ # `TERMINATED` with a status reason that indicates the termination
10009
+ # method used.
10010
+ #
10011
+ # **Learn more**
10012
+ #
10013
+ # [Add Amazon GameLift to your game server][1]
10014
+ #
10015
+ # Amazon GameLift server SDK 5 reference guide for
10016
+ # `OnProcessTerminate()` ([C++][2]) ([C#][3]) ([Unreal][4]) ([Go][5])
10017
+ #
10018
+ #
10019
+ #
10020
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html
10021
+ # [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-server-sdk5-cpp-initsdk.html
10022
+ # [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-server-sdk5-csharp-initsdk.html
10023
+ # [4]: https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-server-sdk5-unreal-initsdk.html
10024
+ # [5]: https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-server-sdk-go-initsdk.html
10025
+ #
10026
+ # @option params [required, String] :game_session_id
10027
+ # A unique identifier for the game session to be terminated. A game
10028
+ # session ARN has the following format:
10029
+ # `arn:aws:gamelift:<region>::gamesession/<fleet ID>/<custom ID string
10030
+ # or idempotency token>`.
10031
+ #
10032
+ # @option params [required, String] :termination_mode
10033
+ # The method to use to terminate the game session. Available methods
10034
+ # include:
10035
+ #
10036
+ # * `TRIGGER_ON_PROCESS_TERMINATE` – Prompts the Amazon GameLift service
10037
+ # to send an `OnProcessTerminate()` callback to the server process and
10038
+ # initiate the normal game session shutdown sequence. The
10039
+ # `OnProcessTerminate` method, which is implemented in the game server
10040
+ # code, must include a call to the server SDK action
10041
+ # `ProcessEnding()`, which is how the server process signals to Amazon
10042
+ # GameLift that a game session is ending. If the server process
10043
+ # doesn't call `ProcessEnding()`, the game session termination won't
10044
+ # conclude successfully.
10045
+ #
10046
+ # * `FORCE_TERMINATE` – Prompts the Amazon GameLift service to stop the
10047
+ # server process immediately. Amazon GameLift takes action (depending
10048
+ # on the type of fleet) to shut down the server process without the
10049
+ # normal game session shutdown sequence.
10050
+ #
10051
+ # <note markdown="1"> This method is not available for game sessions that are running on
10052
+ # Anywhere fleets unless the fleet is deployed with the Amazon
10053
+ # GameLift Agent. In this scenario, a force terminate request results
10054
+ # in an invalid or bad request exception.
10055
+ #
10056
+ # </note>
10057
+ #
10058
+ # @return [Types::TerminateGameSessionOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
10059
+ #
10060
+ # * {Types::TerminateGameSessionOutput#game_session #game_session} => Types::GameSession
10061
+ #
10062
+ # @example Request syntax with placeholder values
10063
+ #
10064
+ # resp = client.terminate_game_session({
10065
+ # game_session_id: "ArnStringModel", # required
10066
+ # termination_mode: "TRIGGER_ON_PROCESS_TERMINATE", # required, accepts TRIGGER_ON_PROCESS_TERMINATE, FORCE_TERMINATE
10067
+ # })
10068
+ #
10069
+ # @example Response structure
10070
+ #
10071
+ # resp.game_session.game_session_id #=> String
10072
+ # resp.game_session.name #=> String
10073
+ # resp.game_session.fleet_id #=> String
10074
+ # resp.game_session.fleet_arn #=> String
10075
+ # resp.game_session.creation_time #=> Time
10076
+ # resp.game_session.termination_time #=> Time
10077
+ # resp.game_session.current_player_session_count #=> Integer
10078
+ # resp.game_session.maximum_player_session_count #=> Integer
10079
+ # resp.game_session.status #=> String, one of "ACTIVE", "ACTIVATING", "TERMINATED", "TERMINATING", "ERROR"
10080
+ # resp.game_session.status_reason #=> String, one of "INTERRUPTED", "TRIGGERED_ON_PROCESS_TERMINATE", "FORCE_TERMINATED"
10081
+ # resp.game_session.game_properties #=> Array
10082
+ # resp.game_session.game_properties[0].key #=> String
10083
+ # resp.game_session.game_properties[0].value #=> String
10084
+ # resp.game_session.ip_address #=> String
10085
+ # resp.game_session.dns_name #=> String
10086
+ # resp.game_session.port #=> Integer
10087
+ # resp.game_session.player_session_creation_policy #=> String, one of "ACCEPT_ALL", "DENY_ALL"
10088
+ # resp.game_session.creator_id #=> String
10089
+ # resp.game_session.game_session_data #=> String
10090
+ # resp.game_session.matchmaker_data #=> String
10091
+ # resp.game_session.location #=> String
10092
+ #
10093
+ # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/TerminateGameSession AWS API Documentation
10094
+ #
10095
+ # @overload terminate_game_session(params = {})
10096
+ # @param [Hash] params ({})
10097
+ def terminate_game_session(params = {}, options = {})
10098
+ req = build_request(:terminate_game_session, params)
10099
+ req.send_request(options)
10100
+ end
10101
+
9882
10102
  # Removes a tag assigned to a Amazon GameLift resource. You can use
9883
10103
  # resource tags to organize Amazon Web Services resources for a range of
9884
10104
  # purposes. This operation handles the permissions necessary to manage
@@ -10069,7 +10289,7 @@ module Aws::GameLift
10069
10289
  # Updates the properties of a managed container fleet. Depending on the
10070
10290
  # properties being updated, this operation might initiate a fleet
10071
10291
  # deployment. You can track deployments for a fleet using
10072
- # DescribeFleetDeployment.
10292
+ # [https://docs.aws.amazon.com/gamelift/latest/apireference/API\_DescribeFleetDeployment.html][1].
10073
10293
  #
10074
10294
  # **Request options**
10075
10295
  #
@@ -10111,6 +10331,10 @@ module Aws::GameLift
10111
10331
  # If a second update request initiates a deployment while another
10112
10332
  # deployment is in progress, the first deployment is cancelled.
10113
10333
  #
10334
+ #
10335
+ #
10336
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetDeployment.html
10337
+ #
10114
10338
  # @option params [required, String] :fleet_id
10115
10339
  # A unique identifier for the container fleet to update. You can use
10116
10340
  # either the fleet ID or ARN value.
@@ -10125,8 +10349,13 @@ module Aws::GameLift
10125
10349
  # you can only update or replace it with another definition.
10126
10350
  #
10127
10351
  # Update a container group definition by calling
10128
- # UpdateContainerGroupDefinition. This operation creates a
10129
- # ContainerGroupDefinition resource with an incremented version.
10352
+ # [UpdateContainerGroupDefinition][1]. This operation creates a
10353
+ # [ContainerGroupDefinition][2] resource with an incremented version.
10354
+ #
10355
+ #
10356
+ #
10357
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateContainerGroupDefinition.html
10358
+ # [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html
10130
10359
  #
10131
10360
  # @option params [String] :per_instance_container_group_definition_name
10132
10361
  # The name or ARN value of a new per-instance container group definition
@@ -10136,12 +10365,17 @@ module Aws::GameLift
10136
10365
  # version of a container group definition, you can use the name value.
10137
10366
  #
10138
10367
  # Update a container group definition by calling
10139
- # UpdateContainerGroupDefinition. This operation creates a
10140
- # ContainerGroupDefinition resource with an incremented version.
10368
+ # [UpdateContainerGroupDefinition][1]. This operation creates a
10369
+ # [ContainerGroupDefinition][2] resource with an incremented version.
10141
10370
  #
10142
10371
  # To remove a fleet's per-instance container group definition, leave
10143
10372
  # this parameter empty and use the parameter `RemoveAttributes`.
10144
10373
  #
10374
+ #
10375
+ #
10376
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateContainerGroupDefinition.html
10377
+ # [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ContainerGroupDefinition.html
10378
+ #
10145
10379
  # @option params [Integer] :game_server_container_groups_per_instance
10146
10380
  # The number of times to replicate the game server container group on
10147
10381
  # each fleet instance. By default, Amazon GameLift calculates the
@@ -10331,7 +10565,11 @@ module Aws::GameLift
10331
10565
  # If the container group definition version is used in an active fleets,
10332
10566
  # the update automatically initiates a new fleet deployment of the new
10333
10567
  # version. You can track a fleet's deployments using
10334
- # ListFleetDeployments.
10568
+ # [ListFleetDeployments][1].
10569
+ #
10570
+ #
10571
+ #
10572
+ # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_ListFleetDeployments.html
10335
10573
  #
10336
10574
  # @option params [required, String] :name
10337
10575
  # A descriptive identifier for the container group definition. The name
@@ -10576,7 +10814,7 @@ module Aws::GameLift
10576
10814
  # The game session protection policy to apply to all new game sessions
10577
10815
  # created in this fleet. Game sessions that already exist are not
10578
10816
  # affected. You can set protection for individual game sessions using
10579
- # [UpdateGameSession][1].
10817
+ # [UpdateGameSession][1] .
10580
10818
  #
10581
10819
  # * **NoProtection** -- The game session can be terminated during a
10582
10820
  # scale-down event.
@@ -10751,9 +10989,6 @@ module Aws::GameLift
10751
10989
  # in `InboundPermissionRevocations`. Permissions to be removed must
10752
10990
  # match existing fleet permissions.
10753
10991
  #
10754
- # For a container fleet, inbound permissions must specify port numbers
10755
- # that are defined in the fleet's connection port settings.
10756
- #
10757
10992
  # If successful, the fleet ID for the updated fleet is returned. For
10758
10993
  # fleets with remote locations, port setting updates can take time to
10759
10994
  # propagate across all locations. You can check the status of updates in
@@ -11081,11 +11316,11 @@ module Aws::GameLift
11081
11316
  # @option params [String] :protection_policy
11082
11317
  # Game session protection policy to apply to this game session only.
11083
11318
  #
11084
- # * **NoProtection** -- The game session can be terminated during a
11319
+ # * `NoProtection` -- The game session can be terminated during a
11085
11320
  # scale-down event.
11086
11321
  #
11087
- # * **FullProtection** -- If the game session is in an `ACTIVE` status,
11088
- # it cannot be terminated during a scale-down event.
11322
+ # * `FullProtection` -- If the game session is in an `ACTIVE` status, it
11323
+ # cannot be terminated during a scale-down event.
11089
11324
  #
11090
11325
  # @option params [Array<Types::GameProperty>] :game_properties
11091
11326
  # A set of key-value pairs that can store custom data in a game session.
@@ -11130,7 +11365,7 @@ module Aws::GameLift
11130
11365
  # resp.game_session.current_player_session_count #=> Integer
11131
11366
  # resp.game_session.maximum_player_session_count #=> Integer
11132
11367
  # resp.game_session.status #=> String, one of "ACTIVE", "ACTIVATING", "TERMINATED", "TERMINATING", "ERROR"
11133
- # resp.game_session.status_reason #=> String, one of "INTERRUPTED"
11368
+ # resp.game_session.status_reason #=> String, one of "INTERRUPTED", "TRIGGERED_ON_PROCESS_TERMINATE", "FORCE_TERMINATED"
11134
11369
  # resp.game_session.game_properties #=> Array
11135
11370
  # resp.game_session.game_properties[0].key #=> String
11136
11371
  # resp.game_session.game_properties[0].value #=> String
@@ -11698,7 +11933,7 @@ module Aws::GameLift
11698
11933
  tracer: tracer
11699
11934
  )
11700
11935
  context[:gem_name] = 'aws-sdk-gamelift'
11701
- context[:gem_version] = '1.96.0'
11936
+ context[:gem_version] = '1.98.0'
11702
11937
  Seahorse::Client::Request.new(handlers, context)
11703
11938
  end
11704
11939