Menu
Amazon GameLift Service
API Reference (API Version 2015-10-01)

ValidateMatchmakingRuleSet

Validates the syntax of a matchmaking rule or rule set. This operation checks that the rule set uses syntactically correct JSON and that it conforms to allowed property expressions. To validate syntax, provide a rule set string.

Operations related to match configurations and rule sets include:

Request Syntax

Copy
{ "RuleSetBody": "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.

RuleSetBody

Collection of matchmaking rules to validate, formatted as a JSON string.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 65535.

Required: Yes

Response Syntax

Copy
{ "Valid": boolean }

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.

Valid

Response indicating whether or not the rule set is valid.

Type: Boolean

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

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: