describe_matchmaking_rule_sets

GameLift.Client.describe_matchmaking_rule_sets(**kwargs)

Retrieves the details for FlexMatch matchmaking rule sets. You can request all existing rule sets for the Region, or provide a list of one or more rule set names. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. If successful, a rule set is returned for each requested name.

Learn more

• Build a rule set

See also: AWS API Documentation

Request Syntax

response = client.describe_matchmaking_rule_sets(
    Names=[
        'string',
    ],
    Limit=123,
    NextToken='string'
)

Parameters

• Names (list) --

  A list of one or more matchmaking rule set names to retrieve details for. (Note: The rule set name is different from the optional "name" field in the rule set body.) You can use either the rule set name or ARN value.

  • (string) --
• Limit (integer) -- The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
• NextToken (string) -- A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value.

Return type

dict

Returns

Response Syntax

{
    'RuleSets': [
        {
            'RuleSetName': 'string',
            'RuleSetArn': 'string',
            'RuleSetBody': 'string',
            'CreationTime': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • RuleSets (list) --

    A collection of requested matchmaking rule set objects.

    • (dict) --

      Set of rule statements, used with FlexMatch, that determine how to build your player matches. Each rule set describes a type of group to be created and defines the parameters for acceptable player matches.

      A rule set may define the following elements for a match. For detailed information and examples showing how to construct a rule set, see Build a FlexMatch rule set.

      • Teams -- Required. A rule set must define one or multiple teams for the match and set minimum and maximum team sizes. For example, a rule set might describe a 4x4 match that requires all eight slots to be filled.
      • Player attributes -- Optional. These attributes specify a set of player characteristics to evaluate when looking for a match. Matchmaking requests that use a rule set with player attributes must provide the corresponding attribute values. For example, an attribute might specify a player's skill or level.
      • Rules -- Optional. Rules define how to evaluate potential players for a match based on player attributes. A rule might specify minimum requirements for individual players, teams, or entire matches. For example, a rule might require each player to meet a certain skill level, each team to have at least one player in a certain role, or the match to have a minimum average skill level. or may describe an entire group--such as all teams must be evenly matched or have at least one player in a certain role.
      • Expansions -- Optional. Expansions allow you to relax the rules after a period of time when no acceptable matches are found. This feature lets you balance getting players into games in a reasonable amount of time instead of making them wait indefinitely for the best possible match. For example, you might use an expansion to increase the maximum skill variance between players after 30 seconds.

      • RuleSetName (string) --

        A unique identifier for the matchmaking rule set

      • RuleSetArn (string) --

        The Amazon Resource Name ( ARN ) that is assigned to a GameLift matchmaking rule set resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::matchmakingruleset/<ruleset name> . In a GameLift rule set ARN, the resource ID matches the RuleSetName value.

      • RuleSetBody (string) --

        A collection of matchmaking rules, formatted as a JSON string. Comments are not allowed in JSON, but most elements support a description field.

      • CreationTime (datetime) --

        A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057" ).

  • NextToken (string) --

    A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.

Exceptions

• GameLift.Client.exceptions.InvalidRequestException
• GameLift.Client.exceptions.InternalServiceException
• GameLift.Client.exceptions.NotFoundException
• GameLift.Client.exceptions.UnsupportedRegionException