Network.AWS.GameLift.StartMatchBackfill

Finds new players to fill open slots in an existing game session. This operation can be used to add players to matched games that start with fewer than the maximum number of players or to replace players when they drop out. By backfilling with the same matchmaker used to create the original match, you ensure that new players meet the match criteria and maintain a consistent experience throughout the game session. You can backfill a match anytime after a game session has been created.

To request a match backfill, specify a unique ticket ID, the existing game session's ARN, a matchmaking configuration, and a set of data that describes all current players in the game session. If successful, a match backfill ticket is created and returned with status set to QUEUED. The ticket is placed in the matchmaker's ticket pool and processed. Track the status of the ticket to respond as needed. For more detail how to set up backfilling, see Backfill Existing Games with FlexMatch .

The process of finding backfill matches is essentially identical to the initial matchmaking process. The matchmaker searches the pool and groups tickets together to form potential matches, allowing only one backfill ticket per potential match. Once the a match is formed, the matchmaker creates player sessions for the new players. All tickets in the match are updated with the game session's connection information, and the GameSession object is updated to include matchmaker data on the new players. For more detail on how match backfill requests are processed, see How Amazon GameLift FlexMatch Works .

Matchmaking-related operations include:

• StartMatchmaking
• DescribeMatchmaking
• StopMatchmaking
• AcceptMatch
• StartMatchBackfill

Creating a Request

startMatchBackfill

Arguments

:: Text

smbConfigurationName

-> Text

smbGameSessionARN

-> StartMatchBackfill

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

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

• smbTicketId - 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.
• smbConfigurationName - Name of the matchmaker to use for this request. The name of the matchmaker that was used with the original game session is listed in the GameSession object, MatchmakerData property. This property contains a matchmaking configuration ARN value, which includes the matchmaker name. (In the ARN value "arn:aws:gamelift:us-west-2:111122223333:matchmakingconfiguration/MM-4v4", the matchmaking configuration name is MM-4v4.) Use only the name for this parameter.
• smbGameSessionARN - Amazon Resource Name (ARN ) that is assigned to a game session and uniquely identifies it.
• smbPlayers - 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. * 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 . * 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.

data StartMatchBackfill

Represents the input for a request action.

See: startMatchBackfill smart constructor.

Instances

Eq StartMatchBackfill

Methods

(==) :: StartMatchBackfill -> StartMatchBackfill -> Bool

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

Data StartMatchBackfill

Methods

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

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

toConstr :: StartMatchBackfill -> Constr

dataTypeOf :: StartMatchBackfill -> DataType

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

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

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

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

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

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

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

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

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

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

Read StartMatchBackfill

Methods

readsPrec :: Int -> ReadS StartMatchBackfill

readList :: ReadS [StartMatchBackfill]

readPrec :: ReadPrec StartMatchBackfill

readListPrec :: ReadPrec [StartMatchBackfill]

Show StartMatchBackfill

Methods

showsPrec :: Int -> StartMatchBackfill -> ShowS

show :: StartMatchBackfill -> String

showList :: [StartMatchBackfill] -> ShowS

Generic StartMatchBackfill

Associated Types

type Rep StartMatchBackfill :: * -> *

Methods

from :: StartMatchBackfill -> Rep StartMatchBackfill x

to :: Rep StartMatchBackfill x -> StartMatchBackfill

Hashable StartMatchBackfill

Methods

hashWithSalt :: Int -> StartMatchBackfill -> Int

hash :: StartMatchBackfill -> Int

ToJSON StartMatchBackfill

Methods

toJSON :: StartMatchBackfill -> Value

toEncoding :: StartMatchBackfill -> Encoding

toJSONList :: [StartMatchBackfill] -> Value

toEncodingList :: [StartMatchBackfill] -> Encoding

NFData StartMatchBackfill

Methods

rnf :: StartMatchBackfill -> ()

AWSRequest StartMatchBackfill

Associated Types

type Rs StartMatchBackfill :: *

Methods

request :: StartMatchBackfill -> Request StartMatchBackfill

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * StartMatchBackfill -> ClientResponse -> m (Response StartMatchBackfill)

ToHeaders StartMatchBackfill

Methods

toHeaders :: StartMatchBackfill -> [Header]

ToPath StartMatchBackfill

Methods

toPath :: StartMatchBackfill -> ByteString

ToQuery StartMatchBackfill

Methods

toQuery :: StartMatchBackfill -> QueryString

type Rep StartMatchBackfill

type Rep StartMatchBackfill = D1 * (MetaData "StartMatchBackfill" "Network.AWS.GameLift.StartMatchBackfill" "amazonka-gamelift-1.6.0-DeAosbEJJf8D8cv8ebS5Uv" False) (C1 * (MetaCons "StartMatchBackfill'" PrefixI True) ((:*:) * ((:*:) * (S1 * (MetaSel (Just Symbol "_smbTicketId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_smbConfigurationName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))) ((:*:) * (S1 * (MetaSel (Just Symbol "_smbGameSessionARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_smbPlayers") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * [Player])))))

type Rs StartMatchBackfill

type Rs StartMatchBackfill = StartMatchBackfillResponse

Request Lenses

smbTicketId :: Lens' StartMatchBackfill (Maybe Text)

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.

smbConfigurationName :: Lens' StartMatchBackfill Text

Name of the matchmaker to use for this request. The name of the matchmaker that was used with the original game session is listed in the GameSession object, MatchmakerData property. This property contains a matchmaking configuration ARN value, which includes the matchmaker name. (In the ARN value "arn:aws:gamelift:us-west-2:111122223333:matchmakingconfiguration/MM-4v4", the matchmaking configuration name is MM-4v4.) Use only the name for this parameter.

smbGameSessionARN :: Lens' StartMatchBackfill Text

Amazon Resource Name (ARN ) that is assigned to a game session and uniquely identifies it.

smbPlayers :: Lens' StartMatchBackfill [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. * 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 . * 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

startMatchBackfillResponse

Arguments

:: Int

smbrsResponseStatus

-> StartMatchBackfillResponse

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

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

• smbrsMatchmakingTicket - 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.
• smbrsResponseStatus - -- | The response status code.

data StartMatchBackfillResponse

Represents the returned data in response to a request action.

See: startMatchBackfillResponse smart constructor.

Instances

Eq StartMatchBackfillResponse

Methods

(==) :: StartMatchBackfillResponse -> StartMatchBackfillResponse -> Bool

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

Data StartMatchBackfillResponse

Methods

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

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

toConstr :: StartMatchBackfillResponse -> Constr

dataTypeOf :: StartMatchBackfillResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read StartMatchBackfillResponse

Methods

readsPrec :: Int -> ReadS StartMatchBackfillResponse

readList :: ReadS [StartMatchBackfillResponse]

readPrec :: ReadPrec StartMatchBackfillResponse

readListPrec :: ReadPrec [StartMatchBackfillResponse]

Show StartMatchBackfillResponse

Methods

showsPrec :: Int -> StartMatchBackfillResponse -> ShowS

show :: StartMatchBackfillResponse -> String

showList :: [StartMatchBackfillResponse] -> ShowS

Generic StartMatchBackfillResponse

Associated Types

type Rep StartMatchBackfillResponse :: * -> *

Methods

from :: StartMatchBackfillResponse -> Rep StartMatchBackfillResponse x

to :: Rep StartMatchBackfillResponse x -> StartMatchBackfillResponse

NFData StartMatchBackfillResponse

Methods

rnf :: StartMatchBackfillResponse -> ()

type Rep StartMatchBackfillResponse

type Rep StartMatchBackfillResponse = D1 * (MetaData "StartMatchBackfillResponse" "Network.AWS.GameLift.StartMatchBackfill" "amazonka-gamelift-1.6.0-DeAosbEJJf8D8cv8ebS5Uv" False) (C1 * (MetaCons "StartMatchBackfillResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_smbrsMatchmakingTicket") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe MatchmakingTicket))) (S1 * (MetaSel (Just Symbol "_smbrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

smbrsMatchmakingTicket :: Lens' StartMatchBackfillResponse (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.

smbrsResponseStatus :: Lens' StartMatchBackfillResponse Int

• - | The response status code.