Amazon GameLift SDK

• Version
• Description
• Contribute
• Licence

Version

1.4.0

Description

Amazon GameLift Service

Welcome to the /Amazon GameLift API Reference/. Amazon GameLift is a managed Amazon Web Services (AWS) service for developers who need a scalable, server-based solution for multiplayer games. Amazon GameLift provides setup and deployment of game servers, and handles infrastructure scaling and session management. For more information about the GameLift service, including a feature overview, getting started guide, and tutorial, see the accompanying <http://docs.aws.amazon.com/gamelift/latest/developerguide/ Amazon GameLift Developer Guide>.

This reference describes the low-level service API for GameLift. You can call this API directly or use the <https://aws.amazon.com/tools/ AWS SDK> for your preferred language. The AWS SDK includes a set of high-level GameLift actions multiplayer game sessions. Alternatively, you can use the <https://aws.amazon.com/cli/ AWS command-line interface> (CLI) tool, which includes commands for GameLift. For administrative actions, you can use the Amazon GameLift console.

Managing Game and Player Sessions Through GameLift

Call these actions from your game clients and/or services to create and manage multiplayer game sessions.

• Game sessions
  • < CreateGameSession>
  • < DescribeGameSessions>
  • < DescribeGameSessionDetails>
  • < UpdateGameSession>
• Player sessions
  • < CreatePlayerSession>
  • < CreatePlayerSessions>
  • < DescribePlayerSessions>
• Other actions:
  • < GetGameSessionLogUrl>

Setting Up Game Servers

Use these administrative actions to configure GameLift to host your game servers. When configuring GameLift, you'll need to (1) configure a build for your game and provide build files, and (2) set up one or more fleets to host game sessions.

• Build actions:
  • < ListBuilds>
  • < CreateBuild>
  • < DescribeBuild>
  • < UpdateBuild>
  • < DeleteBuild>
  • < RequestUploadCredentials>
• Fleet actions:
  • < ListFleets>
  • < CreateFleet>
  • Describe fleet actions:
    • < DescribeFleetAttributes>
    • < DescribeFleetCapacity>
    • < DescribeFleetPortSettings>
    • < DescribeFleetUtilization>
    • < DescribeEC2InstanceLimits>
    • < DescribeFleetEvents>
  • Update fleet actions:
    • < UpdateFleetAttributes>
    • < UpdateFleetCapacity>
    • < UpdateFleetPortSettings>
  • < DeleteFleet>
• Alias actions:
  • < ListAliases>
  • < CreateAlias>
  • < DescribeAlias>
  • < UpdateAlias>
  • < DeleteAlias>
  • < ResolveAlias>
• Scaling policy actions:
  • < PutScalingPolicy>
  • < DescribeScalingPolicies>
  • < DeleteScalingPolicy>

Documentation is available via Hackage and the AWS API Reference.

The types from this library are intended to be used with amazonka, which provides mechanisms for specifying AuthN/AuthZ information and sending requests.

Use of lenses is required for constructing and manipulating types. This is due to the amount of nesting of AWS types and transparency regarding de/serialisation into more palatable Haskell values. The provided lenses should be compatible with any of the major lens libraries lens or lens-family-core.

Contribute

For any problems, comments, or feedback please create an issue here on GitHub.

Note: this library is an auto-generated Haskell package. Please see amazonka-gen for more information.

Licence

amazonka-gamelift is released under the Mozilla Public License Version 2.0.

Parts of the code are derived from AWS service descriptions, licensed under Apache 2.0. Source files subject to this contain an additional licensing clause in their header.