Amazon GameLift provides solutions for hosting session-based multiplayer game servers in the cloud, including tools for deploying, operating, and scaling game servers. Built on Amazon Web Services global computing infrastructure, GameLift helps you deliver high-performance, high-reliability, low-cost game servers while dynamically scaling your resource usage to meet player demand.
About Amazon GameLift solutions
Get more information on these Amazon GameLift solutions in the Amazon GameLift Developer Guide.
Amazon GameLift managed hosting -- Amazon GameLift offers a fully managed service to set up and maintain computing machines for hosting, manage game session and player session life cycle, and handle security, storage, and performance tracking. You can use automatic scaling tools to balance player demand and hosting costs, configure your game session management to minimize player latency, and add FlexMatch for matchmaking.
Managed hosting with Realtime Servers -- With Amazon GameLift Realtime Servers, you can quickly configure and set up ready-to-go game servers for your game. Realtime Servers provides a game server framework with core Amazon GameLift infrastructure already built in. Then use the full range of Amazon GameLift managed hosting features, including FlexMatch, for your game.
Amazon GameLift FleetIQ -- Use Amazon GameLift FleetIQ as a standalone service while hosting your games using EC2 instances and Auto Scaling groups. Amazon GameLift FleetIQ provides optimizations for game hosting, including boosting the viability of low-cost Spot Instances gaming. For a complete solution, pair the Amazon GameLift FleetIQ and FlexMatch standalone services.
Amazon GameLift FlexMatch -- Add matchmaking to your game hosting solution. FlexMatch is a customizable matchmaking service for multiplayer games. Use FlexMatch as integrated with Amazon GameLift managed hosting or incorporate FlexMatch as a standalone service into your own hosting solution.
About this API Reference
This reference guide describes the low-level service API for Amazon GameLift. With each topic in this guide, you can find links to language-specific SDK guides and the Amazon Web Services CLI reference. Useful links:
x-logo: url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png backgroundColor: '#FFFFFF' termsOfService: https://aws.amazon.com/service-terms/ contact: name: Mike Ralphson email: mike.ralphson@gmail.com url: https://github.com/mermade/aws2openapi x-twitter: PermittedSoc license: name: Apache 2.0 License url: http://www.apache.org/licenses/ x-providerName: amazonaws.com x-serviceName: gamelift x-origin: - contentType: application/json url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/gamelift-2015-10-01.normal.json converter: url: https://github.com/mermade/aws2openapi version: 1.0.0 x-apisguru-driver: external x-apiClientRegistration: url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct x-apisguru-categories: - cloud x-preferred: true servers: - url: http://gamelift.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon GameLift multi-region endpoint - url: https://gamelift.{region}.amazonaws.com variables: region: description: The AWS region enum: - us-east-1 - us-east-2 - us-west-1 - us-west-2 - us-gov-west-1 - us-gov-east-1 - ca-central-1 - eu-north-1 - eu-west-1 - eu-west-2 - eu-west-3 - eu-central-1 - eu-south-1 - af-south-1 - ap-northeast-1 - ap-northeast-2 - ap-northeast-3 - ap-southeast-1 - ap-southeast-2 - ap-east-1 - ap-south-1 - sa-east-1 - me-south-1 default: us-east-1 description: The Amazon GameLift multi-region endpoint - url: http://gamelift.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon GameLift endpoint for China (Beijing) and China (Ningxia) - url: https://gamelift.{region}.amazonaws.com.cn variables: region: description: The AWS region enum: - cn-north-1 - cn-northwest-1 default: cn-north-1 description: The Amazon GameLift endpoint for China (Beijing) and China (Ningxia) security: - hmac: [] tags: - name: '#X Amz Target=GameLift.StartGameSessionPlacement' paths: /#X-Amz-Target=GameLift.StartGameSessionPlacement: parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: operationId: StartGameSessionPlacement description:Places a request for a new game session in a queue. When processing a placement request, Amazon GameLift searches for available resources on the queue's destinations, scanning each until it finds resources or the placement request times out.
A game session placement request can also request player sessions. When a new game session is successfully created, Amazon GameLift creates a player session for each player included in the request.
When placing a game session, by default Amazon GameLift tries each fleet in the order they are listed in the queue configuration. Ideally, a queue's destinations are listed in preference order.
Alternatively, when requesting a game session with players, you can also provide latency data for each player in relevant Regions. Latency data indicates the performance lag a player experiences when connected to a fleet in the Region. Amazon GameLift uses latency data to reorder the list of destinations to place the game session in a Region with minimal lag. If latency data is provided for multiple players, Amazon GameLift calculates each Region's average lag for all players and reorders to get the best game play across all players.
To place a new game session request, specify the following:
The queue name and a set of game session properties and settings
A unique ID (such as a UUID) for the placement. You use this ID to track the status of the placement request
(Optional) A set of player data and a unique player ID for each player that you are joining to the new game session (player data is optional, but if you include it, you must also provide a unique ID for each player)
Latency data for all players (if you want to optimize game play for the players)
If successful, a new game session placement is created.
To track the status of a placement request, call DescribeGameSessionPlacement and check the request's status. If the status is FULFILLED, a new game session has been created and a game session ARN and Region are referenced. If the placement request times out, you can resubmit the request or retry it with a different queue.
GameSession object with a request to start a new game session (see Start a Game Session).
IdStringModel:
type: string
pattern: '[a-zA-Z0-9-]+'
minLength: 1
maxLength: 48
WholeNumber:
type: integer
minimum: 0
InternalServiceException: {}
PlacedPlayerSessionList:
type: array
items:
$ref: '#/components/schemas/PlacedPlayerSession'
GameSessionQueueNameOrArn:
type: string
pattern: '[a-zA-Z0-9-]+|^arn:.*:gamesessionqueue\/[a-zA-Z0-9-]+'
minLength: 1
maxLength: 256
PlayerLatencyList:
type: array
items:
$ref: '#/components/schemas/PlayerLatency'
GameSessionPlacementState:
type: string
enum:
- PENDING
- FULFILLED
- CANCELLED
- TIMED_OUT
- FAILED
IpAddress:
type: string
pattern: ^[0-9A-Fa-f\:\.]+
minLength: 1
maxLength: 128
GameProperty:
type: object
required:
- Key
- Value
properties:
Key:
allOf:
- $ref: '#/components/schemas/GamePropertyKey'
- description: The game property identifier.
Value:
allOf:
- $ref: '#/components/schemas/GamePropertyValue'
- description: The game property value.
description: Set of key-value pairs that contain information about a game session. When included in a game session request, these properties communicate details to be used when setting up the new game session. For example, a game property might specify a game mode, level, or map. Game properties are passed to the game server process when initiating a new game session. For more information, see the Amazon GameLift Developer Guide.
PlayerLatency:
type: object
properties:
PlayerId:
allOf:
- $ref: '#/components/schemas/NonZeroAndMaxString'
- description: A unique identifier for a player associated with the latency data.
RegionIdentifier:
allOf:
- $ref: '#/components/schemas/NonZeroAndMaxString'
- description: Name of the Region that is associated with the latency value.
LatencyInMilliseconds:
allOf:
- $ref: '#/components/schemas/Float'
- description: Amount of time that represents the time lag experienced by the player when connected to the specified Region.
description: 'Regional latency information for a player, used when requesting a new game session. This value indicates the amount of time lag that exists when the player is connected to a fleet in the specified Region. The relative difference between a player''s latency values for multiple Regions are used to determine which fleets are best suited to place a new game session for the player. '
GamePropertyKey:
type: string
maxLength: 32
GamePropertyList:
type: array
items:
$ref: '#/components/schemas/GameProperty'
maxItems: 16
DesiredPlayerSession:
type: object
properties:
PlayerId:
allOf:
- $ref: '#/components/schemas/NonZeroAndMaxString'
- description: A unique identifier for a player to associate with the player session.
PlayerData:
allOf:
- $ref: '#/components/schemas/PlayerData'
- description: Developer-defined information related to a player. Amazon GameLift does not use this data, so it can be formatted as needed for use in the game.
description: Player information for use when creating player sessions using a game session placement request.
InvalidRequestException: {}
DnsName:
type: string
Float:
type: number
format: float
NotFoundException: {}
StartGameSessionPlacementOutput:
type: object
properties:
GameSessionPlacement:
allOf:
- $ref: '#/components/schemas/GameSessionPlacement'
- description: 'Object that describes the newly created game session placement. This object includes all the information provided in the request, as well as start/end time stamps and placement status. '
GameSessionPlacement:
type: object
properties:
PlacementId:
allOf:
- $ref: '#/components/schemas/IdStringModel'
- description: A unique identifier for a game session placement.
GameSessionQueueName:
allOf:
- $ref: '#/components/schemas/GameSessionQueueName'
- description: A descriptive label that is associated with game session queue. Queue names must be unique within each Region.
Status:
allOf:
- $ref: '#/components/schemas/GameSessionPlacementState'
- description: Current status of the game session placement request.
PENDING -- The placement request is currently in the queue waiting to be processed.
FULFILLED -- A new game session and player sessions (if requested) have been successfully created. Values for GameSessionArn and GameSessionRegion are available.
CANCELLED -- The placement request was canceled.
TIMED_OUT -- A new game session was not successfully created before the time limit expired. You can resubmit the placement request as needed.
FAILED -- Amazon GameLift is not able to complete the process of placing the game session. Common reasons are the game session terminated before the placement process was completed, or an unexpected internal error.
FULFILLED).
GameSessionArn:
allOf:
- $ref: '#/components/schemas/NonZeroAndMaxString'
- description: Identifier for the game session created by this placement request. This value is set once the new game session is placed (placement status is FULFILLED). This identifier is unique across all Regions. You can use this value as a GameSessionId value as needed.
GameSessionRegion:
allOf:
- $ref: '#/components/schemas/NonZeroAndMaxString'
- description: Name of the Region where the game session created by this placement request is running. This value is set once the new game session is placed (placement status is FULFILLED).
PlayerLatencies:
allOf:
- $ref: '#/components/schemas/PlayerLatencyList'
- description: A set of values, expressed in milliseconds, that indicates the amount of latency that a player experiences when connected to Amazon Web Services Regions.
StartTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: Time stamp indicating when this request was placed in the queue. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
EndTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: Time stamp indicating when this request was completed, canceled, or timed out.
IpAddress:
allOf:
- $ref: '#/components/schemas/IpAddress'
- description: 'The IP address of the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status is FULFILLED). '
DnsName:
allOf:
- $ref: '#/components/schemas/DnsName'
- description: 'The DNS identifier assigned to the instance that is running the game session. Values have the following format:
TLS-enabled fleets: <unique identifier>.<region identifier>.amazongamelift.com.
Non-TLS-enabled fleets: ec2-<unique identifier>.compute.amazonaws.com. (See Amazon EC2 Instance IP Addressing.)
When connecting to a game session that is running on a TLS-enabled fleet, you must use the DNS name, not the IP address.
' Port: allOf: - $ref: '#/components/schemas/PortNumber' - description: The port number for the game session. To connect to a Amazon GameLift game server, an app needs both the IP address and port number. This value is set once the new game session is placed (placement status isFULFILLED).
PlacedPlayerSessions:
allOf:
- $ref: '#/components/schemas/PlacedPlayerSessionList'
- description: A collection of information on player sessions created in response to the game session placement request. These player sessions are created only once a new game session is successfully placed (placement status is FULFILLED). This information includes the player ID (as provided in the placement request) and the corresponding player session ID.
GameSessionData:
allOf:
- $ref: '#/components/schemas/LargeGameSessionData'
- description: A set of custom game session properties, formatted as a single string value. This data is passed to a game server process in the GameSession object with a request to start a new game session (see Start a Game Session).
MatchmakerData:
allOf:
- $ref: '#/components/schemas/MatchmakerData'
- description: Information on the matchmaking process for this game. Data is in JSON syntax, formatted as a string. It identifies the matchmaking configuration used to create the match, and contains data on all players assigned to the match, including player attributes and team assignments. For more details on matchmaker data, see Match Data.
description: This object includes the full details of the original request plus the current status and start/end time stamps.
PortNumber:
type: integer
minimum: 1
maximum: 60000
PlayerData:
type: string
minLength: 1
maxLength: 2048
MatchmakerData:
type: string
minLength: 1
maxLength: 390000
UnauthorizedException: {}
Timestamp:
type: string
format: date-time
PlacedPlayerSession:
type: object
properties:
PlayerId:
allOf:
- $ref: '#/components/schemas/NonZeroAndMaxString'
- description: A unique identifier for a player that is associated with this player session.
PlayerSessionId:
allOf:
- $ref: '#/components/schemas/PlayerSessionId'
- description: A unique identifier for a player session.
description: Information about a player session. This object contains only the player ID and player session ID. To retrieve full details on a player session, call DescribePlayerSessions with the player session ID.
LargeGameSessionData:
type: string
minLength: 1
maxLength: 262144
DesiredPlayerSessionList:
type: array
items:
$ref: '#/components/schemas/DesiredPlayerSession'
PlayerSessionId:
type: string
pattern: ^psess-\S+
GameSessionQueueName:
type: string
pattern: '[a-zA-Z0-9-]+'
minLength: 1
maxLength: 128
GamePropertyValue:
type: string
maxLength: 96
parameters:
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/gamelift/
x-hasEquivalentPaths: true