GameLift / Client / validate_matchmaking_rule_set

validate_matchmaking_rule_set#

GameLift.Client.validate_matchmaking_rule_set(**kwargs)#

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

Learn more

See also: AWS API Documentation

Request Syntax

response = client.validate_matchmaking_rule_set(
    RuleSetBody='string'
)
Parameters:

RuleSetBody (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'Valid': True|False
}

Response Structure

  • (dict) –

    • Valid (boolean) –

      A response indicating whether the rule set is valid.

Exceptions

  • GameLift.Client.exceptions.InternalServiceException

  • GameLift.Client.exceptions.UnsupportedRegionException

  • GameLift.Client.exceptions.InvalidRequestException