StartMatchBackfillInput
¶
Source code in docs_src/capo_gamelift/types/start_match_backfill_input.py
configuration_name
instance-attribute
¶
configuration_name: NotRequired[MatchmakingConfigurationName]
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.
game_session_arn
instance-attribute
¶
game_session_arn: NotRequired[ArnStringModel]
An identifier for the game session that is unique across all regions. The value is always a full ARN in the following format: For Home Region game session - arn:aws:gamelift:. For Remote Location game session - arn:aws:gamelift:. When using FlexMatch as a standalone matchmaking solution, this parameter is not needed.
players
instance-attribute
¶
players: NotRequired[PlayerList]
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
GameSessionobject,MatchmakerDataproperty, 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.
ticket_id
instance-attribute
¶
ticket_id: NotRequired[MatchmakingIdStringModel]
A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift Servers will generate one in the form of a UUID. Use this identifier to track the match backfill ticket status and retrieve match results.