Amazon GameLift · JSON Structure

Gamelift Update Game Server Input Structure

UpdateGameServerInput schema from Amazon GameLift API

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

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

Properties

GameServerGroupName GameServerId GameServerData UtilizationStatus HealthCheck

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-update-game-server-input-structure.json",
  "name": "UpdateGameServerInput",
  "description": "UpdateGameServerInput 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."
        }
      ]
    },
    "GameServerId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GameServerId"
        },
        {
          "description": "A custom string that uniquely identifies the game server to update."
        }
      ]
    },
    "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. "
        }
      ]
    },
    "UtilizationStatus": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GameServerUtilizationStatus"
        },
        {
          "description": "Indicates whether the game server is available or is currently hosting gameplay."
        }
      ]
    },
    "HealthCheck": {
      "allOf": [
        {
          "$ref": "#/components/schemas/GameServerHealthCheck"
        },
        {
          "description": "Indicates health status of the game server. A request that includes this parameter updates the game server's <i>LastHealthCheckTime</i> timestamp. "
        }
      ]
    }
  },
  "required": [
    "GameServerGroupName",
    "GameServerId"
  ]
}