Network.AWS.GameLift.CreateMatchmakingRuleSet

Creates a new rule set for FlexMatch matchmaking. A rule set describes the type of match to create, such as the number and size of teams, and sets the parameters for acceptable player matches, such as minimum skill level or character type. Rule sets are used in matchmaking configurations, which define how matchmaking requests are handled. Each MatchmakingConfiguration uses one rule set; you can set up multiple rule sets to handle the scenarios that suit your game (such as for different game modes), and create a separate matchmaking configuration for each rule set. See additional information on rule set content in the MatchmakingRuleSet structure. For help creating rule sets, including useful examples, see the topic Adding FlexMatch to Your Game .

Once created, matchmaking rule sets cannot be changed or deleted, so we recommend checking the rule set syntax using ValidateMatchmakingRuleSet before creating the rule set.

To create a matchmaking rule set, provide the set of rules and a unique name. Rule sets must be defined in the same region as the matchmaking configuration they will be used with. Rule sets cannot be edited or deleted. If you need to change a rule set, create a new one with the necessary edits and then update matchmaking configurations to use the new rule set.

Operations related to match configurations and rule sets include:

• CreateMatchmakingConfiguration
• DescribeMatchmakingConfigurations
• UpdateMatchmakingConfiguration
• DeleteMatchmakingConfiguration
• CreateMatchmakingRuleSet
• DescribeMatchmakingRuleSets
• ValidateMatchmakingRuleSet

Creating a Request

createMatchmakingRuleSet

Arguments

:: Text

cmrsName

-> Text

cmrsRuleSetBody

-> CreateMatchmakingRuleSet

Creates a value of CreateMatchmakingRuleSet with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cmrsName - Unique identifier for a matchmaking rule set. This name is used to identify the rule set associated with a matchmaking configuration.
• cmrsRuleSetBody - Collection of matchmaking rules, formatted as a JSON string. (Note that comments are not allowed in JSON, but most elements support a description field.)

data CreateMatchmakingRuleSet

Represents the input for a request action.

See: createMatchmakingRuleSet smart constructor.

Instances

Eq CreateMatchmakingRuleSet

Methods

(==) :: CreateMatchmakingRuleSet -> CreateMatchmakingRuleSet -> Bool

(/=) :: CreateMatchmakingRuleSet -> CreateMatchmakingRuleSet -> Bool

Data CreateMatchmakingRuleSet

Methods

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

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

toConstr :: CreateMatchmakingRuleSet -> Constr

dataTypeOf :: CreateMatchmakingRuleSet -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> CreateMatchmakingRuleSet -> CreateMatchmakingRuleSet

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

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

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

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

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

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

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

Read CreateMatchmakingRuleSet

Methods

readsPrec :: Int -> ReadS CreateMatchmakingRuleSet

readList :: ReadS [CreateMatchmakingRuleSet]

readPrec :: ReadPrec CreateMatchmakingRuleSet

readListPrec :: ReadPrec [CreateMatchmakingRuleSet]

Show CreateMatchmakingRuleSet

Methods

showsPrec :: Int -> CreateMatchmakingRuleSet -> ShowS

show :: CreateMatchmakingRuleSet -> String

showList :: [CreateMatchmakingRuleSet] -> ShowS

Generic CreateMatchmakingRuleSet

Associated Types

type Rep CreateMatchmakingRuleSet :: * -> *

Methods

from :: CreateMatchmakingRuleSet -> Rep CreateMatchmakingRuleSet x

to :: Rep CreateMatchmakingRuleSet x -> CreateMatchmakingRuleSet

Hashable CreateMatchmakingRuleSet

Methods

hashWithSalt :: Int -> CreateMatchmakingRuleSet -> Int

hash :: CreateMatchmakingRuleSet -> Int

ToJSON CreateMatchmakingRuleSet

Methods

toJSON :: CreateMatchmakingRuleSet -> Value

toEncoding :: CreateMatchmakingRuleSet -> Encoding

toJSONList :: [CreateMatchmakingRuleSet] -> Value

toEncodingList :: [CreateMatchmakingRuleSet] -> Encoding

NFData CreateMatchmakingRuleSet

Methods

rnf :: CreateMatchmakingRuleSet -> ()

AWSRequest CreateMatchmakingRuleSet

Associated Types

type Rs CreateMatchmakingRuleSet :: *

Methods

request :: CreateMatchmakingRuleSet -> Request CreateMatchmakingRuleSet

response :: MonadResource m => Logger -> Service -> Proxy * CreateMatchmakingRuleSet -> ClientResponse -> m (Response CreateMatchmakingRuleSet)

ToQuery CreateMatchmakingRuleSet

Methods

toQuery :: CreateMatchmakingRuleSet -> QueryString

ToPath CreateMatchmakingRuleSet

Methods

toPath :: CreateMatchmakingRuleSet -> ByteString

ToHeaders CreateMatchmakingRuleSet

Methods

toHeaders :: CreateMatchmakingRuleSet -> [Header]

type Rep CreateMatchmakingRuleSet

type Rep CreateMatchmakingRuleSet = D1 (MetaData "CreateMatchmakingRuleSet" "Network.AWS.GameLift.CreateMatchmakingRuleSet" "amazonka-gamelift-1.5.0-LWFsf2alHztGD91U7ab8u0" False) (C1 (MetaCons "CreateMatchmakingRuleSet'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_cmrsName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_cmrsRuleSetBody") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

type Rs CreateMatchmakingRuleSet

type Rs CreateMatchmakingRuleSet = CreateMatchmakingRuleSetResponse

Request Lenses

cmrsName :: Lens' CreateMatchmakingRuleSet Text

Unique identifier for a matchmaking rule set. This name is used to identify the rule set associated with a matchmaking configuration.

cmrsRuleSetBody :: Lens' CreateMatchmakingRuleSet Text

Collection of matchmaking rules, formatted as a JSON string. (Note that comments are not allowed in JSON, but most elements support a description field.)

Destructuring the Response

createMatchmakingRuleSetResponse

Arguments

:: Int

cmrsrsResponseStatus

-> MatchmakingRuleSet

cmrsrsRuleSet

-> CreateMatchmakingRuleSetResponse

Creates a value of CreateMatchmakingRuleSetResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• cmrsrsResponseStatus - -- | The response status code.
• cmrsrsRuleSet - Object that describes the newly created matchmaking rule set.

data CreateMatchmakingRuleSetResponse

Represents the returned data in response to a request action.

See: createMatchmakingRuleSetResponse smart constructor.

Instances

Eq CreateMatchmakingRuleSetResponse

Methods

(==) :: CreateMatchmakingRuleSetResponse -> CreateMatchmakingRuleSetResponse -> Bool

(/=) :: CreateMatchmakingRuleSetResponse -> CreateMatchmakingRuleSetResponse -> Bool

Data CreateMatchmakingRuleSetResponse

Methods

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

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

toConstr :: CreateMatchmakingRuleSetResponse -> Constr

dataTypeOf :: CreateMatchmakingRuleSetResponse -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> CreateMatchmakingRuleSetResponse -> CreateMatchmakingRuleSetResponse

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

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

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

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

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

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

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

Read CreateMatchmakingRuleSetResponse

Methods

readsPrec :: Int -> ReadS CreateMatchmakingRuleSetResponse

readList :: ReadS [CreateMatchmakingRuleSetResponse]

readPrec :: ReadPrec CreateMatchmakingRuleSetResponse

readListPrec :: ReadPrec [CreateMatchmakingRuleSetResponse]

Show CreateMatchmakingRuleSetResponse

Methods

showsPrec :: Int -> CreateMatchmakingRuleSetResponse -> ShowS

show :: CreateMatchmakingRuleSetResponse -> String

showList :: [CreateMatchmakingRuleSetResponse] -> ShowS

Generic CreateMatchmakingRuleSetResponse

Associated Types

type Rep CreateMatchmakingRuleSetResponse :: * -> *

Methods

from :: CreateMatchmakingRuleSetResponse -> Rep CreateMatchmakingRuleSetResponse x

to :: Rep CreateMatchmakingRuleSetResponse x -> CreateMatchmakingRuleSetResponse

NFData CreateMatchmakingRuleSetResponse

Methods

rnf :: CreateMatchmakingRuleSetResponse -> ()

type Rep CreateMatchmakingRuleSetResponse

type Rep CreateMatchmakingRuleSetResponse = D1 (MetaData "CreateMatchmakingRuleSetResponse" "Network.AWS.GameLift.CreateMatchmakingRuleSet" "amazonka-gamelift-1.5.0-LWFsf2alHztGD91U7ab8u0" False) (C1 (MetaCons "CreateMatchmakingRuleSetResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_cmrsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) (S1 (MetaSel (Just Symbol "_cmrsrsRuleSet") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 MatchmakingRuleSet))))

Response Lenses

cmrsrsResponseStatus :: Lens' CreateMatchmakingRuleSetResponse Int

• - | The response status code.

cmrsrsRuleSet :: Lens' CreateMatchmakingRuleSetResponse MatchmakingRuleSet

Object that describes the newly created matchmaking rule set.