/AWS1/IF_GML=>UPDATEMATCHMAKINGCONF()

About UpdateMatchmakingConfiguration

This API works with the following fleet types: EC2, Anywhere, Container

Updates settings for a FlexMatch matchmaking configuration. These changes affect all matches and game sessions that are created after the update. To update settings, specify the configuration name to be updated and provide the new settings.

Learn more

Design a FlexMatch matchmaker

Method Signature

METHODS /AWS1/IF_GML~UPDATEMATCHMAKINGCONF
  IMPORTING
    !IV_NAME TYPE /AWS1/GMLMATCHMAKINGCONFNAME OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/GMLNONZEROANDMAXSTRING OPTIONAL
    !IT_GAMESESSIONQUEUEARNS TYPE /AWS1/CL_GMLQUEUEARNSLIST_W=>TT_QUEUEARNSLIST OPTIONAL
    !IV_REQUESTTIMEOUTSECONDS TYPE /AWS1/GMLMATCHMAKINGREQTOINT00 OPTIONAL
    !IV_ACCEPTANCETIMEOUTSECONDS TYPE /AWS1/GMLMATCHMAKINGACCANCET00 OPTIONAL
    !IV_ACCEPTANCEREQUIRED TYPE /AWS1/GMLBOOLEANMODEL OPTIONAL
    !IV_RULESETNAME TYPE /AWS1/GMLMATCHMAKINGRLSETNAME OPTIONAL
    !IV_NOTIFICATIONTARGET TYPE /AWS1/GMLSNSARNSTRINGMODEL OPTIONAL
    !IV_ADDITIONALPLAYERCOUNT TYPE /AWS1/GMLWHOLENUMBER OPTIONAL
    !IV_CUSTOMEVENTDATA TYPE /AWS1/GMLCUSTOMEVENTDATA OPTIONAL
    !IT_GAMEPROPERTIES TYPE /AWS1/CL_GMLGAMEPROPERTY=>TT_GAMEPROPERTYLIST OPTIONAL
    !IV_GAMESESSIONDATA TYPE /AWS1/GMLGAMESESSIONDATA OPTIONAL
    !IV_BACKFILLMODE TYPE /AWS1/GMLBACKFILLMODE OPTIONAL
    !IV_FLEXMATCHMODE TYPE /AWS1/GMLFLEXMATCHMODE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_gmlupmatchmakingcon01
  RAISING
    /AWS1/CX_GMLINTERNALSERVICEEX
    /AWS1/CX_GMLINVALIDREQUESTEX
    /AWS1/CX_GMLNOTFOUNDEXCEPTION
    /AWS1/CX_GMLUNSUPPEDREGIONEX
    /AWS1/CX_GMLCLIENTEXC
    /AWS1/CX_GMLSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_name TYPE /AWS1/GMLMATCHMAKINGCONFNAME /AWS1/GMLMATCHMAKINGCONFNAME

A unique identifier for the matchmaking configuration to update. You can use either the configuration name or ARN value.

Optional arguments:

iv_description TYPE /AWS1/GMLNONZEROANDMAXSTRING /AWS1/GMLNONZEROANDMAXSTRING

A description for the matchmaking configuration.

it_gamesessionqueuearns TYPE /AWS1/CL_GMLQUEUEARNSLIST_W=>TT_QUEUEARNSLIST TT_QUEUEARNSLIST

The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift Servers game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:::gamesessionqueue/. 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. If FlexMatchMode is set to STANDALONE, do not set this parameter.

iv_requesttimeoutseconds TYPE /AWS1/GMLMATCHMAKINGREQTOINT00 /AWS1/GMLMATCHMAKINGREQTOINT00

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.

iv_acceptancetimeoutseconds TYPE /AWS1/GMLMATCHMAKINGACCANCET00 /AWS1/GMLMATCHMAKINGACCANCET00

The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.

iv_acceptancerequired TYPE /AWS1/GMLBOOLEANMODEL /AWS1/GMLBOOLEANMODEL

A flag that indicates whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE. With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.

iv_rulesetname TYPE /AWS1/GMLMATCHMAKINGRLSETNAME /AWS1/GMLMATCHMAKINGRLSETNAME

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.

iv_notificationtarget TYPE /AWS1/GMLSNSARNSTRINGMODEL /AWS1/GMLSNSARNSTRINGMODEL

An SNS topic ARN that is set up to receive matchmaking notifications. See Setting up notifications for matchmaking for more information.

iv_additionalplayercount TYPE /AWS1/GMLWHOLENUMBER /AWS1/GMLWHOLENUMBER

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 FlexMatchMode is set to STANDALONE.

iv_customeventdata TYPE /AWS1/GMLCUSTOMEVENTDATA /AWS1/GMLCUSTOMEVENTDATA

Information to add to all events related to the matchmaking configuration.

it_gameproperties TYPE /AWS1/CL_GMLGAMEPROPERTY=>TT_GAMEPROPERTYLIST TT_GAMEPROPERTYLIST

A set of key-value pairs that can store custom data in a game session. For example: {"Key": "difficulty", "Value": "novice"}. This information is added to the new GameSession object that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.

iv_gamesessiondata TYPE /AWS1/GMLGAMESESSIONDATA /AWS1/GMLGAMESESSIONDATA

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 Start a game session. This information is added to the game session that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.

iv_backfillmode TYPE /AWS1/GMLBACKFILLMODE /AWS1/GMLBACKFILLMODE

The method that is used to backfill game sessions created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a match backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.

iv_flexmatchmode TYPE /AWS1/GMLFLEXMATCHMODE /AWS1/GMLFLEXMATCHMODE

Indicates whether this matchmaking configuration is being used with Amazon GameLift Servers hosting or as a standalone matchmaking solution.

• STANDALONE - FlexMatch forms matches and returns match information, including players and team assignments, in a MatchmakingSucceeded event.

• WITH_QUEUE - FlexMatch forms matches and uses the specified Amazon GameLift Servers queue to start a game session for the match.

RETURNING

oo_output TYPE REF TO /aws1/cl_gmlupmatchmakingcon01 /AWS1/CL_GMLUPMATCHMAKINGCON01

Domain	/AWS1/RT_ACCOUNT_ID
Primitive Type	NUMC

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->updatematchmakingconf(
  it_gameproperties = VALUE /aws1/cl_gmlgameproperty=>tt_gamepropertylist(
    (
      new /aws1/cl_gmlgameproperty(
        iv_key = |string|
        iv_value = |string|
      )
    )
  )
  it_gamesessionqueuearns = VALUE /aws1/cl_gmlqueuearnslist_w=>tt_queuearnslist(
    ( new /aws1/cl_gmlqueuearnslist_w( |string| ) )
  )
  iv_acceptancerequired = ABAP_TRUE
  iv_acceptancetimeoutseconds = 123
  iv_additionalplayercount = 123
  iv_backfillmode = |string|
  iv_customeventdata = |string|
  iv_description = |string|
  iv_flexmatchmode = |string|
  iv_gamesessiondata = |string|
  iv_name = |string|
  iv_notificationtarget = |string|
  iv_requesttimeoutseconds = 123
  iv_rulesetname = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_matchmakingconfiguratio = lo_result->get_configuration( ).
  IF lo_matchmakingconfiguratio IS NOT INITIAL.
    lv_matchmakingidstringmode = lo_matchmakingconfiguratio->get_name( ).
    lv_matchmakingconfiguratio_1 = lo_matchmakingconfiguratio->get_configurationarn( ).
    lv_nonzeroandmaxstring = lo_matchmakingconfiguratio->get_description( ).
    LOOP AT lo_matchmakingconfiguratio->get_gamesessionqueuearns( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv_arnstringmodel = lo_row_1->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_matchmakingrequesttimeo = lo_matchmakingconfiguratio->get_requesttimeoutseconds( ).
    lv_matchmakingacceptanceti = lo_matchmakingconfiguratio->get_acceptancetimeoutseconds( ).
    lv_booleanmodel = lo_matchmakingconfiguratio->get_acceptancerequired( ).
    lv_matchmakingidstringmode = lo_matchmakingconfiguratio->get_rulesetname( ).
    lv_matchmakingrulesetarn = lo_matchmakingconfiguratio->get_rulesetarn( ).
    lv_snsarnstringmodel = lo_matchmakingconfiguratio->get_notificationtarget( ).
    lv_wholenumber = lo_matchmakingconfiguratio->get_additionalplayercount( ).
    lv_customeventdata = lo_matchmakingconfiguratio->get_customeventdata( ).
    lv_timestamp = lo_matchmakingconfiguratio->get_creationtime( ).
    LOOP AT lo_matchmakingconfiguratio->get_gameproperties( ) into lo_row_2.
      lo_row_3 = lo_row_2.
      IF lo_row_3 IS NOT INITIAL.
        lv_gamepropertykey = lo_row_3->get_key( ).
        lv_gamepropertyvalue = lo_row_3->get_value( ).
      ENDIF.
    ENDLOOP.
    lv_gamesessiondata = lo_matchmakingconfiguratio->get_gamesessiondata( ).
    lv_backfillmode = lo_matchmakingconfiguratio->get_backfillmode( ).
    lv_flexmatchmode = lo_matchmakingconfiguratio->get_flexmatchmode( ).
  ENDIF.
ENDIF.