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.DescribeFleetAttributes' paths: /#X-Amz-Target=GameLift.DescribeFleetAttributes: 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: DescribeFleetAttributes description: 'Retrieves core fleet-wide properties, including the computing hardware and deployment configuration for all instances in the fleet.
This operation can be used in the following ways:
To get attributes for one or more specific fleets, provide a list of fleet IDs or fleet ARNs.
To get attributes for all fleets, do not provide a fleet identifier.
When requesting attributes for multiple fleets, use the pagination parameters to retrieve results as a set of sequential pages.
If successful, a FleetAttributes object is returned for each fleet requested, unless the fleet identifier is not found.
Some API operations limit the number of fleet IDs that allowed in one request. If a request exceeds this limit, the request fails and the error message contains the maximum allowed number.
Learn more
Setting up Amazon GameLift fleets
' responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DescribeFleetAttributesOutput' examples: DescribeFleetAttributes200Example: summary: Default DescribeFleetAttributes 200 response x-microcks-default: true value: FleetAttributes: example-value NextToken: example-value '480': description: InternalServiceException content: application/json: schema: $ref: '#/components/schemas/InternalServiceException' examples: DescribeFleetAttributes480Example: summary: Default DescribeFleetAttributes 480 response x-microcks-default: true value: example-value '481': description: NotFoundException content: application/json: schema: $ref: '#/components/schemas/NotFoundException' examples: DescribeFleetAttributes481Example: summary: Default DescribeFleetAttributes 481 response x-microcks-default: true value: example-value '482': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' examples: DescribeFleetAttributes482Example: summary: Default DescribeFleetAttributes 482 response x-microcks-default: true value: example-value '483': description: UnauthorizedException content: application/json: schema: $ref: '#/components/schemas/UnauthorizedException' examples: DescribeFleetAttributes483Example: summary: Default DescribeFleetAttributes 483 response x-microcks-default: true value: example-value requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DescribeFleetAttributesInput' parameters: - name: Limit in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - GameLift.DescribeFleetAttributes summary: Amazon GameLift Describe Fleet Attributes x-microcks-operation: delay: 0 dispatcher: FALLBACK tags: - '#X Amz Target=GameLift.DescribeFleetAttributes' components: schemas: NonZeroAndMaxString: type: string minLength: 1 maxLength: 1024 FleetId: type: string pattern: ^fleet-\S+ InternalServiceException: {} WholeNumber: type: integer minimum: 0 DescribeFleetAttributesInput: type: object title: DescribeFleetAttributesInput properties: FleetIds: allOf: - $ref: '#/components/schemas/FleetIdOrArnList' - description: 'A list of unique fleet identifiers to retrieve attributes for. You can use either the fleet ID or ARN value. To retrieve attributes for all current fleets, do not include this parameter. ' Limit: allOf: - $ref: '#/components/schemas/PositiveInteger' - description: The maximum number of results to return. Use this parameter withNextToken to get results as a set of sequential pages. This parameter is ignored when the request specifies one or a list of fleet IDs.
NextToken:
allOf:
- $ref: '#/components/schemas/NonZeroAndMaxString'
- description: A token that indicates the start of the next sequential page of results. Use the token that is returned with a previous call to this operation. To start at the beginning of the result set, do not specify a value. This parameter is ignored when the request specifies one or a list of fleet IDs.
StringList:
type: array
items:
$ref: '#/components/schemas/NonZeroAndMaxString'
ProtectionPolicy:
type: string
enum:
- NoProtection
- FullProtection
FleetActionList:
type: array
items:
$ref: '#/components/schemas/FleetAction'
minItems: 1
maxItems: 1
FleetStatus:
type: string
enum:
- NEW
- DOWNLOADING
- VALIDATING
- BUILDING
- ACTIVATING
- ACTIVE
- DELETING
- ERROR
- TERMINATED
- NOT_FOUND
FleetArn:
type: string
pattern: ^arn:.*:fleet\/fleet-\S+
FleetAction:
type: string
enum:
- AUTO_SCALING
ComputeType:
type: string
enum:
- EC2
- ANYWHERE
ScriptArn:
type: string
pattern: ^arn:.*:script\/script-\S+
MetricGroup:
type: string
minLength: 1
maxLength: 255
FleetIdOrArnList:
type: array
items:
$ref: '#/components/schemas/FleetIdOrArn'
minItems: 1
FleetIdOrArn:
type: string
pattern: ^fleet-\S+|^arn:.*:fleet\/fleet-\S+
LaunchPathStringModel:
type: string
pattern: '[A-Za-z0-9_:.+\/\\\- ]+'
minLength: 1
maxLength: 1024
ScriptId:
type: string
pattern: ^script-\S+
CertificateConfiguration:
type: object
required:
- CertificateType
properties:
CertificateType:
allOf:
- $ref: '#/components/schemas/CertificateType'
- description: 'Indicates whether a TLS/SSL certificate is generated for a fleet.
Valid values include:
GENERATED - Generate a TLS/SSL certificate for this fleet.
DISABLED - (default) Do not generate a TLS/SSL certificate for this fleet.
GetInstanceCertificate. '
FleetAttributes:
type: object
properties:
FleetId:
allOf:
- $ref: '#/components/schemas/FleetId'
- description: A unique identifier for the fleet.
FleetArn:
allOf:
- $ref: '#/components/schemas/FleetArn'
- description: The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift fleet resource and uniquely identifies it. ARNs are unique across all Regions. Format is arn:aws:gamelift:<region>::fleet/fleet-a1234567-b8c9-0d1e-2fa3-b45c6d7e8912. In a GameLift fleet ARN, the resource ID matches the FleetId value.
FleetType:
allOf:
- $ref: '#/components/schemas/FleetType'
- description: Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to ON_DEMAND. Learn more about when to use On-Demand versus Spot Instances. This property cannot be changed after the fleet is created.
InstanceType:
allOf:
- $ref: '#/components/schemas/EC2InstanceType'
- description: The Amazon EC2 instance type that determines the computing resources of each instance in the fleet. Instance type defines the CPU, memory, storage, and networking capacity. See Amazon Elastic Compute Cloud Instance Types for detailed descriptions.
Description:
allOf:
- $ref: '#/components/schemas/NonZeroAndMaxString'
- description: A human-readable description of the fleet.
Name:
allOf:
- $ref: '#/components/schemas/NonZeroAndMaxString'
- description: A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
CreationTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: A time stamp indicating when this data object was created. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
TerminationTime:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: A time stamp indicating when this data object was terminated. Format is a number expressed in Unix time as milliseconds (for example "1469498468.057").
Status:
allOf:
- $ref: '#/components/schemas/FleetStatus'
- description: Current status of the fleet. Possible fleet statuses include the following:
NEW -- A new fleet has been defined and desired instances is set to 1.
DOWNLOADING/VALIDATING/BUILDING/ACTIVATING -- Amazon GameLift is setting up the new fleet, creating new instances with the game build or Realtime script and starting server processes.
ACTIVE -- Hosts can now accept game sessions.
ERROR -- An error occurred when downloading, validating, building, or activating the fleet.
DELETING -- Hosts are responding to a delete fleet request.
TERMINATED -- The fleet no longer exists.
BuildId value.'
ScriptId:
allOf:
- $ref: '#/components/schemas/ScriptId'
- description: A unique identifier for the Realtime script resource that is deployed on instances in this fleet.
ScriptArn:
allOf:
- $ref: '#/components/schemas/ScriptArn'
- description: ' The Amazon Resource Name (ARN) associated with the GameLift script resource that is deployed on instances in this fleet. In a GameLift script ARN, the resource ID matches the ScriptId value.'
ServerLaunchPath:
allOf:
- $ref: '#/components/schemas/LaunchPathStringModel'
- description: ' This parameter is no longer used. Server launch paths are now defined using the fleet''s RuntimeConfiguration . Requests that use this parameter instead continue to be valid.'
ServerLaunchParameters:
allOf:
- $ref: '#/components/schemas/LaunchParametersStringModel'
- description: ' This parameter is no longer used. Server launch parameters are now defined using the fleet''s runtime configuration . Requests that use this parameter instead continue to be valid.'
LogPaths:
allOf:
- $ref: '#/components/schemas/StringList'
- description: ' This parameter is no longer used. Game session log paths are now defined using the Amazon GameLift server API ProcessReady() logParameters. See more information in the Server API Reference. '
NewGameSessionProtectionPolicy:
allOf:
- $ref: '#/components/schemas/ProtectionPolicy'
- description: The type of game session protection to set on all new instances that are started in the fleet.
NoProtection -- The game session can be terminated during a scale-down event.
FullProtection -- If the game session is in an ACTIVE status, it cannot be terminated during a scale-down event.
Describes a Amazon GameLift fleet of game hosting resources.
Related actions
ResourceCreationLimitPolicy: type: object properties: NewGameSessionsPerCreator: allOf: - $ref: '#/components/schemas/WholeNumber' - description:A policy that puts limits on the number of game sessions that a player can create within a specified span of time. With this policy, you can control players' ability to consume available resources.
The policy is evaluated when a player tries to create a new game session. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than game session limit in the specified time period.
A policy that puts limits on the number of game sessions that a player can create within a specified span of time. With this policy, you can control players' ability to consume available resources.
The policy is evaluated when a player tries to create a new game session. On receiving a CreateGameSession request, Amazon GameLift checks that the player (identified by CreatorId) has created fewer than game session limit in the specified time period.