describe_matchmaking_rule_sets ¶

def describe_matchmaking_rule_sets(
    self,
    *,
    config_overrides: Optional[GameLiftClientConfig] = None,
    names: Optional[
        "capo_gamelift.types.matchmaking_rule_set_name_list.MatchmakingRuleSetNameList"
    ] = None,
    limit: Optional["capo_gamelift.types.rule_set_limit.RuleSetLimit"] = None,
    next_token: Optional[
        "capo_gamelift.types.non_zero_and_max_string.NonZeroAndMaxString"
    ] = None,
) -> "capo_gamelift.types.describe_matchmaking_rule_sets_output.DescribeMatchmakingRuleSetsOutput":
    """<p> <b>This API works with the following fleet types:</b> EC2, Anywhere, Container</p> <p>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. </p> <p> <b>Learn more</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-rulesets.html">Build a rule set</a> </p> </li> </ul>

    Args:
        names: <p>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. </p>
        limit: <p>The maximum number of results to return. Use this parameter with <code>NextToken</code> to get results as a set of sequential pages.</p>
        next_token: <p>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.</p>

    Raises:
        capo_gamelift.errors.internal_service_exception.InternalServiceException: <p>The service encountered an unrecoverable internal failure while processing the request. Clients can retry such requests immediately or after a waiting period.</p>
        capo_gamelift.errors.invalid_request_exception.InvalidRequestException: <p>One or more parameter values in the request are invalid. Correct the invalid parameter values before retrying.</p>
        capo_gamelift.errors.not_found_exception.NotFoundException: <p>The requested resource was not found. The resource was either not created yet or deleted.</p>
        capo_gamelift.errors.unsupported_region_exception.UnsupportedRegionException: <p>The requested operation is not supported in the Region specified.</p>
        capo_gamelift.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_gamelift.types.describe_matchmaking_rule_sets_input.DescribeMatchmakingRuleSetsInput]",
    ) -> OperationResponse[
        "capo_gamelift.types.describe_matchmaking_rule_sets_output.DescribeMatchmakingRuleSetsOutput"
    ]:
        import capo_gamelift._operations.game_lift.describe_matchmaking_rule_sets

        output, http_response = (
            capo_gamelift._operations.game_lift.describe_matchmaking_rule_sets.describe_matchmaking_rule_sets(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeMatchmakingRuleSets")
    )
    input_: capo_gamelift.types.describe_matchmaking_rule_sets_input.DescribeMatchmakingRuleSetsInput = {}
    if names is not None:
        input_["names"] = names
    if limit is not None:
        input_["limit"] = limit
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output