Module Values.StartMatchmakingOutputSource

This API works with the following fleet types: EC2, Anywhere, Container Uses FlexMatch to create a game match for a group of players based on custom matchmaking rules. With games that use Amazon GameLift Servers managed hosting, this operation also triggers Amazon GameLift Servers 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 Amazon GameLift Servers FlexMatch works

Sourcetype nonrec t = {
  1. matchmakingTicket : MatchmakingTicket.t option;
    (*

    Ticket representing the matchmaking request. This object include the information included in the request, ticket status, and match results as generated during the matchmaking process.

    *)
}
Sourcetype nonrec error = [
  1. | `InternalServiceException of InternalServiceException.t
  2. | `InvalidRequestException of InvalidRequestException.t
  3. | `NotFoundException of NotFoundException.t
  4. | `UnsupportedRegionException of UnsupportedRegionException.t
  5. | `Unknown_operation_error of string * string option
]
Sourceval make : ?matchmakingTicket:??? -> unit -> t
Sourceval error_of_json : string -> Yojson.Safe.t -> [> `InternalServiceException of InternalServiceException.t | `InvalidRequestException of InvalidRequestException.t | `NotFoundException of NotFoundException.t | `Unknown_operation_error of string * string option | `UnsupportedRegionException of UnsupportedRegionException.t ]
Sourceval error_of_xml : string -> Awso.Xml.t -> [> `InternalServiceException of InternalServiceException.t | `InvalidRequestException of InvalidRequestException.t | `NotFoundException of NotFoundException.t | `Unknown_operation_error of string * string option | `UnsupportedRegionException of UnsupportedRegionException.t ]
Sourceval error_to_json : error -> Yojson.Safe.t
Sourceval to_value : t -> [> `Structure of (string * [> `Structure of (string * [> `Enum of string | `Integer of WholeNumber.t | `List of [> `Structure of (string * [> `Map of ([> `String of NonZeroAndMaxString.t ] * [> `Integer of PositiveInteger.t | `Structure of (string * [> `Double of DoubleObject.t | `List of [> `String of PlayerAttributeString.t ] list | `Map of ([> `String of PlayerAttributeString.t ] * [> `Double of DoubleObject.t ]) list | `String of PlayerAttributeString.t ]) list ]) list | `String of PlayerId.t ]) list ] list | `String of MatchmakingIdStringModel.t | `Structure of (string * [> `Enum of string | `Integer of PositiveInteger.t | `List of [> `Structure of (string * [> `String of PlayerId.t ]) list ] list | `String of ArnStringModel.t ]) list | `Timestamp of Timestamp.t ]) list ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t