Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14104474602.4 KB

This operation is used with the Amazon GameLift FleetIQ solution and game server groups.

Creates a new game server resource and notifies Amazon GameLift FleetIQ that the game server is ready to host gameplay and players. This operation is called by a game server process that is running on an instance in a game server group. Registering game servers enables Amazon GameLift FleetIQ to track available game servers and enables game clients and services to claim a game server for a new game session.

To register a game server, identify the game server group and instance where the game server is running, and provide a unique identifier for the game server. You can also include connection and game server data.

Once a game server is successfully registered, it is put in status AVAILABLE. A request to register a game server may fail if the instance it is running on is in the process of shutting down as part of instance balancing or scale-down activity.

Learn more

Amazon GameLift FleetIQ Guide

post/#X-Amz-Target=GameLift.RegisterGameServer

Headers

X-Amz-Target'GameLift.RegisterGameServer' required

Request body

GameServerGroupNamestring required

A unique identifier for the game server group where the game server is running.

GameServerIdstring required

A custom string that uniquely identifies the game server to register. Game server IDs are developer-defined and must be unique across all game server groups in your Amazon Web Services account.

InstanceIdstring required

The unique identifier for the instance where the game server is running. This ID is available in the instance metadata. EC2 instance IDs use a 17-character format, for example: <code>i-1234567890abcdef0</code>.

ConnectionInfostring

Information that is needed to make inbound client connections to the game server. This might include the IP address and port, DNS name, and other information.

GameServerDatastring

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.

Response

Success