Amazon GameLift · JSON Structure

Gamelift Player Latency Structure

Regional latency information for a player, used when requesting a new game session. 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.

Type: object Properties: 3
Cloud ComputingGame ServersGamingMultiplayerMatchmakingFlexMatchFleetIQ

PlayerLatency is a JSON Structure definition published by Amazon GameLift, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

PlayerId RegionIdentifier LatencyInMilliseconds

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-gamelift/refs/heads/main/json-structure/gamelift-player-latency-structure.json",
  "name": "PlayerLatency",
  "description": "Regional latency information for a player, used when requesting a new game session. 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. ",
  "type": "object",
  "properties": {
    "PlayerId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonZeroAndMaxString"
        },
        {
          "description": "A unique identifier for a player associated with the latency data."
        }
      ]
    },
    "RegionIdentifier": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonZeroAndMaxString"
        },
        {
          "description": "Name of the Region that is associated with the latency value."
        }
      ]
    },
    "LatencyInMilliseconds": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Float"
        },
        {
          "description": "Amount of time that represents the time lag experienced by the player when connected to the specified Region."
        }
      ]
    }
  }
}