Copyright | (c) 2013-2018 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 |
Language | Haskell2010 |
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.
Operations related to match configurations and rule sets include:
CreateMatchmakingConfiguration
DescribeMatchmakingConfigurations
UpdateMatchmakingConfiguration
DeleteMatchmakingConfiguration
CreateMatchmakingRuleSet
DescribeMatchmakingRuleSets
ValidateMatchmakingRuleSet
- describeMatchmakingRuleSets :: DescribeMatchmakingRuleSets
- data DescribeMatchmakingRuleSets
- dmrsNextToken :: Lens' DescribeMatchmakingRuleSets (Maybe Text)
- dmrsNames :: Lens' DescribeMatchmakingRuleSets (Maybe (NonEmpty Text))
- dmrsLimit :: Lens' DescribeMatchmakingRuleSets (Maybe Natural)
- describeMatchmakingRuleSetsResponse :: Int -> DescribeMatchmakingRuleSetsResponse
- data DescribeMatchmakingRuleSetsResponse
- dmrsrsNextToken :: Lens' DescribeMatchmakingRuleSetsResponse (Maybe Text)
- dmrsrsResponseStatus :: Lens' DescribeMatchmakingRuleSetsResponse Int
- dmrsrsRuleSets :: Lens' DescribeMatchmakingRuleSetsResponse [MatchmakingRuleSet]
Creating a Request
describeMatchmakingRuleSets :: DescribeMatchmakingRuleSets Source #
Creates a value of DescribeMatchmakingRuleSets
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dmrsNextToken
- Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.dmrsNames
- Unique identifier for a matchmaking rule set. This name is used to identify the rule set associated with a matchmaking configuration.dmrsLimit
- Maximum number of results to return. Use this parameter withNextToken
to get results as a set of sequential pages.
data DescribeMatchmakingRuleSets Source #
Represents the input for a request action.
See: describeMatchmakingRuleSets
smart constructor.
Request Lenses
dmrsNextToken :: Lens' DescribeMatchmakingRuleSets (Maybe Text) Source #
Token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this action. To start at the beginning of the result set, do not specify a value.
dmrsNames :: Lens' DescribeMatchmakingRuleSets (Maybe (NonEmpty Text)) Source #
Unique identifier for a matchmaking rule set. This name is used to identify the rule set associated with a matchmaking configuration.
dmrsLimit :: Lens' DescribeMatchmakingRuleSets (Maybe Natural) Source #
Maximum number of results to return. Use this parameter with NextToken
to get results as a set of sequential pages.
Destructuring the Response
describeMatchmakingRuleSetsResponse Source #
Creates a value of DescribeMatchmakingRuleSetsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dmrsrsNextToken
- Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.dmrsrsResponseStatus
- -- | The response status code.dmrsrsRuleSets
- Collection of requested matchmaking rule set objects.
data DescribeMatchmakingRuleSetsResponse Source #
Represents the returned data in response to a request action.
See: describeMatchmakingRuleSetsResponse
smart constructor.
Response Lenses
dmrsrsNextToken :: Lens' DescribeMatchmakingRuleSetsResponse (Maybe Text) Source #
Token that indicates where to resume retrieving results on the next call to this action. If no token is returned, these results represent the end of the list.
dmrsrsResponseStatus :: Lens' DescribeMatchmakingRuleSetsResponse Int Source #
- - | The response status code.
dmrsrsRuleSets :: Lens' DescribeMatchmakingRuleSetsResponse [MatchmakingRuleSet] Source #
Collection of requested matchmaking rule set objects.