Amazon GameLift · Schema

PlayerLatency

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.

Cloud ComputingGame ServersGamingMultiplayerMatchmakingFlexMatchFleetIQ

Properties

Name Type Description
PlayerId object
RegionIdentifier object
LatencyInMilliseconds object
View JSON Schema on GitHub

JSON Schema

gamelift-player-latency-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-gamelift/refs/heads/main/json-schema/gamelift-player-latency-schema.json",
  "title": "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."
        }
      ]
    }
  }
}