Amazon GameLift · JSON Structure

Gamelift Claim Game Server Input Structure

ClaimGameServerInput schema from Amazon GameLift API

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

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

Properties

GameServerGroupName GameServerId GameServerData

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-claim-game-server-input-structure.json",
  "name": "ClaimGameServerInput",
  "description": "ClaimGameServerInput schema from Amazon GameLift API",
  "type": "object",
  "properties": {
    "GameServerGroupName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GameServerGroupNameOrArn"
        },
        {
          "description": "A unique identifier for the game server group where the game server is running. If you are not specifying a game server to claim, this value identifies where you want Amazon GameLift FleetIQ to look for an available game server to claim. "
        }
      ]
    },
    "GameServerId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GameServerId"
        },
        {
          "description": "A custom string that uniquely identifies the game server to claim. If this parameter is left empty, Amazon GameLift FleetIQ searches for an available game server in the specified game server group."
        }
      ]
    },
    "GameServerData": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GameServerData"
        },
        {
          "description": "A set of custom game server properties, formatted as a single string value. This data is passed to a game client or service when it requests information on game servers. "
        }
      ]
    }
  },
  "required": [
    "GameServerGroupName"
  ]
}