GameLift service API reference (AWS SDK) - Amazon GameLift

GameLift service API reference (AWS SDK)

The GameLift Service API is packaged into the AWS SDK. Download the AWS SDK or view the Amazon GameLift API reference documentation.

Working with game sessions and players

When using a managed GameLift solution, call these operations from your game client service to start or join game sessions and access game and player session data. These operations are for games with custom game servers that are hosted on GameLift. If you're using Realtime Servers, see the Realtime Servers Client API (C#) Reference.

  • Start new game sessions for one or more players. Find the best hosting resources currently available and use it to start a new game session. Alternatively, create a new game session on a specified fleet.

  • Get players into existing games. Find existing games with available player slots and reserve them for new players.

    • SearchGameSessions – Retrieve all available game sessions or search for game sessions that match a set of criteria.

    • CreatePlayerSession – Reserve an open slot for a player to join a game session. Available in GameLift Local.

    • CreatePlayerSessions – Reserve open slots for multiple players to join a game session. Available in GameLift Local.

  • Work with game session and player session data. Retrieve current data on existing game sessions and player sessions, and update as needed.

    • DescribeGameSessions – Retrieve metadata for one or more game sessions, including length of time active and current player count. Available in GameLift Local.

    • DescribeGameSessionDetails – Retrieve metadata and the game session protection setting for one or more game sessions.

    • GetGameSessionLogUrl – Get the location of saved logs for a game session.

    • DescribePlayerSessions – Get details on player activity, including status, playing time, and player data. Available in GameLift Local.

    • UpdateGameSession – Change game session settings, such as maximum player count and join policy.

Working with managed GameLift hosting resources

When using a managed GameLift solution, call these operations to configure hosting resources for your game servers, scale capacity to meet player demand, access performance and utilization metrics, and more. These API operations are used with game servers that are hosted on GameLift, including Realtime Servers. You can use the GameLift Console for most resource management tasks, or you can make calls to the service using the AWS Command Line Interface (AWS CLI) tool or the AWS SDK.

Set up game servers

Configure the game servers for your game, which are deployed in fleets for hosting.

Custom game server builds

  • CreateBuild – Create a new build using files stored in an Amazon S3 bucket. To create a build and upload files from a local path, use the AWS CLI-only command upload-build.

  • ListBuilds – Get a list of all builds uploaded to a GameLift region.

  • DescribeBuild – Retrieve information associated with a build.

  • UpdateBuild – Change build metadata, including build name and version.

  • DeleteBuild – Remove a build from GameLift.

Realtime Servers configuration scripts

  • CreateScript – Create a new server script to run on Realtime Servers.

  • ListScripts – Get a list of all Realtime scripts uploaded to a GameLift region.

  • DescribeScript – Retrieve information associated with a Realtime script.

  • UpdateScript – Change script metadata and upload revised script content.

  • DeleteScript – Remove a Realtime script from GameLift.

Manage computing resources

Configure hosting resources and deploy your game server build or Realtime configuration script.

Fleets

Set up queues for optimal game session placement

Set up multi-fleet, multi-region queues to place game sessions with the best available hosting resources for cost, latency, and resiliency.

Game session queues

Manage fleet aliases

Use aliases to represent your fleets or create a terminal alternative destination. Aliases are useful when transitioning game activity from one fleet to another, such as during game server build updates.

Aliases

  • CreateAlias – Define a new alias and optionally assign it to a fleet.

  • ListAliases – Get all fleet aliases defined in a GameLift region.

  • DescribeAlias – Retrieve information on an existing alias.

  • UpdateAlias – Change settings for an alias, such as redirecting it from one fleet to another.

  • DeleteAlias – Remove an alias from the region.

  • ResolveAlias – Get the fleet ID that a specified alias points to.

Access hosting instances

View information on individual instances in a fleet, or request remote access to a specified fleet instance for troubleshooting.

  • DescribeInstances – Get information on each instance in a fleet, including instance ID, IP address, and status.

  • GetInstanceAccess – Request access credentials needed to remotely connect to a specified instance in a fleet.

Set up VPC peering

Create and manage VPC peering connections between your GameLift hosting resources and other AWS resources.

Working with FlexMatch matchmaking

When using a managed GameLift solution, use these operations to set up custom matchmaking for your game and request matchmaking for players. You can add FlexMatch to games with a custom game build or Realtime Servers.

Set up matchmaking rules and process

Configure a FlexMatch matchmaker and define a set of rules for creating matches and teams.

Matchmaking configuration

Matchmaking rule set

Request matchmaking

Call these operations from your game client service to manage player matchmaking requests. Successful matches are automatically placed in a new game session.

  • StartMatchmaking – Request matchmaking for one players or a group who want to play together.

  • DescribeMatchmaking – Get details on a matchmaking request, including status.

  • AcceptMatch – For a match that requires player acceptance, register when a player accepts a proposed match.

  • StopMatchmaking – Cancel a matchmaking request.

  • StartMatchBackfill - Request additional player matches to fill empty slots in an existing game session.

Working with GameLift FleetIQ

When using the standalone GameLift FleetIQ solution, use these operations to manage game server groups and game servers that are hosted with Amazon EC2 resources in conjunction with Auto Scaling groups.

Game server groups

Game servers

  • RegisterGameServer – Call from a new game server to notify GameLift FleetIQ that the game server is ready to host gameplay.

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

  • ClaimGameServer – Call from a game client service to locate and reserve a game server to host a new game session.

  • DescribeGameServer – Retrieve metadata for a game server.

  • UpdateGameServer – Change game server metadata, health status, or utilization status.

  • DeregisterGameServer – Call from a terminating game server to prompt GameLift FleetIQ to remove the game server from the game server group.

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.