| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.GameLift.DescribeMatchmakingConfigurations
Description
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
Related actions
CreateMatchmakingConfiguration | DescribeMatchmakingConfigurations | UpdateMatchmakingConfiguration | DeleteMatchmakingConfiguration | CreateMatchmakingRuleSet | DescribeMatchmakingRuleSets | ValidateMatchmakingRuleSet | DeleteMatchmakingRuleSet | All APIs by task
This operation returns paginated results.
Synopsis
- data DescribeMatchmakingConfigurations = DescribeMatchmakingConfigurations' {}
- newDescribeMatchmakingConfigurations :: DescribeMatchmakingConfigurations
- describeMatchmakingConfigurations_ruleSetName :: Lens' DescribeMatchmakingConfigurations (Maybe Text)
- describeMatchmakingConfigurations_nextToken :: Lens' DescribeMatchmakingConfigurations (Maybe Text)
- describeMatchmakingConfigurations_names :: Lens' DescribeMatchmakingConfigurations (Maybe [Text])
- describeMatchmakingConfigurations_limit :: Lens' DescribeMatchmakingConfigurations (Maybe Natural)
- data DescribeMatchmakingConfigurationsResponse = DescribeMatchmakingConfigurationsResponse' {}
- newDescribeMatchmakingConfigurationsResponse :: Int -> DescribeMatchmakingConfigurationsResponse
- describeMatchmakingConfigurationsResponse_configurations :: Lens' DescribeMatchmakingConfigurationsResponse (Maybe [MatchmakingConfiguration])
- describeMatchmakingConfigurationsResponse_nextToken :: Lens' DescribeMatchmakingConfigurationsResponse (Maybe Text)
- describeMatchmakingConfigurationsResponse_httpStatus :: Lens' DescribeMatchmakingConfigurationsResponse Int
Creating a Request
data DescribeMatchmakingConfigurations Source #
Represents the input for a request operation.
See: newDescribeMatchmakingConfigurations smart constructor.
Constructors
| DescribeMatchmakingConfigurations' | |
Fields
| |
Instances
newDescribeMatchmakingConfigurations :: DescribeMatchmakingConfigurations Source #
Create a value of DescribeMatchmakingConfigurations with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ruleSetName:DescribeMatchmakingConfigurations', describeMatchmakingConfigurations_ruleSetName - 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.
$sel:nextToken:DescribeMatchmakingConfigurations', describeMatchmakingConfigurations_nextToken - 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.
$sel:names:DescribeMatchmakingConfigurations', describeMatchmakingConfigurations_names - 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.
$sel:limit:DescribeMatchmakingConfigurations', describeMatchmakingConfigurations_limit - 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.
Request Lenses
describeMatchmakingConfigurations_ruleSetName :: Lens' DescribeMatchmakingConfigurations (Maybe Text) Source #
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.
describeMatchmakingConfigurations_nextToken :: Lens' DescribeMatchmakingConfigurations (Maybe Text) Source #
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.
describeMatchmakingConfigurations_names :: Lens' DescribeMatchmakingConfigurations (Maybe [Text]) Source #
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.
describeMatchmakingConfigurations_limit :: Lens' DescribeMatchmakingConfigurations (Maybe Natural) Source #
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.
Destructuring the Response
data DescribeMatchmakingConfigurationsResponse Source #
Represents the returned data in response to a request operation.
See: newDescribeMatchmakingConfigurationsResponse smart constructor.
Constructors
| DescribeMatchmakingConfigurationsResponse' | |
Fields
| |
Instances
newDescribeMatchmakingConfigurationsResponse Source #
Arguments
| :: Int | |
| -> DescribeMatchmakingConfigurationsResponse |
Create a value of DescribeMatchmakingConfigurationsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:configurations:DescribeMatchmakingConfigurationsResponse', describeMatchmakingConfigurationsResponse_configurations - A collection of requested matchmaking configurations.
$sel:nextToken:DescribeMatchmakingConfigurations', describeMatchmakingConfigurationsResponse_nextToken - 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.
$sel:httpStatus:DescribeMatchmakingConfigurationsResponse', describeMatchmakingConfigurationsResponse_httpStatus - The response's http status code.
Response Lenses
describeMatchmakingConfigurationsResponse_configurations :: Lens' DescribeMatchmakingConfigurationsResponse (Maybe [MatchmakingConfiguration]) Source #
A collection of requested matchmaking configurations.
describeMatchmakingConfigurationsResponse_nextToken :: Lens' DescribeMatchmakingConfigurationsResponse (Maybe Text) Source #
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.
describeMatchmakingConfigurationsResponse_httpStatus :: Lens' DescribeMatchmakingConfigurationsResponse Int Source #
The response's http status code.