AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules. With games that use GameLift managed hosting, this operation also triggers 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

Set Up FlexMatch event notification

How GameLift FlexMatch works

Related actions

StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch | StartMatchBackfill | All APIs by task

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginStartMatchmaking and EndStartMatchmaking.

Namespace: Amazon.GameLift
Assembly: AWSSDK.GameLift.dll
Version: 3.x.y.z

Syntax

C#
public abstract Task<StartMatchmakingResponse> StartMatchmakingAsync(
         StartMatchmakingRequest request,
         CancellationToken cancellationToken
)
Parameters
request
Type: Amazon.GameLift.Model.StartMatchmakingRequest

Container for the necessary parameters to execute the StartMatchmaking service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value
The response from the StartMatchmaking service method, as returned by GameLift.

Exceptions

ExceptionCondition
InternalServiceException The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
InvalidRequestException One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
NotFoundException A service resource associated with the request could not be found. Clients should not retry such requests.
UnsupportedRegionException The requested operation is not supported in the Region specified.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5

See Also