amazonka-gamelift-2.0: Amazon GameLift SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.GameLift.UpdateMatchmakingConfiguration

Description

Updates settings for a FlexMatch matchmaking configuration. These changes affect all matches and game sessions that are created after the update. To update settings, specify the configuration name to be updated and provide the new settings.

Learn more

Design a FlexMatch matchmaker

Synopsis

Creating a Request

data UpdateMatchmakingConfiguration Source #

See: newUpdateMatchmakingConfiguration smart constructor.

Constructors

UpdateMatchmakingConfiguration' 

Fields

  • acceptanceRequired :: Maybe Bool

    A flag that indicates whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE. With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.

  • acceptanceTimeoutSeconds :: Maybe Natural

    The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.

  • additionalPlayerCount :: Maybe Natural

    The 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. This parameter is not used if FlexMatchMode is set to STANDALONE.

  • backfillMode :: Maybe BackfillMode

    The method that is used to backfill game sessions created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a match backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.

  • customEventData :: Maybe Text

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

  • description :: Maybe Text

    A description for the matchmaking configuration.

  • flexMatchMode :: Maybe FlexMatchMode

    Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution.

    • STANDALONE - FlexMatch forms matches and returns match information, including players and team assignments, in a MatchmakingSucceeded event.
    • WITH_QUEUE - FlexMatch forms matches and uses the specified GameLift queue to start a game session for the match.
  • gameProperties :: Maybe [GameProperty]

    A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process 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. This parameter is not used if FlexMatchMode is set to STANDALONE.

  • gameSessionData :: Maybe Text

    A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see Start a Game Session). This information is added to the game session that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.

  • gameSessionQueueArns :: Maybe [Text]

    The Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. Queues can be located in any Region. Queues are used to start new GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If FlexMatchMode is set to STANDALONE, do not set this parameter.

  • notificationTarget :: Maybe Text

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

  • requestTimeoutSeconds :: Maybe Natural

    The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed.

  • ruleSetName :: Maybe Text

    A unique identifier for the matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.

  • name :: Text

    A unique identifier for the matchmaking configuration to update. You can use either the configuration name or ARN value.

Instances

Instances details
ToJSON UpdateMatchmakingConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.UpdateMatchmakingConfiguration

ToHeaders UpdateMatchmakingConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.UpdateMatchmakingConfiguration

ToPath UpdateMatchmakingConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.UpdateMatchmakingConfiguration

ToQuery UpdateMatchmakingConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.UpdateMatchmakingConfiguration

AWSRequest UpdateMatchmakingConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.UpdateMatchmakingConfiguration

Generic UpdateMatchmakingConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.UpdateMatchmakingConfiguration

Associated Types

type Rep UpdateMatchmakingConfiguration :: Type -> Type #

Read UpdateMatchmakingConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.UpdateMatchmakingConfiguration

Show UpdateMatchmakingConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.UpdateMatchmakingConfiguration

NFData UpdateMatchmakingConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.UpdateMatchmakingConfiguration

Eq UpdateMatchmakingConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.UpdateMatchmakingConfiguration

Hashable UpdateMatchmakingConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.UpdateMatchmakingConfiguration

type AWSResponse UpdateMatchmakingConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.UpdateMatchmakingConfiguration

type Rep UpdateMatchmakingConfiguration Source # 
Instance details

Defined in Amazonka.GameLift.UpdateMatchmakingConfiguration

type Rep UpdateMatchmakingConfiguration = D1 ('MetaData "UpdateMatchmakingConfiguration" "Amazonka.GameLift.UpdateMatchmakingConfiguration" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "UpdateMatchmakingConfiguration'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "acceptanceRequired") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 ('MetaSel ('Just "acceptanceTimeoutSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "additionalPlayerCount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :*: ((S1 ('MetaSel ('Just "backfillMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BackfillMode)) :*: S1 ('MetaSel ('Just "customEventData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "flexMatchMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FlexMatchMode))))) :*: ((S1 ('MetaSel ('Just "gameProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [GameProperty])) :*: (S1 ('MetaSel ('Just "gameSessionData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "gameSessionQueueArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :*: ((S1 ('MetaSel ('Just "notificationTarget") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "requestTimeoutSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))) :*: (S1 ('MetaSel ('Just "ruleSetName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newUpdateMatchmakingConfiguration Source #

Create a value of UpdateMatchmakingConfiguration 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:

UpdateMatchmakingConfiguration, updateMatchmakingConfiguration_acceptanceRequired - A flag that indicates whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE. With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.

UpdateMatchmakingConfiguration, updateMatchmakingConfiguration_acceptanceTimeoutSeconds - The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.

UpdateMatchmakingConfiguration, updateMatchmakingConfiguration_additionalPlayerCount - The 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. This parameter is not used if FlexMatchMode is set to STANDALONE.

UpdateMatchmakingConfiguration, updateMatchmakingConfiguration_backfillMode - The method that is used to backfill game sessions created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a match backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.

UpdateMatchmakingConfiguration, updateMatchmakingConfiguration_customEventData - Information to add to all events related to the matchmaking configuration.

UpdateMatchmakingConfiguration, updateMatchmakingConfiguration_description - A description for the matchmaking configuration.

UpdateMatchmakingConfiguration, updateMatchmakingConfiguration_flexMatchMode - Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution.

  • STANDALONE - FlexMatch forms matches and returns match information, including players and team assignments, in a MatchmakingSucceeded event.
  • WITH_QUEUE - FlexMatch forms matches and uses the specified GameLift queue to start a game session for the match.

UpdateMatchmakingConfiguration, updateMatchmakingConfiguration_gameProperties - A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process 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. This parameter is not used if FlexMatchMode is set to STANDALONE.

UpdateMatchmakingConfiguration, updateMatchmakingConfiguration_gameSessionData - A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see Start a Game Session). This information is added to the game session that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.

UpdateMatchmakingConfiguration, updateMatchmakingConfiguration_gameSessionQueueArns - The Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. Queues can be located in any Region. Queues are used to start new GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If FlexMatchMode is set to STANDALONE, do not set this parameter.

UpdateMatchmakingConfiguration, updateMatchmakingConfiguration_notificationTarget - An SNS topic ARN that is set up to receive matchmaking notifications. See Setting up notifications for matchmaking for more information.

UpdateMatchmakingConfiguration, updateMatchmakingConfiguration_requestTimeoutSeconds - The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed.

UpdateMatchmakingConfiguration, updateMatchmakingConfiguration_ruleSetName - A unique identifier for the matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.

UpdateMatchmakingConfiguration, updateMatchmakingConfiguration_name - A unique identifier for the matchmaking configuration to update. You can use either the configuration name or ARN value.

Request Lenses

updateMatchmakingConfiguration_acceptanceRequired :: Lens' UpdateMatchmakingConfiguration (Maybe Bool) Source #

A flag that indicates whether a match that was created with this configuration must be accepted by the matched players. To require acceptance, set to TRUE. With this option enabled, matchmaking tickets use the status REQUIRES_ACCEPTANCE to indicate when a completed potential match is waiting for player acceptance.

updateMatchmakingConfiguration_acceptanceTimeoutSeconds :: Lens' UpdateMatchmakingConfiguration (Maybe Natural) Source #

The length of time (in seconds) to wait for players to accept a proposed match, if acceptance is required.

updateMatchmakingConfiguration_additionalPlayerCount :: Lens' UpdateMatchmakingConfiguration (Maybe Natural) Source #

The 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. This parameter is not used if FlexMatchMode is set to STANDALONE.

updateMatchmakingConfiguration_backfillMode :: Lens' UpdateMatchmakingConfiguration (Maybe BackfillMode) Source #

The method that is used to backfill game sessions created with this matchmaking configuration. Specify MANUAL when your game manages backfill requests manually or does not use the match backfill feature. Specify AUTOMATIC to have GameLift create a match backfill request whenever a game session has one or more open slots. Learn more about manual and automatic backfill in Backfill Existing Games with FlexMatch. Automatic backfill is not available when FlexMatchMode is set to STANDALONE.

updateMatchmakingConfiguration_customEventData :: Lens' UpdateMatchmakingConfiguration (Maybe Text) Source #

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

updateMatchmakingConfiguration_flexMatchMode :: Lens' UpdateMatchmakingConfiguration (Maybe FlexMatchMode) Source #

Indicates whether this matchmaking configuration is being used with GameLift hosting or as a standalone matchmaking solution.

  • STANDALONE - FlexMatch forms matches and returns match information, including players and team assignments, in a MatchmakingSucceeded event.
  • WITH_QUEUE - FlexMatch forms matches and uses the specified GameLift queue to start a game session for the match.

updateMatchmakingConfiguration_gameProperties :: Lens' UpdateMatchmakingConfiguration (Maybe [GameProperty]) Source #

A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process 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. This parameter is not used if FlexMatchMode is set to STANDALONE.

updateMatchmakingConfiguration_gameSessionData :: Lens' UpdateMatchmakingConfiguration (Maybe Text) Source #

A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see Start a Game Session). This information is added to the game session that is created for a successful match. This parameter is not used if FlexMatchMode is set to STANDALONE.

updateMatchmakingConfiguration_gameSessionQueueArns :: Lens' UpdateMatchmakingConfiguration (Maybe [Text]) Source #

The Amazon Resource Name (ARN) that is assigned to a GameLift game session queue resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::gamesessionqueue/<queue name>. Queues can be located in any Region. Queues are used to start new GameLift-hosted game sessions for matches that are created with this matchmaking configuration. If FlexMatchMode is set to STANDALONE, do not set this parameter.

updateMatchmakingConfiguration_notificationTarget :: Lens' UpdateMatchmakingConfiguration (Maybe Text) Source #

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

updateMatchmakingConfiguration_requestTimeoutSeconds :: Lens' UpdateMatchmakingConfiguration (Maybe Natural) Source #

The maximum duration, in seconds, that a matchmaking ticket can remain in process before timing out. Requests that fail due to timing out can be resubmitted as needed.

updateMatchmakingConfiguration_ruleSetName :: Lens' UpdateMatchmakingConfiguration (Maybe Text) Source #

A unique identifier for the matchmaking rule set to use with this configuration. You can use either the rule set name or ARN value. A matchmaking configuration can only use rule sets that are defined in the same Region.

updateMatchmakingConfiguration_name :: Lens' UpdateMatchmakingConfiguration Text Source #

A unique identifier for the matchmaking configuration to update. You can use either the configuration name or ARN value.

Destructuring the Response

data UpdateMatchmakingConfigurationResponse Source #

Constructors

UpdateMatchmakingConfigurationResponse' 

Fields

Instances

Instances details
Generic UpdateMatchmakingConfigurationResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateMatchmakingConfiguration

Read UpdateMatchmakingConfigurationResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateMatchmakingConfiguration

Show UpdateMatchmakingConfigurationResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateMatchmakingConfiguration

NFData UpdateMatchmakingConfigurationResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateMatchmakingConfiguration

Eq UpdateMatchmakingConfigurationResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateMatchmakingConfiguration

type Rep UpdateMatchmakingConfigurationResponse Source # 
Instance details

Defined in Amazonka.GameLift.UpdateMatchmakingConfiguration

type Rep UpdateMatchmakingConfigurationResponse = D1 ('MetaData "UpdateMatchmakingConfigurationResponse" "Amazonka.GameLift.UpdateMatchmakingConfiguration" "amazonka-gamelift-2.0-IjhNQby9jLV6gj30IrgsyK" 'False) (C1 ('MetaCons "UpdateMatchmakingConfigurationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MatchmakingConfiguration)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateMatchmakingConfigurationResponse Source #

Create a value of UpdateMatchmakingConfigurationResponse 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:configuration:UpdateMatchmakingConfigurationResponse', updateMatchmakingConfigurationResponse_configuration - The updated matchmaking configuration.

$sel:httpStatus:UpdateMatchmakingConfigurationResponse', updateMatchmakingConfigurationResponse_httpStatus - The response's http status code.

Response Lenses