DESCRIBEMATCHMAKINGRULESETS()`¶

About DescribeMatchmakingRuleSets¶

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

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.

Learn more

Build a rule set

Method Signature¶

METHODS /AWS1/IF_GML~DESCRIBEMATCHMAKINGRULESETS
  IMPORTING
    !IT_NAMES TYPE /AWS1/CL_GMLMATCHMAKINGRLSET00=>TT_MATCHMAKINGRULESETNAMELIST OPTIONAL
    !IV_LIMIT TYPE /AWS1/GMLRULESETLIMIT OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/GMLNONZEROANDMAXSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_gmldscmatchmakingrl01
  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¶

Optional arguments:¶

`it_names` `TYPE /AWS1/CL_GMLMATCHMAKINGRLSET00=>TT_MATCHMAKINGRULESETNAMELIST` `TT_MATCHMAKINGRULESETNAMELIST`¶

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.

`iv_limit` `TYPE /AWS1/GMLRULESETLIMIT` `/AWS1/GMLRULESETLIMIT`¶

The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.

`iv_nexttoken` `TYPE /AWS1/GMLNONZEROANDMAXSTRING` `/AWS1/GMLNONZEROANDMAXSTRING`¶

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.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_gmldscmatchmakingrl01` `/AWS1/CL_GMLDSCMATCHMAKINGRL01`¶

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->describematchmakingrulesets(
  it_names = VALUE /aws1/cl_gmlmatchmakingrlset00=>tt_matchmakingrulesetnamelist(
    ( new /aws1/cl_gmlmatchmakingrlset00( |string| ) )
  )
  iv_limit = 123
  iv_nexttoken = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_rulesets( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_matchmakingidstringmode = lo_row_1->get_rulesetname( ).
      lv_matchmakingrulesetarn = lo_row_1->get_rulesetarn( ).
      lv_rulesetbody = lo_row_1->get_rulesetbody( ).
      lv_timestamp = lo_row_1->get_creationtime( ).
    ENDIF.
  ENDLOOP.
  lv_nonzeroandmaxstring = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_GML=>DESCRIBEMATCHMAKINGRULESETS()¶