PlayerLatency - Amazon GameLift
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

PlayerLatency

Regional latency information for a player, used when requesting a new game session with StartGameSessionPlacement. This value indicates the amount of time lag that exists when the player is connected to a fleet in the specified Region. The relative difference between a player's latency values for multiple Regions are used to determine which fleets are best suited to place a new game session for the player.

Contents

Note

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

LatencyInMilliseconds

Amount of time that represents the time lag experienced by the player when connected to the specified Region.

Type: Float

Required: No

PlayerId

A unique identifier for a player associated with the latency data.

Type: String

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

Required: No

RegionIdentifier

Name of the Region that is associated with the latency value.

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 Amazon SDKs, see the following: