UpdateMatchmakingConfiguration
Updates settings for a FlexMatch matchmaking configuration. To update settings, specify the configuration name to be updated and provide the new settings.
Request Syntax
{ "AcceptanceRequired":boolean, "AcceptanceTimeoutSeconds":number, "AdditionalPlayerCount":number, "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.
- Name
-
Unique identifier for a matchmaking configuration to update.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9-\.]+Required: Yes
- AcceptanceRequired
-
Flag that determines whether or not a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE.
Type: Boolean
Required: No
- AcceptanceTimeoutSeconds
-
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
-
Number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match.
Type: Integer
Valid Range: Minimum value of 0.
Required: No
- CustomEventData
-
Information to attached to all events related to the matchmaking configuration.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 256.
Required: No
- Description
-
Descriptive label that is associated with matchmaking configuration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- GameProperties
-
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
-
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
- GameSessionQueueArns
-
Amazon Resource Name (ARN) that is assigned to a game session queue and uniquely identifies it. 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: No
- NotificationTarget
-
SNS topic ARN that is set up to receive matchmaking notifications. See Setting up Notifications for Matchmaking for more information.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 300.
Pattern:
[a-zA-Z0-9:_/-]*Required: No
- RequestTimeoutSeconds
-
Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that time out can be resubmitted as needed.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 43200.
Required: No
- RuleSetName
-
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: Minimum length of 1. Maximum length of 128.
Pattern:
[a-zA-Z0-9-\.]+Required: No
Response Syntax
{ "Configuration": { "AcceptanceRequired": boolean, "AcceptanceTimeoutSeconds": number, "AdditionalPlayerCount": number, "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 updated 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
- 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:
