CreateMatchmakingConfiguration
Defines a new matchmaking configuration for use with FlexMatch. A matchmaking configuration sets out guidelines for matching players and getting the matches into games. You can set up multiple matchmaking configurations to handle the scenarios needed for your game. Each matchmaking ticket (StartMatchmaking or StartMatchBackfill) specifies a configuration for the match and provides player attributes to support the configuration being used.
To create a matchmaking configuration, at a minimum you must specify the following: configuration name; a rule set that governs how to evaluate players and find acceptable matches; a game session queue to use when placing a new game session for the match; and the maximum time allowed for a matchmaking attempt.
There are two ways to track the progress of matchmaking tickets: (1) polling ticket
status with DescribeMatchmaking; or (2) receiving notifications with
Amazon Simple Notification Service (SNS). To use notifications, you first need to
set up an SNS topic to receive the
notifications, and provide the topic ARN in the matchmaking configuration. Since
notifications promise only "best effort" delivery, we recommend calling
DescribeMatchmaking
if no notifications are received within 30
seconds.
Learn more
Setting up Notifications for Matchmaking
Related operations
Request Syntax
{ "AcceptanceRequired":
boolean
, "AcceptanceTimeoutSeconds":number
, "AdditionalPlayerCount":number
, "BackfillMode": "string
", "CustomEventData": "string
", "Description": "string
", "GameProperties": [ { "Key": "string
", "Value": "string
" } ], "GameSessionData": "string
", "GameSessionQueueArns": [ "string
" ], "Name": "string
", "NotificationTarget": "string
", "RequestTimeoutSeconds":number
, "RuleSetName": "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.
- AcceptanceRequired
-
A flag that determines whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to
TRUE
.Type: Boolean
Required: Yes
- GameSessionQueueArns
-
An Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. The format is
arn:aws:gamelift:<region>:<aws account>:gamesessionqueue/<queue name>
. These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any Region.Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[a-zA-Z0-9:/-]+
Required: Yes
- Name
-
A unique identifier for a matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.
Type: String
Length Constraints: Maximum length of 128.
Pattern:
[a-zA-Z0-9-\.]*
Required: Yes
- RequestTimeoutSeconds
-
The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 43200.
Required: Yes
- RuleSetName
-
A unique identifier for a matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule sets that are defined in the same Region.
Type: String
Length Constraints: Maximum length of 128.
Pattern:
[a-zA-Z0-9-\.]*
Required: Yes
- AcceptanceTimeoutSeconds
-
The length of time (in seconds) to wait for players to accept a proposed match. If any player rejects the match or fails to accept before the timeout, the ticket continues to look for an acceptable match.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 600.
Required: No
- AdditionalPlayerCount
-
The number of player slots in a match to keep open for future players. For example, assume that the configuration's rule set specifies a match for a single 12-person team. If the additional player count is set to 2, only 10 players are initially selected for the match.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
- BackfillMode
-
The method used to backfill game sessions that are created with this matchmaking configuration. Specify
MANUAL
when your game manages backfill requests manually or does not use the match backfill feature. SpecifyAUTOMATIC
to have GameLift create a StartMatchBackfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch.Type: String
Valid Values:
AUTOMATIC | MANUAL
Required: No
- CustomEventData
-
Information to be added to all events related to this matchmaking configuration.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
- Description
-
A human-readable description of the matchmaking configuration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- GameProperties
-
A set of custom properties for a game session, formatted as key-value pairs. These properties are passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.
Type: Array of GameProperty objects
Array Members: Maximum number of 16 items.
Required: No
- GameSessionData
-
A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session). This information is added to the new GameSession object that is created for a successful match.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4096.
Required: No
- NotificationTarget
-
An SNS topic ARN that is set up to receive matchmaking notifications.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 300.
Pattern:
[a-zA-Z0-9:_/-]*
Required: No
Response Syntax
{ "Configuration": { "AcceptanceRequired": boolean, "AcceptanceTimeoutSeconds": number, "AdditionalPlayerCount": number, "BackfillMode": "string", "CreationTime": number, "CustomEventData": "string", "Description": "string", "GameProperties": [ { "Key": "string", "Value": "string" } ], "GameSessionData": "string", "GameSessionQueueArns": [ "string" ], "Name": "string", "NotificationTarget": "string", "RequestTimeoutSeconds": number, "RuleSetName": "string" } }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Configuration
-
Object that describes the newly created matchmaking configuration.
Type: MatchmakingConfiguration object
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
- LimitExceededException
-
The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue 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: