Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

StartMatchBackfill

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)

How Amazon GameLift FlexMatch works

Request Syntax


{
   "ConfigurationName": "string",
   "GameSessionArn": "string",
   "Players": [ 
      { 
         "LatencyInMs": { 
            "string" : number 
         },
         "PlayerAttributes": { 
            "string" : { 
               "N": number,
               "S": "string",
               "SDM": { 
                  "string" : number 
               },
               "SL": [ "string" ]
            }
         },
         "PlayerId": "string",
         "Team": "string"
      }
   ],
   "TicketId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

In the following list, the required parameters are described first.

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 GameSession object, MatchmakerData property.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9-\.]*|^arn:.*:matchmakingconfiguration\/[a-zA-Z0-9-\.]*

Required: Yes

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 Players in a StartMatchBackfill request.

PlayerID, PlayerAttributes, Team -- This information is maintained in the GameSession object, MatchmakerData property, for all players who are currently assigned to the game session. The matchmaker data is in JSON syntax, formatted as a string. For more details, see Match Data.

The backfill request must specify the team membership for every player. Do not specify team if you are not using backfill.
LatencyInMs -- If the matchmaker uses player latency, include a latency value, in milliseconds, for the Region that the game session is currently in. Do not include latency values for any other Region.

Type: Array of Player objects

Required: Yes

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9:/-]+

Required: No

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.

Type: String

Length Constraints: Maximum length of 128.

Pattern: [a-zA-Z0-9-\.]*

Required: No

Response Syntax


{
   "MatchmakingTicket": { 
      "ConfigurationArn": "string",
      "ConfigurationName": "string",
      "EndTime": number,
      "EstimatedWaitTime": number,
      "GameSessionConnectionInfo": { 
         "DnsName": "string",
         "GameSessionArn": "string",
         "IpAddress": "string",
         "MatchedPlayerSessions": [ 
            { 
               "PlayerId": "string",
               "PlayerSessionId": "string"
            }
         ],
         "Port": number
      },
      "Players": [ 
         { 
            "LatencyInMs": { 
               "string" : number 
            },
            "PlayerAttributes": { 
               "string" : { 
                  "N": number,
                  "S": "string",
                  "SDM": { 
                     "string" : number 
                  },
                  "SL": [ "string" ]
               }
            },
            "PlayerId": "string",
            "Team": "string"
         }
      ],
      "StartTime": number,
      "Status": "string",
      "StatusMessage": "string",
      "StatusReason": "string",
      "TicketId": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

MatchmakingTicket

Ticket representing the backfill matchmaking request. This object includes the information in the request, ticket status, and match results as generated during the matchmaking process.

Type: MatchmakingTicket object

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceException

The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.

HTTP Status Code: 500

InvalidRequestException

One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.

HTTP Status Code: 400

NotFoundException

The requested resources was not found. The resource was either not created yet or deleted.

HTTP Status Code: 400

UnsupportedRegionException

The requested operation is not supported in the Region specified.

HTTP Status Code: 400