Amazon GameLift · JSON Structure

Gamelift Create Player Session Input Structure

CreatePlayerSessionInput schema from Amazon GameLift API

Type: object Properties: 3 Required: 2
Cloud ComputingGame ServersGamingMultiplayerMatchmakingFlexMatchFleetIQ

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

Properties

GameSessionId PlayerId PlayerData

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-create-player-session-input-structure.json",
  "name": "CreatePlayerSessionInput",
  "description": "CreatePlayerSessionInput schema from Amazon GameLift API",
  "type": "object",
  "properties": {
    "GameSessionId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ArnStringModel"
        },
        {
          "description": "A unique identifier for the game session to add a player to."
        }
      ]
    },
    "PlayerId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonZeroAndMaxString"
        },
        {
          "description": "A unique identifier for a player. Player IDs are developer-defined."
        }
      ]
    },
    "PlayerData": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PlayerData"
        },
        {
          "description": "Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game."
        }
      ]
    }
  },
  "required": [
    "GameSessionId",
    "PlayerId"
  ]
}