GameSession

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-gamelift/refs/heads/main/json-schema/gamelift-game-session-schema.json",
  "title": "GameSession",
  "description": "<p>Properties describing a game session.</p> <p>A game session in ACTIVE status can host players. When a game session ends, its status is set to <code>TERMINATED</code>. </p> <p>Once the session ends, the game session object is retained for 30 days. This means you can reuse idempotency token values after this time. Game session logs are retained for 14 days.</p> <p> <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets\">All APIs by task</a> </p>",
  "type": "object",
  "properties": {
    "GameSessionId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonZeroAndMaxString"
        },
        {
          "description": "A unique identifier for the game session. A game session ARN has the following format: <code>arn:aws:gamelift:&lt;region&gt;::gamesession/&lt;fleet ID&gt;/&lt;custom ID string or idempotency token&gt;</code>."
        }
      ]
    },
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonZeroAndMaxString"
        },
        {
          "description": "A descriptive label that is associated with a game session. Session names do not need to be unique."
        }
      ]
    },
    "FleetId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FleetId"
        },
        {
          "description": "A unique identifier for the fleet that the game session is running on."
        }
      ]
    },
    "FleetArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FleetArn"
        },
        {
          "description": " The Amazon Resource Name (<a href=\"https://docs.aws.amazon.com/AmazonS3/latest/dev/s3-arn-format.html\">ARN</a>) associated with the GameLift fleet that this game session is running on. "
        }
      ]
    },
    "CreationTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example <code>\"1469498468.057\"</code>)."
        }
      ]
    },
    "TerminationTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Timestamp"
        },
        {
          "description": "A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example <code>\"1469498468.057\"</code>)."
        }
      ]
    },
    "CurrentPlayerSessionCount": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WholeNumber"
        },
        {
          "description": "Number of players currently in the game session."
        }
      ]
    },
    "MaximumPlayerSessionCount": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WholeNumber"
        },
        {
          "description": "The maximum number of players that can be connected simultaneously to the game session."
        }
      ]
    },
    "Status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GameSessionStatus"
        },
        {
          "description": "Current status of the game session. A game session must have an <code>ACTIVE</code> status to have player sessions."
        }
      ]
    },
    "StatusReason": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GameSessionStatusReason"
        },
        {
          "description": "Provides additional information about game session status. <code>INTERRUPTED</code> indicates that the game session was hosted on a spot instance that was reclaimed, causing the active game session to be terminated."
        }
      ]
    },
    "GameProperties": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GamePropertyList"
        },
        {
          "description": "A set of custom properties for a game session, formatted as key:value pairs. These properties are passed to a game server process with a request to start a new game session (see <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession\">Start a Game Session</a>)."
        }
      ]
    },
    "IpAddress": {
      "allOf": [
        {
          "$ref": "#/components/schemas/IpAddress"
        },
        {
          "description": "The IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number."
        }
      ]
    },
    "DnsName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DnsName"
        },
        {
          "description": "<p>The DNS identifier assigned to the instance that is running the game session. Values have the following format:</p> <ul> <li> <p>TLS-enabled fleets: <code>&lt;unique identifier&gt;.&lt;region identifier&gt;.amazongamelift.com</code>.</p> </li> <li> <p>Non-TLS-enabled fleets: <code>ec2-&lt;unique identifier&gt;.compute.amazonaws.com</code>. (See <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing.html#concepts-public-addresses\">Amazon EC2 Instance IP Addressing</a>.)</p> </li> </ul> <p>When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.</p>"
        }
      ]
    },
    "Port": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PortNumber"
        },
        {
          "description": "The port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number."
        }
      ]
    },
    "PlayerSessionCreationPolicy": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PlayerSessionCreationPolicy"
        },
        {
          "description": "Indicates whether or not the game session is accepting new players."
        }
      ]
    },
    "CreatorId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/NonZeroAndMaxString"
        },
        {
          "description": "A unique identifier for a player. This ID is used to enforce a resource protection policy (if one exists), that limits the number of game sessions a player can create."
        }
      ]
    },
    "GameSessionData": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LargeGameSessionData"
        },
        {
          "description": "A set of custom game session properties, formatted as a single string value. This data is passed to a game server process with a request to start a new game session (see <a href=\"https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-api.html#gamelift-sdk-server-startsession\">Start a Game Session</a>)."
        }
      ]
    },
    "MatchmakerData": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MatchmakerData"
        },
        {
          "description": "Information about the matchmaking process that was used to create the game session. It is in JSON syntax, formatted as a string. In addition the matchmaking configuration used, it contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see <a href=\"https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-server.html#match-server-data\">Match Data</a>. Matchmaker data is useful when requesting match backfills, and is updated whenever new players are added during a successful backfill (see <a href=\"https://docs.aws.amazon.com/gamelift/latest/apireference/API_StartMatchBackfill.html\">StartMatchBackfill</a>). "
        }
      ]
    },
    "Location": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LocationStringModel"
        },
        {
          "description": "The fleet location where the game session is running. This value might specify the fleet's home Region or a remote location. Location is expressed as an Amazon Web Services Region code such as <code>us-west-2</code>. "
        }
      ]
    }
  }
}