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 the ticket. Acceptances are only valid
for tickets when they are in this status; all other acceptances result in an
error.
To register acceptance, specify the ticket ID, a response, and one or more players.
Once all players have registered acceptance, the matchmaking tickets advance to status
PLACING
, where a new game session is created for the match.
If any player rejects the match, or if acceptances are not received before a specified
timeout, the proposed match is dropped. The matchmaking tickets are then handled in
one
of two ways: For tickets where one or more players rejected the match, the ticket
status
is returned to SEARCHING
to find a new match. For tickets where one or more
players failed to respond, the ticket status is set to CANCELLED
, and
processing is terminated. A new matchmaking request for these players can be submitted
as needed.
Learn more
Add FlexMatch to a game client
FlexMatch events (reference)
Related actions
StartMatchmaking | DescribeMatchmaking | StopMatchmaking | AcceptMatch | StartMatchBackfill | All APIs by task
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.
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
-
A service resource associated with the request could not be found. Clients should not retry such requests.
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: