Container for the parameters to the StartMatchmaking operation. Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules. With games that use Amazon GameLift managed hosting, this operation also triggers Amazon GameLift to find hosting resources and start a new game session for the new match. Each matchmaking request includes information on one or more players and specifies the FlexMatch matchmaker to use. When a request is for multiple players, FlexMatch attempts to build a match that includes all players in the request, placing them in the same team and finding additional players as needed to fill the match.
To start matchmaking, provide a unique ticket ID, specify a matchmaking configuration,
and include the players to be matched. You must also include any player attributes
that are required by the matchmaking configuration's rule set. If successful, a matchmaking
ticket is returned with status set to QUEUED.
Track matchmaking events to respond as needed and acquire game session connection information for successfully completed matches. Ticket status updates are tracked using event notification through Amazon Simple Notification Service, which is defined in the matchmaking configuration.
Learn more
Add FlexMatch to a game client
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.GameLift.AmazonGameLiftRequest
Amazon.GameLift.Model.StartMatchmakingRequest
Namespace: Amazon.GameLift.Model
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z
Syntax
public class StartMatchmakingRequest : AmazonGameLiftRequest IAmazonWebServiceRequest
The StartMatchmakingRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
StartMatchmakingRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
ConfigurationName | System.String |
Gets and sets the property ConfigurationName. 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. |
|
|
Players | System.Collections.Generic.List<Amazon.GameLift.Model.Player> |
Gets and sets the property 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,
You can include up to 10 |
|
|
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 matchmaking 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