GameLift / Client / stop_matchmaking

stop_matchmaking#

GameLift.Client.stop_matchmaking(**kwargs)#

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.

Note

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

Request Syntax

response = client.stop_matchmaking(
    TicketId='string'
)

Parameters:

TicketId (string) –

[REQUIRED]

A unique identifier for a matchmaking ticket.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

Exceptions

GameLift.Client.exceptions.InvalidRequestException
GameLift.Client.exceptions.NotFoundException
GameLift.Client.exceptions.InternalServiceException
GameLift.Client.exceptions.UnsupportedRegionException