describeMatchmakingRuleSets method

Future<DescribeMatchmakingRuleSetsOutput> describeMatchmakingRuleSets({ int? limit, List<String>? names, String? nextToken, })

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

Related operations

• CreateMatchmakingConfiguration
• DescribeMatchmakingConfigurations
• UpdateMatchmakingConfiguration
• DeleteMatchmakingConfiguration
• CreateMatchmakingRuleSet
• DescribeMatchmakingRuleSets
• ValidateMatchmakingRuleSet
• DeleteMatchmakingRuleSet

May throw InvalidRequestException. May throw InternalServiceException. May throw NotFoundException. May throw UnsupportedRegionException.

Parameter limit : The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

Parameter names : 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.

Parameter nextToken : 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.

Implementation

Future<DescribeMatchmakingRuleSetsOutput> describeMatchmakingRuleSets({
  int? limit,
  List<String>? names,
  String? nextToken,
}) async {
  _s.validateNumRange(
    'limit',
    limit,
    1,
    10,
  );
  _s.validateStringLength(
    'nextToken',
    nextToken,
    1,
    1024,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'GameLift.DescribeMatchmakingRuleSets'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      if (limit != null) 'Limit': limit,
      if (names != null) 'Names': names,
      if (nextToken != null) 'NextToken': nextToken,
    },
  );

  return DescribeMatchmakingRuleSetsOutput.fromJson(jsonResponse.body);
}