deleteMatchmakingRuleSet method

Future<void> deleteMatchmakingRuleSet({ required String name, })

Deletes an existing matchmaking rule set. To delete the rule set, provide the rule set name. Rule sets cannot be deleted if they are currently being used by a matchmaking configuration.

Learn more

• Build a Rule Set

Related operations

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

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

Parameter name : A unique identifier for a matchmaking rule set to be deleted. (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.

Implementation

Future<void> deleteMatchmakingRuleSet({
  required String name,
}) async {
  ArgumentError.checkNotNull(name, 'name');
  _s.validateStringLength(
    'name',
    name,
    1,
    256,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'GameLift.DeleteMatchmakingRuleSet'
  };
  await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'Name': name,
    },
  );
}