describe_matchmaking_configurations ¶

def describe_matchmaking_configurations(
    self,
    *,
    config_overrides: Optional[GameLiftClientConfig] = None,
    names: Optional[
        "capo_gamelift.types.matchmaking_configuration_name_list.MatchmakingConfigurationNameList"
    ] = None,
    rule_set_name: Optional[
        "capo_gamelift.types.matchmaking_rule_set_name.MatchmakingRuleSetName"
    ] = None,
    limit: Optional["capo_gamelift.types.positive_integer.PositiveInteger"] = None,
    next_token: Optional[
        "capo_gamelift.types.non_zero_and_max_string.NonZeroAndMaxString"
    ] = None,
) -> "capo_gamelift.types.describe_matchmaking_configurations_output.DescribeMatchmakingConfigurationsOutput":
    """<p> <b>This API works with the following fleet types:</b> EC2, Anywhere, Container</p> <p>Retrieves the details of FlexMatch matchmaking configurations. </p> <p>This operation offers the following options: (1) retrieve all matchmaking configurations, (2) retrieve configurations for a specified list, or (3) retrieve all configurations that use a specified rule set name. When requesting multiple items, use the pagination parameters to retrieve results as a set of sequential pages. </p> <p>If successful, a configuration is returned for each requested name. When specifying a list of names, only configurations that currently exist are returned. </p> <p> <b>Learn more</b> </p> <p> <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/matchmaker-build.html"> Setting up FlexMatch matchmakers</a> </p>

    Args:
        names: <p>A unique identifier for the matchmaking configuration(s) to retrieve. You can use either the configuration name or ARN value. To request all existing configurations, leave this parameter empty.</p>
        rule_set_name: <p>A unique identifier for the matchmaking rule set. You can use either the rule set name or ARN value. Use this parameter to retrieve all matchmaking configurations that use this rule set.</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. This parameter is limited to 10.</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.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_configurations_input.DescribeMatchmakingConfigurationsInput]",
    ) -> OperationResponse[
        "capo_gamelift.types.describe_matchmaking_configurations_output.DescribeMatchmakingConfigurationsOutput"
    ]:
        import capo_gamelift._operations.game_lift.describe_matchmaking_configurations

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

    def _redact_output(
        output: "capo_gamelift.types.describe_matchmaking_configurations_output.DescribeMatchmakingConfigurationsOutput",
    ) -> dict[str, Any]:
        import capo_gamelift.types.describe_matchmaking_configurations_output

        return capo_gamelift.types.describe_matchmaking_configurations_output.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "DescribeMatchmakingConfigurations", redact_output=_redact_output
        ),
    )
    input_: capo_gamelift.types.describe_matchmaking_configurations_input.DescribeMatchmakingConfigurationsInput = {}
    if names is not None:
        input_["names"] = names
    if rule_set_name is not None:
        input_["rule_set_name"] = rule_set_name
    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