GameLift FleetIQ service API reference (AWS SDK)

This topic provides a task-based list of API actions for GameLift FleetIQ. The GameLift FleetIQ service API is packaged into the AWS SDK in the aws.gamelift namespace. Download the AWS SDK or view the Amazon GameLift API reference documentation.

GameLift FleetIQ optimizes the use of low-cost Spot Instances for cloud-based game hosting with Amazon EC2. See the GameLift Developer Guide for more information on other GameLift hosting options.

GameLift FleetIQ API actions

The following operations allow you to manage your GameLift FleetIQ resources, including game server groups and game servers, in conjunction with Amazon EC2 and Auto Scaling groups.

Manage game server groups

Use these operations to manage your game server deployments with FleetIQ optimizations. A game server group controls how your game server processes are launched on Amazon EC2 instances, sets up and Auto Scaling group, and defines how to apply FleetIQ optimizations.

• CreateGameServerGroup – Create a new game server group and corresponding Auto Scaling group, and begin launching instances to host your game server. CLI command: create-game-server-group

• ListGameServerGroups – Get a list of all game server groups in a GameLift region. CLI command: list-game-server-groups

• DescribeGameServerGroup – Retrieve metadata for a game server group. CLI command: describe-game-server-group

• UpdateGameServerGroup – Change game server group metadata. CLI command: update-game-server-group

• DeleteGameServerGroup – Permanently remove a game server group and terminate FleetIQ activity for the associated hosting resources. CLI command: delete-game-server-group

• ResumeGameServerGroup – Reinstate suspended FleetIQ activity for a game server group. CLI command: resume-game-server-group

• SuspendGameServerGroup – Temporarily stop FleetIQ activity for a game server group. CLI command: suspend-game-server-group

Manage game servers

Use these operations to manage your game server deployments with FleetIQ optimizations. A game server group controls how your game server processes are launched on Amazon EC2 instances, sets up and Auto Scaling group, and defines how to apply FleetIQ optimizations.

• RegisterGameServer – Call from a new game server to notify GameLift FleetIQ that the game server is ready to host gameplay. CLI command: register-game-server-group

• ListGameServers – Call from a game client service to get a list of all game servers that are currently running in a game server group. CLI command: list-game-servers

• ClaimGameServer – Call from a game client service to locate and reserve a game server to host a new game session. CLI command: claim-game-server

• DescribeGameServer – Retrieve metadata for a game server. CLI command: describe-game-server

• UpdateGameServer – Change game server metadata, health status, or utilization status. CLI command: update-game-server

• DeregisterGameServer – Call from a terminating game server to prompt GameLift FleetIQ to remove the game server from the game server group. CLI command: deregister-game-server

Available programming languages

The AWS SDK with Amazon GameLift is available in the following languages. See documentation for each language for details on support for development environments.

• C++ (SDK docs) (Amazon GameLift)

• Java (SDK docs) (Amazon GameLift)

• .NET (SDK docs) (Amazon GameLift)

• Go (SDK docs) (Amazon GameLift)

• Python (SDK docs) (Amazon GameLift)

• Ruby (SDK docs) (Amazon GameLift)

• PHP (SDK docs) (Amazon GameLift)

• JavaScript/Node.js ((SDK docs) (Amazon GameLift)