class Aws::GameLift::Types::StartMatchmakingInput
Represents the input for a request operation.
@note When making an API call, you may pass StartMatchmakingInput
data as a hash: { ticket_id: "MatchmakingIdStringModel", configuration_name: "MatchmakingConfigurationName", # 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, }, }, ], }
@!attribute [rw] ticket_id
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 matchmaking ticket status and retrieve match results. @return [String]
@!attribute [rw] configuration_name
Name of the matchmaking configuration to use for this request. Matchmaking configurations must exist in the same Region as this request. You can use either the configuration name or ARN value. @return [String]
@!attribute [rw] players
Information on each player to be matched. This information must include a player ID, and may contain player attributes and latency data to be used in the matchmaking process. After a successful match, `Player` objects contain the name of the team the player is assigned to. @return [Array<Types::Player>]
@see docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/StartMatchmakingInput AWS API Documentation
Constants
- SENSITIVE