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.StartMatchBackfill

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Finds new players to fill open slots in currently running game sessions. The backfill match process is essentially identical to the process of forming new matches. Backfill requests use the same matchmaker that was used to make the original match, and they provide matchmaking data for all players currently in the game session. FlexMatch uses this information to select new players so that backfilled match continues to meet the original match requirements.

When using FlexMatch with GameLift managed hosting, you can request a backfill match from a client service by calling this operation with a GameSessions ID. You also have the option of making backfill requests directly from your game server. In response to a request, FlexMatch creates player sessions for the new players, updates the GameSession resource, and sends updated matchmaking data to the game server. You can request a backfill match at any point after a game session is started. Each game session can have only one active backfill request at a time; a subsequent request automatically replaces the earlier request.

When using FlexMatch as a standalone component, request a backfill match by calling this operation without a game session identifier. As with newly formed matches, matchmaking results are returned in a matchmaking event so that your game can update the game session that is being backfilled.

To request a backfill match, specify a unique ticket ID, the original matchmaking configuration, and matchmaking data for all current players in the game session being backfilled. Optionally, specify the GameSession ARN. If successful, a match backfill ticket is created and returned with status set to QUEUED. Track the status of backfill tickets using the same method for tracking tickets for new matches.

Only game sessions created by FlexMatch are supported for match backfill.

Learn more

Backfill existing games with FlexMatch

Matchmaking events (reference)

How GameLift FlexMatch works

Synopsis

data StartMatchBackfill = StartMatchBackfill' {
- gameSessionArn :: Maybe Text
- ticketId :: Maybe Text
- configurationName :: Text
- players :: [Player]
}
newStartMatchBackfill :: Text -> StartMatchBackfill
startMatchBackfill_gameSessionArn :: Lens' StartMatchBackfill (Maybe Text)
startMatchBackfill_ticketId :: Lens' StartMatchBackfill (Maybe Text)
startMatchBackfill_configurationName :: Lens' StartMatchBackfill Text
startMatchBackfill_players :: Lens' StartMatchBackfill [Player]
data StartMatchBackfillResponse = StartMatchBackfillResponse' {
- matchmakingTicket :: Maybe MatchmakingTicket
- httpStatus :: Int
}
newStartMatchBackfillResponse :: Int -> StartMatchBackfillResponse
startMatchBackfillResponse_matchmakingTicket :: Lens' StartMatchBackfillResponse (Maybe MatchmakingTicket)
startMatchBackfillResponse_httpStatus :: Lens' StartMatchBackfillResponse Int

Creating a Request

data StartMatchBackfill Source #

See: newStartMatchBackfill smart constructor.

Constructors

StartMatchBackfill'

Fields

gameSessionArn :: Maybe Text
A unique identifier for the game session. Use the game session ID. When using FlexMatch as a standalone matchmaking solution, this parameter is not needed.
ticketId :: Maybe Text
A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the match backfill ticket status and retrieve match results.
configurationName :: Text
Name of the matchmaker to use for this request. You can use either the configuration name or ARN value. The ARN of the matchmaker that was used with the original game session is listed in the GameSession object, MatchmakerData property.
players :: [Player]
Match information on all players that are currently assigned to the game session. This information is used by the matchmaker to find new players and add them to the existing game.
You can include up to 199 Players in a StartMatchBackfill request.
- PlayerID, PlayerAttributes, Team -- This information is maintained in the GameSession object, MatchmakerData property, for all players who are currently assigned to the game session. The matchmaker data is in JSON syntax, formatted as a string. For more details, see Match Data.
  The backfill request must specify the team membership for every player. Do not specify team if you are not using backfill.
- LatencyInMs -- If the matchmaker uses player latency, include a latency value, in milliseconds, for the Region that the game session is currently in. Do not include latency values for any other Region.

Instances

Instances details

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

newStartMatchBackfill Source #

Arguments

:: Text	`StartMatchBackfill`
-> StartMatchBackfill

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

StartMatchBackfill, startMatchBackfill_gameSessionArn - A unique identifier for the game session. Use the game session ID. When using FlexMatch as a standalone matchmaking solution, this parameter is not needed.

StartMatchBackfill, startMatchBackfill_ticketId - A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the match backfill ticket status and retrieve match results.

StartMatchBackfill, startMatchBackfill_configurationName - Name of the matchmaker to use for this request. You can use either the configuration name or ARN value. The ARN of the matchmaker that was used with the original game session is listed in the GameSession object, MatchmakerData property.

StartMatchBackfill, startMatchBackfill_players - Match information on all players that are currently assigned to the game session. This information is used by the matchmaker to find new players and add them to the existing game.

You can include up to 199 Players in a StartMatchBackfill request.

PlayerID, PlayerAttributes, Team -- This information is maintained in the GameSession object, MatchmakerData property, for all players who are currently assigned to the game session. The matchmaker data is in JSON syntax, formatted as a string. For more details, see Match Data.
The backfill request must specify the team membership for every player. Do not specify team if you are not using backfill.
LatencyInMs -- If the matchmaker uses player latency, include a latency value, in milliseconds, for the Region that the game session is currently in. Do not include latency values for any other Region.

Request Lenses

startMatchBackfill_gameSessionArn :: Lens' StartMatchBackfill (Maybe Text) Source #

A unique identifier for the game session. Use the game session ID. When using FlexMatch as a standalone matchmaking solution, this parameter is not needed.

startMatchBackfill_ticketId :: Lens' StartMatchBackfill (Maybe Text) Source #

A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the match backfill ticket status and retrieve match results.

startMatchBackfill_configurationName :: Lens' StartMatchBackfill Text Source #

Name of the matchmaker to use for this request. You can use either the configuration name or ARN value. The ARN of the matchmaker that was used with the original game session is listed in the GameSession object, MatchmakerData property.

startMatchBackfill_players :: Lens' StartMatchBackfill [Player] Source #

Match information on all players that are currently assigned to the game session. This information is used by the matchmaker to find new players and add them to the existing game.

You can include up to 199 Players in a StartMatchBackfill request.

PlayerID, PlayerAttributes, Team -- This information is maintained in the GameSession object, MatchmakerData property, for all players who are currently assigned to the game session. The matchmaker data is in JSON syntax, formatted as a string. For more details, see Match Data.
The backfill request must specify the team membership for every player. Do not specify team if you are not using backfill.
LatencyInMs -- If the matchmaker uses player latency, include a latency value, in milliseconds, for the Region that the game session is currently in. Do not include latency values for any other Region.

Destructuring the Response

data StartMatchBackfillResponse Source #

See: newStartMatchBackfillResponse smart constructor.

Constructors

StartMatchBackfillResponse'
Fields matchmakingTicket :: Maybe MatchmakingTicket Ticket representing the backfill matchmaking request. This object includes the information in the request, ticket status, and match results as generated during the matchmaking process. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newStartMatchBackfillResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartMatchBackfillResponse'`
-> StartMatchBackfillResponse

Create a value of StartMatchBackfillResponse 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:matchmakingTicket:StartMatchBackfillResponse', startMatchBackfillResponse_matchmakingTicket - Ticket representing the backfill matchmaking request. This object includes the information in the request, ticket status, and match results as generated during the matchmaking process.

$sel:httpStatus:StartMatchBackfillResponse', startMatchBackfillResponse_httpStatus - The response's http status code.

Response Lenses

startMatchBackfillResponse_matchmakingTicket :: Lens' StartMatchBackfillResponse (Maybe MatchmakingTicket) Source #

Ticket representing the backfill matchmaking request. This object includes the information in the request, ticket status, and match results as generated during the matchmaking process.

startMatchBackfillResponse_httpStatus :: Lens' StartMatchBackfillResponse Int Source #

The response's http status code.