Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14104474602.4 KB

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

post/#X-Amz-Target=GameLift.DescribeMatchmakingConfigurations

Query parameters

Limitstring

Pagination limit

NextTokenstring

Pagination token

Headers

X-Amz-Target'GameLift.DescribeMatchmakingConfigurations' required

Request body

NamesMatchmakingConfigurationName[]

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.

RuleSetNamestring

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.

Limitinteger

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.

NextTokenstring

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.

Response

Success

NextTokenstring

A token that indicates where to resume retrieving results on the next call to this operation. If no token is returned, these results represent the end of the list.