Amazon GameLift service API

Use this task-based list to find API operations when building your Amazon GameLift game hosting solutions and other features. The AWS SDK includes these operations in the aws.gamelift namespace. Download the AWS SDK or view the Amazon GameLift API reference documentation. You can also use the API with the AWS command line interface (AWS CLI), as documented in the AWS CLI command reference.

The API includes two sets of operations for managed game hosting:

• Manage Amazon GameLift hosting resources

• Start game sessions and join players

The Amazon GameLift Service API also contains operations for use with other Amazon GameLift tools and solutions. For a list of FleetIQ APIs, see FleetIQ API operations. For a list of FlexMatch APIs for matchmaking, see FlexMatch API operations.

Manage Amazon GameLift hosting resources

Call these operations to configure hosting resources for your game servers, scale capacity to meet player demand, get performance and usage metrics, and more. Use these API operations when hosting game servers with Amazon GameLift, including Realtime Servers. You can also work in Amazon GameLift console for most resource management tasks, or you can make calls with the AWS Command Line Interface (AWS CLI) tool.

Prepare game servers for deployment

Upload and configure your game's game server code in preparation for deployment and launching on hosting resources.

Manage custom game server builds

• upload-build – Upload build files from a local path and create a new Amazon GameLift build resource. This operation, available as an AWS CLI command, is the most common way to upload game server builds.

• CreateBuild – Create a new build using files stored in an Amazon S3 bucket.

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

• DescribeBuild – Retrieve information associated with a build.

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

• DeleteBuild – Remove a build from Amazon GameLift.

Manage Realtime Servers configuration scripts

• CreateScript – Upload JavaScript files and create a new Amazon GameLift script resource.

• ListScripts – Get a list of all Realtime scripts uploaded to a Amazon 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 Amazon GameLift.

Set up computing resources for hosting

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

Create and manage fleets

• CreateFleet – Configure and deploy a new Amazon GameLift fleet of computing resources to run your game servers. Once deployed, game servers are automatically launched as configured and ready to host game sessions.

• ListFleets – Get a list of all fleets in a Amazon GameLift region.

• DeleteFleet – Remove a fleet that's no longer running game servers or hosting players.

• View / update fleet locations.

  • CreateFleetLocations – Add remote locations to an existing fleet that supports multiple locations

  • DescribeFleetLocationAttributes – Get a list of all remote locations for a fleet and view the current status of each location.

  • DeleteFleetLocations – Remove remote locations from a fleet that supports multiple locations.

• View / update fleet configurations.

  • DescribeFleetAttributes / UpdateFleetAttributes – View or change a fleet's metadata and settings for game session protection and resource creation limits.

  • DescribeFleetPortSettings / UpdateFleetPortSettings – View or change the inbound permissions (IP address and port setting ranges) allowed for a fleet.

  • DescribeRuntimeConfiguration / UpdateRuntimeConfiguration – View or change what server processes (and how many) to run on each instance in a fleet.

Manage fleet capacity

• DescribeEC2InstanceLimits – Retrieve maximum number of instances allowed for the current AWS account and the current usage level.

• DescribeFleetCapacity – Retrieve the current capacity settings for a fleet's home Region.

• DescribeFleetLocationCapacity – Retrieve the current capacity settings for each location a multi-location fleet.

• UpdateFleetCapacity – Manually adjust capacity settings for a fleet.

• Set up :

  • PutScalingPolicy – Turn on target-based auto-scaling or create a custom auto-scaling policy, or update an existing policy.

  • DescribeScalingPolicies – Retrieve an existing auto-scaling policy.

  • DeleteScalingPolicy – Delete an auto-scaling policy and stop it from affecting a fleet's capacity.

  • StartFleetActions – Restart a fleet's auto-scaling policies.

  • StopFleetActions – Suspend a fleet's auto-scaling policies.

Monitor fleet activity.

• DescribeFleetUtilization – Retrieve statistics on the number of server processes, game sessions, and players that are currently active on a fleet.

• DescribeFleetLocationUtilization – Retrieve utilization statistics for each location in a multi-location fleet.

• DescribeFleetEvents – View logged events for a fleet during a specified time span.

• DescribeGameSessions – Retrieve game session metadata, including a game's running time and current player count.

Set up queues for 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.

• CreateGameSessionQueue – Create a queue for use when processing requests for game session placements.

• DescribeGameSessionQueues – Retrieve game session queues defined in a Amazon GameLift region.

• UpdateGameSessionQueue – Change the configuration of a game session queue.

• DeleteGameSessionQueue – Remove a game session queue from the region.

Manage 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.

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

• ListAliases – Get all fleet aliases defined in a Amazon 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.

Connect to managed 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, location, 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 Amazon GameLift hosting resources and other AWS resources.

• CreateVpcPeeringAuthorization – Authorize a peering connection to one of your VPCs.

• DescribeVpcPeeringAuthorizations – Retrieve valid peering connection authorizations.

• DeleteVpcPeeringAuthorization – Delete a peering connection authorization.

• CreateVpcPeeringConnection – Establish a peering connection between the VPC for a Amazon GameLift fleet and one of your VPCs.

• DescribeVpcPeeringConnections – Retrieve information on active or pending VPC peering connections with a Amazon GameLift fleet.

• DeleteVpcPeeringConnection – Delete a VPC peering connection with a Amazon GameLift fleet.

Start game sessions and join players

Call these operations from a backend service to start new game sessions, get information on existing game sessions, and join players to game sessions. These operations are for use with custom game servers that are hosted on Amazon GameLift. If you're using Realtime Servers, manage game sessions using the Realtime Servers client API (C#) reference.

• Start new game sessions for one or more players.

  • StartGameSessionPlacement – Ask Amazon GameLift to find the best available hosting resources and start a new game session. This is the preferred method for creating new game sessions. It relies on game session queues to track hosting availability across multiple regions, and uses FleetIQ algorithms to prioritize placements based on player latency, hosting cost, location, etc.

  • DescribeGameSessionPlacement – Get details and status on a placement request.

  • StopGameSessionPlacement – Cancel a placement request.

  • CreateGameSession – Start a new, empty game session on a specific fleet location. This operation gives you greater control over where to start the game session, instead of using FleetIQ to evaluate placement options. You must add players to the new game session in a separate step.

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

  • CreatePlayerSession – Reserve an open slot for a player to join a game session.

  • CreatePlayerSessions – Reserve open slots for multiple players to join a game session.

• Work with game session and player session data. Manage information on game sessions and player sessions.

  • SearchGameSessions – Request a list of active game sessions based on a set of search criteria.

  • DescribeGameSessions – Retrieve metadata for specific game sessions, including length of time active and current player count.

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

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

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

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