Module Smaws_Client_GameLift.StopMatchmaking

This API works with the following fleet types: EC2, Anywhere, Container

Cancels a matchmaking ticket or match backfill ticket that is currently being processed. To stop the matchmaking operation, specify the ticket ID. If successful, work on the ticket is stopped, and the ticket status is changed to CANCELLED.

This call is also used to turn off automatic backfill for an individual game session. This is for game sessions that are created with a matchmaking configuration that has automatic backfill enabled. The ticket ID is included in the MatchmakerData of an updated game session object, which is provided to the game server.

If the operation is successful, the service sends back an empty JSON struct with the HTTP 200 response (not an empty HTTP body).

Learn more

Add FlexMatch to a game client

val error_to_string : [ Smaws_Lib.Protocols.AwsJson.error | `InternalServiceException of Types.internal_service_exception | `InvalidRequestException of Types.invalid_request_exception | `NotFoundException of Types.not_found_exception | `UnsupportedRegionException of Types.unsupported_region_exception ] -> string
val request : 'http_type Smaws_Lib.Context.t -> Types.stop_matchmaking_input -> (Types.stop_matchmaking_output, [> Smaws_Lib.Protocols.AwsJson.error | `InternalServiceException of Types.internal_service_exception | `InvalidRequestException of Types.invalid_request_exception | `NotFoundException of Types.not_found_exception | `UnsupportedRegionException of Types.unsupported_region_exception ]) Stdlib.result
val request_with_metadata : 'http_type Smaws_Lib.Context.t -> Types.stop_matchmaking_input -> (Types.stop_matchmaking_output Smaws_Lib.Response.t, [> Smaws_Lib.Protocols.AwsJson.error | `InternalServiceException of Types.internal_service_exception | `InvalidRequestException of Types.invalid_request_exception | `NotFoundException of Types.not_found_exception | `UnsupportedRegionException of Types.unsupported_region_exception ] * Smaws_Lib.Response.metadata) Stdlib.result