Amazon GameLift Service
API Reference (API Version 2015-10-01)
AWS services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with AWS services in China.

Player

Represents a player in matchmaking. When starting a matchmaking request, a player has a player ID, attributes, and may have latency data. Team information is added after a match has been successfully completed.

Contents

Note

In the following list, the required parameters are described first.

LatencyInMs

Set of values, expressed in milliseconds, indicating the amount of latency that a player experiences when connected to AWS regions. If this property is present, FlexMatch considers placing the match only in regions for which latency is reported.

If a matchmaker has a rule that evaluates player latency, players must report latency in order to be matched. If no latency is reported in this scenario, FlexMatch assumes that no regions are available to the player and the ticket is not matchable.

Type: String to integer map

Key Length Constraints: Minimum length of 1.

Valid Range: Minimum value of 1.

Required: No

PlayerAttributes

Collection of key:value pairs containing player information for use in matchmaking. Player attribute keys must match the playerAttributes used in a matchmaking rule set. Example: "PlayerAttributes": {"skill": {"N": "23"}, "gameMode": {"S": "deathmatch"}}.

Type: String to AttributeValue object map

Key Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

PlayerId

Unique identifier for a player

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

Team

Name of the team that the player is assigned to in a match. Team names are defined in a matchmaking rule set.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: