Container for the parameters to the StartMatchBackfill operation. Finds new players to fill open slots in currently running game sessions. The backfill match process is essentially identical to the process of forming new matches. Backfill requests use the same matchmaker that was used to make the original match, and they provide matchmaking data for all players currently in the game session. FlexMatch uses this information to select new players so that backfilled match continues to meet the original match requirements.
When using FlexMatch with Amazon GameLift managed hosting, you can request a backfill
match from a client service by calling this operation with a GameSessions ID.
You also have the option of making backfill requests directly from your game server.
In response to a request, FlexMatch creates player sessions for the new players, updates
the GameSession resource, and sends updated matchmaking data to the game server.
You can request a backfill match at any point after a game session is started. Each
game session can have only one active backfill request at a time; a subsequent request
automatically replaces the earlier request.
When using FlexMatch as a standalone component, request a backfill match by calling this operation without a game session identifier. As with newly formed matches, matchmaking results are returned in a matchmaking event so that your game can update the game session that is being backfilled.
To request a backfill match, specify a unique ticket ID, the original matchmaking
configuration, and matchmaking data for all current players in the game session being
backfilled. Optionally, specify the GameSession ARN. If successful, a match
backfill ticket is created and returned with status set to QUEUED. Track the status
of backfill tickets using the same method for tracking tickets for new matches.
Only game sessions created by FlexMatch are supported for match backfill.
Learn more
Backfill existing games with FlexMatch
Matchmaking events (reference)
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.GameLift.AmazonGameLiftRequest
Amazon.GameLift.Model.StartMatchBackfillRequest
Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z
Syntax
public class StartMatchBackfillRequest : AmazonGameLiftRequest IAmazonWebServiceRequest
The StartMatchBackfillRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
StartMatchBackfillRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
ConfigurationName | System.String |
Gets and sets the property ConfigurationName.
Name of the matchmaker to use for this request. You can use either the configuration
name or ARN value. The ARN of the matchmaker that was used with the original game
session is listed in the |
|
|
GameSessionArn | System.String |
Gets and sets the property GameSessionArn. A unique identifier for the game session. Use the game session ID. When using FlexMatch as a standalone matchmaking solution, this parameter is not needed. |
|
|
Players | System.Collections.Generic.List<Amazon.GameLift.Model.Player> |
Gets and sets the property Players. Match information on all players that are currently assigned to the game session. This information is used by the matchmaker to find new players and add them to the existing game.
You can include up to 199
|
|
|
TicketId | System.String |
Gets and sets the property TicketId. A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the match backfill ticket status and retrieve match results. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5