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.

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

Related actions

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

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to StopMatchmakingAsync.

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

Syntax

C#
public abstract StopMatchmakingResponse StopMatchmaking(
         StopMatchmakingRequest request
)
Parameters
request
Type: Amazon.GameLift.Model.StopMatchmakingRequest

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

Return Value
The response from the StopMatchmaking 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 Framework:
Supported in: 4.5, 4.0, 3.5

See Also