Network.AWS.GameLift.CreateMatchmakingConfiguration

Defines a new matchmaking configuration for use with FlexMatch. A matchmaking configuration sets out guidelines for matching players and getting the matches into games. You can set up multiple matchmaking configurations to handle the scenarios needed for your game. Each matchmaking request (StartMatchmaking ) specifies a configuration for the match and provides player attributes to support the configuration being used.

To create a matchmaking configuration, at a minimum you must specify the following: configuration name; a rule set that governs how to evaluate players and find acceptable matches; a game session queue to use when placing a new game session for the match; and the maximum time allowed for a matchmaking attempt.

Player acceptance -- In each configuration, you have the option to require that all players accept participation in a proposed match. To enable this feature, set AcceptanceRequired to true and specify a time limit for player acceptance. Players have the option to accept or reject a proposed match, and a match does not move ahead to game session placement unless all matched players accept.

Matchmaking status notification -- There are two ways to track the progress of matchmaking tickets: (1) polling ticket status with DescribeMatchmaking ; or (2) receiving notifications with Amazon Simple Notification Service (SNS). To use notifications, you first need to set up an SNS topic to receive the notifications, and provide the topic ARN in the matchmaking configuration (see Setting up Notifications for Matchmaking ). Since notifications promise only "best effort" delivery, we recommend calling DescribeMatchmaking if no notifications are received within 30 seconds.

Operations related to match configurations and rule sets include:

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

Creating a Request

createMatchmakingConfiguration

Arguments

:: Text

cmcName

-> Natural

cmcRequestTimeoutSeconds

-> Bool

cmcAcceptanceRequired

-> Text

cmcRuleSetName

-> CreateMatchmakingConfiguration

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

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

• cmcGameProperties - Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session ). This information is added to the new GameSession object that is created for a successful match.
• cmcAcceptanceTimeoutSeconds - Length of time (in seconds) to wait for players to accept a proposed match. If any player rejects the match or fails to accept before the timeout, the ticket continues to look for an acceptable match.
• cmcNotificationTarget - SNS topic ARN that is set up to receive matchmaking notifications.
• cmcCustomEventData - Information to attached to all events related to the matchmaking configuration.
• cmcGameSessionData - Set of developer-defined game session properties, formatted as a single string value. This data is included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session ). This information is added to the new GameSession object that is created for a successful match.
• cmcDescription - Meaningful description of the matchmaking configuration.
• cmcAdditionalPlayerCount - Number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match.
• cmcName - Unique identifier for a matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.
• cmcGameSessionQueueARNs - Amazon Resource Name (ARN ) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:region::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.
• cmcRequestTimeoutSeconds - Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that time out can be resubmitted as needed.
• cmcAcceptanceRequired - Flag that determines whether or not a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE.
• cmcRuleSetName - Unique identifier for a matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule sets that are defined in the same region.

data CreateMatchmakingConfiguration

Represents the input for a request action.

See: createMatchmakingConfiguration smart constructor.

Instances

Eq CreateMatchmakingConfiguration

Methods

(==) :: CreateMatchmakingConfiguration -> CreateMatchmakingConfiguration -> Bool

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

Data CreateMatchmakingConfiguration

Methods

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

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

toConstr :: CreateMatchmakingConfiguration -> Constr

dataTypeOf :: CreateMatchmakingConfiguration -> DataType

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

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

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

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

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

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

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

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

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

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

Read CreateMatchmakingConfiguration

Methods

readsPrec :: Int -> ReadS CreateMatchmakingConfiguration

readList :: ReadS [CreateMatchmakingConfiguration]

readPrec :: ReadPrec CreateMatchmakingConfiguration

readListPrec :: ReadPrec [CreateMatchmakingConfiguration]

Show CreateMatchmakingConfiguration

Methods

showsPrec :: Int -> CreateMatchmakingConfiguration -> ShowS

show :: CreateMatchmakingConfiguration -> String

showList :: [CreateMatchmakingConfiguration] -> ShowS

Generic CreateMatchmakingConfiguration

Associated Types

type Rep CreateMatchmakingConfiguration :: * -> *

Methods

from :: CreateMatchmakingConfiguration -> Rep CreateMatchmakingConfiguration x

to :: Rep CreateMatchmakingConfiguration x -> CreateMatchmakingConfiguration

Hashable CreateMatchmakingConfiguration

Methods

hashWithSalt :: Int -> CreateMatchmakingConfiguration -> Int

hash :: CreateMatchmakingConfiguration -> Int

ToJSON CreateMatchmakingConfiguration

Methods

toJSON :: CreateMatchmakingConfiguration -> Value

toEncoding :: CreateMatchmakingConfiguration -> Encoding

toJSONList :: [CreateMatchmakingConfiguration] -> Value

toEncodingList :: [CreateMatchmakingConfiguration] -> Encoding

NFData CreateMatchmakingConfiguration

Methods

rnf :: CreateMatchmakingConfiguration -> ()

AWSRequest CreateMatchmakingConfiguration

Associated Types

type Rs CreateMatchmakingConfiguration :: *

Methods

request :: CreateMatchmakingConfiguration -> Request CreateMatchmakingConfiguration

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

ToQuery CreateMatchmakingConfiguration

Methods

toQuery :: CreateMatchmakingConfiguration -> QueryString

ToPath CreateMatchmakingConfiguration

Methods

toPath :: CreateMatchmakingConfiguration -> ByteString

ToHeaders CreateMatchmakingConfiguration

Methods

toHeaders :: CreateMatchmakingConfiguration -> [Header]

type Rep CreateMatchmakingConfiguration

type Rep CreateMatchmakingConfiguration = D1 (MetaData "CreateMatchmakingConfiguration" "Network.AWS.GameLift.CreateMatchmakingConfiguration" "amazonka-gamelift-1.5.0-LWFsf2alHztGD91U7ab8u0" False) (C1 (MetaCons "CreateMatchmakingConfiguration'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cmcGameProperties") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [GameProperty]))) ((:*:) (S1 (MetaSel (Just Symbol "_cmcAcceptanceTimeoutSeconds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_cmcNotificationTarget") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_cmcCustomEventData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_cmcGameSessionData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_cmcDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_cmcAdditionalPlayerCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) ((:*:) (S1 (MetaSel (Just Symbol "_cmcName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_cmcGameSessionQueueARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Text])))) ((:*:) (S1 (MetaSel (Just Symbol "_cmcRequestTimeoutSeconds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Nat)) ((:*:) (S1 (MetaSel (Just Symbol "_cmcAcceptanceRequired") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Bool)) (S1 (MetaSel (Just Symbol "_cmcRuleSetName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))))

type Rs CreateMatchmakingConfiguration

type Rs CreateMatchmakingConfiguration = CreateMatchmakingConfigurationResponse

Request Lenses

cmcGameProperties :: Lens' CreateMatchmakingConfiguration [GameProperty]

Set of developer-defined properties for a game session, formatted as a set of type:value pairs. These properties are included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session ). This information is added to the new GameSession object that is created for a successful match.

cmcAcceptanceTimeoutSeconds :: Lens' CreateMatchmakingConfiguration (Maybe Natural)

Length of time (in seconds) to wait for players to accept a proposed match. If any player rejects the match or fails to accept before the timeout, the ticket continues to look for an acceptable match.

cmcNotificationTarget :: Lens' CreateMatchmakingConfiguration (Maybe Text)

SNS topic ARN that is set up to receive matchmaking notifications.

cmcCustomEventData :: Lens' CreateMatchmakingConfiguration (Maybe Text)

Information to attached to all events related to the matchmaking configuration.

cmcGameSessionData :: Lens' CreateMatchmakingConfiguration (Maybe Text)

Set of developer-defined game session properties, formatted as a single string value. This data is included in the GameSession object, which is passed to the game server with a request to start a new game session (see Start a Game Session ). This information is added to the new GameSession object that is created for a successful match.

cmcDescription :: Lens' CreateMatchmakingConfiguration (Maybe Text)

Meaningful description of the matchmaking configuration.

cmcAdditionalPlayerCount :: Lens' CreateMatchmakingConfiguration (Maybe Natural)

Number of player slots in a match to keep open for future players. For example, if the configuration's rule set specifies a match for a single 12-person team, and the additional player count is set to 2, only 10 players are selected for the match.

cmcName :: Lens' CreateMatchmakingConfiguration Text

Unique identifier for a matchmaking configuration. This name is used to identify the configuration associated with a matchmaking request or ticket.

cmcGameSessionQueueARNs :: Lens' CreateMatchmakingConfiguration [Text]

Amazon Resource Name (ARN ) that is assigned to a game session queue and uniquely identifies it. Format is arn:aws:gamelift:region::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912 . These queues are used when placing game sessions for matches that are created with this matchmaking configuration. Queues can be located in any region.

cmcRequestTimeoutSeconds :: Lens' CreateMatchmakingConfiguration Natural

Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that time out can be resubmitted as needed.

cmcAcceptanceRequired :: Lens' CreateMatchmakingConfiguration Bool

Flag that determines whether or not a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE.

cmcRuleSetName :: Lens' CreateMatchmakingConfiguration Text

Unique identifier for a matchmaking rule set to use with this configuration. A matchmaking configuration can only use rule sets that are defined in the same region.

Destructuring the Response

createMatchmakingConfigurationResponse

Arguments

:: Int

cmcrsResponseStatus

-> CreateMatchmakingConfigurationResponse

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

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

• cmcrsConfiguration - Object that describes the newly created matchmaking configuration.
• cmcrsResponseStatus - -- | The response status code.

data CreateMatchmakingConfigurationResponse

Represents the returned data in response to a request action.

See: createMatchmakingConfigurationResponse smart constructor.

Instances

Eq CreateMatchmakingConfigurationResponse

Methods

(==) :: CreateMatchmakingConfigurationResponse -> CreateMatchmakingConfigurationResponse -> Bool

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

Data CreateMatchmakingConfigurationResponse

Methods

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

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

toConstr :: CreateMatchmakingConfigurationResponse -> Constr

dataTypeOf :: CreateMatchmakingConfigurationResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read CreateMatchmakingConfigurationResponse

Methods

readsPrec :: Int -> ReadS CreateMatchmakingConfigurationResponse

readList :: ReadS [CreateMatchmakingConfigurationResponse]

readPrec :: ReadPrec CreateMatchmakingConfigurationResponse

readListPrec :: ReadPrec [CreateMatchmakingConfigurationResponse]

Show CreateMatchmakingConfigurationResponse

Methods

showsPrec :: Int -> CreateMatchmakingConfigurationResponse -> ShowS

show :: CreateMatchmakingConfigurationResponse -> String

showList :: [CreateMatchmakingConfigurationResponse] -> ShowS

Generic CreateMatchmakingConfigurationResponse

Associated Types

type Rep CreateMatchmakingConfigurationResponse :: * -> *

Methods

from :: CreateMatchmakingConfigurationResponse -> Rep CreateMatchmakingConfigurationResponse x

to :: Rep CreateMatchmakingConfigurationResponse x -> CreateMatchmakingConfigurationResponse

NFData CreateMatchmakingConfigurationResponse

Methods

rnf :: CreateMatchmakingConfigurationResponse -> ()

type Rep CreateMatchmakingConfigurationResponse

type Rep CreateMatchmakingConfigurationResponse = D1 (MetaData "CreateMatchmakingConfigurationResponse" "Network.AWS.GameLift.CreateMatchmakingConfiguration" "amazonka-gamelift-1.5.0-LWFsf2alHztGD91U7ab8u0" False) (C1 (MetaCons "CreateMatchmakingConfigurationResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_cmcrsConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe MatchmakingConfiguration))) (S1 (MetaSel (Just Symbol "_cmcrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

cmcrsConfiguration :: Lens' CreateMatchmakingConfigurationResponse (Maybe MatchmakingConfiguration)

Object that describes the newly created matchmaking configuration.

cmcrsResponseStatus :: Lens' CreateMatchmakingConfigurationResponse Int

• - | The response status code.