create_matchmaking_configuration ¶

def create_matchmaking_configuration(
    self,
    *,
    config_overrides: Optional[GameLiftClientConfig] = None,
    name: Optional[
        "capo_gamelift.types.matchmaking_id_string_model.MatchmakingIdStringModel"
    ] = None,
    description: Optional[
        "capo_gamelift.types.non_zero_and_max_string.NonZeroAndMaxString"
    ] = None,
    game_session_queue_arns: Optional[
        "capo_gamelift.types.queue_arns_list.QueueArnsList"
    ] = None,
    request_timeout_seconds: Optional[
        "capo_gamelift.types.matchmaking_request_timeout_integer.MatchmakingRequestTimeoutInteger"
    ] = None,
    acceptance_timeout_seconds: Optional[
        "capo_gamelift.types.matchmaking_acceptance_timeout_integer.MatchmakingAcceptanceTimeoutInteger"
    ] = None,
    acceptance_required: Optional[
        "capo_gamelift.types.boolean_model.BooleanModel"
    ] = None,
    rule_set_name: Optional[
        "capo_gamelift.types.matchmaking_rule_set_name.MatchmakingRuleSetName"
    ] = None,
    notification_target: Optional[
        "capo_gamelift.types.sns_arn_string_model.SnsArnStringModel"
    ] = None,
    additional_player_count: Optional[
        "capo_gamelift.types.whole_number.WholeNumber"
    ] = None,
    custom_event_data: Optional[
        "capo_gamelift.types.custom_event_data.CustomEventData"
    ] = None,
    game_properties: Optional[
        "capo_gamelift.types.game_property_list.GamePropertyList"
    ] = None,
    game_session_data: Optional[
        "capo_gamelift.types.game_session_data.GameSessionData"
    ] = None,
    backfill_mode: Optional[
        "capo_gamelift.types.backfill_mode.BackfillMode"
    ] = None,
    flex_match_mode: Optional[
        "capo_gamelift.types.flex_match_mode.FlexMatchMode"
    ] = None,
    tags: Optional["capo_gamelift.types.tag_list.TagList"] = None,
) -> "capo_gamelift.types.create_matchmaking_configuration_output.CreateMatchmakingConfigurationOutput":
    """<p> <b>This API works with the following fleet types:</b> EC2, Anywhere, Container</p> <p>Defines a new matchmaking configuration for use with FlexMatch. Whether you are using FlexMatch with Amazon GameLift Servers hosting or as a standalone matchmaking service, the matchmaking configuration sets out rules for matching players and forming teams. If you're also using Amazon GameLift Servers hosting, it defines how to start game sessions for each match. Your matchmaking system can use multiple configurations to handle different game scenarios. All matchmaking requests identify the matchmaking configuration to use and provide player attributes consistent with that configuration. </p> <p>To create a matchmaking configuration, you must provide the following: configuration name and FlexMatch mode (with or without Amazon GameLift Servers hosting); a rule set that specifies how to evaluate players and find acceptable matches; whether player acceptance is required; and the maximum time allowed for a matchmaking attempt. When using FlexMatch with Amazon GameLift Servers hosting, you also need to identify the game session queue to use when starting a game session for the match.</p> <p>In addition, you must set up an Amazon Simple Notification Service topic to receive matchmaking notifications. Provide the topic ARN in the matchmaking configuration.</p> <p> <b>Learn more</b> </p> <p> <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-configuration.html"> Design a FlexMatch matchmaker</a> </p> <p> <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html"> Set up FlexMatch event notification</a> </p>

    Args:
        name: <p>A unique identifier for the matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.</p>
        description: <p>A human-readable description of the matchmaking configuration. </p>
        game_session_queue_arns: <p>The Amazon Resource Name (<a href="https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html">ARN</a>) that is assigned to a Amazon GameLift Servers game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is <code>arn:aws:gamelift:<region>::gamesessionqueue/<queue name></code>. Queues can be located in any Region. Queues are used to start new Amazon GameLift Servers-hosted game sessions for matches that are created with this matchmaking configuration. A matchmaking configuration supports only one queue; if you specify more than one ARN, the request fails with an <code>InvalidRequestException</code>. If <code>FlexMatchMode</code> is set to <code>STANDALONE</code>, do not set this parameter. </p>
        request_timeout_seconds: <p>The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed.</p>
        acceptance_timeout_seconds: <p>The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required. </p>
        acceptance_required: <p>A flag that determines whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to <code>TRUE</code>. With this option enabled, matchmaking tickets use the status <code>REQUIRES_ACCEPTANCE</code> to indicate when a completed potential match is waiting for player acceptance. </p>
        rule_set_name: <p>A unique identifier for the matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.</p>
        notification_target: <p>An SNS topic ARN that is set up to receive matchmaking notifications. See <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-notification.html"> Setting up notifications for matchmaking</a> for more information.</p>
        additional_player_count: <p>The number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match. This parameter is not used if <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p>
        custom_event_data: <p>Information to be added to all events related to this matchmaking configuration. </p>
        game_properties: <p>A set of key-value pairs that can store custom data in a game session. For example: <code>{"Key": "difficulty", "Value": "novice"}</code>. This information is added to the new <code>GameSession</code> object that is created for a successful match. This parameter is not used if <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p> <note> <ul> <li> <p>Avoid using periods (".") in property keys if you plan to search for game sessions by properties. Property keys containing periods cannot be searched and will be filtered out from search results due to search index limitations.</p> </li> <li> <p>If you use SearchGameSessions API, there is a limit of 500 game property keys across all game sessions and all fleets per region. If the limit is exceeded, there will potentially be game session entries missing from SearchGameSessions API results.</p> </li> </ul> </note>
        game_session_data: <p>A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session. For more information, see <a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession">Start a game session</a>. This information is added to the new <code>GameSession</code> object that is created for a successful match. This parameter is not used if <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p>
        backfill_mode: <p>The method used to backfill game sessions that are created with this matchmaking configuration. Specify <code>MANUAL</code> when your game manages backfill requests manually or does not use the match backfill feature. Specify <code>AUTOMATIC</code> to have Amazon GameLift Servers create a backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-backfill.html"> Backfill Existing Games with FlexMatch</a>. Automatic backfill is not available when <code>FlexMatchMode</code> is set to <code>STANDALONE</code>.</p>
        flex_match_mode: <p>Indicates whether this matchmaking configuration is being used with Amazon GameLift Servers hosting or as a standalone matchmaking solution. </p> <ul> <li> <p> <b>STANDALONE</b> - FlexMatch forms matches and returns match information, including players and team assignments, in a <a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-events.html#match-events-matchmakingsucceeded"> MatchmakingSucceeded</a> event.</p> </li> <li> <p> <b>WITH_QUEUE</b> - FlexMatch forms matches and uses the specified Amazon GameLift Servers queue to start a game session for the match. </p> </li> </ul>
        tags: <p>A list of labels to assign to the new matchmaking configuration resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources is useful for resource management, access management and cost allocation. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html"> Tagging Amazon Web Services Resources</a> in the <i>Amazon Web Services General Reference</i>.</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.limit_exceeded_exception.LimitExceededException: <p>The requested operation would cause the resource to exceed the allowed service limit. Resolve the issue 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.tagging_failed_exception.TaggingFailedException: <p>The requested tagging operation did not succeed. This may be due to invalid tag format or the maximum tag limit may have been exceeded. Resolve the issue 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.create_matchmaking_configuration_input.CreateMatchmakingConfigurationInput]",
    ) -> OperationResponse[
        "capo_gamelift.types.create_matchmaking_configuration_output.CreateMatchmakingConfigurationOutput"
    ]:
        import capo_gamelift._operations.game_lift.create_matchmaking_configuration

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

    def _redact_input(
        input_: "capo_gamelift.types.create_matchmaking_configuration_input.CreateMatchmakingConfigurationInput",
    ) -> dict[str, Any]:
        import capo_gamelift.types.create_matchmaking_configuration_input

        return capo_gamelift.types.create_matchmaking_configuration_input.redact_sensitive(
            input_
        )

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

        return capo_gamelift.types.create_matchmaking_configuration_output.redact_sensitive(
            output
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "CreateMatchmakingConfiguration",
            redact_input=_redact_input,
            redact_output=_redact_output,
        ),
    )
    input_: capo_gamelift.types.create_matchmaking_configuration_input.CreateMatchmakingConfigurationInput = {}
    if name is not None:
        input_["name"] = name
    if description is not None:
        input_["description"] = description
    if game_session_queue_arns is not None:
        input_["game_session_queue_arns"] = game_session_queue_arns
    if request_timeout_seconds is not None:
        input_["request_timeout_seconds"] = request_timeout_seconds
    if acceptance_timeout_seconds is not None:
        input_["acceptance_timeout_seconds"] = acceptance_timeout_seconds
    if acceptance_required is not None:
        input_["acceptance_required"] = acceptance_required
    if rule_set_name is not None:
        input_["rule_set_name"] = rule_set_name
    if notification_target is not None:
        input_["notification_target"] = notification_target
    if additional_player_count is not None:
        input_["additional_player_count"] = additional_player_count
    if custom_event_data is not None:
        input_["custom_event_data"] = custom_event_data
    if game_properties is not None:
        input_["game_properties"] = game_properties
    if game_session_data is not None:
        input_["game_session_data"] = game_session_data
    if backfill_mode is not None:
        input_["backfill_mode"] = backfill_mode
    if flex_match_mode is not None:
        input_["flex_match_mode"] = flex_match_mode
    if tags is not None:
        input_["tags"] = tags

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