AcceptMatch
Registers a player's acceptance or rejection of a proposed FlexMatch match. A matchmaking configuration may require player acceptance; if so, then matches built with that configuration cannot be completed unless all players accept the proposed match within a specified time limit.
When FlexMatch builds a match, all the matchmaking tickets involved in the proposed
match are placed into status REQUIRES_ACCEPTANCE
. This is a trigger for
your game to get acceptance from all players in each ticket. Calls to this action are only valid
for tickets that are in this status; calls for tickets not in this status result in an
error.
To register acceptance, specify the ticket ID, one or more players, and an acceptance response.
When all players have accepted, Amazon GameLift advances the matchmaking tickets to status
PLACING
, and attempts to create a new game session for the match.
If any player rejects the match, or if acceptances are not received before a specified timeout, the proposed match is dropped. Each matchmaking ticket in the failed match is handled as follows:
-
If the ticket has one or more players who rejected the match or failed to respond, the ticket status is set
CANCELLED
and processing is terminated. -
If all players in the ticket accepted the match, the ticket status is returned to
SEARCHING
to find a new match.
Learn more
Add FlexMatch to a game client
FlexMatch events (reference)
Request Syntax
{
"AcceptanceType": "string
",
"PlayerIds": [ "string
" ],
"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.
- AcceptanceType
-
Player response to the proposed match.
Type: String
Valid Values:
ACCEPT | REJECT
Required: Yes
- PlayerIds
-
A unique identifier for a player delivering the response. This parameter can include one or multiple player IDs.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: Yes
- TicketId
-
A unique identifier for a matchmaking ticket. The ticket must be in status
REQUIRES_ACCEPTANCE
; otherwise this request will fail.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: