Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.GameLift.CreateMatchmakingRuleSet

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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. It also sets the parameters for acceptable player matches, such as minimum skill level or character type.

To create a matchmaking rule set, provide unique rule set name and the rule set body in JSON format. Rule sets must be defined in the same Region as the matchmaking configuration they are used with.

Since matchmaking rule sets cannot be edited, it is a good idea to check the rule set syntax using ValidateMatchmakingRuleSet before creating a new rule set.

Learn more

Creating a Request

data CreateMatchmakingRuleSet Source #

See: newCreateMatchmakingRuleSet smart constructor.

Constructors

CreateMatchmakingRuleSet'

Fields

tags :: Maybe [Tag]
A list of labels to assign to the new matchmaking rule set resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.
name :: Text
A unique identifier for the matchmaking rule set. A matchmaking configuration identifies the rule set it uses by this name value. Note that the rule set name is different from the optional name field in the rule set body.
ruleSetBody :: Text
A collection of matchmaking rules, formatted as a JSON string. Comments are not allowed in JSON, but most elements support a description field.

Instances

Instances details

ToJSON CreateMatchmakingRuleSet Source #
Instance details Defined in Amazonka.GameLift.CreateMatchmakingRuleSet Methods toJSON :: CreateMatchmakingRuleSet -> Value # toEncoding :: CreateMatchmakingRuleSet -> Encoding # toJSONList :: [CreateMatchmakingRuleSet] -> Value # toEncodingList :: [CreateMatchmakingRuleSet] -> Encoding #
ToHeaders CreateMatchmakingRuleSet Source #
Instance details Defined in Amazonka.GameLift.CreateMatchmakingRuleSet Methods toHeaders :: CreateMatchmakingRuleSet -> [Header] #
ToPath CreateMatchmakingRuleSet Source #
Instance details Defined in Amazonka.GameLift.CreateMatchmakingRuleSet Methods toPath :: CreateMatchmakingRuleSet -> ByteString #
ToQuery CreateMatchmakingRuleSet Source #
Instance details Defined in Amazonka.GameLift.CreateMatchmakingRuleSet Methods toQuery :: CreateMatchmakingRuleSet -> QueryString #
AWSRequest CreateMatchmakingRuleSet Source #
Instance details Defined in Amazonka.GameLift.CreateMatchmakingRuleSet Associated Types type AWSResponse CreateMatchmakingRuleSet # Methods request :: (Service -> Service) -> CreateMatchmakingRuleSet -> Request CreateMatchmakingRuleSet # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateMatchmakingRuleSet -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateMatchmakingRuleSet))) #
Generic CreateMatchmakingRuleSet Source #
Instance details Defined in Amazonka.GameLift.CreateMatchmakingRuleSet Associated Types type Rep CreateMatchmakingRuleSet :: Type -> Type # Methods from :: CreateMatchmakingRuleSet -> Rep CreateMatchmakingRuleSet x # to :: Rep CreateMatchmakingRuleSet x -> CreateMatchmakingRuleSet #
Read CreateMatchmakingRuleSet Source #
Instance details Defined in Amazonka.GameLift.CreateMatchmakingRuleSet Methods readsPrec :: Int -> ReadS CreateMatchmakingRuleSet # readList :: ReadS [CreateMatchmakingRuleSet] # readPrec :: ReadPrec CreateMatchmakingRuleSet # readListPrec :: ReadPrec [CreateMatchmakingRuleSet] #
Show CreateMatchmakingRuleSet Source #
Instance details Defined in Amazonka.GameLift.CreateMatchmakingRuleSet Methods showsPrec :: Int -> CreateMatchmakingRuleSet -> ShowS # show :: CreateMatchmakingRuleSet -> String # showList :: [CreateMatchmakingRuleSet] -> ShowS #
NFData CreateMatchmakingRuleSet Source #
Instance details Defined in Amazonka.GameLift.CreateMatchmakingRuleSet Methods rnf :: CreateMatchmakingRuleSet -> () #
Eq CreateMatchmakingRuleSet Source #
Instance details Defined in Amazonka.GameLift.CreateMatchmakingRuleSet Methods (==) :: CreateMatchmakingRuleSet -> CreateMatchmakingRuleSet -> Bool # (/=) :: CreateMatchmakingRuleSet -> CreateMatchmakingRuleSet -> Bool #
Hashable CreateMatchmakingRuleSet Source #
Instance details Defined in Amazonka.GameLift.CreateMatchmakingRuleSet Methods hashWithSalt :: Int -> CreateMatchmakingRuleSet -> Int # hash :: CreateMatchmakingRuleSet -> Int #
type AWSResponse CreateMatchmakingRuleSet Source #
Instance details Defined in Amazonka.GameLift.CreateMatchmakingRuleSet type AWSResponse CreateMatchmakingRuleSet = CreateMatchmakingRuleSetResponse
type Rep CreateMatchmakingRuleSet Source #
Instance details Defined in Amazonka.GameLift.CreateMatchmakingRuleSet type Rep CreateMatchmakingRuleSet = D1 ('MetaData "CreateMatchmakingRuleSet" "Amazonka.GameLift.CreateMatchmakingRuleSet" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "CreateMatchmakingRuleSet'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "ruleSetBody") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateMatchmakingRuleSet Source #

Arguments

:: Text	`CreateMatchmakingRuleSet`
-> Text	`CreateMatchmakingRuleSet`
-> CreateMatchmakingRuleSet

Create a value of CreateMatchmakingRuleSet 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:tags:CreateMatchmakingRuleSet', createMatchmakingRuleSet_tags - A list of labels to assign to the new matchmaking rule set resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

CreateMatchmakingRuleSet, createMatchmakingRuleSet_name - A unique identifier for the matchmaking rule set. A matchmaking configuration identifies the rule set it uses by this name value. Note that the rule set name is different from the optional name field in the rule set body.

CreateMatchmakingRuleSet, createMatchmakingRuleSet_ruleSetBody - A collection of matchmaking rules, formatted as a JSON string. Comments are not allowed in JSON, but most elements support a description field.

Request Lenses

createMatchmakingRuleSet_tags :: Lens' CreateMatchmakingRuleSet (Maybe [Tag]) Source #

A list of labels to assign to the new matchmaking rule set resource. Tags are developer-defined key-value pairs. Tagging Amazon Web Services resources are useful for resource management, access management and cost allocation. For more information, see Tagging Amazon Web Services Resources in the Amazon Web Services General Reference.

createMatchmakingRuleSet_name :: Lens' CreateMatchmakingRuleSet Text Source #

A unique identifier for the matchmaking rule set. A matchmaking configuration identifies the rule set it uses by this name value. Note that the rule set name is different from the optional name field in the rule set body.

createMatchmakingRuleSet_ruleSetBody :: Lens' CreateMatchmakingRuleSet Text Source #

A collection of matchmaking rules, formatted as a JSON string. Comments are not allowed in JSON, but most elements support a description field.

Destructuring the Response

data CreateMatchmakingRuleSetResponse Source #

See: newCreateMatchmakingRuleSetResponse smart constructor.

Constructors

CreateMatchmakingRuleSetResponse'
Fields httpStatus :: Int The response's http status code. ruleSet :: MatchmakingRuleSet The newly created matchmaking rule set.

Instances

Instances details

Generic CreateMatchmakingRuleSetResponse Source #
Instance details Defined in Amazonka.GameLift.CreateMatchmakingRuleSet Associated Types type Rep CreateMatchmakingRuleSetResponse :: Type -> Type # Methods from :: CreateMatchmakingRuleSetResponse -> Rep CreateMatchmakingRuleSetResponse x # to :: Rep CreateMatchmakingRuleSetResponse x -> CreateMatchmakingRuleSetResponse #
Read CreateMatchmakingRuleSetResponse Source #
Instance details Defined in Amazonka.GameLift.CreateMatchmakingRuleSet Methods readsPrec :: Int -> ReadS CreateMatchmakingRuleSetResponse # readList :: ReadS [CreateMatchmakingRuleSetResponse] # readPrec :: ReadPrec CreateMatchmakingRuleSetResponse # readListPrec :: ReadPrec [CreateMatchmakingRuleSetResponse] #
Show CreateMatchmakingRuleSetResponse Source #
Instance details Defined in Amazonka.GameLift.CreateMatchmakingRuleSet Methods showsPrec :: Int -> CreateMatchmakingRuleSetResponse -> ShowS # show :: CreateMatchmakingRuleSetResponse -> String # showList :: [CreateMatchmakingRuleSetResponse] -> ShowS #
NFData CreateMatchmakingRuleSetResponse Source #
Instance details Defined in Amazonka.GameLift.CreateMatchmakingRuleSet Methods rnf :: CreateMatchmakingRuleSetResponse -> () #
Eq CreateMatchmakingRuleSetResponse Source #
Instance details Defined in Amazonka.GameLift.CreateMatchmakingRuleSet Methods (==) :: CreateMatchmakingRuleSetResponse -> CreateMatchmakingRuleSetResponse -> Bool # (/=) :: CreateMatchmakingRuleSetResponse -> CreateMatchmakingRuleSetResponse -> Bool #
type Rep CreateMatchmakingRuleSetResponse Source #
Instance details Defined in Amazonka.GameLift.CreateMatchmakingRuleSet type Rep CreateMatchmakingRuleSetResponse = D1 ('MetaData "CreateMatchmakingRuleSetResponse" "Amazonka.GameLift.CreateMatchmakingRuleSet" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "CreateMatchmakingRuleSetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "ruleSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 MatchmakingRuleSet)))

newCreateMatchmakingRuleSetResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateMatchmakingRuleSetResponse'`
-> MatchmakingRuleSet	`$sel:ruleSet:CreateMatchmakingRuleSetResponse'`
-> CreateMatchmakingRuleSetResponse

Create a value of CreateMatchmakingRuleSetResponse 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:httpStatus:CreateMatchmakingRuleSetResponse', createMatchmakingRuleSetResponse_httpStatus - The response's http status code.

$sel:ruleSet:CreateMatchmakingRuleSetResponse', createMatchmakingRuleSetResponse_ruleSet - The newly created matchmaking rule set.

Response Lenses

createMatchmakingRuleSetResponse_httpStatus :: Lens' CreateMatchmakingRuleSetResponse Int Source #

The response's http status code.

createMatchmakingRuleSetResponse_ruleSet :: Lens' CreateMatchmakingRuleSetResponse MatchmakingRuleSet Source #

The newly created matchmaking rule set.