Amazon GameLift · Schema

StartMatchmakingInput

StartMatchmakingInput schema from Amazon GameLift API

Cloud ComputingGame ServersGamingMultiplayerMatchmakingFlexMatchFleetIQ

Properties

Name Type Description
TicketId object
ConfigurationName object
Players object
View JSON Schema on GitHub

JSON Schema

gamelift-start-matchmaking-input-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-start-matchmaking-input-schema.json",
  "title": "StartMatchmakingInput",
  "description": "StartMatchmakingInput schema from Amazon GameLift API",
  "type": "object",
  "properties": {
    "TicketId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MatchmakingIdStringModel"
        },
        {
          "description": "A unique identifier for a matchmaking ticket. If no ticket ID is specified here, Amazon GameLift will generate one in the form of a UUID. Use this identifier to track the matchmaking ticket status and retrieve match results."
        }
      ]
    },
    "ConfigurationName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MatchmakingConfigurationName"
        },
        {
          "description": "Name of the matchmaking configuration to use for this request. Matchmaking configurations must exist in the same Region as this request. You can use either the configuration name or ARN value."
        }
      ]
    },
    "Players": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PlayerList"
        },
        {
          "description": "<p>Information on each player to be matched. This information must include a player ID, and may contain player attributes and latency data to be used in the matchmaking process. After a successful match, <code>Player</code> objects contain the name of the team the player is assigned to.</p> <p>You can include up to 10 <code>Players</code> in a <code>StartMatchmaking</code> request.</p>"
        }
      ]
    }
  },
  "required": [
    "ConfigurationName",
    "Players"
  ]
}