Network.AWS.GameLift.UpdateMatchmakingConfiguration

Updates settings for a FlexMatch matchmaking configuration. To update settings, specify the configuration name to be updated and provide the new settings.

Operations related to match configurations and rule sets include:

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

Creating a Request

updateMatchmakingConfiguration

Arguments

:: Text

umcName

-> UpdateMatchmakingConfiguration

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

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

• umcGameProperties - 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.
• umcRuleSetName - 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.
• umcAcceptanceTimeoutSeconds - 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.
• umcRequestTimeoutSeconds - Maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that time out can be resubmitted as needed.
• umcNotificationTarget - SNS topic ARN that is set up to receive matchmaking notifications. See Setting up Notifications for Matchmaking for more information.
• umcGameSessionQueueARNs - 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.
• umcCustomEventData - Information to attached to all events related to the matchmaking configuration.
• umcAcceptanceRequired - 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.
• umcGameSessionData - 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.
• umcDescription - Descriptive label that is associated with matchmaking configuration.
• umcAdditionalPlayerCount - 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.
• umcName - Unique identifier for a matchmaking configuration to update.

data UpdateMatchmakingConfiguration

Represents the input for a request action.

See: updateMatchmakingConfiguration smart constructor.

Instances

Eq UpdateMatchmakingConfiguration

Methods

(==) :: UpdateMatchmakingConfiguration -> UpdateMatchmakingConfiguration -> Bool

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

Data UpdateMatchmakingConfiguration

Methods

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

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

toConstr :: UpdateMatchmakingConfiguration -> Constr

dataTypeOf :: UpdateMatchmakingConfiguration -> DataType

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

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

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

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

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

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

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

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

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

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

Read UpdateMatchmakingConfiguration

Methods

readsPrec :: Int -> ReadS UpdateMatchmakingConfiguration

readList :: ReadS [UpdateMatchmakingConfiguration]

readPrec :: ReadPrec UpdateMatchmakingConfiguration

readListPrec :: ReadPrec [UpdateMatchmakingConfiguration]

Show UpdateMatchmakingConfiguration

Methods

showsPrec :: Int -> UpdateMatchmakingConfiguration -> ShowS

show :: UpdateMatchmakingConfiguration -> String

showList :: [UpdateMatchmakingConfiguration] -> ShowS

Generic UpdateMatchmakingConfiguration

Associated Types

type Rep UpdateMatchmakingConfiguration :: * -> *

Methods

from :: UpdateMatchmakingConfiguration -> Rep UpdateMatchmakingConfiguration x

to :: Rep UpdateMatchmakingConfiguration x -> UpdateMatchmakingConfiguration

Hashable UpdateMatchmakingConfiguration

Methods

hashWithSalt :: Int -> UpdateMatchmakingConfiguration -> Int

hash :: UpdateMatchmakingConfiguration -> Int

ToJSON UpdateMatchmakingConfiguration

Methods

toJSON :: UpdateMatchmakingConfiguration -> Value

toEncoding :: UpdateMatchmakingConfiguration -> Encoding

toJSONList :: [UpdateMatchmakingConfiguration] -> Value

toEncodingList :: [UpdateMatchmakingConfiguration] -> Encoding

NFData UpdateMatchmakingConfiguration

Methods

rnf :: UpdateMatchmakingConfiguration -> ()

AWSRequest UpdateMatchmakingConfiguration

Associated Types

type Rs UpdateMatchmakingConfiguration :: *

Methods

request :: UpdateMatchmakingConfiguration -> Request UpdateMatchmakingConfiguration

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

ToQuery UpdateMatchmakingConfiguration

Methods

toQuery :: UpdateMatchmakingConfiguration -> QueryString

ToPath UpdateMatchmakingConfiguration

Methods

toPath :: UpdateMatchmakingConfiguration -> ByteString

ToHeaders UpdateMatchmakingConfiguration

Methods

toHeaders :: UpdateMatchmakingConfiguration -> [Header]

type Rep UpdateMatchmakingConfiguration

type Rep UpdateMatchmakingConfiguration = D1 (MetaData "UpdateMatchmakingConfiguration" "Network.AWS.GameLift.UpdateMatchmakingConfiguration" "amazonka-gamelift-1.5.0-LWFsf2alHztGD91U7ab8u0" False) (C1 (MetaCons "UpdateMatchmakingConfiguration'" PrefixI True) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_umcGameProperties") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [GameProperty]))) ((:*:) (S1 (MetaSel (Just Symbol "_umcRuleSetName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_umcAcceptanceTimeoutSeconds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))))) ((:*:) (S1 (MetaSel (Just Symbol "_umcRequestTimeoutSeconds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) ((:*:) (S1 (MetaSel (Just Symbol "_umcNotificationTarget") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_umcGameSessionQueueARNs") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text])))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_umcCustomEventData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_umcAcceptanceRequired") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_umcGameSessionData") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) (S1 (MetaSel (Just Symbol "_umcDescription") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_umcAdditionalPlayerCount") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Nat))) (S1 (MetaSel (Just Symbol "_umcName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))))))

type Rs UpdateMatchmakingConfiguration

type Rs UpdateMatchmakingConfiguration = UpdateMatchmakingConfigurationResponse

Request Lenses

umcGameProperties :: Lens' UpdateMatchmakingConfiguration [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.

umcRuleSetName :: Lens' UpdateMatchmakingConfiguration (Maybe 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.

umcAcceptanceTimeoutSeconds :: Lens' UpdateMatchmakingConfiguration (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.

umcRequestTimeoutSeconds :: Lens' UpdateMatchmakingConfiguration (Maybe 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.

umcNotificationTarget :: Lens' UpdateMatchmakingConfiguration (Maybe Text)

SNS topic ARN that is set up to receive matchmaking notifications. See Setting up Notifications for Matchmaking for more information.

umcGameSessionQueueARNs :: Lens' UpdateMatchmakingConfiguration [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.

umcCustomEventData :: Lens' UpdateMatchmakingConfiguration (Maybe Text)

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

umcAcceptanceRequired :: Lens' UpdateMatchmakingConfiguration (Maybe 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.

umcGameSessionData :: Lens' UpdateMatchmakingConfiguration (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.

umcDescription :: Lens' UpdateMatchmakingConfiguration (Maybe Text)

Descriptive label that is associated with matchmaking configuration.

umcAdditionalPlayerCount :: Lens' UpdateMatchmakingConfiguration (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.

umcName :: Lens' UpdateMatchmakingConfiguration Text

Unique identifier for a matchmaking configuration to update.

Destructuring the Response

updateMatchmakingConfigurationResponse

Arguments

:: Int

umcrsResponseStatus

-> UpdateMatchmakingConfigurationResponse

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

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

• umcrsConfiguration - Object that describes the updated matchmaking configuration.
• umcrsResponseStatus - -- | The response status code.

data UpdateMatchmakingConfigurationResponse

Represents the returned data in response to a request action.

See: updateMatchmakingConfigurationResponse smart constructor.

Instances

Eq UpdateMatchmakingConfigurationResponse

Methods

(==) :: UpdateMatchmakingConfigurationResponse -> UpdateMatchmakingConfigurationResponse -> Bool

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

Data UpdateMatchmakingConfigurationResponse

Methods

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

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

toConstr :: UpdateMatchmakingConfigurationResponse -> Constr

dataTypeOf :: UpdateMatchmakingConfigurationResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read UpdateMatchmakingConfigurationResponse

Methods

readsPrec :: Int -> ReadS UpdateMatchmakingConfigurationResponse

readList :: ReadS [UpdateMatchmakingConfigurationResponse]

readPrec :: ReadPrec UpdateMatchmakingConfigurationResponse

readListPrec :: ReadPrec [UpdateMatchmakingConfigurationResponse]

Show UpdateMatchmakingConfigurationResponse

Methods

showsPrec :: Int -> UpdateMatchmakingConfigurationResponse -> ShowS

show :: UpdateMatchmakingConfigurationResponse -> String

showList :: [UpdateMatchmakingConfigurationResponse] -> ShowS

Generic UpdateMatchmakingConfigurationResponse

Associated Types

type Rep UpdateMatchmakingConfigurationResponse :: * -> *

Methods

from :: UpdateMatchmakingConfigurationResponse -> Rep UpdateMatchmakingConfigurationResponse x

to :: Rep UpdateMatchmakingConfigurationResponse x -> UpdateMatchmakingConfigurationResponse

NFData UpdateMatchmakingConfigurationResponse

Methods

rnf :: UpdateMatchmakingConfigurationResponse -> ()

type Rep UpdateMatchmakingConfigurationResponse

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

Response Lenses

umcrsConfiguration :: Lens' UpdateMatchmakingConfigurationResponse (Maybe MatchmakingConfiguration)

Object that describes the updated matchmaking configuration.

umcrsResponseStatus :: Lens' UpdateMatchmakingConfigurationResponse Int

• - | The response status code.