amazonka-gamelift-1.6.0: Amazon GameLift SDK.

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.GameLift.DescribeMatchmakingRuleSets

Contents

Description

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

Synopsis

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 with NextToken to get results as a set of sequential pages.

data DescribeMatchmakingRuleSets Source #

Represents the input for a request action.

See: describeMatchmakingRuleSets smart constructor.

Instances

Eq DescribeMatchmakingRuleSets Source # 
Data DescribeMatchmakingRuleSets Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeMatchmakingRuleSets -> c DescribeMatchmakingRuleSets #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeMatchmakingRuleSets #

toConstr :: DescribeMatchmakingRuleSets -> Constr #

dataTypeOf :: DescribeMatchmakingRuleSets -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeMatchmakingRuleSets) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeMatchmakingRuleSets) #

gmapT :: (forall b. Data b => b -> b) -> DescribeMatchmakingRuleSets -> DescribeMatchmakingRuleSets #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeMatchmakingRuleSets -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeMatchmakingRuleSets -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeMatchmakingRuleSets -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeMatchmakingRuleSets -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeMatchmakingRuleSets -> m DescribeMatchmakingRuleSets #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeMatchmakingRuleSets -> m DescribeMatchmakingRuleSets #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeMatchmakingRuleSets -> m DescribeMatchmakingRuleSets #

Read DescribeMatchmakingRuleSets Source # 
Show DescribeMatchmakingRuleSets Source # 
Generic DescribeMatchmakingRuleSets Source # 
Hashable DescribeMatchmakingRuleSets Source # 
ToJSON DescribeMatchmakingRuleSets Source # 
NFData DescribeMatchmakingRuleSets Source # 
AWSRequest DescribeMatchmakingRuleSets Source # 
ToHeaders DescribeMatchmakingRuleSets Source # 
ToPath DescribeMatchmakingRuleSets Source # 
ToQuery DescribeMatchmakingRuleSets Source # 
type Rep DescribeMatchmakingRuleSets Source # 
type Rep DescribeMatchmakingRuleSets = D1 * (MetaData "DescribeMatchmakingRuleSets" "Network.AWS.GameLift.DescribeMatchmakingRuleSets" "amazonka-gamelift-1.6.0-DeAosbEJJf8D8cv8ebS5Uv" False) (C1 * (MetaCons "DescribeMatchmakingRuleSets'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dmrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dmrsNames") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe (List1 Text)))) (S1 * (MetaSel (Just Symbol "_dmrsLimit") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Nat))))))
type Rs DescribeMatchmakingRuleSets Source # 

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.

Instances

Eq DescribeMatchmakingRuleSetsResponse Source # 
Data DescribeMatchmakingRuleSetsResponse Source # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeMatchmakingRuleSetsResponse -> c DescribeMatchmakingRuleSetsResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeMatchmakingRuleSetsResponse #

toConstr :: DescribeMatchmakingRuleSetsResponse -> Constr #

dataTypeOf :: DescribeMatchmakingRuleSetsResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeMatchmakingRuleSetsResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeMatchmakingRuleSetsResponse) #

gmapT :: (forall b. Data b => b -> b) -> DescribeMatchmakingRuleSetsResponse -> DescribeMatchmakingRuleSetsResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeMatchmakingRuleSetsResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeMatchmakingRuleSetsResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeMatchmakingRuleSetsResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeMatchmakingRuleSetsResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeMatchmakingRuleSetsResponse -> m DescribeMatchmakingRuleSetsResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeMatchmakingRuleSetsResponse -> m DescribeMatchmakingRuleSetsResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeMatchmakingRuleSetsResponse -> m DescribeMatchmakingRuleSetsResponse #

Read DescribeMatchmakingRuleSetsResponse Source # 
Show DescribeMatchmakingRuleSetsResponse Source # 
Generic DescribeMatchmakingRuleSetsResponse Source # 
NFData DescribeMatchmakingRuleSetsResponse Source # 
type Rep DescribeMatchmakingRuleSetsResponse Source # 
type Rep DescribeMatchmakingRuleSetsResponse = D1 * (MetaData "DescribeMatchmakingRuleSetsResponse" "Network.AWS.GameLift.DescribeMatchmakingRuleSets" "amazonka-gamelift-1.6.0-DeAosbEJJf8D8cv8ebS5Uv" False) (C1 * (MetaCons "DescribeMatchmakingRuleSetsResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_dmrsrsNextToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_dmrsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int)) (S1 * (MetaSel (Just Symbol "_dmrsrsRuleSets") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [MatchmakingRuleSet])))))

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.

dmrsrsRuleSets :: Lens' DescribeMatchmakingRuleSetsResponse [MatchmakingRuleSet] Source #

Collection of requested matchmaking rule set objects.