/AWS1/CL_GML=>DESCRIBEMATCHMAKINGCONFS()
¶
About DescribeMatchmakingConfigurations¶
Retrieves the details of FlexMatch matchmaking configurations.
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.
If successful, a configuration is returned for each requested name. When specifying a list of names, only configurations that currently exist are returned.
Learn more
Setting up FlexMatch matchmakers
Method Signature¶
IMPORTING¶
Optional arguments:¶
IT_NAMES
TYPE /AWS1/CL_GMLMATCHMAKINGCONFN00=>TT_MATCHMAKINGCONFNAMELIST
TT_MATCHMAKINGCONFNAMELIST
¶
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.
IV_RULESETNAME
TYPE /AWS1/GMLMATCHMAKINGRLSETNAME
/AWS1/GMLMATCHMAKINGRLSETNAME
¶
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.
IV_LIMIT
TYPE /AWS1/GMLPOSITIVEINTEGER
/AWS1/GMLPOSITIVEINTEGER
¶
The maximum number of results to return. Use this parameter with
NextToken
to get results as a set of sequential pages. This parameter is limited to 10.
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.