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
{
"TicketId": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
Note
In the following list, the required parameters are described first.
- TicketId
-
A unique identifier for a matchmaking ticket.
Type: String
Length Constraints: Maximum length of 128.
Pattern:
[a-zA-Z0-9-\.]*Required: Yes
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceException
-
The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.
HTTP Status Code: 500
- InvalidRequestException
-
One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.
HTTP Status Code: 400
- NotFoundException
-
The requested resources was not found. The resource was either not created yet or deleted.
HTTP Status Code: 400
- UnsupportedRegionException
-
The requested operation is not supported in the Region specified.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
