aws-sdk-gamelift 1.97.0 → 1.98.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb9d860f6068c44945612080a5a78893a7f4f8890adbb00a9d3373d7e80ba0ce
-  data.tar.gz: d857cfb5ff056b1f4a5b0700d671ddcf5645d2a712fe0e42f477bbc21ea46bb8
+  metadata.gz: 24e268796d25bf08c2b521f8c4edc0ace29f0a24742addf10b7809087d043122
+  data.tar.gz: 431399c6e95a708ad5dba69a884cc235880ec3a1d66c81fc305d6fd30fde5647
 SHA512:
-  metadata.gz: bd0558caacc924f8cb7b394d79dc444eeb5b211c1c90f15966f5bbacb73817bbb451de5fdcc26b4bd953517f073a4269e27e031aef12a5b047b7a3f286ba8161
-  data.tar.gz: c8018375f3affe4c3d05e5a76370ca5ef7c6978b9ff1acf319e3c00b7de546b2f2c9ec01e184f23d949415c24a5db429a0c8b6637c589174b71c252259b4aa8a
+  metadata.gz: 2d8b58d78ac33ffcc9efbbf8615d9026f1473f59a93bf0b778fd3b15b91f39f4c469abbf60d7c16a5758fca3d483963063f4e53fec82e88f17ff10a3f0885c8f
+  data.tar.gz: 418e9a6576cd99a2d58cdf73c30a11fcc3f823b8e93ae902e6215bcdac1244d1b46717d721a1a71301e80e6bfec92837c6e98a327f543704679a303c27512edb

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.98.0 (2025-01-14)
+------------------
+
+* Feature - Amazon GameLift releases a new game session placement feature: PriorityConfigurationOverride. You can now override how a game session queue prioritizes placement locations for a single StartGameSessionPlacement request.
+
 1.97.0 (2025-01-02)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.97.0
+1.98.0

data/lib/aws-sdk-gamelift/client.rb

@@ -1196,7 +1196,7 @@ module Aws::GameLift
     # @example Request syntax with placeholder values
     #
     #   resp = client.create_container_fleet({
-    #     fleet_role_arn: "ArnStringModel", # required
+    #     fleet_role_arn: "IamRoleArn", # required
     #     description: "NonZeroAndMaxString",
     #     game_server_container_group_definition_name: "ContainerGroupDefinitionNameOrArn",
     #     per_instance_container_group_definition_name: "ContainerGroupDefinitionNameOrArn",
@@ -5882,9 +5882,9 @@ module Aws::GameLift
     #
     # This operation is not designed to be continually called to track game
     # session status. This practice can cause you to exceed your API limit,
-    # which results in errors. Instead, you must configure configure an
-    # Amazon Simple Notification Service (SNS) topic to receive
-    # notifications from FlexMatch or queues. Continuously polling with
+    # which results in errors. Instead, you must configure an Amazon Simple
+    # Notification Service (SNS) topic to receive notifications from
+    # FlexMatch or queues. Continuously polling with
     # `DescribeGameSessionPlacement` should only be used for games in
     # development with low game session usage.
     #
@@ -5928,6 +5928,9 @@ module Aws::GameLift
     #   resp.game_session_placement.placed_player_sessions[0].player_session_id #=> String
     #   resp.game_session_placement.game_session_data #=> String
     #   resp.game_session_placement.matchmaker_data #=> String
+    #   resp.game_session_placement.priority_configuration_override.placement_fallback_strategy #=> String, one of "DEFAULT_AFTER_SINGLE_PASS", "NONE"
+    #   resp.game_session_placement.priority_configuration_override.location_order #=> Array
+    #   resp.game_session_placement.priority_configuration_override.location_order[0] #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeGameSessionPlacement AWS API Documentation
     #
@@ -9175,55 +9178,83 @@ module Aws::GameLift
       req.send_request(options)
     end
 
-    # Places a request for a new game session in a queue. When processing a
-    # placement request, Amazon GameLift searches for available resources on
-    # the queue's destinations, scanning each until it finds resources or
-    # the placement request times out.
-    #
-    # A game session placement request can also request player sessions.
-    # When a new game session is successfully created, Amazon GameLift
-    # creates a player session for each player included in the request.
+    # Makes a request to start a new game session using a game session
+    # queue. When processing a placement request in a queue, Amazon GameLift
+    # finds the best possible available resource to host the game session
+    # and prompts the resource to start the game session.
     #
-    # When placing a game session, by default Amazon GameLift tries each
-    # fleet in the order they are listed in the queue configuration.
-    # Ideally, a queue's destinations are listed in preference order.
-    #
-    # Alternatively, when requesting a game session with players, you can
-    # also provide latency data for each player in relevant Regions. Latency
-    # data indicates the performance lag a player experiences when connected
-    # to a fleet in the Region. Amazon GameLift uses latency data to reorder
-    # the list of destinations to place the game session in a Region with
-    # minimal lag. If latency data is provided for multiple players, Amazon
-    # GameLift calculates each Region's average lag for all players and
-    # reorders to get the best game play across all players.
+    # **Request options**
     #
-    # To place a new game session request, specify the following:
+    # Call this API with the following minimum parameters:
+    # *GameSessionQueueName*, *MaximumPlayerSessionCount*, and
+    # *PlacementID*. You can also include game session data (data formatted
+    # as strings) or game properties (data formatted as key-value pairs) to
+    # pass to the new game session.
+    #
+    # * You can change how Amazon GameLift chooses a hosting resource for
+    #   the new game session. Prioritizing resources for game session
+    #   placements is defined when you configure a game session queue. You
+    #   can use the default prioritization process or specify a custom
+    #   process by providing a [ PriorityConfiguration][1] when you create
+    #   or update a queue.
+    #
+    #   * Prioritize based on resource cost and location, using the queue's
+    #     configured priority settings. Call this API with the minimum
+    #     parameters.
+    #
+    #   * Prioritize based on latency. Include a set of values for
+    #     *PlayerLatencies*. You can provide latency data with or without
+    #     player session data. This option instructs Amazon GameLift to
+    #     reorder the queue's prioritized locations list based on the
+    #     latency data. If latency data is provided for multiple players,
+    #     Amazon GameLift calculates each location's average latency for
+    #     all players and reorders to find the lowest latency across all
+    #     players. Don't include latency data if you're providing a custom
+    #     list of locations.
+    #
+    #   * Prioritize based on a custom list of locations. If you're using a
+    #     queue that's configured to prioritize location first (see
+    #     [PriorityConfiguration][1] for game session queues), use the
+    #     *PriorityConfigurationOverride* parameter to substitute a
+    #     different location list for this placement request. When
+    #     prioritizing placements by location, Amazon GameLift searches each
+    #     location in prioritized order to find an available hosting
+    #     resource for the new game session. You can choose whether to use
+    #     the override list for the first placement attempt only or for all
+    #     attempts.
+    # * You can request new player sessions for a group of players. Include
+    #   the *DesiredPlayerSessions* parameter and include at minimum a
+    #   unique player ID for each. You can also include player-specific data
+    #   to pass to the new game session.
     #
-    # * The queue name and a set of game session properties and settings
+    # **Result**
     #
-    # * A unique ID (such as a UUID) for the placement. You use this ID to
-    #   track the status of the placement request
+    # If successful, this request generates a new game session placement
+    # request and adds it to the game session queue for Amazon GameLift to
+    # process in turn. You can track the status of individual placement
+    # requests by calling [DescribeGameSessionPlacement][2]. A new game
+    # session is running if the status is `FULFILLED` and the request
+    # returns the game session connection information (IP address and port).
+    # If you include player session data, Amazon GameLift creates a player
+    # session for each player ID in the request.
     #
-    # * (Optional) A set of player data and a unique player ID for each
-    #   player that you are joining to the new game session (player data is
-    #   optional, but if you include it, you must also provide a unique ID
-    #   for each player)
+    # The request results in a `BadRequestException` in the following
+    # situations:
     #
-    # * Latency data for all players (if you want to optimize game play for
-    #   the players)
+    # * If the request includes both *PlayerLatencies* and
+    #   *PriorityConfigurationOverride* parameters.
     #
-    # If successful, a new game session placement is created.
+    # * If the request includes the *PriorityConfigurationOverride*
+    #   parameter and designates a queue doesn't prioritize locations.
     #
-    # To track the status of a placement request, call
-    # [DescribeGameSessionPlacement][1] and check the request's status. If
-    # the status is `FULFILLED`, a new game session has been created and a
-    # game session ARN and Region are referenced. If the placement request
-    # times out, you can resubmit the request or retry it with a different
-    # queue.
+    # Amazon GameLift continues to retry each placement request until it
+    # reaches the queue's timeout setting. If a request times out, you can
+    # resubmit the request to the same queue or try a different queue.
     #
     #
     #
-    # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionPlacement.html
+    # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_PriorityConfiguration.html
+    # [2]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeGameSessionPlacement.html
     #
     # @option params [required, String] :placement_id
     #   A unique identifier to assign to the new game session placement. This
@@ -9248,9 +9279,10 @@ module Aws::GameLift
     #
     # @option params [Array<Types::PlayerLatency>] :player_latencies
     #   A set of values, expressed in milliseconds, that indicates the amount
-    #   of latency that a player experiences when connected to @aws; Regions.
-    #   This information is used to try to place the new game session where it
-    #   can offer the best possible gameplay experience for the players.
+    #   of latency that a player experiences when connected to Amazon Web
+    #   Services Regions. This information is used to try to place the new
+    #   game session where it can offer the best possible gameplay experience
+    #   for the players.
     #
     # @option params [Array<Types::DesiredPlayerSession>] :desired_player_sessions
     #   Set of information on each player to create a player session for.
@@ -9265,6 +9297,15 @@ module Aws::GameLift
     #
     #   [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
     #
+    # @option params [Types::PriorityConfigurationOverride] :priority_configuration_override
+    #   A prioritized list of locations to use for the game session placement
+    #   and instructions on how to use it. This list overrides a queue's
+    #   prioritized location list for this game session placement request
+    #   only. You can include Amazon Web Services Regions, local zones, and
+    #   custom locations (for Anywhere fleets). Choose a fallback strategy to
+    #   instruct Amazon GameLift to use the override list for the first
+    #   placement attempt only or for all placement attempts.
+    #
     # @return [Types::StartGameSessionPlacementOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::StartGameSessionPlacementOutput#game_session_placement #game_session_placement} => Types::GameSessionPlacement
@@ -9296,6 +9337,10 @@ module Aws::GameLift
     #       },
     #     ],
     #     game_session_data: "LargeGameSessionData",
+    #     priority_configuration_override: {
+    #       placement_fallback_strategy: "DEFAULT_AFTER_SINGLE_PASS", # accepts DEFAULT_AFTER_SINGLE_PASS, NONE
+    #       location_order: ["LocationStringModel"], # required
+    #     },
     #   })
     #
     # @example Response structure
@@ -9325,6 +9370,9 @@ module Aws::GameLift
     #   resp.game_session_placement.placed_player_sessions[0].player_session_id #=> String
     #   resp.game_session_placement.game_session_data #=> String
     #   resp.game_session_placement.matchmaker_data #=> String
+    #   resp.game_session_placement.priority_configuration_override.placement_fallback_strategy #=> String, one of "DEFAULT_AFTER_SINGLE_PASS", "NONE"
+    #   resp.game_session_placement.priority_configuration_override.location_order #=> Array
+    #   resp.game_session_placement.priority_configuration_override.location_order[0] #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/StartGameSessionPlacement AWS API Documentation
     #
@@ -9714,6 +9762,9 @@ module Aws::GameLift
     #   resp.game_session_placement.placed_player_sessions[0].player_session_id #=> String
     #   resp.game_session_placement.game_session_data #=> String
     #   resp.game_session_placement.matchmaker_data #=> String
+    #   resp.game_session_placement.priority_configuration_override.placement_fallback_strategy #=> String, one of "DEFAULT_AFTER_SINGLE_PASS", "NONE"
+    #   resp.game_session_placement.priority_configuration_override.location_order #=> Array
+    #   resp.game_session_placement.priority_configuration_override.location_order[0] #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/StopGameSessionPlacement AWS API Documentation
     #
@@ -9918,45 +9969,59 @@ module Aws::GameLift
       req.send_request(options)
     end
 
-    # Ends a game session that's currently in progress. You can use this
-    # action to terminate any game session that isn't in `TERMINATED` or
-    # `TERMINATING` status. Terminating a game session is the most efficient
-    # way to free up a server process when it's hosting a game session
-    # that's in a bad state or not ending naturally. You can use this
-    # action to terminate a game session that's being hosted on any type of
-    # Amazon GameLift fleet compute, including computes for managed EC2,
-    # managed container, and Anywhere fleets.
+    # Ends a game session that's currently in progress. Use this action to
+    # terminate any game session that isn't in `ERROR` status. Terminating
+    # a game session is the most efficient way to free up a server process
+    # when it's hosting a game session that's in a bad state or not ending
+    # properly. You can use this action to terminate a game session that's
+    # being hosted on any type of Amazon GameLift fleet compute, including
+    # computes for managed EC2, managed container, and Anywhere fleets. The
+    # game server must be integrated with Amazon GameLift server SDK 5.x or
+    # greater.
+    #
+    # **Request options**
     #
-    # There are two potential methods for terminating a game session:
+    # Request termination for a single game session. Provide the game
+    # session ID and the termination mode. There are two potential methods
+    # for terminating a game session:
     #
-    # * With a graceful termination, the Amazon GameLift service prompts the
-    #   server process to initiate its normal game session shutdown
-    #   sequence. This sequence is implemented in the game server code and
+    # * Initiate a graceful termination using the normal game session
+    #   shutdown sequence. With this mode, the Amazon GameLift service
+    #   prompts the server process that's hosting the game session by
+    #   calling the server SDK callback method `OnProcessTerminate()`. The
+    #   callback implementation is part of the custom game server code. It
     #   might involve a variety of actions to gracefully end a game session,
-    #   such as notifying players, and stop the server process.
+    #   such as notifying players, before stopping the server process.
     #
-    # * With a forceful termination, the Amazon GameLift service takes
-    #   immediate action to terminate the game session by stopping the
-    #   server process. Termination occurs without the normal game session
-    #   shutdown sequence.
+    # * Force an immediate game session termination. With this mode, the
+    #   Amazon GameLift service takes action to stop the server process,
+    #   which ends the game session without the normal game session shutdown
+    #   sequence.
     #
-    # **Request options**
+    # **Results**
     #
-    # * Request termination for a single game session. Provide the game
-    #   session ID and the termination method.
+    # If successful, game session termination is initiated. During this
+    # activity, the game session status is changed to `TERMINATING`. When
+    # completed, the server process that was hosting the game session has
+    # been stopped and replaced with a new server process that's ready to
+    # host a new game session. The old game session's status is changed to
+    # `TERMINATED` with a status reason that indicates the termination
+    # method used.
     #
-    # ^
+    # **Learn more**
     #
-    # **Results**
+    # [Add Amazon GameLift to your game server][1]
     #
-    # If successful, game session termination is initiated, which includes
-    # changing the game session status to `TERMINATING`. As a result of this
-    # action, and depending on the implementation of `OnProcessTerminate()`,
-    # the server process either becomes available to host a new game
-    # session, or it's recycled and a new server process started with
-    # availability to host a game session. The game session status is
-    # changed to `TERMINATED`, with a status reason that indicates the
-    # termination method used.
+    # Amazon GameLift server SDK 5 reference guide for
+    # `OnProcessTerminate()` ([C++][2]) ([C#][3]) ([Unreal][4]) ([Go][5])
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html
+    # [2]: https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-server-sdk5-cpp-initsdk.html
+    # [3]: https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-server-sdk5-csharp-initsdk.html
+    # [4]: https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-server-sdk5-unreal-initsdk.html
+    # [5]: https://docs.aws.amazon.com/gamelift/latest/developerguide/integration-server-sdk-go-initsdk.html
     #
     # @option params [required, String] :game_session_id
     #   A unique identifier for the game session to be terminated. A game
@@ -9968,17 +10033,20 @@ module Aws::GameLift
     #   The method to use to terminate the game session. Available methods
     #   include:
     #
-    #   * `TRIGGER_ON_PROCESS_TERMINATE` – Sends an `OnProcessTerminate()`
-    #     callback to the server process to initiate the normal game session
-    #     shutdown sequence. At a minimum, the callback method must include a
-    #     call to the server SDK action `ProcessEnding()`, which is how the
-    #     server process signals that a game session is ending. If the server
-    #     process doesn't call `ProcessEnding()`, this termination method
-    #     won't be successful.
-    #
-    #   * `FORCE_TERMINATE` – Takes action to stop the server process, using
-    #     existing methods to control how server processes run on an Amazon
-    #     GameLift managed compute.
+    #   * `TRIGGER_ON_PROCESS_TERMINATE` – Prompts the Amazon GameLift service
+    #     to send an `OnProcessTerminate()` callback to the server process and
+    #     initiate the normal game session shutdown sequence. The
+    #     `OnProcessTerminate` method, which is implemented in the game server
+    #     code, must include a call to the server SDK action
+    #     `ProcessEnding()`, which is how the server process signals to Amazon
+    #     GameLift that a game session is ending. If the server process
+    #     doesn't call `ProcessEnding()`, the game session termination won't
+    #     conclude successfully.
+    #
+    #   * `FORCE_TERMINATE` – Prompts the Amazon GameLift service to stop the
+    #     server process immediately. Amazon GameLift takes action (depending
+    #     on the type of fleet) to shut down the server process without the
+    #     normal game session shutdown sequence.
     #
     #     <note markdown="1"> This method is not available for game sessions that are running on
     #     Anywhere fleets unless the fleet is deployed with the Amazon
@@ -11865,7 +11933,7 @@ module Aws::GameLift
         tracer: tracer
       )
       context[:gem_name] = 'aws-sdk-gamelift'
-      context[:gem_version] = '1.97.0'
+      context[:gem_version] = '1.98.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-gamelift/client_api.rb

@@ -407,6 +407,7 @@ module Aws::GameLift
     LocationList = Shapes::ListShape.new(name: 'LocationList')
     LocationModel = Shapes::StructureShape.new(name: 'LocationModel')
     LocationModelList = Shapes::ListShape.new(name: 'LocationModelList')
+    LocationOrderOverrideList = Shapes::ListShape.new(name: 'LocationOrderOverrideList')
     LocationState = Shapes::StructureShape.new(name: 'LocationState')
     LocationStateList = Shapes::ListShape.new(name: 'LocationStateList')
     LocationStringModel = Shapes::StringShape.new(name: 'LocationStringModel')
@@ -455,6 +456,7 @@ module Aws::GameLift
     OutOfCapacityException = Shapes::StructureShape.new(name: 'OutOfCapacityException')
     PlacedPlayerSession = Shapes::StructureShape.new(name: 'PlacedPlayerSession')
     PlacedPlayerSessionList = Shapes::ListShape.new(name: 'PlacedPlayerSessionList')
+    PlacementFallbackStrategy = Shapes::StringShape.new(name: 'PlacementFallbackStrategy')
     Player = Shapes::StructureShape.new(name: 'Player')
     PlayerAttributeMap = Shapes::MapShape.new(name: 'PlayerAttributeMap')
     PlayerAttributeString = Shapes::StringShape.new(name: 'PlayerAttributeString')
@@ -480,6 +482,7 @@ module Aws::GameLift
     PositiveInteger = Shapes::IntegerShape.new(name: 'PositiveInteger')
     PositiveLong = Shapes::IntegerShape.new(name: 'PositiveLong')
     PriorityConfiguration = Shapes::StructureShape.new(name: 'PriorityConfiguration')
+    PriorityConfigurationOverride = Shapes::StructureShape.new(name: 'PriorityConfigurationOverride')
     PriorityType = Shapes::StringShape.new(name: 'PriorityType')
     PriorityTypeList = Shapes::ListShape.new(name: 'PriorityTypeList')
     ProtectionPolicy = Shapes::StringShape.new(name: 'ProtectionPolicy')
@@ -714,7 +717,7 @@ module Aws::GameLift
 
     ContainerFleet.add_member(:fleet_id, Shapes::ShapeRef.new(shape: FleetId, location_name: "FleetId"))
     ContainerFleet.add_member(:fleet_arn, Shapes::ShapeRef.new(shape: FleetArn, location_name: "FleetArn"))
-    ContainerFleet.add_member(:fleet_role_arn, Shapes::ShapeRef.new(shape: ArnStringModel, location_name: "FleetRoleArn"))
+    ContainerFleet.add_member(:fleet_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, location_name: "FleetRoleArn"))
     ContainerFleet.add_member(:game_server_container_group_definition_name, Shapes::ShapeRef.new(shape: ContainerGroupDefinitionName, location_name: "GameServerContainerGroupDefinitionName"))
     ContainerFleet.add_member(:game_server_container_group_definition_arn, Shapes::ShapeRef.new(shape: ContainerGroupDefinitionArn, location_name: "GameServerContainerGroupDefinitionArn"))
     ContainerFleet.add_member(:per_instance_container_group_definition_name, Shapes::ShapeRef.new(shape: ContainerGroupDefinitionName, location_name: "PerInstanceContainerGroupDefinitionName"))
@@ -815,7 +818,7 @@ module Aws::GameLift
     CreateBuildOutput.add_member(:storage_location, Shapes::ShapeRef.new(shape: S3Location, location_name: "StorageLocation"))
     CreateBuildOutput.struct_class = Types::CreateBuildOutput
 
-    CreateContainerFleetInput.add_member(:fleet_role_arn, Shapes::ShapeRef.new(shape: ArnStringModel, required: true, location_name: "FleetRoleArn"))
+    CreateContainerFleetInput.add_member(:fleet_role_arn, Shapes::ShapeRef.new(shape: IamRoleArn, required: true, location_name: "FleetRoleArn"))
     CreateContainerFleetInput.add_member(:description, Shapes::ShapeRef.new(shape: NonZeroAndMaxString, location_name: "Description"))
     CreateContainerFleetInput.add_member(:game_server_container_group_definition_name, Shapes::ShapeRef.new(shape: ContainerGroupDefinitionNameOrArn, location_name: "GameServerContainerGroupDefinitionName"))
     CreateContainerFleetInput.add_member(:per_instance_container_group_definition_name, Shapes::ShapeRef.new(shape: ContainerGroupDefinitionNameOrArn, location_name: "PerInstanceContainerGroupDefinitionName"))
@@ -1620,6 +1623,7 @@ module Aws::GameLift
     GameSessionPlacement.add_member(:placed_player_sessions, Shapes::ShapeRef.new(shape: PlacedPlayerSessionList, location_name: "PlacedPlayerSessions"))
     GameSessionPlacement.add_member(:game_session_data, Shapes::ShapeRef.new(shape: LargeGameSessionData, location_name: "GameSessionData"))
     GameSessionPlacement.add_member(:matchmaker_data, Shapes::ShapeRef.new(shape: MatchmakerData, location_name: "MatchmakerData"))
+    GameSessionPlacement.add_member(:priority_configuration_override, Shapes::ShapeRef.new(shape: PriorityConfigurationOverride, location_name: "PriorityConfigurationOverride"))
     GameSessionPlacement.struct_class = Types::GameSessionPlacement
 
     GameSessionQueue.add_member(:name, Shapes::ShapeRef.new(shape: GameSessionQueueName, location_name: "Name"))
@@ -1885,6 +1889,8 @@ module Aws::GameLift
 
     LocationModelList.member = Shapes::ShapeRef.new(shape: LocationModel)
 
+    LocationOrderOverrideList.member = Shapes::ShapeRef.new(shape: LocationStringModel)
+
     LocationState.add_member(:location, Shapes::ShapeRef.new(shape: LocationStringModel, location_name: "Location"))
     LocationState.add_member(:status, Shapes::ShapeRef.new(shape: FleetStatus, location_name: "Status"))
     LocationState.struct_class = Types::LocationState
@@ -2031,6 +2037,10 @@ module Aws::GameLift
     PriorityConfiguration.add_member(:location_order, Shapes::ShapeRef.new(shape: LocationList, location_name: "LocationOrder"))
     PriorityConfiguration.struct_class = Types::PriorityConfiguration
 
+    PriorityConfigurationOverride.add_member(:placement_fallback_strategy, Shapes::ShapeRef.new(shape: PlacementFallbackStrategy, location_name: "PlacementFallbackStrategy"))
+    PriorityConfigurationOverride.add_member(:location_order, Shapes::ShapeRef.new(shape: LocationOrderOverrideList, required: true, location_name: "LocationOrder"))
+    PriorityConfigurationOverride.struct_class = Types::PriorityConfigurationOverride
+
     PriorityTypeList.member = Shapes::ShapeRef.new(shape: PriorityType)
 
     PutScalingPolicyInput.add_member(:name, Shapes::ShapeRef.new(shape: NonZeroAndMaxString, required: true, location_name: "Name"))
@@ -2178,6 +2188,7 @@ module Aws::GameLift
     StartGameSessionPlacementInput.add_member(:player_latencies, Shapes::ShapeRef.new(shape: PlayerLatencyList, location_name: "PlayerLatencies"))
     StartGameSessionPlacementInput.add_member(:desired_player_sessions, Shapes::ShapeRef.new(shape: DesiredPlayerSessionList, location_name: "DesiredPlayerSessions"))
     StartGameSessionPlacementInput.add_member(:game_session_data, Shapes::ShapeRef.new(shape: LargeGameSessionData, location_name: "GameSessionData"))
+    StartGameSessionPlacementInput.add_member(:priority_configuration_override, Shapes::ShapeRef.new(shape: PriorityConfigurationOverride, location_name: "PriorityConfigurationOverride"))
     StartGameSessionPlacementInput.struct_class = Types::StartGameSessionPlacementInput
 
     StartGameSessionPlacementOutput.add_member(:game_session_placement, Shapes::ShapeRef.new(shape: GameSessionPlacement, location_name: "GameSessionPlacement"))
@@ -3883,6 +3894,7 @@ module Aws::GameLift
         o.errors << Shapes::ShapeRef.new(shape: InvalidRequestException)
         o.errors << Shapes::ShapeRef.new(shape: NotFoundException)
         o.errors << Shapes::ShapeRef.new(shape: UnauthorizedException)
+        o.errors << Shapes::ShapeRef.new(shape: UnsupportedRegionException)
       end)
 
       api.add_operation(:start_match_backfill, Seahorse::Model::Operation.new.tap do |o|

data/lib/aws-sdk-gamelift/types.rb

@@ -5338,10 +5338,10 @@ module Aws::GameLift
     end
 
     # A list of fleet locations where a game session queue can place new
-    # game sessions. You can use a filter to temporarily turn off placements
-    # for specific locations. For queues that have multi-location fleets,
-    # you can use a filter configuration allow placement with some, but not
-    # all of these locations.
+    # game sessions. You can use a filter to temporarily exclude specific
+    # locations from receiving placements. For queues that have
+    # multi-location fleets, you can use a filter configuration allow
+    # placement with some, but not all, of a fleet's locations.
     #
     # @!attribute [rw] allowed_locations
     #   A list of locations to allow game session placement in, in the form
@@ -6830,7 +6830,7 @@ module Aws::GameLift
     # before succeeding. With each attempt it creates a
     # [https://docs.aws.amazon.com/gamelift/latest/apireference/API\_GameSession][1]
     # object and updates this placement object with the new game session
-    # properties..
+    # properties.
     #
     #  </note>
     #
@@ -6902,8 +6902,8 @@ module Aws::GameLift
     #
     # @!attribute [rw] player_latencies
     #   A set of values, expressed in milliseconds, that indicates the
-    #   amount of latency that a player experiences when connected to @aws;
-    #   Regions.
+    #   amount of latency that a player experiences when connected to Amazon
+    #   Web Services Regions.
     #   @return [Array<Types::PlayerLatency>]
     #
     # @!attribute [rw] start_time
@@ -6982,6 +6982,17 @@ module Aws::GameLift
     #   [1]: https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data
     #   @return [String]
     #
+    # @!attribute [rw] priority_configuration_override
+    #   A prioritized list of locations to use with a game session placement
+    #   request and instructions on how to use it. This list overrides a
+    #   queue's prioritized location list for a single game session
+    #   placement request only. The list can include Amazon Web Services
+    #   Regions, local zones, and custom locations (for Anywhere fleets).
+    #   The fallback strategy instructs Amazon GameLift to use the override
+    #   list for the first placement attempt only or for all placement
+    #   attempts.
+    #   @return [Types::PriorityConfigurationOverride]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/GameSessionPlacement AWS API Documentation
     #
     class GameSessionPlacement < Struct.new(
@@ -7002,7 +7013,8 @@ module Aws::GameLift
       :port,
       :placed_player_sessions,
       :game_session_data,
-      :matchmaker_data)
+      :matchmaker_data,
+      :priority_configuration_override)
       SENSITIVE = [:ip_address, :port]
       include Aws::Structure
     end
@@ -9082,9 +9094,10 @@ module Aws::GameLift
     #
     # @!attribute [rw] latency_in_ms
     #   A set of values, expressed in milliseconds, that indicates the
-    #   amount of latency that a player experiences when connected to @aws;
-    #   Regions. If this property is present, FlexMatch considers placing
-    #   the match only in Regions for which latency is reported.
+    #   amount of latency that a player experiences when connected to Amazon
+    #   Web Services Regions. If this property is present, FlexMatch
+    #   considers placing the match only in Regions for which latency is
+    #   reported.
     #
     #   If a matchmaker has a rule that evaluates player latency, players
     #   must report latency in order to be matched. If no latency is
@@ -9291,52 +9304,61 @@ module Aws::GameLift
       include Aws::Structure
     end
 
-    # Custom prioritization settings for use by a game session queue when
-    # placing new game sessions with available game servers. When defined,
-    # this configuration replaces the default FleetIQ prioritization
-    # process, which is as follows:
+    # Custom prioritization settings for a game session queue to use when
+    # searching for available game servers to place new game sessions. This
+    # configuration replaces the default FleetIQ prioritization process.
     #
-    # * If player latency data is included in a game session request,
-    #   destinations and locations are prioritized first based on lowest
-    #   average latency (1), then on lowest hosting cost (2), then on
-    #   destination list order (3), and finally on location (alphabetical)
-    #   (4). This approach ensures that the queue's top priority is to
-    #   place game sessions where average player latency is lowest, and--if
-    #   latency is the same--where the hosting cost is less, etc.
+    # By default, a queue makes placements based on the following default
+    # prioritizations:
     #
-    # * If player latency data is not included, destinations and locations
-    #   are prioritized first on destination list order (1), and then on
-    #   location (alphabetical) (2). This approach ensures that the queue's
-    #   top priority is to place game sessions on the first destination
-    #   fleet listed. If that fleet has multiple locations, the game session
-    #   is placed on the first location (when listed alphabetically).
+    # * If player latency data is included in a game session request, Amazon
+    #   GameLift prioritizes placing game sessions where the average player
+    #   latency is lowest. Amazon GameLift re-orders the queue's
+    #   destinations and locations (for multi-location fleets) based on the
+    #   following priorities: (1) the lowest average latency across all
+    #   players, (2) the lowest hosting cost, (3) the queue's default
+    #   destination order, and then (4), an alphabetic list of locations.
     #
-    # Changing the priority order will affect how game sessions are placed.
+    # * If player latency data is not included, Amazon GameLift prioritizes
+    #   placing game sessions in the queue's first destination. If that
+    #   fleet has multiple locations, the game session is placed on the
+    #   first location (when listed alphabetically). Amazon GameLift
+    #   re-orders the queue's destinations and locations (for
+    #   multi-location fleets) based on the following priorities: (1) the
+    #   queue's default destination order, and then (2) an alphabetic list
+    #   of locations.
     #
     # @!attribute [rw] priority_order
-    #   The recommended sequence to use when prioritizing where to place new
-    #   game sessions. Each type can only be listed once.
+    #   A custom sequence to use when prioritizing where to place new game
+    #   sessions. Each priority type is listed once.
     #
-    #   * `LATENCY` -- FleetIQ prioritizes locations where the average
-    #     player latency (provided in each game session request) is lowest.
+    #   * `LATENCY` -- Amazon GameLift prioritizes locations where the
+    #     average player latency is lowest. Player latency data is provided
+    #     in each game session placement request.
     #
-    #   * `COST` -- FleetIQ prioritizes destinations with the lowest current
-    #     hosting costs. Cost is evaluated based on the location, instance
-    #     type, and fleet type (Spot or On-Demand) for each destination in
-    #     the queue.
+    #   * `COST` -- Amazon GameLift prioritizes destinations with the lowest
+    #     current hosting costs. Cost is evaluated based on the location,
+    #     instance type, and fleet type (Spot or On-Demand) of each
+    #     destination in the queue.
     #
-    #   * `DESTINATION` -- FleetIQ prioritizes based on the order that
-    #     destinations are listed in the queue configuration.
+    #   * `DESTINATION` -- Amazon GameLift prioritizes based on the list
+    #     order of destinations in the queue configuration.
     #
-    #   * `LOCATION` -- FleetIQ prioritizes based on the provided order of
-    #     locations, as defined in `LocationOrder`.
+    #   * `LOCATION` -- Amazon GameLift prioritizes based on the provided
+    #     order of locations, as defined in `LocationOrder`.
     #   @return [Array<String>]
     #
     # @!attribute [rw] location_order
     #   The prioritization order to use for fleet locations, when the
-    #   `PriorityOrder` property includes `LOCATION`. Locations are
-    #   identified by Amazon Web Services Region codes such as `us-west-2`.
-    #   Each location can only be listed once.
+    #   `PriorityOrder` property includes `LOCATION`. Locations can include
+    #   Amazon Web Services Region codes (such as `us-west-2`), local zones,
+    #   and custom locations (for Anywhere fleets). Each location must be
+    #   listed only once. For details, see [Amazon GameLift service
+    #   locations.][1]
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html
     #   @return [Array<String>]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/PriorityConfiguration AWS API Documentation
@@ -9348,6 +9370,65 @@ module Aws::GameLift
       include Aws::Structure
     end
 
+    # An alternate list of prioritized locations for use with a game session
+    # queue. When this property is included in a
+    # [StartGameSessionPlacement][1] request, this list overrides the
+    # queue's default location prioritization, as defined in the queue's
+    # [PriorityConfiguration](gamelift/latest/apireference/API_PriorityConfiguration.html)
+    # setting (*LocationOrder*). This property overrides the queue's
+    # default priority list for individual placement requests only. Use this
+    # property only with queues that have a `PriorityConfiguration` setting
+    # that prioritizes first.
+    #
+    # <note markdown="1"> A priority configuration override list does not override a queue's
+    # FilterConfiguration setting, if the queue has one. Filter
+    # configurations are used to limit placements to a subset of the
+    # locations in a queue's destinations. If the override list includes a
+    # location that's not included in the FilterConfiguration allowed list,
+    # Amazon GameLift won't attempt to place a game session there.
+    #
+    #  </note>
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartGameSessionPlacement.html
+    #
+    # @!attribute [rw] placement_fallback_strategy
+    #   Instructions for how to use the override list if the first round of
+    #   placement attempts fails. The first round is a failure if Amazon
+    #   GameLift searches all listed locations, in all of the queue's
+    #   destinations, without finding an available hosting resource for a
+    #   new game session. Valid strategies include:
+    #
+    #   * `DEFAULT_AFTER_SINGLE_PASS` -- After the first round of placement
+    #     attempts, discard the override list and use the queue's default
+    #     location priority list. Continue to use the queue's default list
+    #     until the placement request times out.
+    #
+    #   * `NONE` -- Continue to use the override list for all rounds of
+    #     placement attempts until the placement request times out.
+    #   @return [String]
+    #
+    # @!attribute [rw] location_order
+    #   A prioritized list of hosting locations. The list can include Amazon
+    #   Web Services Regions (such as `us-west-2`), local zones, and custom
+    #   locations (for Anywhere fleets). Each location must be listed only
+    #   once. For details, see [Amazon GameLift service locations.][1]
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html
+    #   @return [Array<String>]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/PriorityConfigurationOverride AWS API Documentation
+    #
+    class PriorityConfigurationOverride < Struct.new(
+      :placement_fallback_strategy,
+      :location_order)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @!attribute [rw] name
     #   A descriptive label that is associated with a fleet's scaling
     #   policy. Policy names do not need to be unique. A fleet can have only
@@ -10360,10 +10441,10 @@ module Aws::GameLift
     #
     # @!attribute [rw] player_latencies
     #   A set of values, expressed in milliseconds, that indicates the
-    #   amount of latency that a player experiences when connected to @aws;
-    #   Regions. This information is used to try to place the new game
-    #   session where it can offer the best possible gameplay experience for
-    #   the players.
+    #   amount of latency that a player experiences when connected to Amazon
+    #   Web Services Regions. This information is used to try to place the
+    #   new game session where it can offer the best possible gameplay
+    #   experience for the players.
     #   @return [Array<Types::PlayerLatency>]
     #
     # @!attribute [rw] desired_player_sessions
@@ -10381,6 +10462,16 @@ module Aws::GameLift
     #   [1]: https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession
     #   @return [String]
     #
+    # @!attribute [rw] priority_configuration_override
+    #   A prioritized list of locations to use for the game session
+    #   placement and instructions on how to use it. This list overrides a
+    #   queue's prioritized location list for this game session placement
+    #   request only. You can include Amazon Web Services Regions, local
+    #   zones, and custom locations (for Anywhere fleets). Choose a fallback
+    #   strategy to instruct Amazon GameLift to use the override list for
+    #   the first placement attempt only or for all placement attempts.
+    #   @return [Types::PriorityConfigurationOverride]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/StartGameSessionPlacementInput AWS API Documentation
     #
     class StartGameSessionPlacementInput < Struct.new(
@@ -10391,7 +10482,8 @@ module Aws::GameLift
       :game_session_name,
       :player_latencies,
       :desired_player_sessions,
-      :game_session_data)
+      :game_session_data,
+      :priority_configuration_override)
       SENSITIVE = []
       include Aws::Structure
     end
@@ -11097,17 +11189,20 @@ module Aws::GameLift
     #   The method to use to terminate the game session. Available methods
     #   include:
     #
-    #   * `TRIGGER_ON_PROCESS_TERMINATE` – Sends an `OnProcessTerminate()`
-    #     callback to the server process to initiate the normal game session
-    #     shutdown sequence. At a minimum, the callback method must include
-    #     a call to the server SDK action `ProcessEnding()`, which is how
-    #     the server process signals that a game session is ending. If the
-    #     server process doesn't call `ProcessEnding()`, this termination
-    #     method won't be successful.
-    #
-    #   * `FORCE_TERMINATE` – Takes action to stop the server process, using
-    #     existing methods to control how server processes run on an Amazon
-    #     GameLift managed compute.
+    #   * `TRIGGER_ON_PROCESS_TERMINATE` – Prompts the Amazon GameLift
+    #     service to send an `OnProcessTerminate()` callback to the server
+    #     process and initiate the normal game session shutdown sequence.
+    #     The `OnProcessTerminate` method, which is implemented in the game
+    #     server code, must include a call to the server SDK action
+    #     `ProcessEnding()`, which is how the server process signals to
+    #     Amazon GameLift that a game session is ending. If the server
+    #     process doesn't call `ProcessEnding()`, the game session
+    #     termination won't conclude successfully.
+    #
+    #   * `FORCE_TERMINATE` – Prompts the Amazon GameLift service to stop
+    #     the server process immediately. Amazon GameLift takes action
+    #     (depending on the type of fleet) to shut down the server process
+    #     without the normal game session shutdown sequence.
     #
     #     <note markdown="1"> This method is not available for game sessions that are running on
     #     Anywhere fleets unless the fleet is deployed with the Amazon

data/lib/aws-sdk-gamelift.rb

@@ -54,7 +54,7 @@ module Aws::GameLift
   autoload :EndpointProvider, 'aws-sdk-gamelift/endpoint_provider'
   autoload :Endpoints, 'aws-sdk-gamelift/endpoints'
 
-  GEM_VERSION = '1.97.0'
+  GEM_VERSION = '1.98.0'
 
 end
 

data/sig/client.rbs

@@ -1529,7 +1529,11 @@ module Aws
                                               player_data: ::String?
                                             },
                                           ],
-                                          ?game_session_data: ::String
+                                          ?game_session_data: ::String,
+                                          ?priority_configuration_override: {
+                                            placement_fallback_strategy: ("DEFAULT_AFTER_SINGLE_PASS" | "NONE")?,
+                                            location_order: Array[::String]
+                                          }
                                         ) -> _StartGameSessionPlacementResponseSuccess
                                       | (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartGameSessionPlacementResponseSuccess
 

data/sig/types.rbs

@@ -1298,6 +1298,7 @@ module Aws::GameLift
       attr_accessor placed_player_sessions: ::Array[Types::PlacedPlayerSession]
       attr_accessor game_session_data: ::String
       attr_accessor matchmaker_data: ::String
+      attr_accessor priority_configuration_override: Types::PriorityConfigurationOverride
       SENSITIVE: [:ip_address, :port]
     end
 
@@ -1773,6 +1774,12 @@ module Aws::GameLift
       SENSITIVE: []
     end
 
+    class PriorityConfigurationOverride
+      attr_accessor placement_fallback_strategy: ("DEFAULT_AFTER_SINGLE_PASS" | "NONE")
+      attr_accessor location_order: ::Array[::String]
+      SENSITIVE: []
+    end
+
     class PutScalingPolicyInput
       attr_accessor name: ::String
       attr_accessor fleet_id: ::String
@@ -1957,6 +1964,7 @@ module Aws::GameLift
       attr_accessor player_latencies: ::Array[Types::PlayerLatency]
       attr_accessor desired_player_sessions: ::Array[Types::DesiredPlayerSession]
       attr_accessor game_session_data: ::String
+      attr_accessor priority_configuration_override: Types::PriorityConfigurationOverride
       SENSITIVE: []
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-gamelift
 version: !ruby/object:Gem::Version
-  version: 1.97.0
+  version: 1.98.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-02 00:00:00.000000000 Z
+date: 2025-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core