You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::GameLift::Types::StartMatchBackfillInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::GameLift::Types::StartMatchBackfillInput
- Defined in:
- (unknown)
Overview
When passing StartMatchBackfillInput as input to an Aws::Client method, you can use a vanilla Hash:
{
ticket_id: "MatchmakingIdStringModel",
configuration_name: "MatchmakingConfigurationName", # required
game_session_arn: "ArnStringModel", # required
players: [ # required
{
player_id: "NonZeroAndMaxString",
player_attributes: {
"NonZeroAndMaxString" => "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
},
team: "NonZeroAndMaxString",
latency_in_ms: {
"NonEmptyString" => 1,
},
},
],
}
Represents the input for a request operation.
Instance Attribute Summary collapse
-
#configuration_name ⇒ String
Name of the matchmaker to use for this request.
-
#game_session_arn ⇒ String
Amazon Resource Name ([ARN][1]) that is assigned to a game session and uniquely identifies it.
-
#players ⇒ Array<Types::Player>
Match information on all players that are currently assigned to the game session.
-
#ticket_id ⇒ String
A unique identifier for a matchmaking ticket.
Instance Attribute Details
#configuration_name ⇒ String
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 ⇒ String
Amazon Resource Name (ARN) that is assigned to a game session and uniquely identifies it. This is the same as the game session ID.
#players ⇒ Array<Types::Player>
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.
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.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 ⇒ String
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.